Table of Contents

Class CfnResourceDataSync

Namespace
Amazon.CDK.AWS.SSM
Assembly
Amazon.CDK.AWS.SSM.dll

A CloudFormation AWS::SSM::ResourceDataSync.

public class CfnResourceDataSync : CfnResource, IInspectable
Inheritance
CfnResourceDataSync
Implements
IInspectable

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.SSM;

             var cfnResourceDataSync = new CfnResourceDataSync(this, "MyCfnResourceDataSync", new CfnResourceDataSyncProps {
                 SyncName = "syncName",

                 // the properties below are optional
                 BucketName = "bucketName",
                 BucketPrefix = "bucketPrefix",
                 BucketRegion = "bucketRegion",
                 KmsKeyArn = "kmsKeyArn",
                 S3Destination = new S3DestinationProperty {
                     BucketName = "bucketName",
                     BucketRegion = "bucketRegion",
                     SyncFormat = "syncFormat",

                     // the properties below are optional
                     BucketPrefix = "bucketPrefix",
                     KmsKeyArn = "kmsKeyArn"
                 },
                 SyncFormat = "syncFormat",
                 SyncSource = new SyncSourceProperty {
                     SourceRegions = new [] { "sourceRegions" },
                     SourceType = "sourceType",

                     // the properties below are optional
                     AwsOrganizationsSource = new AwsOrganizationsSourceProperty {
                         OrganizationSourceType = "organizationSourceType",

                         // the properties below are optional
                         OrganizationalUnits = new [] { "organizationalUnits" }
                     },
                     IncludeFutureRegions = false
                 },
                 SyncType = "syncType"
             });

Remarks

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 .

Important: 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. Please see the Examples section when you create your resource data sync.

CloudformationResource: AWS::SSM::ResourceDataSync

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

ExampleMetadata: fixture=_generated

Constructors

CfnResourceDataSync(Construct, string, ICfnResourceDataSyncProps)

Create a new AWS::SSM::ResourceDataSync.

public CfnResourceDataSync(Construct scope, string id, ICfnResourceDataSyncProps props)

Parameters

scope Construct
  • scope in which this resource is defined.
id string
  • scoped id of the resource.
props ICfnResourceDataSyncProps
  • resource properties.

Properties

AttrSyncName

The name of the resource data sync.

public virtual string AttrSyncName { get; }

Property Value

string

Remarks

CloudformationAttribute: SyncName

BucketName

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

public virtual string? BucketName { get; set; }

Property Value

string

Remarks

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

BucketPrefix

An Amazon S3 prefix for the bucket.

public virtual string? BucketPrefix { get; set; }

Property Value

string

Remarks

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

BucketRegion

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

public virtual string? BucketRegion { get; set; }

Property Value

string

Remarks

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

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

string

CfnProperties 

protected override IDictionary<string, object> CfnProperties { get; }

Property Value

IDictionary<string, object>

KmsKeyArn

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

public virtual string? KmsKeyArn { get; set; }

Property Value

string

Remarks

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

S3Destination

Configuration information for the target S3 bucket.

public virtual object? S3Destination { get; set; }

Property Value

object

Remarks

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

SyncFormat

A supported sync format.

public virtual string? SyncFormat { get; set; }

Property Value

string

Remarks

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

SyncName

A name for the resource data sync.

public virtual string SyncName { get; set; }

Property Value

string

Remarks

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

SyncSource

Information about the source where the data was synchronized.

public virtual object? SyncSource { get; set; }

Property Value

object

Remarks

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

SyncType

The type of resource data sync.

public virtual string? SyncType { get; set; }

Property Value

string

Remarks

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

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)

Parameters

inspector TreeInspector
  • tree inspector to collect and process attributes.

RenderProperties(IDictionary<string, object>) 

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Parameters

props IDictionary<string, object>

Returns

IDictionary<string, object>