Package software.amazon.awscdk.services.ssm

Interface CfnResourceDataSync.S3DestinationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnResourceDataSync.S3DestinationProperty.Jsii$Proxy

Enclosing class:

CfnResourceDataSync

@Stability(Stable)
public static interface CfnResourceDataSync.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.services.ssm.*;
 S3DestinationProperty s3DestinationProperty = S3DestinationProperty.builder()
         .bucketName("bucketName")
         .bucketRegion("bucketRegion")
         .syncFormat("syncFormat")
         // the properties below are optional
         .bucketPrefix("bucketPrefix")
         .kmsKeyArn("kmsKeyArn")
         .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	CfnResourceDataSync.S3DestinationProperty.Builder	A builder for CfnResourceDataSync.S3DestinationProperty
static final class	CfnResourceDataSync.S3DestinationProperty.Jsii$Proxy	An implementation for CfnResourceDataSync.S3DestinationProperty

Method Summary

Modifier and Type	Method	Description
static CfnResourceDataSync.S3DestinationProperty.Builder	builder()
String	getBucketName()	The name of the S3 bucket where the aggregated data is stored.
default String	getBucketPrefix()	An Amazon S3 prefix for the bucket.
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.
String	getSyncFormat()	A supported sync format.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getBucketName

@Stability(Stable)
@NotNull
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

getBucketRegion

@Stability(Stable)
@NotNull
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

getSyncFormat

@Stability(Stable)
@NotNull
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

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

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

builder

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

Returns:

a CfnResourceDataSync.S3DestinationProperty.Builder of CfnResourceDataSync.S3DestinationProperty