libZSservicesZSamazonka-ssmZSamazonka-ssm
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.SSM.CreateResourceDataSync

Description

A resource data sync helps you view data from multiple sources in a single location. Amazon Web Services 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 Amazon Web Services Regions to a single Amazon Simple Storage Service (Amazon S3) bucket. For more information, see Configuring resource data sync for Inventory in the Amazon Web Services Systems Manager User Guide.

You can configure Systems Manager Explorer to use the SyncFromSource type to synchronize operational work items (OpsItems) and operational data (OpsData) from multiple Amazon Web Services Regions to a single Amazon S3 bucket. This type can synchronize OpsItems and OpsData from multiple Amazon Web Services accounts and Amazon Web Services Regions or EntireOrganization by using Organizations. For more information, see Setting up Systems Manager Explorer to display data from multiple accounts and Regions in the Amazon Web Services Systems Manager User Guide.

A resource data sync is an asynchronous operation that returns immediately. After a successful initial sync is completed, the system continuously syncs data. To check the status of a sync, use the ListResourceDataSync.

By default, data isn't 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.

Synopsis

Creating a Request

data CreateResourceDataSync Source #

See: newCreateResourceDataSync smart constructor.

Constructors

CreateResourceDataSync' 

Fields

  • syncType :: Maybe Text

    Specify SyncToDestination to create a resource data sync that synchronizes data to an S3 bucket for Inventory. If you specify SyncToDestination, you must provide a value for S3Destination. Specify SyncFromSource to synchronize data from a single account and multiple Regions, or multiple Amazon Web Services accounts and Amazon Web Services Regions, as listed in Organizations for Explorer. If you specify SyncFromSource, you must provide a value for SyncSource. The default value is SyncToDestination.

  • syncSource :: Maybe ResourceDataSyncSource

    Specify information about the data sources to synchronize. This parameter is required if the SyncType value is SyncFromSource.

  • s3Destination :: Maybe ResourceDataSyncS3Destination

    Amazon S3 configuration details for the sync. This parameter is required if the SyncType value is SyncToDestination.

  • syncName :: Text

    A name for the configuration.

Instances

Instances details
Eq CreateResourceDataSync Source # 
Instance details

Defined in Amazonka.SSM.CreateResourceDataSync

Read CreateResourceDataSync Source # 
Instance details

Defined in Amazonka.SSM.CreateResourceDataSync

Show CreateResourceDataSync Source # 
Instance details

Defined in Amazonka.SSM.CreateResourceDataSync

Generic CreateResourceDataSync Source # 
Instance details

Defined in Amazonka.SSM.CreateResourceDataSync

Associated Types

type Rep CreateResourceDataSync :: Type -> Type #

NFData CreateResourceDataSync Source # 
Instance details

Defined in Amazonka.SSM.CreateResourceDataSync

Methods

rnf :: CreateResourceDataSync -> () #

Hashable CreateResourceDataSync Source # 
Instance details

Defined in Amazonka.SSM.CreateResourceDataSync

ToJSON CreateResourceDataSync Source # 
Instance details

Defined in Amazonka.SSM.CreateResourceDataSync

AWSRequest CreateResourceDataSync Source # 
Instance details

Defined in Amazonka.SSM.CreateResourceDataSync

Associated Types

type AWSResponse CreateResourceDataSync #

ToHeaders CreateResourceDataSync Source # 
Instance details

Defined in Amazonka.SSM.CreateResourceDataSync

ToPath CreateResourceDataSync Source # 
Instance details

Defined in Amazonka.SSM.CreateResourceDataSync

ToQuery CreateResourceDataSync Source # 
Instance details

Defined in Amazonka.SSM.CreateResourceDataSync

type Rep CreateResourceDataSync Source # 
Instance details

Defined in Amazonka.SSM.CreateResourceDataSync

type Rep CreateResourceDataSync = D1 ('MetaData "CreateResourceDataSync" "Amazonka.SSM.CreateResourceDataSync" "libZSservicesZSamazonka-ssmZSamazonka-ssm" 'False) (C1 ('MetaCons "CreateResourceDataSync'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "syncType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "syncSource") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ResourceDataSyncSource))) :*: (S1 ('MetaSel ('Just "s3Destination") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ResourceDataSyncS3Destination)) :*: S1 ('MetaSel ('Just "syncName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse CreateResourceDataSync Source # 
Instance details

Defined in Amazonka.SSM.CreateResourceDataSync

newCreateResourceDataSync Source #

Create a value of CreateResourceDataSync with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:syncType:CreateResourceDataSync', createResourceDataSync_syncType - Specify SyncToDestination to create a resource data sync that synchronizes data to an S3 bucket for Inventory. If you specify SyncToDestination, you must provide a value for S3Destination. Specify SyncFromSource to synchronize data from a single account and multiple Regions, or multiple Amazon Web Services accounts and Amazon Web Services Regions, as listed in Organizations for Explorer. If you specify SyncFromSource, you must provide a value for SyncSource. The default value is SyncToDestination.

$sel:syncSource:CreateResourceDataSync', createResourceDataSync_syncSource - Specify information about the data sources to synchronize. This parameter is required if the SyncType value is SyncFromSource.

$sel:s3Destination:CreateResourceDataSync', createResourceDataSync_s3Destination - Amazon S3 configuration details for the sync. This parameter is required if the SyncType value is SyncToDestination.

$sel:syncName:CreateResourceDataSync', createResourceDataSync_syncName - A name for the configuration.

Request Lenses

createResourceDataSync_syncType :: Lens' CreateResourceDataSync (Maybe Text) Source #

Specify SyncToDestination to create a resource data sync that synchronizes data to an S3 bucket for Inventory. If you specify SyncToDestination, you must provide a value for S3Destination. Specify SyncFromSource to synchronize data from a single account and multiple Regions, or multiple Amazon Web Services accounts and Amazon Web Services Regions, as listed in Organizations for Explorer. If you specify SyncFromSource, you must provide a value for SyncSource. The default value is SyncToDestination.

createResourceDataSync_syncSource :: Lens' CreateResourceDataSync (Maybe ResourceDataSyncSource) Source #

Specify information about the data sources to synchronize. This parameter is required if the SyncType value is SyncFromSource.

createResourceDataSync_s3Destination :: Lens' CreateResourceDataSync (Maybe ResourceDataSyncS3Destination) Source #

Amazon S3 configuration details for the sync. This parameter is required if the SyncType value is SyncToDestination.

Destructuring the Response

data CreateResourceDataSyncResponse Source #

See: newCreateResourceDataSyncResponse smart constructor.

Constructors

CreateResourceDataSyncResponse' 

Fields

Instances

Instances details
Eq CreateResourceDataSyncResponse Source # 
Instance details

Defined in Amazonka.SSM.CreateResourceDataSync

Read CreateResourceDataSyncResponse Source # 
Instance details

Defined in Amazonka.SSM.CreateResourceDataSync

Show CreateResourceDataSyncResponse Source # 
Instance details

Defined in Amazonka.SSM.CreateResourceDataSync

Generic CreateResourceDataSyncResponse Source # 
Instance details

Defined in Amazonka.SSM.CreateResourceDataSync

Associated Types

type Rep CreateResourceDataSyncResponse :: Type -> Type #

NFData CreateResourceDataSyncResponse Source # 
Instance details

Defined in Amazonka.SSM.CreateResourceDataSync

type Rep CreateResourceDataSyncResponse Source # 
Instance details

Defined in Amazonka.SSM.CreateResourceDataSync

type Rep CreateResourceDataSyncResponse = D1 ('MetaData "CreateResourceDataSyncResponse" "Amazonka.SSM.CreateResourceDataSync" "libZSservicesZSamazonka-ssmZSamazonka-ssm" 'False) (C1 ('MetaCons "CreateResourceDataSyncResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateResourceDataSyncResponse Source #

Create a value of CreateResourceDataSyncResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:CreateResourceDataSyncResponse', createResourceDataSyncResponse_httpStatus - The response's http status code.

Response Lenses