Class: Aws::RDS::Types::StartDBInstanceAutomatedBackupsReplicationMessage

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb

Overview

Note:

When making an API call, you may pass StartDBInstanceAutomatedBackupsReplicationMessage data as a hash:

{
  source_db_instance_arn: "String", # required
  backup_retention_period: 1,
  kms_key_id: "String",
  pre_signed_url: "String",
  source_region: "String",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#backup_retention_periodInteger

The retention period for the replicated automated backups.

Returns:

  • (Integer)


23339
23340
23341
23342
23343
23344
23345
23346
23347
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 23339

class StartDBInstanceAutomatedBackupsReplicationMessage < Struct.new(
  :source_db_instance_arn,
  :backup_retention_period,
  :kms_key_id,
  :pre_signed_url,
  :source_region)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_idString

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.

Returns:

  • (String)


23339
23340
23341
23342
23343
23344
23345
23346
23347
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 23339

class StartDBInstanceAutomatedBackupsReplicationMessage < Struct.new(
  :source_db_instance_arn,
  :backup_retention_period,
  :kms_key_id,
  :pre_signed_url,
  :source_region)
  SENSITIVE = []
  include Aws::Structure
end

#pre_signed_urlString

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.

Returns:

  • (String)


23339
23340
23341
23342
23343
23344
23345
23346
23347
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 23339

class StartDBInstanceAutomatedBackupsReplicationMessage < Struct.new(
  :source_db_instance_arn,
  :backup_retention_period,
  :kms_key_id,
  :pre_signed_url,
  :source_region)
  SENSITIVE = []
  include Aws::Structure
end

#source_db_instance_arnString

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.

Returns:

  • (String)


23339
23340
23341
23342
23343
23344
23345
23346
23347
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 23339

class StartDBInstanceAutomatedBackupsReplicationMessage < Struct.new(
  :source_db_instance_arn,
  :backup_retention_period,
  :kms_key_id,
  :pre_signed_url,
  :source_region)
  SENSITIVE = []
  include Aws::Structure
end

#source_regionString

The source region of the snapshot. This is only needed when the shapshot is encrypted and in a different region.

Returns:

  • (String)


23339
23340
23341
23342
23343
23344
23345
23346
23347
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 23339

class StartDBInstanceAutomatedBackupsReplicationMessage < Struct.new(
  :source_db_instance_arn,
  :backup_retention_period,
  :kms_key_id,
  :pre_signed_url,
  :source_region)
  SENSITIVE = []
  include Aws::Structure
end