Interface CfnResourceDataSyncProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnResourceDataSyncProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.102.0 (build e354887)",
date="2024-08-23T05:56:24.131Z")
@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:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forCfnResourceDataSyncProps
static final class
An implementation forCfnResourceDataSyncProps
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
default String
The name of the S3 bucket where the aggregated data is stored.default String
An Amazon S3 prefix for the bucket.default String
The AWS Region with the S3 bucket targeted by the resource data sync.default String
The Amazon Resource Name (ARN) of an encryption key for a destination in Amazon S3 .default Object
Configuration information for the target S3 bucket.default String
A supported sync format.A name for the resource data sync.default Object
Information about the source where the data was synchronized.default String
The type of resource data sync.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getSyncName
A name for the resource data sync.- See Also:
-
getBucketName
The name of the S3 bucket where the aggregated data is stored.- See Also:
-
getBucketPrefix
An Amazon S3 prefix for the bucket.- See Also:
-
getBucketRegion
The AWS Region with the S3 bucket targeted by the resource data sync.- See Also:
-
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:
-
getS3Destination
Configuration information for the target S3 bucket.- See Also:
-
getSyncFormat
A supported sync format.The following format is currently supported: JsonSerDe
- See Also:
-
getSyncSource
Information about the source where the data was synchronized.- See Also:
-
getSyncType
The type of resource data sync.If
SyncType
isSyncToDestination
, then the resource data sync synchronizes data to an S3 bucket. If theSyncType
isSyncFromSource
then the resource data sync synchronizes data from AWS Organizations or from multiple AWS Regions .- See Also:
-
builder
- Returns:
- a
CfnResourceDataSyncProps.Builder
ofCfnResourceDataSyncProps
-