integrations

Creates, updates, deletes or gets an integration resource or lists integrations in a region

Overview

Name	integrations
Type	Resource
Description	Resource Schema for Logs Integration Resource
Id	awscc.logs.integrations

Fields

get (all properties)

Name	Datatype	Description
integration_name	string	User provided identifier for integration, unique to the user account.
integration_type	string	The type of the Integration.
▶resource_config	object	OpenSearchResourceConfig for the given Integration
integration_status	string	Status of creation for the Integration and its resources
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
integration_name	string	User provided identifier for integration, unique to the user account.
region	string	AWS region.

For more information, see AWS::Logs::Integration.

Methods

Name	Resource	Accessible by	Required Params
create_resource	integrations	INSERT	IntegrationName, IntegrationType, ResourceConfig, region
delete_resource	integrations	DELETE	Identifier, region
list_resources	integrations_list_only	SELECT	region
get_resource	integrations	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual integration.

SELECT
  region,
  integration_name,
  integration_type,
  resource_config,
  integration_status
FROM awscc.logs.integrations
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ integration_name }}';

list (identifiers only)

Lists all integrations in a region.

SELECT
  region,
  integration_name
FROM awscc.logs.integrations_list_only
WHERE
  region = '{{ region }}';

INSERT example

Use the following StackQL query and manifest file to create a new integration resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO awscc.logs.integrations (
  IntegrationName,
  IntegrationType,
  ResourceConfig,
  region
)
SELECT
  '{{ integration_name }}',
  '{{ integration_type }}',
  '{{ resource_config }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.logs.integrations (
  IntegrationName,
  IntegrationType,
  ResourceConfig,
  region
)
SELECT
  '{{ integration_name }}',
  '{{ integration_type }}',
  '{{ resource_config }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Manifest

version: 1
name: stack name
description: stack description
providers:
- aws
globals:
- name: region
  value: '{{ vars.AWS_REGION }}'
resources:
- name: integration
  props:
    - name: integration_name
      value: '{{ integration_name }}'
    - name: integration_type
      value: '{{ integration_type }}'
    - name: resource_config
      value:
        open_search_resource_config:
          kms_key_arn: '{{ kms_key_arn }}'
          data_source_role_arn: null
          dashboard_viewer_principals:
            - null
          application_arn: null
          retention_days: '{{ retention_days }}'

DELETE example

/*+ delete */
DELETE FROM awscc.logs.integrations
WHERE
  Identifier = '{{ integration_name }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

Permissions

To operate on the integrations resource, the following permissions are required:

Create

logs:PutIntegration,
logs:GetIntegration,
aoss:CreateCollection,
aoss:CreateSecurityPolicy,
aoss:CreateAccessPolicy,
aoss:CreateLifeCyclePolicy,
aoss:BatchGetCollection,
aoss:DeleteCollection,
aoss:DeleteSecurityPolicy,
aoss:DeleteAccessPolicy,
aoss:DeleteLifeCyclePolicy,
aoss:GetAccessPolicy,
aoss:GetSecurityPolicy,
aoss:BatchGetLifecyclePolicy,
aoss:TagResource,
aoss:APIAccessAll,
opensearch:AddDirectQueryDataSource,
opensearch:DeleteDirectQueryDataSource,
opensearch:GetDirectQueryDataSource,
opensearch:CreateApplication,
opensearch:GetApplication,
opensearch:UpdateApplication,
opensearch:DeleteApplication,
opensearch:ApplicationAccessAll,
opensearch:DashboardsAccessAll,
opensearch:StartDirectQuery,
opensearch:GetDirectQuery,
iam:PassRole,
iam:CreateServiceLinkedRole,
iam:AttachRolePolicy,
iam:AttachUserPolicy,
es:AddDirectQueryDataSource,
es:CreateApplication,
es:UpdateApplication,
es:GetApplication,
es:DeleteApplication,
es:DeleteDirectQueryDataSource,
es:GetDirectQueryDataSource,
es:AddTags,
es:ListApplications

Read

logs:GetIntegration

Delete

logs:DeleteIntegration

List

logs:ListIntegrations