CfnResourceDataSyncPropsMixin

class aws_cdk.mixins_preview.aws_ssm.mixins.CfnResourceDataSyncPropsMixin(props, *, strategy=None)

Bases: Mixin

The AWS::SSM::ResourceDataSync resource creates, updates, or deletes a resource data sync for AWS Systems Manager .

A resource data sync helps you view data from multiple sources in a single location. Systems Manager offers two types of resource data sync: SyncToDestination and SyncFromSource .

You can configure Systems Manager Inventory to use the SyncToDestination type to synchronize Inventory data from multiple AWS Regions to a single Amazon S3 bucket.

You can configure Systems Manager Explorer to use the SyncFromSource type to synchronize operational work items (OpsItems) and operational data (OpsData) from multiple AWS Regions . This type can synchronize OpsItems and OpsData from multiple AWS accounts and Regions or from an EntireOrganization by using AWS Organizations .

A resource data sync is an asynchronous operation that returns immediately. After a successful initial sync is completed, the system continuously syncs data.

By default, data is not encrypted in Amazon S3 . We strongly recommend that you enable encryption in Amazon S3 to ensure secure data storage. We also recommend that you secure access to the Amazon S3 bucket by creating a restrictive bucket policy.

For more information, see Configuring Inventory Collection and Setting Up Systems Manager Explorer to Display Data from Multiple Accounts and Regions in the AWS Systems Manager User Guide . .. epigraph:

The following *Syntax* section shows all fields that are supported for a resource data sync. The *Examples* section below shows the recommended way to specify configurations for each sync type. Refer to the *Examples* section when you create your resource data sync.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcedatasync.html
CloudformationResource:: AWS::SSM::ResourceDataSync
Mixin:: true
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 import mixins
from aws_cdk.mixins_preview.aws_ssm import mixins as ssm_mixins

cfn_resource_data_sync_props_mixin = ssm_mixins.CfnResourceDataSyncPropsMixin(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"
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::SSM::ResourceDataSync.

Parameters:

props (Union[CfnResourceDataSyncMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['bucketName', 'bucketPrefix', 'bucketRegion', 'kmsKeyArn', 's3Destination', 'syncFormat', 'syncName', 'syncSource', 'syncType']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

AwsOrganizationsSourceProperty

class CfnResourceDataSyncPropsMixin.AwsOrganizationsSourceProperty(*, organizational_units=None, organization_source_type=None)

Bases: object

Information about the AwsOrganizationsSource resource data sync source.

A sync source of this type can synchronize data from AWS Organizations or, if an AWS organization isn’t present, from multiple AWS Regions .

Parameters:

organizational_units (Optional[Sequence[str]]) – The AWS Organizations organization units included in the sync.
organization_source_type (Optional[str]) – If an AWS organization is present, this is either OrganizationalUnits or EntireOrganization . For OrganizationalUnits , the data is aggregated from a set of organization units. For EntireOrganization , the data is aggregated from the entire AWS organization.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-resourcedatasync-awsorganizationssource.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

aws_organizations_source_property = ssm_mixins.CfnResourceDataSyncPropsMixin.AwsOrganizationsSourceProperty(
    organizational_units=["organizationalUnits"],
    organization_source_type="organizationSourceType"
)

Attributes

organization_source_type

If an AWS organization is present, this is either OrganizationalUnits or EntireOrganization .

For OrganizationalUnits , the data is aggregated from a set of organization units. For EntireOrganization , the data is aggregated from the entire AWS organization.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-resourcedatasync-awsorganizationssource.html#cfn-ssm-resourcedatasync-awsorganizationssource-organizationsourcetype

organizational_units

The AWS Organizations organization units included in the sync.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-resourcedatasync-awsorganizationssource.html#cfn-ssm-resourcedatasync-awsorganizationssource-organizationalunits

S3DestinationProperty

class CfnResourceDataSyncPropsMixin.S3DestinationProperty(*, bucket_name=None, bucket_prefix=None, bucket_region=None, kms_key_arn=None, sync_format=None)

Bases: object

Information about the target S3 bucket for the resource data sync.

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 ARN of an encryption key for a destination in Amazon S3. Must belong to the same Region as the destination S3 bucket.
sync_format (Optional[str]) – A supported sync format. The following format is currently supported: JsonSerDe

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-resourcedatasync-s3destination.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

s3_destination_property = ssm_mixins.CfnResourceDataSyncPropsMixin.S3DestinationProperty(
    bucket_name="bucketName",
    bucket_prefix="bucketPrefix",
    bucket_region="bucketRegion",
    kms_key_arn="kmsKeyArn",
    sync_format="syncFormat"
)

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-properties-ssm-resourcedatasync-s3destination.html#cfn-ssm-resourcedatasync-s3destination-bucketname

bucket_prefix

An Amazon S3 prefix for the bucket.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-resourcedatasync-s3destination.html#cfn-ssm-resourcedatasync-s3destination-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-properties-ssm-resourcedatasync-s3destination.html#cfn-ssm-resourcedatasync-s3destination-bucketregion

kms_key_arn

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

Must belong to the same Region as the destination S3 bucket.

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

sync_format

A supported sync format.

The following format is currently supported: JsonSerDe

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

SyncSourceProperty

class CfnResourceDataSyncPropsMixin.SyncSourceProperty(*, aws_organizations_source=None, include_future_regions=None, source_regions=None, source_type=None)

Bases: object

Information about the source of the data included in the resource data sync.

Parameters:

aws_organizations_source (Union[IResolvable, AwsOrganizationsSourceProperty, Dict[str, Any], None]) – Information about the AwsOrganizationsSource resource data sync source. A sync source of this type can synchronize data from AWS Organizations .
include_future_regions (Union[bool, IResolvable, None]) – Whether to automatically synchronize and aggregate data from new AWS Regions when those Regions come online.
source_regions (Optional[Sequence[str]]) – The SyncSource AWS Regions included in the resource data sync.
source_type (Optional[str]) – The type of data source for the resource data sync. SourceType is either AwsOrganizations (if an organization is present in AWS Organizations ) or SingleAccountMultiRegions .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-resourcedatasync-syncsource.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

sync_source_property = 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"
)