Class: Aws::RDS::Types::DBInstanceAutomatedBackup

Inherits:

Struct

Object
Struct
Aws::RDS::Types::DBInstanceAutomatedBackup

show all

Includes:: Structure

Defined in:: lib/aws-sdk-rds/types.rb

Overview

An automated backup of a DB instance. It consists of system backups, transaction logs, and the database instance properties that existed at the time you deleted the source instance.

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#additional_storage_volumes ⇒ Array<Types::AdditionalStorageVolume>

The additional storage volumes associated with the automated backup.
#allocated_storage ⇒ Integer

The allocated storage size for the automated backup in gibibytes (GiB).
#availability_zone ⇒ String

The Availability Zone that the automated backup was created in.
#aws_backup_recovery_point_arn ⇒ String

The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
#backup_retention_period ⇒ Integer

The retention period for the automated backups.
#backup_target ⇒ String

The location where automated backups are stored: Dedicated Local Zones, Amazon Web Services Outposts or the Amazon Web Services Region.
#db_instance_arn ⇒ String

The Amazon Resource Name (ARN) for the automated backups.
#db_instance_automated_backups_arn ⇒ String

The Amazon Resource Name (ARN) for the replicated automated backups.
#db_instance_automated_backups_replications ⇒ Array<Types::DBInstanceAutomatedBackupsReplication>

The list of replications to different Amazon Web Services Regions associated with the automated backup.
#db_instance_identifier ⇒ String

The identifier for the source DB instance, which can’t be changed and which is unique to an Amazon Web Services Region.
#dbi_resource_id ⇒ String

The resource ID for the source DB instance, which can’t be changed and which is unique to an Amazon Web Services Region.
#dedicated_log_volume ⇒ Boolean

Indicates whether the DB instance has a dedicated log volume (DLV) enabled.
#encrypted ⇒ Boolean

Indicates whether the automated backup is encrypted.
#engine ⇒ String

The name of the database engine for this automated backup.
#engine_version ⇒ String

The version of the database engine for the automated backup.
#iam_database_authentication_enabled ⇒ Boolean

True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
#instance_create_time ⇒ Time

The date and time when the DB instance was created.
#iops ⇒ Integer

The IOPS (I/O operations per second) value for the automated backup.
#kms_key_id ⇒ String

The Amazon Web Services KMS key ID for an automated backup.
#license_model ⇒ String

The license model information for the automated backup.
#master_username ⇒ String

The master user name of an automated backup.
#multi_tenant ⇒ Boolean

Specifies whether the automatic backup is for a DB instance in the multi-tenant configuration (TRUE) or the single-tenant configuration (FALSE).
#option_group_name ⇒ String

The option group the automated backup is associated with.
#port ⇒ Integer

The port number that the automated backup used for connections.
#preferred_backup_window ⇒ String

The daily time range during which automated backups are created if automated backups are enabled, as determined by the ‘BackupRetentionPeriod`.
#region ⇒ String

The Amazon Web Services Region associated with the automated backup.
#restore_window ⇒ Types::RestoreWindow

The earliest and latest time a DB instance can be restored to.
#status ⇒ String

A list of status information for an automated backup:.
#storage_encryption_type ⇒ String

The type of encryption used to protect data at rest in the automated backup.
#storage_throughput ⇒ Integer

The storage throughput for the automated backup.
#storage_type ⇒ String

The storage type associated with the automated backup.
#tag_list ⇒ Array<Types::Tag>

A list of tags.
#tde_credential_arn ⇒ String

The ARN from the key store with which the automated backup is associated for TDE encryption.
#timezone ⇒ String

The time zone of the automated backup.
#vpc_id ⇒ String

The VPC ID associated with the DB instance.

Instance Attribute Details

#additional_storage_volumes ⇒ `Array<Types::AdditionalStorageVolume>`

The additional storage volumes associated with the automated backup.

Valid Values: ‘GP3 | IO2`

Returns:

(Array<Types::AdditionalStorageVolume>)

# File 'lib/aws-sdk-rds/types.rb', line 10456

class DBInstanceAutomatedBackup < Struct.new(
  :db_instance_arn,
  :dbi_resource_id,
  :region,
  :db_instance_identifier,
  :restore_window,
  :allocated_storage,
  :status,
  :port,
  :availability_zone,
  :vpc_id,
  :instance_create_time,
  :master_username,
  :engine,
  :engine_version,
  :license_model,
  :iops,
  :storage_throughput,
  :option_group_name,
  :tde_credential_arn,
  :encrypted,
  :storage_encryption_type,
  :storage_type,
  :kms_key_id,
  :timezone,
  :iam_database_authentication_enabled,
  :backup_retention_period,
  :preferred_backup_window,
  :db_instance_automated_backups_arn,
  :db_instance_automated_backups_replications,
  :backup_target,
  :multi_tenant,
  :aws_backup_recovery_point_arn,
  :tag_list,
  :dedicated_log_volume,
  :additional_storage_volumes)
  SENSITIVE = []
  include Aws::Structure
end

#allocated_storage ⇒ `Integer`

The allocated storage size for the automated backup in gibibytes (GiB).

Returns:

(Integer)

# File 'lib/aws-sdk-rds/types.rb', line 10456

class DBInstanceAutomatedBackup < Struct.new(
  :db_instance_arn,
  :dbi_resource_id,
  :region,
  :db_instance_identifier,
  :restore_window,
  :allocated_storage,
  :status,
  :port,
  :availability_zone,
  :vpc_id,
  :instance_create_time,
  :master_username,
  :engine,
  :engine_version,
  :license_model,
  :iops,
  :storage_throughput,
  :option_group_name,
  :tde_credential_arn,
  :encrypted,
  :storage_encryption_type,
  :storage_type,
  :kms_key_id,
  :timezone,
  :iam_database_authentication_enabled,
  :backup_retention_period,
  :preferred_backup_window,
  :db_instance_automated_backups_arn,
  :db_instance_automated_backups_replications,
  :backup_target,
  :multi_tenant,
  :aws_backup_recovery_point_arn,
  :tag_list,
  :dedicated_log_volume,
  :additional_storage_volumes)
  SENSITIVE = []
  include Aws::Structure
end

#availability_zone ⇒ `String`

The Availability Zone that the automated backup was created in. For information on Amazon Web Services Regions and Availability Zones, see [Regions and Availability Zones].

[1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html

Returns:

(String)

# File 'lib/aws-sdk-rds/types.rb', line 10456

class DBInstanceAutomatedBackup < Struct.new(
  :db_instance_arn,
  :dbi_resource_id,
  :region,
  :db_instance_identifier,
  :restore_window,
  :allocated_storage,
  :status,
  :port,
  :availability_zone,
  :vpc_id,
  :instance_create_time,
  :master_username,
  :engine,
  :engine_version,
  :license_model,
  :iops,
  :storage_throughput,
  :option_group_name,
  :tde_credential_arn,
  :encrypted,
  :storage_encryption_type,
  :storage_type,
  :kms_key_id,
  :timezone,
  :iam_database_authentication_enabled,
  :backup_retention_period,
  :preferred_backup_window,
  :db_instance_automated_backups_arn,
  :db_instance_automated_backups_replications,
  :backup_target,
  :multi_tenant,
  :aws_backup_recovery_point_arn,
  :tag_list,
  :dedicated_log_volume,
  :additional_storage_volumes)
  SENSITIVE = []
  include Aws::Structure
end

#aws_backup_recovery_point_arn ⇒ `String`

The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.

Returns:

(String)

# File 'lib/aws-sdk-rds/types.rb', line 10456

class DBInstanceAutomatedBackup < Struct.new(
  :db_instance_arn,
  :dbi_resource_id,
  :region,
  :db_instance_identifier,
  :restore_window,
  :allocated_storage,
  :status,
  :port,
  :availability_zone,
  :vpc_id,
  :instance_create_time,
  :master_username,
  :engine,
  :engine_version,
  :license_model,
  :iops,
  :storage_throughput,
  :option_group_name,
  :tde_credential_arn,
  :encrypted,
  :storage_encryption_type,
  :storage_type,
  :kms_key_id,
  :timezone,
  :iam_database_authentication_enabled,
  :backup_retention_period,
  :preferred_backup_window,
  :db_instance_automated_backups_arn,
  :db_instance_automated_backups_replications,
  :backup_target,
  :multi_tenant,
  :aws_backup_recovery_point_arn,
  :tag_list,
  :dedicated_log_volume,
  :additional_storage_volumes)
  SENSITIVE = []
  include Aws::Structure
end

#backup_retention_period ⇒ `Integer`

The retention period for the automated backups.

Returns:

(Integer)

# File 'lib/aws-sdk-rds/types.rb', line 10456

class DBInstanceAutomatedBackup < Struct.new(
  :db_instance_arn,
  :dbi_resource_id,
  :region,
  :db_instance_identifier,
  :restore_window,
  :allocated_storage,
  :status,
  :port,
  :availability_zone,
  :vpc_id,
  :instance_create_time,
  :master_username,
  :engine,
  :engine_version,
  :license_model,
  :iops,
  :storage_throughput,
  :option_group_name,
  :tde_credential_arn,
  :encrypted,
  :storage_encryption_type,
  :storage_type,
  :kms_key_id,
  :timezone,
  :iam_database_authentication_enabled,
  :backup_retention_period,
  :preferred_backup_window,
  :db_instance_automated_backups_arn,
  :db_instance_automated_backups_replications,
  :backup_target,
  :multi_tenant,
  :aws_backup_recovery_point_arn,
  :tag_list,
  :dedicated_log_volume,
  :additional_storage_volumes)
  SENSITIVE = []
  include Aws::Structure
end

#backup_target ⇒ `String`

The location where automated backups are stored: Dedicated Local Zones, Amazon Web Services Outposts or the Amazon Web Services Region.

Returns:

(String)

# File 'lib/aws-sdk-rds/types.rb', line 10456

class DBInstanceAutomatedBackup < Struct.new(
  :db_instance_arn,
  :dbi_resource_id,
  :region,
  :db_instance_identifier,
  :restore_window,
  :allocated_storage,
  :status,
  :port,
  :availability_zone,
  :vpc_id,
  :instance_create_time,
  :master_username,
  :engine,
  :engine_version,
  :license_model,
  :iops,
  :storage_throughput,
  :option_group_name,
  :tde_credential_arn,
  :encrypted,
  :storage_encryption_type,
  :storage_type,
  :kms_key_id,
  :timezone,
  :iam_database_authentication_enabled,
  :backup_retention_period,
  :preferred_backup_window,
  :db_instance_automated_backups_arn,
  :db_instance_automated_backups_replications,
  :backup_target,
  :multi_tenant,
  :aws_backup_recovery_point_arn,
  :tag_list,
  :dedicated_log_volume,
  :additional_storage_volumes)
  SENSITIVE = []
  include Aws::Structure
end

#db_instance_arn ⇒ `String`

The Amazon Resource Name (ARN) for the automated backups.

Returns:

(String)

# File 'lib/aws-sdk-rds/types.rb', line 10456

class DBInstanceAutomatedBackup < Struct.new(
  :db_instance_arn,
  :dbi_resource_id,
  :region,
  :db_instance_identifier,
  :restore_window,
  :allocated_storage,
  :status,
  :port,
  :availability_zone,
  :vpc_id,
  :instance_create_time,
  :master_username,
  :engine,
  :engine_version,
  :license_model,
  :iops,
  :storage_throughput,
  :option_group_name,
  :tde_credential_arn,
  :encrypted,
  :storage_encryption_type,
  :storage_type,
  :kms_key_id,
  :timezone,
  :iam_database_authentication_enabled,
  :backup_retention_period,
  :preferred_backup_window,
  :db_instance_automated_backups_arn,
  :db_instance_automated_backups_replications,
  :backup_target,
  :multi_tenant,
  :aws_backup_recovery_point_arn,
  :tag_list,
  :dedicated_log_volume,
  :additional_storage_volumes)
  SENSITIVE = []
  include Aws::Structure
end

#db_instance_automated_backups_arn ⇒ `String`

The Amazon Resource Name (ARN) for the replicated automated backups.

Returns:

(String)

# File 'lib/aws-sdk-rds/types.rb', line 10456

class DBInstanceAutomatedBackup < Struct.new(
  :db_instance_arn,
  :dbi_resource_id,
  :region,
  :db_instance_identifier,
  :restore_window,
  :allocated_storage,
  :status,
  :port,
  :availability_zone,
  :vpc_id,
  :instance_create_time,
  :master_username,
  :engine,
  :engine_version,
  :license_model,
  :iops,
  :storage_throughput,
  :option_group_name,
  :tde_credential_arn,
  :encrypted,
  :storage_encryption_type,
  :storage_type,
  :kms_key_id,
  :timezone,
  :iam_database_authentication_enabled,
  :backup_retention_period,
  :preferred_backup_window,
  :db_instance_automated_backups_arn,
  :db_instance_automated_backups_replications,
  :backup_target,
  :multi_tenant,
  :aws_backup_recovery_point_arn,
  :tag_list,
  :dedicated_log_volume,
  :additional_storage_volumes)
  SENSITIVE = []
  include Aws::Structure
end

#db_instance_automated_backups_replications ⇒ `Array<Types::DBInstanceAutomatedBackupsReplication>`

The list of replications to different Amazon Web Services Regions associated with the automated backup.

Returns:

(Array<Types::DBInstanceAutomatedBackupsReplication>)

# File 'lib/aws-sdk-rds/types.rb', line 10456

class DBInstanceAutomatedBackup < Struct.new(
  :db_instance_arn,
  :dbi_resource_id,
  :region,
  :db_instance_identifier,
  :restore_window,
  :allocated_storage,
  :status,
  :port,
  :availability_zone,
  :vpc_id,
  :instance_create_time,
  :master_username,
  :engine,
  :engine_version,
  :license_model,
  :iops,
  :storage_throughput,
  :option_group_name,
  :tde_credential_arn,
  :encrypted,
  :storage_encryption_type,
  :storage_type,
  :kms_key_id,
  :timezone,
  :iam_database_authentication_enabled,
  :backup_retention_period,
  :preferred_backup_window,
  :db_instance_automated_backups_arn,
  :db_instance_automated_backups_replications,
  :backup_target,
  :multi_tenant,
  :aws_backup_recovery_point_arn,
  :tag_list,
  :dedicated_log_volume,
  :additional_storage_volumes)
  SENSITIVE = []
  include Aws::Structure
end

#db_instance_identifier ⇒ `String`

The identifier for the source DB instance, which can’t be changed and which is unique to an Amazon Web Services Region.

Returns:

(String)

# File 'lib/aws-sdk-rds/types.rb', line 10456

class DBInstanceAutomatedBackup < Struct.new(
  :db_instance_arn,
  :dbi_resource_id,
  :region,
  :db_instance_identifier,
  :restore_window,
  :allocated_storage,
  :status,
  :port,
  :availability_zone,
  :vpc_id,
  :instance_create_time,
  :master_username,
  :engine,
  :engine_version,
  :license_model,
  :iops,
  :storage_throughput,
  :option_group_name,
  :tde_credential_arn,
  :encrypted,
  :storage_encryption_type,
  :storage_type,
  :kms_key_id,
  :timezone,
  :iam_database_authentication_enabled,
  :backup_retention_period,
  :preferred_backup_window,
  :db_instance_automated_backups_arn,
  :db_instance_automated_backups_replications,
  :backup_target,
  :multi_tenant,
  :aws_backup_recovery_point_arn,
  :tag_list,
  :dedicated_log_volume,
  :additional_storage_volumes)
  SENSITIVE = []
  include Aws::Structure
end

#dbi_resource_id ⇒ `String`

The resource ID for the source DB instance, which can’t be changed and which is unique to an Amazon Web Services Region.

Returns:

(String)

# File 'lib/aws-sdk-rds/types.rb', line 10456

class DBInstanceAutomatedBackup < Struct.new(
  :db_instance_arn,
  :dbi_resource_id,
  :region,
  :db_instance_identifier,
  :restore_window,
  :allocated_storage,
  :status,
  :port,
  :availability_zone,
  :vpc_id,
  :instance_create_time,
  :master_username,
  :engine,
  :engine_version,
  :license_model,
  :iops,
  :storage_throughput,
  :option_group_name,
  :tde_credential_arn,
  :encrypted,
  :storage_encryption_type,
  :storage_type,
  :kms_key_id,
  :timezone,
  :iam_database_authentication_enabled,
  :backup_retention_period,
  :preferred_backup_window,
  :db_instance_automated_backups_arn,
  :db_instance_automated_backups_replications,
  :backup_target,
  :multi_tenant,
  :aws_backup_recovery_point_arn,
  :tag_list,
  :dedicated_log_volume,
  :additional_storage_volumes)
  SENSITIVE = []
  include Aws::Structure
end

#dedicated_log_volume ⇒ `Boolean`

Indicates whether the DB instance has a dedicated log volume (DLV) enabled.

Returns:

(Boolean)

# File 'lib/aws-sdk-rds/types.rb', line 10456

class DBInstanceAutomatedBackup < Struct.new(
  :db_instance_arn,
  :dbi_resource_id,
  :region,
  :db_instance_identifier,
  :restore_window,
  :allocated_storage,
  :status,
  :port,
  :availability_zone,
  :vpc_id,
  :instance_create_time,
  :master_username,
  :engine,
  :engine_version,
  :license_model,
  :iops,
  :storage_throughput,
  :option_group_name,
  :tde_credential_arn,
  :encrypted,
  :storage_encryption_type,
  :storage_type,
  :kms_key_id,
  :timezone,
  :iam_database_authentication_enabled,
  :backup_retention_period,
  :preferred_backup_window,
  :db_instance_automated_backups_arn,
  :db_instance_automated_backups_replications,
  :backup_target,
  :multi_tenant,
  :aws_backup_recovery_point_arn,
  :tag_list,
  :dedicated_log_volume,
  :additional_storage_volumes)
  SENSITIVE = []
  include Aws::Structure
end

#encrypted ⇒ `Boolean`

Indicates whether the automated backup is encrypted.

Returns:

(Boolean)

# File 'lib/aws-sdk-rds/types.rb', line 10456

class DBInstanceAutomatedBackup < Struct.new(
  :db_instance_arn,
  :dbi_resource_id,
  :region,
  :db_instance_identifier,
  :restore_window,
  :allocated_storage,
  :status,
  :port,
  :availability_zone,
  :vpc_id,
  :instance_create_time,
  :master_username,
  :engine,
  :engine_version,
  :license_model,
  :iops,
  :storage_throughput,
  :option_group_name,
  :tde_credential_arn,
  :encrypted,
  :storage_encryption_type,
  :storage_type,
  :kms_key_id,
  :timezone,
  :iam_database_authentication_enabled,
  :backup_retention_period,
  :preferred_backup_window,
  :db_instance_automated_backups_arn,
  :db_instance_automated_backups_replications,
  :backup_target,
  :multi_tenant,
  :aws_backup_recovery_point_arn,
  :tag_list,
  :dedicated_log_volume,
  :additional_storage_volumes)
  SENSITIVE = []
  include Aws::Structure
end

#engine ⇒ `String`

The name of the database engine for this automated backup.

Returns:

(String)

# File 'lib/aws-sdk-rds/types.rb', line 10456

class DBInstanceAutomatedBackup < Struct.new(
  :db_instance_arn,
  :dbi_resource_id,
  :region,
  :db_instance_identifier,
  :restore_window,
  :allocated_storage,
  :status,
  :port,
  :availability_zone,
  :vpc_id,
  :instance_create_time,
  :master_username,
  :engine,
  :engine_version,
  :license_model,
  :iops,
  :storage_throughput,
  :option_group_name,
  :tde_credential_arn,
  :encrypted,
  :storage_encryption_type,
  :storage_type,
  :kms_key_id,
  :timezone,
  :iam_database_authentication_enabled,
  :backup_retention_period,
  :preferred_backup_window,
  :db_instance_automated_backups_arn,
  :db_instance_automated_backups_replications,
  :backup_target,
  :multi_tenant,
  :aws_backup_recovery_point_arn,
  :tag_list,
  :dedicated_log_volume,
  :additional_storage_volumes)
  SENSITIVE = []
  include Aws::Structure
end

#engine_version ⇒ `String`

The version of the database engine for the automated backup.

Returns:

(String)

# File 'lib/aws-sdk-rds/types.rb', line 10456

class DBInstanceAutomatedBackup < Struct.new(
  :db_instance_arn,
  :dbi_resource_id,
  :region,
  :db_instance_identifier,
  :restore_window,
  :allocated_storage,
  :status,
  :port,
  :availability_zone,
  :vpc_id,
  :instance_create_time,
  :master_username,
  :engine,
  :engine_version,
  :license_model,
  :iops,
  :storage_throughput,
  :option_group_name,
  :tde_credential_arn,
  :encrypted,
  :storage_encryption_type,
  :storage_type,
  :kms_key_id,
  :timezone,
  :iam_database_authentication_enabled,
  :backup_retention_period,
  :preferred_backup_window,
  :db_instance_automated_backups_arn,
  :db_instance_automated_backups_replications,
  :backup_target,
  :multi_tenant,
  :aws_backup_recovery_point_arn,
  :tag_list,
  :dedicated_log_volume,
  :additional_storage_volumes)
  SENSITIVE = []
  include Aws::Structure
end

#iam_database_authentication_enabled ⇒ `Boolean`

True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

Returns:

(Boolean)

# File 'lib/aws-sdk-rds/types.rb', line 10456

class DBInstanceAutomatedBackup < Struct.new(
  :db_instance_arn,
  :dbi_resource_id,
  :region,
  :db_instance_identifier,
  :restore_window,
  :allocated_storage,
  :status,
  :port,
  :availability_zone,
  :vpc_id,
  :instance_create_time,
  :master_username,
  :engine,
  :engine_version,
  :license_model,
  :iops,
  :storage_throughput,
  :option_group_name,
  :tde_credential_arn,
  :encrypted,
  :storage_encryption_type,
  :storage_type,
  :kms_key_id,
  :timezone,
  :iam_database_authentication_enabled,
  :backup_retention_period,
  :preferred_backup_window,
  :db_instance_automated_backups_arn,
  :db_instance_automated_backups_replications,
  :backup_target,
  :multi_tenant,
  :aws_backup_recovery_point_arn,
  :tag_list,
  :dedicated_log_volume,
  :additional_storage_volumes)
  SENSITIVE = []
  include Aws::Structure
end

#instance_create_time ⇒ `Time`

The date and time when the DB instance was created.

Returns:

(Time)

# File 'lib/aws-sdk-rds/types.rb', line 10456

class DBInstanceAutomatedBackup < Struct.new(
  :db_instance_arn,
  :dbi_resource_id,
  :region,
  :db_instance_identifier,
  :restore_window,
  :allocated_storage,
  :status,
  :port,
  :availability_zone,
  :vpc_id,
  :instance_create_time,
  :master_username,
  :engine,
  :engine_version,
  :license_model,
  :iops,
  :storage_throughput,
  :option_group_name,
  :tde_credential_arn,
  :encrypted,
  :storage_encryption_type,
  :storage_type,
  :kms_key_id,
  :timezone,
  :iam_database_authentication_enabled,
  :backup_retention_period,
  :preferred_backup_window,
  :db_instance_automated_backups_arn,
  :db_instance_automated_backups_replications,
  :backup_target,
  :multi_tenant,
  :aws_backup_recovery_point_arn,
  :tag_list,
  :dedicated_log_volume,
  :additional_storage_volumes)
  SENSITIVE = []
  include Aws::Structure
end

#iops ⇒ `Integer`

The IOPS (I/O operations per second) value for the automated backup.

Returns:

(Integer)

# File 'lib/aws-sdk-rds/types.rb', line 10456

class DBInstanceAutomatedBackup < Struct.new(
  :db_instance_arn,
  :dbi_resource_id,
  :region,
  :db_instance_identifier,
  :restore_window,
  :allocated_storage,
  :status,
  :port,
  :availability_zone,
  :vpc_id,
  :instance_create_time,
  :master_username,
  :engine,
  :engine_version,
  :license_model,
  :iops,
  :storage_throughput,
  :option_group_name,
  :tde_credential_arn,
  :encrypted,
  :storage_encryption_type,
  :storage_type,
  :kms_key_id,
  :timezone,
  :iam_database_authentication_enabled,
  :backup_retention_period,
  :preferred_backup_window,
  :db_instance_automated_backups_arn,
  :db_instance_automated_backups_replications,
  :backup_target,
  :multi_tenant,
  :aws_backup_recovery_point_arn,
  :tag_list,
  :dedicated_log_volume,
  :additional_storage_volumes)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_id ⇒ `String`

The Amazon Web Services KMS key ID for an automated backup.

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

Returns:

(String)

# File 'lib/aws-sdk-rds/types.rb', line 10456

class DBInstanceAutomatedBackup < Struct.new(
  :db_instance_arn,
  :dbi_resource_id,
  :region,
  :db_instance_identifier,
  :restore_window,
  :allocated_storage,
  :status,
  :port,
  :availability_zone,
  :vpc_id,
  :instance_create_time,
  :master_username,
  :engine,
  :engine_version,
  :license_model,
  :iops,
  :storage_throughput,
  :option_group_name,
  :tde_credential_arn,
  :encrypted,
  :storage_encryption_type,
  :storage_type,
  :kms_key_id,
  :timezone,
  :iam_database_authentication_enabled,
  :backup_retention_period,
  :preferred_backup_window,
  :db_instance_automated_backups_arn,
  :db_instance_automated_backups_replications,
  :backup_target,
  :multi_tenant,
  :aws_backup_recovery_point_arn,
  :tag_list,
  :dedicated_log_volume,
  :additional_storage_volumes)
  SENSITIVE = []
  include Aws::Structure
end

#license_model ⇒ `String`

The license model information for the automated backup.

Returns:

(String)

# File 'lib/aws-sdk-rds/types.rb', line 10456

class DBInstanceAutomatedBackup < Struct.new(
  :db_instance_arn,
  :dbi_resource_id,
  :region,
  :db_instance_identifier,
  :restore_window,
  :allocated_storage,
  :status,
  :port,
  :availability_zone,
  :vpc_id,
  :instance_create_time,
  :master_username,
  :engine,
  :engine_version,
  :license_model,
  :iops,
  :storage_throughput,
  :option_group_name,
  :tde_credential_arn,
  :encrypted,
  :storage_encryption_type,
  :storage_type,
  :kms_key_id,
  :timezone,
  :iam_database_authentication_enabled,
  :backup_retention_period,
  :preferred_backup_window,
  :db_instance_automated_backups_arn,
  :db_instance_automated_backups_replications,
  :backup_target,
  :multi_tenant,
  :aws_backup_recovery_point_arn,
  :tag_list,
  :dedicated_log_volume,
  :additional_storage_volumes)
  SENSITIVE = []
  include Aws::Structure
end

#master_username ⇒ `String`

The master user name of an automated backup.

Returns:

(String)

# File 'lib/aws-sdk-rds/types.rb', line 10456

class DBInstanceAutomatedBackup < Struct.new(
  :db_instance_arn,
  :dbi_resource_id,
  :region,
  :db_instance_identifier,
  :restore_window,
  :allocated_storage,
  :status,
  :port,
  :availability_zone,
  :vpc_id,
  :instance_create_time,
  :master_username,
  :engine,
  :engine_version,
  :license_model,
  :iops,
  :storage_throughput,
  :option_group_name,
  :tde_credential_arn,
  :encrypted,
  :storage_encryption_type,
  :storage_type,
  :kms_key_id,
  :timezone,
  :iam_database_authentication_enabled,
  :backup_retention_period,
  :preferred_backup_window,
  :db_instance_automated_backups_arn,
  :db_instance_automated_backups_replications,
  :backup_target,
  :multi_tenant,
  :aws_backup_recovery_point_arn,
  :tag_list,
  :dedicated_log_volume,
  :additional_storage_volumes)
  SENSITIVE = []
  include Aws::Structure
end

#multi_tenant ⇒ `Boolean`

Specifies whether the automatic backup is for a DB instance in the multi-tenant configuration (TRUE) or the single-tenant configuration (FALSE).

Returns:

(Boolean)

# File 'lib/aws-sdk-rds/types.rb', line 10456

class DBInstanceAutomatedBackup < Struct.new(
  :db_instance_arn,
  :dbi_resource_id,
  :region,
  :db_instance_identifier,
  :restore_window,
  :allocated_storage,
  :status,
  :port,
  :availability_zone,
  :vpc_id,
  :instance_create_time,
  :master_username,
  :engine,
  :engine_version,
  :license_model,
  :iops,
  :storage_throughput,
  :option_group_name,
  :tde_credential_arn,
  :encrypted,
  :storage_encryption_type,
  :storage_type,
  :kms_key_id,
  :timezone,
  :iam_database_authentication_enabled,
  :backup_retention_period,
  :preferred_backup_window,
  :db_instance_automated_backups_arn,
  :db_instance_automated_backups_replications,
  :backup_target,
  :multi_tenant,
  :aws_backup_recovery_point_arn,
  :tag_list,
  :dedicated_log_volume,
  :additional_storage_volumes)
  SENSITIVE = []
  include Aws::Structure
end

#option_group_name ⇒ `String`

The option group the automated backup is associated with. If omitted, the default option group for the engine specified is used.

Returns:

(String)

# File 'lib/aws-sdk-rds/types.rb', line 10456

class DBInstanceAutomatedBackup < Struct.new(
  :db_instance_arn,
  :dbi_resource_id,
  :region,
  :db_instance_identifier,
  :restore_window,
  :allocated_storage,
  :status,
  :port,
  :availability_zone,
  :vpc_id,
  :instance_create_time,
  :master_username,
  :engine,
  :engine_version,
  :license_model,
  :iops,
  :storage_throughput,
  :option_group_name,
  :tde_credential_arn,
  :encrypted,
  :storage_encryption_type,
  :storage_type,
  :kms_key_id,
  :timezone,
  :iam_database_authentication_enabled,
  :backup_retention_period,
  :preferred_backup_window,
  :db_instance_automated_backups_arn,
  :db_instance_automated_backups_replications,
  :backup_target,
  :multi_tenant,
  :aws_backup_recovery_point_arn,
  :tag_list,
  :dedicated_log_volume,
  :additional_storage_volumes)
  SENSITIVE = []
  include Aws::Structure
end

#port ⇒ `Integer`

The port number that the automated backup used for connections.

Default: Inherits from the source DB instance

Valid Values: ‘1150-65535`

Returns:

(Integer)

# File 'lib/aws-sdk-rds/types.rb', line 10456

class DBInstanceAutomatedBackup < Struct.new(
  :db_instance_arn,
  :dbi_resource_id,
  :region,
  :db_instance_identifier,
  :restore_window,
  :allocated_storage,
  :status,
  :port,
  :availability_zone,
  :vpc_id,
  :instance_create_time,
  :master_username,
  :engine,
  :engine_version,
  :license_model,
  :iops,
  :storage_throughput,
  :option_group_name,
  :tde_credential_arn,
  :encrypted,
  :storage_encryption_type,
  :storage_type,
  :kms_key_id,
  :timezone,
  :iam_database_authentication_enabled,
  :backup_retention_period,
  :preferred_backup_window,
  :db_instance_automated_backups_arn,
  :db_instance_automated_backups_replications,
  :backup_target,
  :multi_tenant,
  :aws_backup_recovery_point_arn,
  :tag_list,
  :dedicated_log_volume,
  :additional_storage_volumes)
  SENSITIVE = []
  include Aws::Structure
end

#preferred_backup_window ⇒ `String`

The daily time range during which automated backups are created if automated backups are enabled, as determined by the ‘BackupRetentionPeriod`.

Returns:

(String)

# File 'lib/aws-sdk-rds/types.rb', line 10456

class DBInstanceAutomatedBackup < Struct.new(
  :db_instance_arn,
  :dbi_resource_id,
  :region,
  :db_instance_identifier,
  :restore_window,
  :allocated_storage,
  :status,
  :port,
  :availability_zone,
  :vpc_id,
  :instance_create_time,
  :master_username,
  :engine,
  :engine_version,
  :license_model,
  :iops,
  :storage_throughput,
  :option_group_name,
  :tde_credential_arn,
  :encrypted,
  :storage_encryption_type,
  :storage_type,
  :kms_key_id,
  :timezone,
  :iam_database_authentication_enabled,
  :backup_retention_period,
  :preferred_backup_window,
  :db_instance_automated_backups_arn,
  :db_instance_automated_backups_replications,
  :backup_target,
  :multi_tenant,
  :aws_backup_recovery_point_arn,
  :tag_list,
  :dedicated_log_volume,
  :additional_storage_volumes)
  SENSITIVE = []
  include Aws::Structure
end

#region ⇒ `String`

The Amazon Web Services Region associated with the automated backup.

Returns:

(String)

# File 'lib/aws-sdk-rds/types.rb', line 10456

class DBInstanceAutomatedBackup < Struct.new(
  :db_instance_arn,
  :dbi_resource_id,
  :region,
  :db_instance_identifier,
  :restore_window,
  :allocated_storage,
  :status,
  :port,
  :availability_zone,
  :vpc_id,
  :instance_create_time,
  :master_username,
  :engine,
  :engine_version,
  :license_model,
  :iops,
  :storage_throughput,
  :option_group_name,
  :tde_credential_arn,
  :encrypted,
  :storage_encryption_type,
  :storage_type,
  :kms_key_id,
  :timezone,
  :iam_database_authentication_enabled,
  :backup_retention_period,
  :preferred_backup_window,
  :db_instance_automated_backups_arn,
  :db_instance_automated_backups_replications,
  :backup_target,
  :multi_tenant,
  :aws_backup_recovery_point_arn,
  :tag_list,
  :dedicated_log_volume,
  :additional_storage_volumes)
  SENSITIVE = []
  include Aws::Structure
end

#restore_window ⇒ `Types::RestoreWindow`

The earliest and latest time a DB instance can be restored to.

Returns:

(Types::RestoreWindow)

# File 'lib/aws-sdk-rds/types.rb', line 10456

class DBInstanceAutomatedBackup < Struct.new(
  :db_instance_arn,
  :dbi_resource_id,
  :region,
  :db_instance_identifier,
  :restore_window,
  :allocated_storage,
  :status,
  :port,
  :availability_zone,
  :vpc_id,
  :instance_create_time,
  :master_username,
  :engine,
  :engine_version,
  :license_model,
  :iops,
  :storage_throughput,
  :option_group_name,
  :tde_credential_arn,
  :encrypted,
  :storage_encryption_type,
  :storage_type,
  :kms_key_id,
  :timezone,
  :iam_database_authentication_enabled,
  :backup_retention_period,
  :preferred_backup_window,
  :db_instance_automated_backups_arn,
  :db_instance_automated_backups_replications,
  :backup_target,
  :multi_tenant,
  :aws_backup_recovery_point_arn,
  :tag_list,
  :dedicated_log_volume,
  :additional_storage_volumes)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ `String`

A list of status information for an automated backup:

‘active` - Automated backups for current instances.
‘retained` - Automated backups for deleted instances.
‘creating` - Automated backups that are waiting for the first automated snapshot to be available.

Returns:

(String)

# File 'lib/aws-sdk-rds/types.rb', line 10456

class DBInstanceAutomatedBackup < Struct.new(
  :db_instance_arn,
  :dbi_resource_id,
  :region,
  :db_instance_identifier,
  :restore_window,
  :allocated_storage,
  :status,
  :port,
  :availability_zone,
  :vpc_id,
  :instance_create_time,
  :master_username,
  :engine,
  :engine_version,
  :license_model,
  :iops,
  :storage_throughput,
  :option_group_name,
  :tde_credential_arn,
  :encrypted,
  :storage_encryption_type,
  :storage_type,
  :kms_key_id,
  :timezone,
  :iam_database_authentication_enabled,
  :backup_retention_period,
  :preferred_backup_window,
  :db_instance_automated_backups_arn,
  :db_instance_automated_backups_replications,
  :backup_target,
  :multi_tenant,
  :aws_backup_recovery_point_arn,
  :tag_list,
  :dedicated_log_volume,
  :additional_storage_volumes)
  SENSITIVE = []
  include Aws::Structure
end

#storage_encryption_type ⇒ `String`

The type of encryption used to protect data at rest in the automated backup. Possible values:

‘none` - The automated backup is not encrypted.
‘sse-rds` - The automated backup is encrypted using an Amazon Web Services owned KMS key.
‘sse-kms` - The automated backup is encrypted using a customer managed KMS key or Amazon Web Services managed KMS key.

Returns:

(String)

# File 'lib/aws-sdk-rds/types.rb', line 10456

class DBInstanceAutomatedBackup < Struct.new(
  :db_instance_arn,
  :dbi_resource_id,
  :region,
  :db_instance_identifier,
  :restore_window,
  :allocated_storage,
  :status,
  :port,
  :availability_zone,
  :vpc_id,
  :instance_create_time,
  :master_username,
  :engine,
  :engine_version,
  :license_model,
  :iops,
  :storage_throughput,
  :option_group_name,
  :tde_credential_arn,
  :encrypted,
  :storage_encryption_type,
  :storage_type,
  :kms_key_id,
  :timezone,
  :iam_database_authentication_enabled,
  :backup_retention_period,
  :preferred_backup_window,
  :db_instance_automated_backups_arn,
  :db_instance_automated_backups_replications,
  :backup_target,
  :multi_tenant,
  :aws_backup_recovery_point_arn,
  :tag_list,
  :dedicated_log_volume,
  :additional_storage_volumes)
  SENSITIVE = []
  include Aws::Structure
end

#storage_throughput ⇒ `Integer`

The storage throughput for the automated backup.

Returns:

(Integer)

# File 'lib/aws-sdk-rds/types.rb', line 10456

class DBInstanceAutomatedBackup < Struct.new(
  :db_instance_arn,
  :dbi_resource_id,
  :region,
  :db_instance_identifier,
  :restore_window,
  :allocated_storage,
  :status,
  :port,
  :availability_zone,
  :vpc_id,
  :instance_create_time,
  :master_username,
  :engine,
  :engine_version,
  :license_model,
  :iops,
  :storage_throughput,
  :option_group_name,
  :tde_credential_arn,
  :encrypted,
  :storage_encryption_type,
  :storage_type,
  :kms_key_id,
  :timezone,
  :iam_database_authentication_enabled,
  :backup_retention_period,
  :preferred_backup_window,
  :db_instance_automated_backups_arn,
  :db_instance_automated_backups_replications,
  :backup_target,
  :multi_tenant,
  :aws_backup_recovery_point_arn,
  :tag_list,
  :dedicated_log_volume,
  :additional_storage_volumes)
  SENSITIVE = []
  include Aws::Structure
end

#storage_type ⇒ `String`

The storage type associated with the automated backup.

Returns:

(String)

# File 'lib/aws-sdk-rds/types.rb', line 10456

class DBInstanceAutomatedBackup < Struct.new(
  :db_instance_arn,
  :dbi_resource_id,
  :region,
  :db_instance_identifier,
  :restore_window,
  :allocated_storage,
  :status,
  :port,
  :availability_zone,
  :vpc_id,
  :instance_create_time,
  :master_username,
  :engine,
  :engine_version,
  :license_model,
  :iops,
  :storage_throughput,
  :option_group_name,
  :tde_credential_arn,
  :encrypted,
  :storage_encryption_type,
  :storage_type,
  :kms_key_id,
  :timezone,
  :iam_database_authentication_enabled,
  :backup_retention_period,
  :preferred_backup_window,
  :db_instance_automated_backups_arn,
  :db_instance_automated_backups_replications,
  :backup_target,
  :multi_tenant,
  :aws_backup_recovery_point_arn,
  :tag_list,
  :dedicated_log_volume,
  :additional_storage_volumes)
  SENSITIVE = []
  include Aws::Structure
end

A list of tags.

For more information, see [Tagging Amazon RDS resources] in the *Amazon RDS User Guide* or [Tagging Amazon Aurora and Amazon RDS resources] in the *Amazon Aurora User Guide*.

[1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html [2]: docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html

Returns:

(Array<Types::Tag>)

# File 'lib/aws-sdk-rds/types.rb', line 10456

class DBInstanceAutomatedBackup < Struct.new(
  :db_instance_arn,
  :dbi_resource_id,
  :region,
  :db_instance_identifier,
  :restore_window,
  :allocated_storage,
  :status,
  :port,
  :availability_zone,
  :vpc_id,
  :instance_create_time,
  :master_username,
  :engine,
  :engine_version,
  :license_model,
  :iops,
  :storage_throughput,
  :option_group_name,
  :tde_credential_arn,
  :encrypted,
  :storage_encryption_type,
  :storage_type,
  :kms_key_id,
  :timezone,
  :iam_database_authentication_enabled,
  :backup_retention_period,
  :preferred_backup_window,
  :db_instance_automated_backups_arn,
  :db_instance_automated_backups_replications,
  :backup_target,
  :multi_tenant,
  :aws_backup_recovery_point_arn,
  :tag_list,
  :dedicated_log_volume,
  :additional_storage_volumes)
  SENSITIVE = []
  include Aws::Structure
end

#tde_credential_arn ⇒ `String`

The ARN from the key store with which the automated backup is associated for TDE encryption.

Returns:

(String)

# File 'lib/aws-sdk-rds/types.rb', line 10456

class DBInstanceAutomatedBackup < Struct.new(
  :db_instance_arn,
  :dbi_resource_id,
  :region,
  :db_instance_identifier,
  :restore_window,
  :allocated_storage,
  :status,
  :port,
  :availability_zone,
  :vpc_id,
  :instance_create_time,
  :master_username,
  :engine,
  :engine_version,
  :license_model,
  :iops,
  :storage_throughput,
  :option_group_name,
  :tde_credential_arn,
  :encrypted,
  :storage_encryption_type,
  :storage_type,
  :kms_key_id,
  :timezone,
  :iam_database_authentication_enabled,
  :backup_retention_period,
  :preferred_backup_window,
  :db_instance_automated_backups_arn,
  :db_instance_automated_backups_replications,
  :backup_target,
  :multi_tenant,
  :aws_backup_recovery_point_arn,
  :tag_list,
  :dedicated_log_volume,
  :additional_storage_volumes)
  SENSITIVE = []
  include Aws::Structure
end

#timezone ⇒ `String`

The time zone of the automated backup. In most cases, the ‘Timezone` element is empty. `Timezone` content appears only for Microsoft SQL Server DB instances that were created with a time zone specified.

Returns:

(String)

# File 'lib/aws-sdk-rds/types.rb', line 10456

class DBInstanceAutomatedBackup < Struct.new(
  :db_instance_arn,
  :dbi_resource_id,
  :region,
  :db_instance_identifier,
  :restore_window,
  :allocated_storage,
  :status,
  :port,
  :availability_zone,
  :vpc_id,
  :instance_create_time,
  :master_username,
  :engine,
  :engine_version,
  :license_model,
  :iops,
  :storage_throughput,
  :option_group_name,
  :tde_credential_arn,
  :encrypted,
  :storage_encryption_type,
  :storage_type,
  :kms_key_id,
  :timezone,
  :iam_database_authentication_enabled,
  :backup_retention_period,
  :preferred_backup_window,
  :db_instance_automated_backups_arn,
  :db_instance_automated_backups_replications,
  :backup_target,
  :multi_tenant,
  :aws_backup_recovery_point_arn,
  :tag_list,
  :dedicated_log_volume,
  :additional_storage_volumes)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_id ⇒ `String`

The VPC ID associated with the DB instance.

Returns:

(String)

# File 'lib/aws-sdk-rds/types.rb', line 10456

class DBInstanceAutomatedBackup < Struct.new(
  :db_instance_arn,
  :dbi_resource_id,
  :region,
  :db_instance_identifier,
  :restore_window,
  :allocated_storage,
  :status,
  :port,
  :availability_zone,
  :vpc_id,
  :instance_create_time,
  :master_username,
  :engine,
  :engine_version,
  :license_model,
  :iops,
  :storage_throughput,
  :option_group_name,
  :tde_credential_arn,
  :encrypted,
  :storage_encryption_type,
  :storage_type,
  :kms_key_id,
  :timezone,
  :iam_database_authentication_enabled,
  :backup_retention_period,
  :preferred_backup_window,
  :db_instance_automated_backups_arn,
  :db_instance_automated_backups_replications,
  :backup_target,
  :multi_tenant,
  :aws_backup_recovery_point_arn,
  :tag_list,
  :dedicated_log_volume,
  :additional_storage_volumes)
  SENSITIVE = []
  include Aws::Structure
end

Class: Aws::RDS::Types::DBInstanceAutomatedBackup

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#additional_storage_volumes ⇒ Array<Types::AdditionalStorageVolume>

#allocated_storage ⇒ Integer

#availability_zone ⇒ String

#aws_backup_recovery_point_arn ⇒ String

#backup_retention_period ⇒ Integer

#backup_target ⇒ String

#db_instance_arn ⇒ String

#db_instance_automated_backups_arn ⇒ String

#db_instance_automated_backups_replications ⇒ Array<Types::DBInstanceAutomatedBackupsReplication>

#db_instance_identifier ⇒ String

#dbi_resource_id ⇒ String

#dedicated_log_volume ⇒ Boolean

#encrypted ⇒ Boolean

#engine ⇒ String

#engine_version ⇒ String

#iam_database_authentication_enabled ⇒ Boolean

#instance_create_time ⇒ Time

#iops ⇒ Integer

#kms_key_id ⇒ String

#license_model ⇒ String

#master_username ⇒ String

#multi_tenant ⇒ Boolean

#option_group_name ⇒ String

#port ⇒ Integer

#preferred_backup_window ⇒ String

#region ⇒ String

#restore_window ⇒ Types::RestoreWindow

#status ⇒ String

#storage_encryption_type ⇒ String

#storage_throughput ⇒ Integer

#storage_type ⇒ String

#tag_list ⇒ Array<Types::Tag>

#tde_credential_arn ⇒ String

#timezone ⇒ String

#vpc_id ⇒ String

#additional_storage_volumes ⇒ `Array<Types::AdditionalStorageVolume>`

#allocated_storage ⇒ `Integer`

#availability_zone ⇒ `String`

#aws_backup_recovery_point_arn ⇒ `String`

#backup_retention_period ⇒ `Integer`

#backup_target ⇒ `String`

#db_instance_arn ⇒ `String`

#db_instance_automated_backups_arn ⇒ `String`

#db_instance_automated_backups_replications ⇒ `Array<Types::DBInstanceAutomatedBackupsReplication>`

#db_instance_identifier ⇒ `String`

#dbi_resource_id ⇒ `String`

#dedicated_log_volume ⇒ `Boolean`

#encrypted ⇒ `Boolean`

#engine ⇒ `String`

#engine_version ⇒ `String`

#iam_database_authentication_enabled ⇒ `Boolean`

#instance_create_time ⇒ `Time`

#iops ⇒ `Integer`

#kms_key_id ⇒ `String`

#license_model ⇒ `String`

#master_username ⇒ `String`

#multi_tenant ⇒ `Boolean`

#option_group_name ⇒ `String`

#port ⇒ `Integer`

#preferred_backup_window ⇒ `String`

#region ⇒ `String`

#restore_window ⇒ `Types::RestoreWindow`

#status ⇒ `String`

#storage_encryption_type ⇒ `String`

#storage_throughput ⇒ `Integer`

#storage_type ⇒ `String`

#tag_list ⇒ `Array<Types::Tag>`

#tde_credential_arn ⇒ `String`

#timezone ⇒ `String`

#vpc_id ⇒ `String`