Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.SSM.CreateResourceDataSync

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

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

s3Destination :: Maybe ResourceDataSyncS3Destination
Amazon S3 configuration details for the sync. This parameter is required if the SyncType value is SyncToDestination.
syncSource :: Maybe ResourceDataSyncSource
Specify information about the data sources to synchronize. This parameter is required if the SyncType value is SyncFromSource.
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.
syncName :: Text
A name for the configuration.

Instances

Instances details

ToJSON CreateResourceDataSync Source #
Instance details Defined in Amazonka.SSM.CreateResourceDataSync Methods toJSON :: CreateResourceDataSync -> Value # toEncoding :: CreateResourceDataSync -> Encoding # toJSONList :: [CreateResourceDataSync] -> Value # toEncodingList :: [CreateResourceDataSync] -> Encoding #
ToHeaders CreateResourceDataSync Source #
Instance details Defined in Amazonka.SSM.CreateResourceDataSync Methods toHeaders :: CreateResourceDataSync -> [Header] #
ToPath CreateResourceDataSync Source #
Instance details Defined in Amazonka.SSM.CreateResourceDataSync Methods toPath :: CreateResourceDataSync -> ByteString #
ToQuery CreateResourceDataSync Source #
Instance details Defined in Amazonka.SSM.CreateResourceDataSync Methods toQuery :: CreateResourceDataSync -> QueryString #
AWSRequest CreateResourceDataSync Source #
Instance details Defined in Amazonka.SSM.CreateResourceDataSync Associated Types type AWSResponse CreateResourceDataSync # Methods request :: (Service -> Service) -> CreateResourceDataSync -> Request CreateResourceDataSync # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateResourceDataSync -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateResourceDataSync))) #
Generic CreateResourceDataSync Source #
Instance details Defined in Amazonka.SSM.CreateResourceDataSync Associated Types type Rep CreateResourceDataSync :: Type -> Type # Methods from :: CreateResourceDataSync -> Rep CreateResourceDataSync x # to :: Rep CreateResourceDataSync x -> CreateResourceDataSync #
Read CreateResourceDataSync Source #
Instance details Defined in Amazonka.SSM.CreateResourceDataSync Methods readsPrec :: Int -> ReadS CreateResourceDataSync # readList :: ReadS [CreateResourceDataSync] # readPrec :: ReadPrec CreateResourceDataSync # readListPrec :: ReadPrec [CreateResourceDataSync] #
Show CreateResourceDataSync Source #
Instance details Defined in Amazonka.SSM.CreateResourceDataSync Methods showsPrec :: Int -> CreateResourceDataSync -> ShowS # show :: CreateResourceDataSync -> String # showList :: [CreateResourceDataSync] -> ShowS #
NFData CreateResourceDataSync Source #
Instance details Defined in Amazonka.SSM.CreateResourceDataSync Methods rnf :: CreateResourceDataSync -> () #
Eq CreateResourceDataSync Source #
Instance details Defined in Amazonka.SSM.CreateResourceDataSync Methods (==) :: CreateResourceDataSync -> CreateResourceDataSync -> Bool # (/=) :: CreateResourceDataSync -> CreateResourceDataSync -> Bool #
Hashable CreateResourceDataSync Source #
Instance details Defined in Amazonka.SSM.CreateResourceDataSync Methods hashWithSalt :: Int -> CreateResourceDataSync -> Int # hash :: CreateResourceDataSync -> Int #
type AWSResponse CreateResourceDataSync Source #
Instance details Defined in Amazonka.SSM.CreateResourceDataSync type AWSResponse CreateResourceDataSync = CreateResourceDataSyncResponse
type Rep CreateResourceDataSync Source #
Instance details Defined in Amazonka.SSM.CreateResourceDataSync type Rep CreateResourceDataSync = D1 ('MetaData "CreateResourceDataSync" "Amazonka.SSM.CreateResourceDataSync" "amazonka-ssm-2.0-Ak65QSGRhJDC5x7UvsCpi8" 'False) (C1 ('MetaCons "CreateResourceDataSync'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "s3Destination") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ResourceDataSyncS3Destination)) :: S1 ('MetaSel ('Just "syncSource") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ResourceDataSyncSource))) :: (S1 ('MetaSel ('Just "syncType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "syncName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newCreateResourceDataSync Source #

Arguments

:: Text	`CreateResourceDataSync`
-> CreateResourceDataSync

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:

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

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

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.

CreateResourceDataSync, createResourceDataSync_syncName - A name for the configuration.

Request Lenses

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

Amazon S3 configuration details for the sync. This parameter is required if the SyncType 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_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_syncName :: Lens' CreateResourceDataSync Text Source #

A name for the configuration.

Destructuring the Response

data CreateResourceDataSyncResponse Source #

See: newCreateResourceDataSyncResponse smart constructor.

Constructors

CreateResourceDataSyncResponse'
Fields httpStatus :: Int The response's http status code.

Instances

Instances details

Generic CreateResourceDataSyncResponse Source #
Instance details Defined in Amazonka.SSM.CreateResourceDataSync Associated Types type Rep CreateResourceDataSyncResponse :: Type -> Type # Methods from :: CreateResourceDataSyncResponse -> Rep CreateResourceDataSyncResponse x # to :: Rep CreateResourceDataSyncResponse x -> CreateResourceDataSyncResponse #
Read CreateResourceDataSyncResponse Source #
Instance details Defined in Amazonka.SSM.CreateResourceDataSync Methods readsPrec :: Int -> ReadS CreateResourceDataSyncResponse # readList :: ReadS [CreateResourceDataSyncResponse] # readPrec :: ReadPrec CreateResourceDataSyncResponse # readListPrec :: ReadPrec [CreateResourceDataSyncResponse] #
Show CreateResourceDataSyncResponse Source #
Instance details Defined in Amazonka.SSM.CreateResourceDataSync Methods showsPrec :: Int -> CreateResourceDataSyncResponse -> ShowS # show :: CreateResourceDataSyncResponse -> String # showList :: [CreateResourceDataSyncResponse] -> ShowS #
NFData CreateResourceDataSyncResponse Source #
Instance details Defined in Amazonka.SSM.CreateResourceDataSync Methods rnf :: CreateResourceDataSyncResponse -> () #
Eq CreateResourceDataSyncResponse Source #
Instance details Defined in Amazonka.SSM.CreateResourceDataSync Methods (==) :: CreateResourceDataSyncResponse -> CreateResourceDataSyncResponse -> Bool # (/=) :: CreateResourceDataSyncResponse -> CreateResourceDataSyncResponse -> Bool #
type Rep CreateResourceDataSyncResponse Source #
Instance details Defined in Amazonka.SSM.CreateResourceDataSync type Rep CreateResourceDataSyncResponse = D1 ('MetaData "CreateResourceDataSyncResponse" "Amazonka.SSM.CreateResourceDataSync" "amazonka-ssm-2.0-Ak65QSGRhJDC5x7UvsCpi8" 'False) (C1 ('MetaCons "CreateResourceDataSyncResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateResourceDataSyncResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateResourceDataSyncResponse'`
-> CreateResourceDataSyncResponse

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

createResourceDataSyncResponse_httpStatus :: Lens' CreateResourceDataSyncResponse Int Source #

The response's http status code.