s3_table_integrations

Creates, updates, deletes, gets or lists a s3_table_integrations resource.

Overview

Name	s3_table_integrations
Type	Resource
Id	aws.observabilityadmin.s3_table_integrations

Fields

The following fields are returned by SELECT queries:

get_s3_table_integration

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the S3 Table integration. (pattern: <code>arn:aws([a-z0-9-]+)?:([a-zA-Z0-9-]+):([a-z0-9-]+)?:([0-9]{12})?:(.+)</code>)
created_time_stamp	integer (int64)	The timestamp when the S3 Table integration was created.
destination_table_bucket_arn	string	The Amazon Resource Name (ARN) of the S3 bucket used as the destination for the table data. (pattern: <code>arn:aws([a-z0-9-]+)?:([a-zA-Z0-9-]+):([a-z0-9-]+)?:([0-9]{12})?:(.+)</code>)
encryption	object	Defines the encryption configuration for S3 Table integrations, including the encryption algorithm and KMS key settings.
role_arn	string	The Amazon Resource Name (ARN) of the IAM role used by the S3 Table integration. (pattern: <code>arn:aws([a-z0-9-]+)?:([a-zA-Z0-9-]+):([a-z0-9-]+)?:([0-9]{12})?:(.+)</code>)
status	string	The current status of the S3 Table integration. (ACTIVE, DELETING)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_s3_table_integration	select	region		Retrieves information about a specific S3 Table integration, including its configuration, status, and metadata.
create_s3_table_integration	insert	region, RoleArn		Creates an integration between CloudWatch and S3 Tables for analytics. This integration enables querying CloudWatch telemetry data using analytics engines like Amazon Athena, Amazon Redshift, and Apache Spark.
delete_s3_table_integration	delete	region		Deletes an S3 Table integration and its associated data. This operation removes the connection between CloudWatch Observability Admin and S3 Tables.
list_s3_table_integrations	exec	region		Lists all S3 Table integrations in your account. We recommend using pagination to ensure that the operation returns quickly and successfully.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

get_s3_table_integration

Retrieves information about a specific S3 Table integration, including its configuration, status, and metadata.

SELECT
arn,
created_time_stamp,
destination_table_bucket_arn,
encryption,
role_arn,
status
FROM aws.observabilityadmin.s3_table_integrations
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_s3_table_integration

Creates an integration between CloudWatch and S3 Tables for analytics. This integration enables querying CloudWatch telemetry data using analytics engines like Amazon Athena, Amazon Redshift, and Apache Spark.

INSERT INTO aws.observabilityadmin.s3_table_integrations (
Encryption,
RoleArn,
Tags,
region
)
SELECT 
'{{ Encryption }}',
'{{ RoleArn }}' /* required */,
'{{ Tags }}',
'{{ region }}'
RETURNING
arn
;

Manifest

# Description fields are for documentation purposes
- name: s3_table_integrations
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the s3_table_integrations resource.
  - name: Encryption
    description: |
      Defines the encryption configuration for S3 Table integrations, including the encryption algorithm and KMS key settings.
    value:
      SseAlgorithm: "{{ SseAlgorithm }}"
      KmsKeyArn: "{{ KmsKeyArn }}"
  - name: RoleArn
    value: "{{ RoleArn }}"
  - name: Tags
    value: "{{ Tags }}"

DELETE examples

delete_s3_table_integration

Deletes an S3 Table integration and its associated data. This operation removes the connection between CloudWatch Observability Admin and S3 Tables.

DELETE FROM aws.observabilityadmin.s3_table_integrations
WHERE region = '{{ region }}' --required
;

Lifecycle Methods

list_s3_table_integrations

Lists all S3 Table integrations in your account. We recommend using pagination to ensure that the operation returns quickly and successfully.

EXEC aws.observabilityadmin.s3_table_integrations.list_s3_table_integrations 
@region='{{ region }}' --required 
@@json=
'{
"MaxResults": {{ MaxResults }}, 
"NextToken": "{{ NextToken }}"
}'
;