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.RDS.StartDBInstanceAutomatedBackupsReplication

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Enables replication of automated backups to a different Amazon Web Services Region.

This command doesn't apply to RDS Custom.

For more information, see Replicating Automated Backups to Another Amazon Web Services Region in the Amazon RDS User Guide.

Synopsis

Creating a Request

data StartDBInstanceAutomatedBackupsReplication Source #

See: newStartDBInstanceAutomatedBackupsReplication smart constructor.

Constructors

StartDBInstanceAutomatedBackupsReplication'

Fields

backupRetentionPeriod :: Maybe Int
The retention period for the replicated automated backups.
destinationRegion :: Maybe Text
Pseudo-parameter used when populating the PreSignedUrl of a cross-region StartDBInstanceAutomatedBackupsReplication request. To replicate from region SRC to region DST, send a request to region DST. In that request, pass a PreSignedUrl for region SRC with DestinationRegion set to region DST.
kmsKeyId :: Maybe Text
The Amazon Web Services KMS key identifier for encryption of the replicated automated backups. The KMS key ID is the Amazon Resource Name (ARN) for the KMS encryption key in the destination Amazon Web Services Region, for example, arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE.
preSignedUrl :: Maybe Text
In an Amazon Web Services GovCloud (US) Region, an URL that contains a Signature Version 4 signed request for the StartDBInstanceAutomatedBackupsReplication operation to call in the Amazon Web Services Region of the source DB instance. The presigned URL must be a valid request for the StartDBInstanceAutomatedBackupsReplication API operation that can run in the Amazon Web Services Region that contains the source DB instance.
This setting applies only to Amazon Web Services GovCloud (US) Regions. It's ignored in other Amazon Web Services Regions.
To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and Signature Version 4 Signing Process.
If you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or --source-region for the CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a presigned URL that is a valid request for the operation that can run in the source Amazon Web Services Region.
sourceDBInstanceArn :: Text
The Amazon Resource Name (ARN) of the source DB instance for the replicated automated backups, for example, arn:aws:rds:us-west-2:123456789012:db:mydatabase.

Instances

Instances details

ToHeaders StartDBInstanceAutomatedBackupsReplication Source #
Instance details Defined in Amazonka.RDS.StartDBInstanceAutomatedBackupsReplication Methods toHeaders :: StartDBInstanceAutomatedBackupsReplication -> [Header] #
ToPath StartDBInstanceAutomatedBackupsReplication Source #
Instance details Defined in Amazonka.RDS.StartDBInstanceAutomatedBackupsReplication Methods toPath :: StartDBInstanceAutomatedBackupsReplication -> ByteString #
ToQuery StartDBInstanceAutomatedBackupsReplication Source #
Instance details Defined in Amazonka.RDS.StartDBInstanceAutomatedBackupsReplication Methods toQuery :: StartDBInstanceAutomatedBackupsReplication -> QueryString #
AWSRequest StartDBInstanceAutomatedBackupsReplication Source #
Instance details Defined in Amazonka.RDS.StartDBInstanceAutomatedBackupsReplication Associated Types type AWSResponse StartDBInstanceAutomatedBackupsReplication # Methods request :: (Service -> Service) -> StartDBInstanceAutomatedBackupsReplication -> Request StartDBInstanceAutomatedBackupsReplication # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy StartDBInstanceAutomatedBackupsReplication -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse StartDBInstanceAutomatedBackupsReplication))) #
Generic StartDBInstanceAutomatedBackupsReplication Source #
Instance details Defined in Amazonka.RDS.StartDBInstanceAutomatedBackupsReplication Associated Types type Rep StartDBInstanceAutomatedBackupsReplication :: Type -> Type # Methods from :: StartDBInstanceAutomatedBackupsReplication -> Rep StartDBInstanceAutomatedBackupsReplication x # to :: Rep StartDBInstanceAutomatedBackupsReplication x -> StartDBInstanceAutomatedBackupsReplication #
Read StartDBInstanceAutomatedBackupsReplication Source #
Instance details Defined in Amazonka.RDS.StartDBInstanceAutomatedBackupsReplication Methods readsPrec :: Int -> ReadS StartDBInstanceAutomatedBackupsReplication # readList :: ReadS [StartDBInstanceAutomatedBackupsReplication] # readPrec :: ReadPrec StartDBInstanceAutomatedBackupsReplication # readListPrec :: ReadPrec [StartDBInstanceAutomatedBackupsReplication] #
Show StartDBInstanceAutomatedBackupsReplication Source #
Instance details Defined in Amazonka.RDS.StartDBInstanceAutomatedBackupsReplication Methods showsPrec :: Int -> StartDBInstanceAutomatedBackupsReplication -> ShowS # show :: StartDBInstanceAutomatedBackupsReplication -> String # showList :: [StartDBInstanceAutomatedBackupsReplication] -> ShowS #
NFData StartDBInstanceAutomatedBackupsReplication Source #
Instance details Defined in Amazonka.RDS.StartDBInstanceAutomatedBackupsReplication Methods rnf :: StartDBInstanceAutomatedBackupsReplication -> () #
Eq StartDBInstanceAutomatedBackupsReplication Source #
Instance details Defined in Amazonka.RDS.StartDBInstanceAutomatedBackupsReplication Methods (==) :: StartDBInstanceAutomatedBackupsReplication -> StartDBInstanceAutomatedBackupsReplication -> Bool # (/=) :: StartDBInstanceAutomatedBackupsReplication -> StartDBInstanceAutomatedBackupsReplication -> Bool #
Hashable StartDBInstanceAutomatedBackupsReplication Source #
Instance details Defined in Amazonka.RDS.StartDBInstanceAutomatedBackupsReplication Methods hashWithSalt :: Int -> StartDBInstanceAutomatedBackupsReplication -> Int # hash :: StartDBInstanceAutomatedBackupsReplication -> Int #
type AWSResponse StartDBInstanceAutomatedBackupsReplication Source #
Instance details Defined in Amazonka.RDS.StartDBInstanceAutomatedBackupsReplication type AWSResponse StartDBInstanceAutomatedBackupsReplication = StartDBInstanceAutomatedBackupsReplicationResponse
type Rep StartDBInstanceAutomatedBackupsReplication Source #
Instance details Defined in Amazonka.RDS.StartDBInstanceAutomatedBackupsReplication type Rep StartDBInstanceAutomatedBackupsReplication = D1 ('MetaData "StartDBInstanceAutomatedBackupsReplication" "Amazonka.RDS.StartDBInstanceAutomatedBackupsReplication" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "StartDBInstanceAutomatedBackupsReplication'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "backupRetentionPeriod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "destinationRegion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "kmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "preSignedUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "sourceDBInstanceArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newStartDBInstanceAutomatedBackupsReplication Source #

Arguments

:: Text	`$sel:sourceDBInstanceArn:StartDBInstanceAutomatedBackupsReplication'`
-> StartDBInstanceAutomatedBackupsReplication

Create a value of StartDBInstanceAutomatedBackupsReplication 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:

StartDBInstanceAutomatedBackupsReplication, startDBInstanceAutomatedBackupsReplication_backupRetentionPeriod - The retention period for the replicated automated backups.

$sel:destinationRegion:StartDBInstanceAutomatedBackupsReplication', startDBInstanceAutomatedBackupsReplication_destinationRegion - Pseudo-parameter used when populating the PreSignedUrl of a cross-region StartDBInstanceAutomatedBackupsReplication request. To replicate from region SRC to region DST, send a request to region DST. In that request, pass a PreSignedUrl for region SRC with DestinationRegion set to region DST.

StartDBInstanceAutomatedBackupsReplication, startDBInstanceAutomatedBackupsReplication_kmsKeyId - The Amazon Web Services KMS key identifier for encryption of the replicated automated backups. The KMS key ID is the Amazon Resource Name (ARN) for the KMS encryption key in the destination Amazon Web Services Region, for example, arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE.

$sel:preSignedUrl:StartDBInstanceAutomatedBackupsReplication', startDBInstanceAutomatedBackupsReplication_preSignedUrl - In an Amazon Web Services GovCloud (US) Region, an URL that contains a Signature Version 4 signed request for the StartDBInstanceAutomatedBackupsReplication operation to call in the Amazon Web Services Region of the source DB instance. The presigned URL must be a valid request for the StartDBInstanceAutomatedBackupsReplication API operation that can run in the Amazon Web Services Region that contains the source DB instance.

This setting applies only to Amazon Web Services GovCloud (US) Regions. It's ignored in other Amazon Web Services Regions.

To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and Signature Version 4 Signing Process.

If you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or --source-region for the CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a presigned URL that is a valid request for the operation that can run in the source Amazon Web Services Region.

$sel:sourceDBInstanceArn:StartDBInstanceAutomatedBackupsReplication', startDBInstanceAutomatedBackupsReplication_sourceDBInstanceArn - The Amazon Resource Name (ARN) of the source DB instance for the replicated automated backups, for example, arn:aws:rds:us-west-2:123456789012:db:mydatabase.

Request Lenses

startDBInstanceAutomatedBackupsReplication_backupRetentionPeriod :: Lens' StartDBInstanceAutomatedBackupsReplication (Maybe Int) Source #

The retention period for the replicated automated backups.

startDBInstanceAutomatedBackupsReplication_destinationRegion :: Lens' StartDBInstanceAutomatedBackupsReplication (Maybe Text) Source #

Pseudo-parameter used when populating the PreSignedUrl of a cross-region StartDBInstanceAutomatedBackupsReplication request. To replicate from region SRC to region DST, send a request to region DST. In that request, pass a PreSignedUrl for region SRC with DestinationRegion set to region DST.

startDBInstanceAutomatedBackupsReplication_kmsKeyId :: Lens' StartDBInstanceAutomatedBackupsReplication (Maybe Text) Source #

The Amazon Web Services KMS key identifier for encryption of the replicated automated backups. The KMS key ID is the Amazon Resource Name (ARN) for the KMS encryption key in the destination Amazon Web Services Region, for example, arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE.

startDBInstanceAutomatedBackupsReplication_preSignedUrl :: Lens' StartDBInstanceAutomatedBackupsReplication (Maybe Text) Source #

In an Amazon Web Services GovCloud (US) Region, an URL that contains a Signature Version 4 signed request for the StartDBInstanceAutomatedBackupsReplication operation to call in the Amazon Web Services Region of the source DB instance. The presigned URL must be a valid request for the StartDBInstanceAutomatedBackupsReplication API operation that can run in the Amazon Web Services Region that contains the source DB instance.

This setting applies only to Amazon Web Services GovCloud (US) Regions. It's ignored in other Amazon Web Services Regions.

To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and Signature Version 4 Signing Process.

If you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or --source-region for the CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a presigned URL that is a valid request for the operation that can run in the source Amazon Web Services Region.

startDBInstanceAutomatedBackupsReplication_sourceDBInstanceArn :: Lens' StartDBInstanceAutomatedBackupsReplication Text Source #

The Amazon Resource Name (ARN) of the source DB instance for the replicated automated backups, for example, arn:aws:rds:us-west-2:123456789012:db:mydatabase.

Destructuring the Response

data StartDBInstanceAutomatedBackupsReplicationResponse Source #

See: newStartDBInstanceAutomatedBackupsReplicationResponse smart constructor.

Constructors

StartDBInstanceAutomatedBackupsReplicationResponse'
Fields dbInstanceAutomatedBackup :: Maybe DBInstanceAutomatedBackup httpStatus :: Int The response's http status code.

Instances

Instances details

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

newStartDBInstanceAutomatedBackupsReplicationResponse Source #

Arguments

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

Create a value of StartDBInstanceAutomatedBackupsReplicationResponse 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:dbInstanceAutomatedBackup:StartDBInstanceAutomatedBackupsReplicationResponse', startDBInstanceAutomatedBackupsReplicationResponse_dbInstanceAutomatedBackup - Undocumented member.

$sel:httpStatus:StartDBInstanceAutomatedBackupsReplicationResponse', startDBInstanceAutomatedBackupsReplicationResponse_httpStatus - The response's http status code.

Response Lenses

startDBInstanceAutomatedBackupsReplicationResponse_dbInstanceAutomatedBackup :: Lens' StartDBInstanceAutomatedBackupsReplicationResponse (Maybe DBInstanceAutomatedBackup) Source #

Undocumented member.

startDBInstanceAutomatedBackupsReplicationResponse_httpStatus :: Lens' StartDBInstanceAutomatedBackupsReplicationResponse Int Source #

The response's http status code.