Interface ICfnResourceDataSyncProps

Namespace

Amazon.CDK.AWS.SSM

Assembly

Amazon.CDK.AWS.SSM.dll

Properties for defining a CfnResourceDataSync.

public interface ICfnResourceDataSyncProps

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 cfnResourceDataSyncProps = 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

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

ExampleMetadata: fixture=_generated

Properties

BucketName

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

string? BucketName { get; }

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.

string? BucketPrefix { get; }

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.

string? BucketRegion { get; }

Property Value

string

Remarks

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

KmsKeyArn

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

string? KmsKeyArn { get; }

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.

object? S3Destination { get; }

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.

string? SyncFormat { get; }

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.

string SyncName { get; }

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.

object? SyncSource { get; }

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.

string? SyncType { get; }

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