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

Inherits:
Struct
  • Object
show all
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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#allocated_storageInteger

Specifies the allocated storage size in gibibytes (GiB).

Returns:

  • (Integer)


6628
6629
6630
6631
6632
6633
6634
6635
6636
6637
6638
6639
6640
6641
6642
6643
6644
6645
6646
6647
6648
6649
6650
6651
6652
6653
6654
# 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_zoneString

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)


6628
6629
6630
6631
6632
6633
6634
6635
6636
6637
6638
6639
6640
6641
6642
6643
6644
6645
6646
6647
6648
6649
6650
6651
6652
6653
6654
# 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_arnString

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

Returns:

  • (String)


6628
6629
6630
6631
6632
6633
6634
6635
6636
6637
6638
6639
6640
6641
6642
6643
6644
6645
6646
6647
6648
6649
6650
6651
6652
6653
6654
# 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_identifierString

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

Returns:

  • (String)


6628
6629
6630
6631
6632
6633
6634
6635
6636
6637
6638
6639
6640
6641
6642
6643
6644
6645
6646
6647
6648
6649
6650
6651
6652
6653
6654
# 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_idString

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

Returns:

  • (String)


6628
6629
6630
6631
6632
6633
6634
6635
6636
6637
6638
6639
6640
6641
6642
6643
6644
6645
6646
6647
6648
6649
6650
6651
6652
6653
6654
# 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

#encryptedBoolean

Specifies whether the automated backup is encrypted.

Returns:

  • (Boolean)


6628
6629
6630
6631
6632
6633
6634
6635
6636
6637
6638
6639
6640
6641
6642
6643
6644
6645
6646
6647
6648
6649
6650
6651
6652
6653
6654
# 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

#engineString

The name of the database engine for this automated backup.

Returns:

  • (String)


6628
6629
6630
6631
6632
6633
6634
6635
6636
6637
6638
6639
6640
6641
6642
6643
6644
6645
6646
6647
6648
6649
6650
6651
6652
6653
6654
# 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_versionString

The version of the database engine for the automated backup.

Returns:

  • (String)


6628
6629
6630
6631
6632
6633
6634
6635
6636
6637
6638
6639
6640
6641
6642
6643
6644
6645
6646
6647
6648
6649
6650
6651
6652
6653
6654
# 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_enabledBoolean

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

Returns:

  • (Boolean)


6628
6629
6630
6631
6632
6633
6634
6635
6636
6637
6638
6639
6640
6641
6642
6643
6644
6645
6646
6647
6648
6649
6650
6651
6652
6653
6654
# 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_timeTime

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

Returns:

  • (Time)


6628
6629
6630
6631
6632
6633
6634
6635
6636
6637
6638
6639
6640
6641
6642
6643
6644
6645
6646
6647
6648
6649
6650
6651
6652
6653
6654
# 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

#iopsInteger

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

Returns:

  • (Integer)


6628
6629
6630
6631
6632
6633
6634
6635
6636
6637
6638
6639
6640
6641
6642
6643
6644
6645
6646
6647
6648
6649
6650
6651
6652
6653
6654
# 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_idString

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)


6628
6629
6630
6631
6632
6633
6634
6635
6636
6637
6638
6639
6640
6641
6642
6643
6644
6645
6646
6647
6648
6649
6650
6651
6652
6653
6654
# 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_modelString

License model information for the automated backup.

Returns:

  • (String)


6628
6629
6630
6631
6632
6633
6634
6635
6636
6637
6638
6639
6640
6641
6642
6643
6644
6645
6646
6647
6648
6649
6650
6651
6652
6653
6654
# 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_usernameString

The license model of an automated backup.

Returns:

  • (String)


6628
6629
6630
6631
6632
6633
6634
6635
6636
6637
6638
6639
6640
6641
6642
6643
6644
6645
6646
6647
6648
6649
6650
6651
6652
6653
6654
# 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_nameString

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

Returns:

  • (String)


6628
6629
6630
6631
6632
6633
6634
6635
6636
6637
6638
6639
6640
6641
6642
6643
6644
6645
6646
6647
6648
6649
6650
6651
6652
6653
6654
# 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

#portInteger

The port number that the automated backup used for connections.

Default: Inherits from the source DB instance

Valid Values: 1150-65535

Returns:

  • (Integer)


6628
6629
6630
6631
6632
6633
6634
6635
6636
6637
6638
6639
6640
6641
6642
6643
6644
6645
6646
6647
6648
6649
6650
6651
6652
6653
6654
# 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

#regionString

The AWS Region associated with the automated backup.

Returns:

  • (String)


6628
6629
6630
6631
6632
6633
6634
6635
6636
6637
6638
6639
6640
6641
6642
6643
6644
6645
6646
6647
6648
6649
6650
6651
6652
6653
6654
# 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_windowTypes::RestoreWindow

Earliest and latest time an instance can be restored to.



6628
6629
6630
6631
6632
6633
6634
6635
6636
6637
6638
6639
6640
6641
6642
6643
6644
6645
6646
6647
6648
6649
6650
6651
6652
6653
6654
# 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

#statusString

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)


6628
6629
6630
6631
6632
6633
6634
6635
6636
6637
6638
6639
6640
6641
6642
6643
6644
6645
6646
6647
6648
6649
6650
6651
6652
6653
6654
# 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_typeString

Specifies the storage type associated with the automated backup.

Returns:

  • (String)


6628
6629
6630
6631
6632
6633
6634
6635
6636
6637
6638
6639
6640
6641
6642
6643
6644
6645
6646
6647
6648
6649
6650
6651
6652
6653
6654
# 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_arnString

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

Returns:

  • (String)


6628
6629
6630
6631
6632
6633
6634
6635
6636
6637
6638
6639
6640
6641
6642
6643
6644
6645
6646
6647
6648
6649
6650
6651
6652
6653
6654
# 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

#timezoneString

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)


6628
6629
6630
6631
6632
6633
6634
6635
6636
6637
6638
6639
6640
6641
6642
6643
6644
6645
6646
6647
6648
6649
6650
6651
6652
6653
6654
# 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_idString

Provides the VPC ID associated with the DB instance

Returns:

  • (String)


6628
6629
6630
6631
6632
6633
6634
6635
6636
6637
6638
6639
6640
6641
6642
6643
6644
6645
6646
6647
6648
6649
6650
6651
6652
6653
6654
# 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