amazonka-dms-2.0: Amazon Database Migration Service SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.DMS.UpdateSubscriptionsToEventBridge

Description

Migrates 10 active and enabled Amazon SNS subscriptions at a time and converts them to corresponding Amazon EventBridge rules. By default, this operation migrates subscriptions only when all your replication instance versions are 3.4.6 or higher. If any replication instances are from versions earlier than 3.4.6, the operation raises an error and tells you to upgrade these instances to version 3.4.6 or higher. To enable migration regardless of version, set the Force option to true. However, if you don't upgrade instances earlier than version 3.4.6, some types of events might not be available when you use Amazon EventBridge.

To call this operation, make sure that you have certain permissions added to your user account. For more information, see Migrating event subscriptions to Amazon EventBridge in the Amazon Web Services Database Migration Service User Guide.

Synopsis

Creating a Request

data UpdateSubscriptionsToEventBridge Source #

See: newUpdateSubscriptionsToEventBridge smart constructor.

Constructors

UpdateSubscriptionsToEventBridge' 

Fields

  • forceMove :: Maybe Bool

    When set to true, this operation migrates DMS subscriptions for Amazon SNS notifications no matter what your replication instance version is. If not set or set to false, this operation runs only when all your replication instances are from DMS version 3.4.6 or higher.

Instances

Instances details
ToJSON UpdateSubscriptionsToEventBridge Source # 
Instance details

Defined in Amazonka.DMS.UpdateSubscriptionsToEventBridge

ToHeaders UpdateSubscriptionsToEventBridge Source # 
Instance details

Defined in Amazonka.DMS.UpdateSubscriptionsToEventBridge

ToPath UpdateSubscriptionsToEventBridge Source # 
Instance details

Defined in Amazonka.DMS.UpdateSubscriptionsToEventBridge

ToQuery UpdateSubscriptionsToEventBridge Source # 
Instance details

Defined in Amazonka.DMS.UpdateSubscriptionsToEventBridge

AWSRequest UpdateSubscriptionsToEventBridge Source # 
Instance details

Defined in Amazonka.DMS.UpdateSubscriptionsToEventBridge

Generic UpdateSubscriptionsToEventBridge Source # 
Instance details

Defined in Amazonka.DMS.UpdateSubscriptionsToEventBridge

Associated Types

type Rep UpdateSubscriptionsToEventBridge :: Type -> Type #

Read UpdateSubscriptionsToEventBridge Source # 
Instance details

Defined in Amazonka.DMS.UpdateSubscriptionsToEventBridge

Show UpdateSubscriptionsToEventBridge Source # 
Instance details

Defined in Amazonka.DMS.UpdateSubscriptionsToEventBridge

NFData UpdateSubscriptionsToEventBridge Source # 
Instance details

Defined in Amazonka.DMS.UpdateSubscriptionsToEventBridge

Eq UpdateSubscriptionsToEventBridge Source # 
Instance details

Defined in Amazonka.DMS.UpdateSubscriptionsToEventBridge

Hashable UpdateSubscriptionsToEventBridge Source # 
Instance details

Defined in Amazonka.DMS.UpdateSubscriptionsToEventBridge

type AWSResponse UpdateSubscriptionsToEventBridge Source # 
Instance details

Defined in Amazonka.DMS.UpdateSubscriptionsToEventBridge

type Rep UpdateSubscriptionsToEventBridge Source # 
Instance details

Defined in Amazonka.DMS.UpdateSubscriptionsToEventBridge

type Rep UpdateSubscriptionsToEventBridge = D1 ('MetaData "UpdateSubscriptionsToEventBridge" "Amazonka.DMS.UpdateSubscriptionsToEventBridge" "amazonka-dms-2.0-LVCLJv4CY4nJuf0WXCDs3O" 'False) (C1 ('MetaCons "UpdateSubscriptionsToEventBridge'" 'PrefixI 'True) (S1 ('MetaSel ('Just "forceMove") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))))

newUpdateSubscriptionsToEventBridge :: UpdateSubscriptionsToEventBridge Source #

Create a value of UpdateSubscriptionsToEventBridge 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:forceMove:UpdateSubscriptionsToEventBridge', updateSubscriptionsToEventBridge_forceMove - When set to true, this operation migrates DMS subscriptions for Amazon SNS notifications no matter what your replication instance version is. If not set or set to false, this operation runs only when all your replication instances are from DMS version 3.4.6 or higher.

Request Lenses

updateSubscriptionsToEventBridge_forceMove :: Lens' UpdateSubscriptionsToEventBridge (Maybe Bool) Source #

When set to true, this operation migrates DMS subscriptions for Amazon SNS notifications no matter what your replication instance version is. If not set or set to false, this operation runs only when all your replication instances are from DMS version 3.4.6 or higher.

Destructuring the Response

data UpdateSubscriptionsToEventBridgeResponse Source #

Constructors

UpdateSubscriptionsToEventBridgeResponse' 

Fields

  • result :: Maybe Text

    A string that indicates how many event subscriptions were migrated and how many remain to be migrated.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic UpdateSubscriptionsToEventBridgeResponse Source # 
Instance details

Defined in Amazonka.DMS.UpdateSubscriptionsToEventBridge

Read UpdateSubscriptionsToEventBridgeResponse Source # 
Instance details

Defined in Amazonka.DMS.UpdateSubscriptionsToEventBridge

Show UpdateSubscriptionsToEventBridgeResponse Source # 
Instance details

Defined in Amazonka.DMS.UpdateSubscriptionsToEventBridge

NFData UpdateSubscriptionsToEventBridgeResponse Source # 
Instance details

Defined in Amazonka.DMS.UpdateSubscriptionsToEventBridge

Eq UpdateSubscriptionsToEventBridgeResponse Source # 
Instance details

Defined in Amazonka.DMS.UpdateSubscriptionsToEventBridge

type Rep UpdateSubscriptionsToEventBridgeResponse Source # 
Instance details

Defined in Amazonka.DMS.UpdateSubscriptionsToEventBridge

type Rep UpdateSubscriptionsToEventBridgeResponse = D1 ('MetaData "UpdateSubscriptionsToEventBridgeResponse" "Amazonka.DMS.UpdateSubscriptionsToEventBridge" "amazonka-dms-2.0-LVCLJv4CY4nJuf0WXCDs3O" 'False) (C1 ('MetaCons "UpdateSubscriptionsToEventBridgeResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "result") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newUpdateSubscriptionsToEventBridgeResponse Source #

Create a value of UpdateSubscriptionsToEventBridgeResponse 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:result:UpdateSubscriptionsToEventBridgeResponse', updateSubscriptionsToEventBridgeResponse_result - A string that indicates how many event subscriptions were migrated and how many remain to be migrated.

$sel:httpStatus:UpdateSubscriptionsToEventBridgeResponse', updateSubscriptionsToEventBridgeResponse_httpStatus - The response's http status code.

Response Lenses

updateSubscriptionsToEventBridgeResponse_result :: Lens' UpdateSubscriptionsToEventBridgeResponse (Maybe Text) Source #

A string that indicates how many event subscriptions were migrated and how many remain to be migrated.