software.amazon.awscdk.services.ssm

Class CfnResourceDataSync

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.ssm.CfnResourceDataSync

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:42.325Z")
 @Stability(value=Stable)
public class CfnResourceDataSync
extends CfnResource
implements IInspectable

A CloudFormation `AWS::SSM::ResourceDataSync`.

The AWS::SSM::ResourceDataSync resource creates, updates, or deletes a resource data sync for AWS Systems Manager . A resource data sync helps you view data from multiple sources in a single location. Systems Manager offers two types of resource data sync: SyncToDestination and SyncFromSource .

You can configure Systems Manager Inventory to use the SyncToDestination type to synchronize Inventory data from multiple AWS Regions to a single Amazon S3 bucket.

You can configure Systems Manager Explorer to use the SyncFromSource type to synchronize operational work items (OpsItems) and operational data (OpsData) from multiple AWS Regions . This type can synchronize OpsItems and OpsData from multiple AWS accounts and Regions or from an EntireOrganization by using AWS Organizations .

A resource data sync is an asynchronous operation that returns immediately. After a successful initial sync is completed, the system continuously syncs data.

By default, data is not encrypted in Amazon S3 . We strongly recommend that you enable encryption in Amazon S3 to ensure secure data storage. We also recommend that you secure access to the Amazon S3 bucket by creating a restrictive bucket policy.

For more information, see Configuring Inventory Collection and Setting Up Systems Manager Explorer to Display Data from Multiple Accounts and Regions in the AWS Systems Manager User Guide .

Important: The following Syntax section shows all fields that are supported for a resource data sync. The Examples section below shows the recommended way to specify configurations for each sync type. Please see the Examples section when you create your 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.*;
 CfnResourceDataSync cfnResourceDataSync = CfnResourceDataSync.Builder.create(this, "MyCfnResourceDataSync")
         .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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CfnResourceDataSync.AwsOrganizationsSourceProperty Information about the `AwsOrganizationsSource` resource data sync source.
static class	CfnResourceDataSync.Builder A fluent builder for CfnResourceDataSync.
static interface	CfnResourceDataSync.S3DestinationProperty Information about the target S3 bucket for the resource data sync.
static interface	CfnResourceDataSync.SyncSourceProperty Information about the source of the data included in the resource data sync.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnResourceDataSync(software.constructs.Construct scope, String id, CfnResourceDataSyncProps props) Create a new `AWS::SSM::ResourceDataSync`.
protected	CfnResourceDataSync(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnResourceDataSync(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrSyncName() The name of the resource data sync.
String	getBucketName() The name of the S3 bucket where the aggregated data is stored.
String	getBucketPrefix() An Amazon S3 prefix for the bucket.
String	getBucketRegion() The AWS Region with the S3 bucket targeted by the resource data sync.
protected Map<String,Object>	getCfnProperties()
String	getKmsKeyArn() The ARN of an encryption key for a destination in Amazon S3 .
Object	getS3Destination() Configuration information for the target S3 bucket.
String	getSyncFormat() A supported sync format.
String	getSyncName() A name for the resource data sync.
Object	getSyncSource() Information about the source where the data was synchronized.
String	getSyncType() The type of resource data sync.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setBucketName(String value) The name of the S3 bucket where the aggregated data is stored.
void	setBucketPrefix(String value) An Amazon S3 prefix for the bucket.
void	setBucketRegion(String value) The AWS Region with the S3 bucket targeted by the resource data sync.
void	setKmsKeyArn(String value) The ARN of an encryption key for a destination in Amazon S3 .
void	setS3Destination(CfnResourceDataSync.S3DestinationProperty value) Configuration information for the target S3 bucket.
void	setS3Destination(IResolvable value) Configuration information for the target S3 bucket.
void	setSyncFormat(String value) A supported sync format.
void	setSyncName(String value) A name for the resource data sync.
void	setSyncSource(CfnResourceDataSync.SyncSourceProperty value) Information about the source where the data was synchronized.
void	setSyncSource(IResolvable value) Information about the source where the data was synchronized.
void	setSyncType(String value) The type of resource data sync.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnResourceDataSync

protected CfnResourceDataSync(software.amazon.jsii.JsiiObjectRef objRef)

CfnResourceDataSync

protected CfnResourceDataSync(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnResourceDataSync

@Stability(value=Stable)
public CfnResourceDataSync(@NotNull
                                                    software.constructs.Construct scope,
                                                    @NotNull
                                                    String id,
                                                    @NotNull
                                                    CfnResourceDataSyncProps props)

Create a new `AWS::SSM::ResourceDataSync`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrSyncName

@Stability(value=Stable)
 @NotNull
public String getAttrSyncName()

The name of the resource data sync.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getSyncName

@Stability(value=Stable)
 @NotNull
public String getSyncName()

A name for the resource data sync.

setSyncName

@Stability(value=Stable)
public void setSyncName(@NotNull
                                                 String value)

A name for the resource data sync.

getBucketName

@Stability(value=Stable)
 @Nullable
public String getBucketName()

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

setBucketName

@Stability(value=Stable)
public void setBucketName(@Nullable
                                                   String value)

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

getBucketPrefix

@Stability(value=Stable)
 @Nullable
public String getBucketPrefix()

An Amazon S3 prefix for the bucket.

setBucketPrefix

@Stability(value=Stable)
public void setBucketPrefix(@Nullable
                                                     String value)

An Amazon S3 prefix for the bucket.

getBucketRegion

@Stability(value=Stable)
 @Nullable
public String getBucketRegion()

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

setBucketRegion

@Stability(value=Stable)
public void setBucketRegion(@Nullable
                                                     String value)

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

getKmsKeyArn

@Stability(value=Stable)
 @Nullable
public String getKmsKeyArn()

The 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 region as the destination Amazon S3 bucket.

setKmsKeyArn

@Stability(value=Stable)
public void setKmsKeyArn(@Nullable
                                                  String value)

The 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 region as the destination Amazon S3 bucket.

getS3Destination

@Stability(value=Stable)
 @Nullable
public Object getS3Destination()

Configuration information for the target S3 bucket.

setS3Destination

@Stability(value=Stable)
public void setS3Destination(@Nullable
                                                      CfnResourceDataSync.S3DestinationProperty value)

Configuration information for the target S3 bucket.

setS3Destination

@Stability(value=Stable)
public void setS3Destination(@Nullable
                                                      IResolvable value)

Configuration information for the target S3 bucket.

getSyncFormat

@Stability(value=Stable)
 @Nullable
public String getSyncFormat()

A supported sync format.

The following format is currently supported: JsonSerDe

setSyncFormat

@Stability(value=Stable)
public void setSyncFormat(@Nullable
                                                   String value)

A supported sync format.

The following format is currently supported: JsonSerDe

getSyncSource

@Stability(value=Stable)
 @Nullable
public Object getSyncSource()

Information about the source where the data was synchronized.

setSyncSource

@Stability(value=Stable)
public void setSyncSource(@Nullable
                                                   CfnResourceDataSync.SyncSourceProperty value)

Information about the source where the data was synchronized.

setSyncSource

@Stability(value=Stable)
public void setSyncSource(@Nullable
                                                   IResolvable value)

Information about the source where the data was synchronized.

getSyncType

@Stability(value=Stable)
 @Nullable
public 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 .

setSyncType

@Stability(value=Stable)
public void setSyncType(@Nullable
                                                 String value)

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 .