Class CfnResourceDataSync
- All Implemented Interfaces:
IInspectable
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
,software.constructs.IDependable
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 .
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. Refer to 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();
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic interface
Information about theAwsOrganizationsSource
resource data sync source.static final class
A fluent builder forCfnResourceDataSync
.static interface
Information about the target S3 bucket for the resource data sync.static interface
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.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ModifierConstructorDescriptionprotected
CfnResourceDataSync
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnResourceDataSync
(software.amazon.jsii.JsiiObjectRef objRef) CfnResourceDataSync
(software.constructs.Construct scope, String id, CfnResourceDataSyncProps props) -
Method Summary
Modifier and TypeMethodDescriptionThe name of the resource data sync.The name of the S3 bucket where the aggregated data is stored.An Amazon S3 prefix for the bucket.The AWS Region with the S3 bucket targeted by the resource data sync.The Amazon Resource Name (ARN) of an encryption key for a destination in Amazon S3 .Configuration information for the target S3 bucket.A supported sync format.A name for the resource data sync.Information about the source where the data was synchronized.The type of resource data sync.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.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 Amazon Resource Name (ARN) of an encryption key for a destination in Amazon S3 .void
setS3Destination
(IResolvable value) Configuration information for the target S3 bucket.void
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
(IResolvable value) Information about the source where the data was synchronized.void
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, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, 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 Details
-
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
-
-
Constructor Details
-
CfnResourceDataSync
protected CfnResourceDataSync(software.amazon.jsii.JsiiObjectRef objRef) -
CfnResourceDataSync
protected CfnResourceDataSync(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
CfnResourceDataSync
@Stability(Stable) public CfnResourceDataSync(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnResourceDataSyncProps props) - Parameters:
scope
- Scope in which this resource is defined. This parameter is required.id
- Construct identifier for this resource (unique in its scope). This parameter is required.props
- Resource properties. This parameter is required.
-
-
Method Details
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- Parameters:
inspector
- tree inspector to collect and process attributes. This parameter is required.
-
renderProperties
@Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String, Object> props) - Overrides:
renderProperties
in classCfnResource
- Parameters:
props
- This parameter is required.
-
getAttrSyncName
The name of the resource data sync. -
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getSyncName
A name for the resource data sync. -
setSyncName
A name for the resource data sync. -
getBucketName
The name of the S3 bucket where the aggregated data is stored. -
setBucketName
The name of the S3 bucket where the aggregated data is stored. -
getBucketPrefix
An Amazon S3 prefix for the bucket. -
setBucketPrefix
An Amazon S3 prefix for the bucket. -
getBucketRegion
The AWS Region with the S3 bucket targeted by the resource data sync. -
setBucketRegion
The AWS Region with the S3 bucket targeted by the resource data sync. -
getKmsKeyArn
The Amazon Resource Name (ARN) of an encryption key for a destination in Amazon S3 . -
setKmsKeyArn
The Amazon Resource Name (ARN) of an encryption key for a destination in Amazon S3 . -
getS3Destination
Configuration information for the target S3 bucket. -
setS3Destination
Configuration information for the target S3 bucket. -
setS3Destination
@Stability(Stable) public void setS3Destination(@Nullable CfnResourceDataSync.S3DestinationProperty value) Configuration information for the target S3 bucket. -
getSyncFormat
A supported sync format. -
setSyncFormat
A supported sync format. -
getSyncSource
Information about the source where the data was synchronized. -
setSyncSource
Information about the source where the data was synchronized. -
setSyncSource
@Stability(Stable) public void setSyncSource(@Nullable CfnResourceDataSync.SyncSourceProperty value) Information about the source where the data was synchronized. -
getSyncType
The type of resource data sync. -
setSyncType
The type of resource data sync.
-