CfnResourceDataSyncMixinProps

class aws_cdk.mixins_preview.aws_ssm.mixins.CfnResourceDataSyncMixinProps(*, bucket_name=None, bucket_prefix=None, bucket_region=None, kms_key_arn=None, s3_destination=None, sync_format=None, sync_name=None, sync_source=None, sync_type=None)

Bases: object

Properties for CfnResourceDataSyncPropsMixin.

Parameters:

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 Amazon Resource Name (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 AWS 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_name (Optional[str]) – A name for the resource data sync.
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 .

See:

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.
from aws_cdk.mixins_preview.aws_ssm import mixins as ssm_mixins

cfn_resource_data_sync_mixin_props = ssm_mixins.CfnResourceDataSyncMixinProps(
    bucket_name="bucketName",
    bucket_prefix="bucketPrefix",
    bucket_region="bucketRegion",
    kms_key_arn="kmsKeyArn",
    s3_destination=ssm_mixins.CfnResourceDataSyncPropsMixin.S3DestinationProperty(
        bucket_name="bucketName",
        bucket_prefix="bucketPrefix",
        bucket_region="bucketRegion",
        kms_key_arn="kmsKeyArn",
        sync_format="syncFormat"
    ),
    sync_format="syncFormat",
    sync_name="syncName",
    sync_source=ssm_mixins.CfnResourceDataSyncPropsMixin.SyncSourceProperty(
        aws_organizations_source=ssm_mixins.CfnResourceDataSyncPropsMixin.AwsOrganizationsSourceProperty(
            organizational_units=["organizationalUnits"],
            organization_source_type="organizationSourceType"
        ),
        include_future_regions=False,
        source_regions=["sourceRegions"],
        source_type="sourceType"
    ),
    sync_type="syncType"
)

Attributes

bucket_name

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

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

bucket_prefix

An Amazon S3 prefix for the bucket.

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

bucket_region

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

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

kms_key_arn

The Amazon Resource Name (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 AWS Region as the destination Amazon S3 bucket.

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

s3_destination

Configuration information for the target S3 bucket.

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

sync_format

A supported sync format.

The following format is currently supported: JsonSerDe

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

sync_name

A name for the resource data sync.

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

sync_source

Information about the source where the data was synchronized.

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

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 .

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