Class CfnResourceDataSync

The AWS::SSM::ResourceDataSync resource creates, updates, or deletes a resource data sync for AWS Systems Manager .

Inheritance
System.Object
CfnElement
CfnRefElement
CfnResource
CfnResourceDataSync
Implements
Inherited Members
Namespace: Amazon.CDK.AWS.SSM
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnResourceDataSync : CfnResource, IInspectable
Syntax (vb)
Public Class CfnResourceDataSync
    Inherits CfnResource
    Implements IInspectable
Remarks

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcedatasync.html

CloudformationResource: AWS::SSM::ResourceDataSync

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.SSM;

var cfnResourceDataSync = new CfnResourceDataSync(this, "MyCfnResourceDataSync", new CfnResourceDataSyncProps {
    SyncName = "syncName",

    // the properties below are optional
    BucketName = "bucketName",
    BucketPrefix = "bucketPrefix",
    BucketRegion = "bucketRegion",
    KmsKeyArn = "kmsKeyArn",
    S3Destination = new S3DestinationProperty {
        BucketName = "bucketName",
        BucketRegion = "bucketRegion",
        SyncFormat = "syncFormat",

        // the properties below are optional
        BucketPrefix = "bucketPrefix",
        KmsKeyArn = "kmsKeyArn"
    },
    SyncFormat = "syncFormat",
    SyncSource = new SyncSourceProperty {
        SourceRegions = new [] { "sourceRegions" },
        SourceType = "sourceType",

        // the properties below are optional
        AwsOrganizationsSource = new AwsOrganizationsSourceProperty {
            OrganizationSourceType = "organizationSourceType",

            // the properties below are optional
            OrganizationalUnits = new [] { "organizationalUnits" }
        },
        IncludeFutureRegions = false
    },
    SyncType = "syncType"
});

Synopsis

Constructors

CfnResourceDataSync(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference
CfnResourceDataSync(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps
CfnResourceDataSync(Construct, String, ICfnResourceDataSyncProps)

Properties

AttrSyncName

The name of the resource data sync.
BucketName

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

An Amazon S3 prefix for the bucket.
BucketRegion

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

The CloudFormation resource type name for this resource class.
CfnProperties
KmsKeyArn

The Amazon Resource Name (ARN) of an encryption key for a destination in Amazon S3 .
S3Destination

Configuration information for the target S3 bucket.
SyncFormat

A supported sync format.
SyncName

A name for the resource data sync.
SyncSource

Information about the source where the data was synchronized.
SyncType

The type of resource data sync.

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.
RenderProperties(IDictionary<String, Object>)

Constructors

CfnResourceDataSync(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected CfnResourceDataSync(ByRefValue reference)
Parameters
reference Amazon.JSII.Runtime.Deputy.ByRefValue

The Javascript-owned object reference

CfnResourceDataSync(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected CfnResourceDataSync(DeputyBase.DeputyProps props)
Parameters
props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps

The deputy props

CfnResourceDataSync(Construct, String, ICfnResourceDataSyncProps)

public CfnResourceDataSync(Construct scope, string id, ICfnResourceDataSyncProps props)
Parameters
scope Constructs.Construct

Scope in which this resource is defined.

id System.String

Construct identifier for this resource (unique in its scope).

props ICfnResourceDataSyncProps

Resource properties.

Properties

AttrSyncName

The name of the resource data sync.

public virtual string AttrSyncName { get; }
Property Value

System.String

Remarks

CloudformationAttribute: SyncName

BucketName

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

public virtual string BucketName { get; set; }
Property Value

System.String

BucketPrefix

An Amazon S3 prefix for the bucket.

public virtual string BucketPrefix { get; set; }
Property Value

System.String

BucketRegion

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

public virtual string BucketRegion { get; set; }
Property Value

System.String

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value

System.String

CfnProperties

protected override IDictionary<string, object> CfnProperties { get; }
Property Value

System.Collections.Generic.IDictionary<System.String, System.Object>

Overrides

KmsKeyArn

The Amazon Resource Name (ARN) of an encryption key for a destination in Amazon S3 .

public virtual string KmsKeyArn { get; set; }
Property Value

System.String

S3Destination

Configuration information for the target S3 bucket.

public virtual object S3Destination { get; set; }
Property Value

System.Object

SyncFormat

A supported sync format.

public virtual string SyncFormat { get; set; }
Property Value

System.String

SyncName

A name for the resource data sync.

public virtual string SyncName { get; set; }
Property Value

System.String

SyncSource

Information about the source where the data was synchronized.

public virtual object SyncSource { get; set; }
Property Value

System.Object

SyncType

The type of resource data sync.

public virtual string SyncType { get; set; }
Property Value

System.String

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)
Parameters
inspector TreeInspector

tree inspector to collect and process attributes.

RenderProperties(IDictionary<String, Object>)

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns

System.Collections.Generic.IDictionary<System.String, System.Object>

Overrides

Implements