Package software.amazon.awscdk.cfnpropertymixins.services.ssm

Interface CfnResourceDataSyncPropsMixin.S3DestinationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnResourceDataSyncPropsMixin.S3DestinationProperty.Jsii$Proxy

Enclosing class:

CfnResourceDataSyncPropsMixin

@Stability(Stable)
public static interface CfnResourceDataSyncPropsMixin.S3DestinationProperty
extends software.amazon.jsii.JsiiSerializable

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

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.ssm.*;
 S3DestinationProperty s3DestinationProperty = S3DestinationProperty.builder()
         .bucketName("bucketName")
         .bucketPrefix("bucketPrefix")
         .bucketRegion("bucketRegion")
         .kmsKeyArn("kmsKeyArn")
         .syncFormat("syncFormat")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnResourceDataSyncPropsMixin.S3DestinationProperty.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 ARN of an encryption key for a destination in Amazon S3.
default String	getSyncFormat()	A supported sync format.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

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

getKmsKeyArn

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

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

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

See Also:

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

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

builder

@Stability(Stable)
static CfnResourceDataSyncPropsMixin.S3DestinationProperty.Builder builder()

Returns:

a CfnResourceDataSyncPropsMixin.S3DestinationProperty.Builder of CfnResourceDataSyncPropsMixin.S3DestinationProperty