You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

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.

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#allocated_storageInteger

Specifies the allocated storage size in gibibytes (GiB).

Returns:

  • (Integer)

    Specifies the allocated storage size in gibibytes (GiB).

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

    The Availability Zone that the automated backup was created in.

#db_instance_arnString

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

Returns:

  • (String)

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

#db_instance_identifierString

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

Returns:

  • (String)

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

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

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

#encryptedBoolean

Specifies whether the automated backup is encrypted.

Returns:

  • (Boolean)

    Specifies whether the automated backup is encrypted.

#engineString

The name of the database engine for this automated backup.

Returns:

  • (String)

    The name of the database engine for this automated backup.

#engine_versionString

The version of the database engine for the automated backup.

Returns:

  • (String)

    The version of the database engine for the automated backup.

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

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

#instance_create_timeTime

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

Returns:

  • (Time)

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

#iopsInteger

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

Returns:

  • (Integer)

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

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

    The AWS KMS key ID for an automated backup.

#license_modelString

License model information for the automated backup.

Returns:

  • (String)

    License model information for the automated backup.

#master_usernameString

The license model of an automated backup.

Returns:

  • (String)

    The license model of an automated backup.

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

    The option group the automated backup is associated with.

#portInteger

The port number that the automated backup used for connections.

Default: Inherits from the source DB instance

Valid Values: 1150-65535

Returns:

  • (Integer)

    The port number that the automated backup used for connections.

#regionString

The AWS Region associated with the automated backup.

Returns:

  • (String)

    The AWS Region associated with the automated backup.

#restore_windowTypes::RestoreWindow

Earliest and latest time an instance can be restored to.

Returns:

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

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

#storage_typeString

Specifies the storage type associated with the automated backup.

Returns:

  • (String)

    Specifies the storage type associated with the automated backup.

#tde_credential_arnString

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

Returns:

  • (String)

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

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

    The time zone of the automated backup.

#vpc_idString

Provides the VPC ID associated with the DB instance

Returns:

  • (String)

    Provides the VPC ID associated with the DB instance.