Package software.amazon.awscdk.services.ssm

Interface CfnResourceDataSyncProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnResourceDataSyncProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-21T06:34:16.562Z")
@Stability(Stable)
public interface CfnResourceDataSyncProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnResourceDataSync.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.ssm.*;
 CfnResourceDataSyncProps cfnResourceDataSyncProps = CfnResourceDataSyncProps.builder()
         .syncName("syncName")
         // the properties below are optional
         .bucketName("bucketName")
         .bucketPrefix("bucketPrefix")
         .bucketRegion("bucketRegion")
         .kmsKeyArn("kmsKeyArn")
         .s3Destination(S3DestinationProperty.builder()
                 .bucketName("bucketName")
                 .bucketRegion("bucketRegion")
                 .syncFormat("syncFormat")
                 // the properties below are optional
                 .bucketPrefix("bucketPrefix")
                 .kmsKeyArn("kmsKeyArn")
                 .build())
         .syncFormat("syncFormat")
         .syncSource(SyncSourceProperty.builder()
                 .sourceRegions(List.of("sourceRegions"))
                 .sourceType("sourceType")
                 // the properties below are optional
                 .awsOrganizationsSource(AwsOrganizationsSourceProperty.builder()
                         .organizationSourceType("organizationSourceType")
                         // the properties below are optional
                         .organizationalUnits(List.of("organizationalUnits"))
                         .build())
                 .includeFutureRegions(false)
                 .build())
         .syncType("syncType")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnResourceDataSyncProps.Builder	A builder for CfnResourceDataSyncProps
static final class	CfnResourceDataSyncProps.Jsii$Proxy	An implementation for CfnResourceDataSyncProps

Method Summary

Modifier and Type	Method	Description
static CfnResourceDataSyncProps.Builder	builder()
default String	getBucketName()	The name of the S3 bucket where the aggregated data is stored.
default String	getBucketPrefix()	An Amazon S3 prefix for the bucket.
default String	getBucketRegion()	The AWS Region with the S3 bucket targeted by the resource data sync.
default String	getKmsKeyArn()	The Amazon Resource Name (ARN) of an encryption key for a destination in Amazon S3 .
default Object	getS3Destination()	Configuration information for the target S3 bucket.
default String	getSyncFormat()	A supported sync format.
String	getSyncName()	A name for the resource data sync.
default Object	getSyncSource()	Information about the source where the data was synchronized.
default String	getSyncType()	The type of resource data sync.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getSyncName

@Stability(Stable)
@NotNull
String getSyncName()

A name for the resource data sync.

See Also:

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

getBucketName

@Stability(Stable)
@Nullable
default String getBucketName()

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

See Also:

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

getBucketPrefix

@Stability(Stable)
@Nullable
default String getBucketPrefix()

An Amazon S3 prefix for the bucket.

See Also:

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

getBucketRegion

@Stability(Stable)
@Nullable
default String getBucketRegion()

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

See Also:

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

getKmsKeyArn

@Stability(Stable)
@Nullable
default String getKmsKeyArn()

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 Also:

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

getS3Destination

@Stability(Stable)
@Nullable
default Object getS3Destination()

Configuration information for the target S3 bucket.

See Also:

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

getSyncFormat

@Stability(Stable)
@Nullable
default String getSyncFormat()

A supported sync format.

The following format is currently supported: JsonSerDe

See Also:

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

getSyncSource

@Stability(Stable)
@Nullable
default Object getSyncSource()

Information about the source where the data was synchronized.

See Also:

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

getSyncType

@Stability(Stable)
@Nullable
default String getSyncType()

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 Also:

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

builder

@Stability(Stable)
static CfnResourceDataSyncProps.Builder builder()

Returns:

a CfnResourceDataSyncProps.Builder of CfnResourceDataSyncProps