resource_data_syncs

Creates, updates, deletes or gets a resource_data_sync resource or lists resource_data_syncs in a region

Overview

Name	resource_data_syncs
Type	Resource
Description	Resource Type definition for AWS::SSM::ResourceDataSync
Id	aws.ssm.resource_data_syncs

Fields

Name	Datatype	Description
s3_destination	object
kms_key_arn	string
sync_source	object
bucket_name	string
bucket_region	string
sync_format	string
sync_name	string
sync_type	string
bucket_prefix	string
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	SyncName, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all resource_data_syncs in a region.

SELECT
region,
s3_destination,
kms_key_arn,
sync_source,
bucket_name,
bucket_region,
sync_format,
sync_name,
sync_type,
bucket_prefix
FROM aws.ssm.resource_data_syncs
WHERE region = 'us-east-1';

Gets all properties from an individual resource_data_sync.

SELECT
region,
s3_destination,
kms_key_arn,
sync_source,
bucket_name,
bucket_region,
sync_format,
sync_name,
sync_type,
bucket_prefix
FROM aws.ssm.resource_data_syncs
WHERE region = 'us-east-1' AND data__Identifier = '<SyncName>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.ssm.resource_data_syncs (
 ,
 region
)
SELECT 
'{{  }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.ssm.resource_data_syncs (
 S3Destination,
 KMSKeyArn,
 SyncSource,
 BucketName,
 BucketRegion,
 SyncFormat,
 SyncType,
 BucketPrefix,
 region
)
SELECT 
 '{{ S3Destination }}',
 '{{ KMSKeyArn }}',
 '{{ SyncSource }}',
 '{{ BucketName }}',
 '{{ BucketRegion }}',
 '{{ SyncFormat }}',
 '{{ SyncType }}',
 '{{ BucketPrefix }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: resource_data_sync
    props:
      - name: S3Destination
        value:
          KMSKeyArn: '{{ KMSKeyArn }}'
          BucketPrefix: '{{ BucketPrefix }}'
          BucketName: '{{ BucketName }}'
          BucketRegion: '{{ BucketRegion }}'
          SyncFormat: '{{ SyncFormat }}'
      - name: KMSKeyArn
        value: '{{ KMSKeyArn }}'
      - name: SyncSource
        value:
          IncludeFutureRegions: '{{ IncludeFutureRegions }}'
          SourceRegions:
            - '{{ SourceRegions[0] }}'
          SourceType: '{{ SourceType }}'
          AwsOrganizationsSource:
            OrganizationalUnits:
              - '{{ OrganizationalUnits[0] }}'
            OrganizationSourceType: '{{ OrganizationSourceType }}'
      - name: BucketName
        value: '{{ BucketName }}'
      - name: BucketRegion
        value: '{{ BucketRegion }}'
      - name: SyncFormat
        value: '{{ SyncFormat }}'
      - name: SyncType
        value: '{{ SyncType }}'
      - name: BucketPrefix
        value: '{{ BucketPrefix }}'

DELETE example

/*+ delete */
DELETE FROM aws.ssm.resource_data_syncs
WHERE data__Identifier = '<SyncName>'
AND region = 'us-east-1';

Permissions

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

Create

ssm:CreateResourceDataSync,
ssm:ListResourceDataSync

Delete

ssm:ListResourceDataSync,
ssm:DeleteResourceDataSync

Update

ssm:ListResourceDataSync,
ssm:UpdateResourceDataSync

List

ssm:ListResourceDataSync

Read

ssm:ListResourceDataSync