CfnResourceDataSyncProps

class aws_cdk.aws_ssm.CfnResourceDataSyncProps(*, sync_name, bucket_name=None, bucket_prefix=None, bucket_region=None, kms_key_arn=None, s3_destination=None, sync_format=None, sync_source=None, sync_type=None)

Bases: object

Properties for defining a CfnResourceDataSync.

Parameters
  • sync_name (str) – A name for the resource data sync.

  • bucket_name (Optional[str]) – The name of the S3 bucket where the aggregated data is stored.

  • bucket_prefix (Optional[str]) – An Amazon S3 prefix for the bucket.

  • bucket_region (Optional[str]) – The AWS Region with the S3 bucket targeted by the resource data sync.

  • kms_key_arn (Optional[str]) – The ARN of an encryption key for a destination in Amazon S3 . You can use a KMS key to encrypt inventory data in Amazon S3 . You must specify a key that exist in the same region as the destination Amazon S3 bucket.

  • s3_destination (Union[IResolvable, S3DestinationProperty, Dict[str, Any], None]) – Configuration information for the target S3 bucket.

  • sync_format (Optional[str]) – A supported sync format. The following format is currently supported: JsonSerDe

  • sync_source (Union[IResolvable, SyncSourceProperty, Dict[str, Any], None]) – Information about the source where the data was synchronized.

  • sync_type (Optional[str]) – The type of resource data sync. If SyncType is SyncToDestination , then the resource data sync synchronizes data to an S3 bucket. If the SyncType is SyncFromSource then the resource data sync synchronizes data from AWS Organizations or from multiple AWS Regions .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcedatasync.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_ssm as ssm

cfn_resource_data_sync_props = ssm.CfnResourceDataSyncProps(
    sync_name="syncName",

    # the properties below are optional
    bucket_name="bucketName",
    bucket_prefix="bucketPrefix",
    bucket_region="bucketRegion",
    kms_key_arn="kmsKeyArn",
    s3_destination=ssm.CfnResourceDataSync.S3DestinationProperty(
        bucket_name="bucketName",
        bucket_region="bucketRegion",
        sync_format="syncFormat",

        # the properties below are optional
        bucket_prefix="bucketPrefix",
        kms_key_arn="kmsKeyArn"
    ),
    sync_format="syncFormat",
    sync_source=ssm.CfnResourceDataSync.SyncSourceProperty(
        source_regions=["sourceRegions"],
        source_type="sourceType",

        # the properties below are optional
        aws_organizations_source=ssm.CfnResourceDataSync.AwsOrganizationsSourceProperty(
            organization_source_type="organizationSourceType",

            # the properties below are optional
            organizational_units=["organizationalUnits"]
        ),
        include_future_regions=False
    ),
    sync_type="syncType"
)

Attributes

bucket_name

The name of the S3 bucket where the aggregated data is stored.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcedatasync.html#cfn-ssm-resourcedatasync-bucketname

Return type

Optional[str]

bucket_prefix

An Amazon S3 prefix for the bucket.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcedatasync.html#cfn-ssm-resourcedatasync-bucketprefix

Return type

Optional[str]

bucket_region

The AWS Region with the S3 bucket targeted by the resource data sync.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcedatasync.html#cfn-ssm-resourcedatasync-bucketregion

Return type

Optional[str]

kms_key_arn

The ARN of an encryption key for a destination in Amazon S3 .

You can use a KMS key to encrypt inventory data in Amazon S3 . You must specify a key that exist in the same region as the destination Amazon S3 bucket.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcedatasync.html#cfn-ssm-resourcedatasync-kmskeyarn

Return type

Optional[str]

s3_destination

Configuration information for the target S3 bucket.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcedatasync.html#cfn-ssm-resourcedatasync-s3destination

Return type

Union[IResolvable, S3DestinationProperty, None]

sync_format

A supported sync format.

The following format is currently supported: JsonSerDe

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcedatasync.html#cfn-ssm-resourcedatasync-syncformat

Return type

Optional[str]

sync_name

A name for the resource data sync.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcedatasync.html#cfn-ssm-resourcedatasync-syncname

Return type

str

sync_source

Information about the source where the data was synchronized.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcedatasync.html#cfn-ssm-resourcedatasync-syncsource

Return type

Union[IResolvable, SyncSourceProperty, None]

sync_type

The type of resource data sync.

If SyncType is SyncToDestination , then the resource data sync synchronizes data to an S3 bucket. If the SyncType is SyncFromSource then the resource data sync synchronizes data from AWS Organizations or from multiple AWS Regions .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcedatasync.html#cfn-ssm-resourcedatasync-synctype

Return type

Optional[str]