Interface ICfnResourceDataSyncProps

Properties for defining a CfnResourceDataSync.

Namespace: Amazon.CDK.AWS.SSM

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface ICfnResourceDataSyncProps

Syntax (vb)

Public Interface ICfnResourceDataSyncProps

Remarks

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

ExampleMetadata: fixture=_generated

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"
};

Synopsis

Properties

BucketName	The name of the S3 bucket where the aggregated data is stored.
BucketPrefix	An Amazon S3 prefix for the bucket.
BucketRegion	The AWS Region with the S3 bucket targeted by the resource data sync.
KmsKeyArn	The Amazon Resource Name (ARN) of an encryption key for a destination in Amazon S3 .
S3Destination	Configuration information for the target S3 bucket.
SyncFormat	A supported sync format.
SyncName	A name for the resource data sync.
SyncSource	Information about the source where the data was synchronized.
SyncType	The type of resource data sync.

Properties

BucketName

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

virtual string BucketName { get; }

Property Value

System.String

Remarks

See: 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.

virtual string BucketPrefix { get; }

Property Value

System.String

Remarks

See: 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.

virtual string BucketRegion { get; }

Property Value

System.String

Remarks

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

KmsKeyArn

The Amazon Resource Name (ARN) of an encryption key for a destination in Amazon S3 .

virtual string KmsKeyArn { get; }

Property Value

System.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 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

S3Destination

Configuration information for the target S3 bucket.

virtual object S3Destination { get; }

Property Value

System.Object

Remarks

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

SyncFormat

A supported sync format.

virtual string SyncFormat { get; }

Property Value

System.String

Remarks

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

SyncName

A name for the resource data sync.

string SyncName { get; }

Property Value

System.String

Remarks

See: 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.

virtual object SyncSource { get; }

Property Value

System.Object

Remarks

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

SyncType

The type of resource data sync.

virtual string SyncType { get; }

Property Value

System.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 .

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