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

Inherits:

Struct

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

Defined in:

gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb

Overview

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

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #allocated_storage ⇒ Integer

  Specifies the allocated storage size in gibibytes (GiB).

• #availability_zone ⇒ String

  The Availability Zone that the automated backup was created in.

• #db_instance_arn ⇒ String

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

• #db_instance_identifier ⇒ String

  The customer id of the instance that is/was associated with the automated backup.

• #dbi_resource_id ⇒ String

  The identifier for the source DB instance, which can't be changed and which is unique to an AWS Region.

• #encrypted ⇒ Boolean

  Specifies 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 AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

• #instance_create_time ⇒ Time

  Provides the date and time that the DB instance was created.

• #iops ⇒ Integer

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

• #kms_key_id ⇒ String

  The AWS KMS key ID for an automated backup.

• #license_model ⇒ String

  License model information for the automated backup.

• #master_username ⇒ String

  The license model of an automated backup.

• #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.

• #region ⇒ String

  The AWS Region associated with the automated backup.

• #restore_window ⇒ Types::RestoreWindow

  Earliest and latest time an instance can be restored to.

• #status ⇒ String

  Provides a list of status information for an automated backup:.

• #storage_type ⇒ String

  Specifies the storage type associated with the automated backup.

• #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

  Provides the VPC ID associated with the DB instance.

Instance Attribute Details

#allocated_storage ⇒ Integer

Specifies the allocated storage size in gibibytes (GiB).

Returns:

• (Integer)

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

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,
  :option_group_name,
  :tde_credential_arn,
  :encrypted,
  :storage_type,
  :kms_key_id,
  :timezone,
  :iam_database_authentication_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#availability_zone ⇒ String

The Availability Zone that the automated backup was created in. For information on AWS Regions and Availability Zones, see Regions and Availability Zones.

Returns:

• (String)

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

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,
  :option_group_name,
  :tde_credential_arn,
  :encrypted,
  :storage_type,
  :kms_key_id,
  :timezone,
  :iam_database_authentication_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#db_instance_arn ⇒ String

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

Returns:

• (String)

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

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,
  :option_group_name,
  :tde_credential_arn,
  :encrypted,
  :storage_type,
  :kms_key_id,
  :timezone,
  :iam_database_authentication_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#db_instance_identifier ⇒ String

The customer id of the instance that is/was associated with the automated backup.

Returns:

• (String)

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

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,
  :option_group_name,
  :tde_credential_arn,
  :encrypted,
  :storage_type,
  :kms_key_id,
  :timezone,
  :iam_database_authentication_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#dbi_resource_id ⇒ String

The identifier for the source DB instance, which can't be changed and which is unique to an AWS Region.

Returns:

• (String)

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

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,
  :option_group_name,
  :tde_credential_arn,
  :encrypted,
  :storage_type,
  :kms_key_id,
  :timezone,
  :iam_database_authentication_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#encrypted ⇒ Boolean

Specifies whether the automated backup is encrypted.

Returns:

• (Boolean)

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

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,
  :option_group_name,
  :tde_credential_arn,
  :encrypted,
  :storage_type,
  :kms_key_id,
  :timezone,
  :iam_database_authentication_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#engine ⇒ String

The name of the database engine for this automated backup.

Returns:

• (String)

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

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,
  :option_group_name,
  :tde_credential_arn,
  :encrypted,
  :storage_type,
  :kms_key_id,
  :timezone,
  :iam_database_authentication_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#engine_version ⇒ String

The version of the database engine for the automated backup.

Returns:

• (String)

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

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,
  :option_group_name,
  :tde_credential_arn,
  :encrypted,
  :storage_type,
  :kms_key_id,
  :timezone,
  :iam_database_authentication_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#iam_database_authentication_enabled ⇒ Boolean

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

Returns:

• (Boolean)

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

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,
  :option_group_name,
  :tde_credential_arn,
  :encrypted,
  :storage_type,
  :kms_key_id,
  :timezone,
  :iam_database_authentication_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#instance_create_time ⇒ Time

Provides the date and time that the DB instance was created.

Returns:

• (Time)

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

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,
  :option_group_name,
  :tde_credential_arn,
  :encrypted,
  :storage_type,
  :kms_key_id,
  :timezone,
  :iam_database_authentication_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#iops ⇒ Integer

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

Returns:

• (Integer)

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

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,
  :option_group_name,
  :tde_credential_arn,
  :encrypted,
  :storage_type,
  :kms_key_id,
  :timezone,
  :iam_database_authentication_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_id ⇒ String

The AWS KMS key ID for an automated backup. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.

Returns:

• (String)

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

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,
  :option_group_name,
  :tde_credential_arn,
  :encrypted,
  :storage_type,
  :kms_key_id,
  :timezone,
  :iam_database_authentication_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#license_model ⇒ String

License model information for the automated backup.

Returns:

• (String)

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

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,
  :option_group_name,
  :tde_credential_arn,
  :encrypted,
  :storage_type,
  :kms_key_id,
  :timezone,
  :iam_database_authentication_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#master_username ⇒ String

The license model of an automated backup.

Returns:

• (String)

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

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,
  :option_group_name,
  :tde_credential_arn,
  :encrypted,
  :storage_type,
  :kms_key_id,
  :timezone,
  :iam_database_authentication_enabled)
  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 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 6628

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,
  :option_group_name,
  :tde_credential_arn,
  :encrypted,
  :storage_type,
  :kms_key_id,
  :timezone,
  :iam_database_authentication_enabled)
  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 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 6628

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,
  :option_group_name,
  :tde_credential_arn,
  :encrypted,
  :storage_type,
  :kms_key_id,
  :timezone,
  :iam_database_authentication_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#region ⇒ String

The AWS Region associated with the automated backup.

Returns:

• (String)

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

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,
  :option_group_name,
  :tde_credential_arn,
  :encrypted,
  :storage_type,
  :kms_key_id,
  :timezone,
  :iam_database_authentication_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#restore_window ⇒ Types::RestoreWindow

Earliest and latest time an instance can be restored to.

Returns:

• (Types::RestoreWindow)

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

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,
  :option_group_name,
  :tde_credential_arn,
  :encrypted,
  :storage_type,
  :kms_key_id,
  :timezone,
  :iam_database_authentication_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

Provides 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 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 6628

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,
  :option_group_name,
  :tde_credential_arn,
  :encrypted,
  :storage_type,
  :kms_key_id,
  :timezone,
  :iam_database_authentication_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#storage_type ⇒ String

Specifies the storage type associated with the automated backup.

Returns:

• (String)

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

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,
  :option_group_name,
  :tde_credential_arn,
  :encrypted,
  :storage_type,
  :kms_key_id,
  :timezone,
  :iam_database_authentication_enabled)
  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 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 6628

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,
  :option_group_name,
  :tde_credential_arn,
  :encrypted,
  :storage_type,
  :kms_key_id,
  :timezone,
  :iam_database_authentication_enabled)
  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 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 6628

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,
  :option_group_name,
  :tde_credential_arn,
  :encrypted,
  :storage_type,
  :kms_key_id,
  :timezone,
  :iam_database_authentication_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_id ⇒ String

Provides the VPC ID associated with the DB instance

Returns:

• (String)

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

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,
  :option_group_name,
  :tde_credential_arn,
  :encrypted,
  :storage_type,
  :kms_key_id,
  :timezone,
  :iam_database_authentication_enabled)
  SENSITIVE = []
  include Aws::Structure
end