Class: Aws::RDS::Types::DBClusterAutomatedBackup

Inherits:

Struct

• Object
• Struct
• Aws::RDS::Types::DBClusterAutomatedBackup

Includes:

Structure

Defined in:

lib/aws-sdk-rds/types.rb

Overview

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

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #allocated_storage ⇒ Integer

  For all database engines except Amazon Aurora, ‘AllocatedStorage` specifies the allocated storage size in gibibytes (GiB).

• #availability_zones ⇒ Array<String>

  The Availability Zones where instances in the DB cluster can be created.

• #backup_retention_period ⇒ Integer

  The retention period for the automated backups.

• #cluster_create_time ⇒ Time

  The time when the DB cluster was created, in Universal Coordinated Time (UTC).

• #db_cluster_arn ⇒ String

  The Amazon Resource Name (ARN) for the source DB cluster.

• #db_cluster_automated_backups_arn ⇒ String

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

• #db_cluster_identifier ⇒ String

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

• #db_cluster_resource_id ⇒ String

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

• #engine ⇒ String

  The name of the database engine for this automated backup.

• #engine_mode ⇒ String

  The engine mode of the database engine for the 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.

• #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 this DB cluster automated backup.

• #master_username ⇒ String

  The master user name of the automated backup.

• #port ⇒ Integer

  The port number that the automated backup used for connections.

• #region ⇒ String

  The Amazon Web Services Region associated with the automated backup.

• #restore_window ⇒ Types::RestoreWindow

  Earliest and latest time an instance can be restored to:.

• #status ⇒ String

  A list of status information for an automated backup:.

• #storage_encrypted ⇒ Boolean

  Specifies whether the source DB cluster is encrypted.

• #storage_type ⇒ String

  The storage type associated with the DB cluster.

• #vpc_id ⇒ String

  The VPC ID associated with the DB cluster.

Instance Attribute Details

#allocated_storage ⇒ Integer

For all database engines except Amazon Aurora, ‘AllocatedStorage` specifies the allocated storage size in gibibytes (GiB). For Aurora, `AllocatedStorage` always returns 1, because Aurora DB cluster storage size isn’t fixed, but instead automatically adjusts as needed.

Returns:

• (Integer)

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

class DBClusterAutomatedBackup < Struct.new(
  :engine,
  :vpc_id,
  :db_cluster_automated_backups_arn,
  :db_cluster_identifier,
  :restore_window,
  :master_username,
  :db_cluster_resource_id,
  :region,
  :license_model,
  :status,
  :iam_database_authentication_enabled,
  :cluster_create_time,
  :storage_encrypted,
  :allocated_storage,
  :engine_version,
  :db_cluster_arn,
  :backup_retention_period,
  :engine_mode,
  :availability_zones,
  :port,
  :kms_key_id,
  :storage_type,
  :iops)
  SENSITIVE = []
  include Aws::Structure
end

#availability_zones ⇒ Array<String>

The Availability Zones where instances in the DB cluster can be created. For information on Amazon Web Services Regions and Availability Zones, see [Regions and Availability Zones].

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

Returns:

• (Array<String>)

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

class DBClusterAutomatedBackup < Struct.new(
  :engine,
  :vpc_id,
  :db_cluster_automated_backups_arn,
  :db_cluster_identifier,
  :restore_window,
  :master_username,
  :db_cluster_resource_id,
  :region,
  :license_model,
  :status,
  :iam_database_authentication_enabled,
  :cluster_create_time,
  :storage_encrypted,
  :allocated_storage,
  :engine_version,
  :db_cluster_arn,
  :backup_retention_period,
  :engine_mode,
  :availability_zones,
  :port,
  :kms_key_id,
  :storage_type,
  :iops)
  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 6661

class DBClusterAutomatedBackup < Struct.new(
  :engine,
  :vpc_id,
  :db_cluster_automated_backups_arn,
  :db_cluster_identifier,
  :restore_window,
  :master_username,
  :db_cluster_resource_id,
  :region,
  :license_model,
  :status,
  :iam_database_authentication_enabled,
  :cluster_create_time,
  :storage_encrypted,
  :allocated_storage,
  :engine_version,
  :db_cluster_arn,
  :backup_retention_period,
  :engine_mode,
  :availability_zones,
  :port,
  :kms_key_id,
  :storage_type,
  :iops)
  SENSITIVE = []
  include Aws::Structure
end

#cluster_create_time ⇒ Time

The time when the DB cluster was created, in Universal Coordinated Time (UTC).

Returns:

• (Time)

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

class DBClusterAutomatedBackup < Struct.new(
  :engine,
  :vpc_id,
  :db_cluster_automated_backups_arn,
  :db_cluster_identifier,
  :restore_window,
  :master_username,
  :db_cluster_resource_id,
  :region,
  :license_model,
  :status,
  :iam_database_authentication_enabled,
  :cluster_create_time,
  :storage_encrypted,
  :allocated_storage,
  :engine_version,
  :db_cluster_arn,
  :backup_retention_period,
  :engine_mode,
  :availability_zones,
  :port,
  :kms_key_id,
  :storage_type,
  :iops)
  SENSITIVE = []
  include Aws::Structure
end

#db_cluster_arn ⇒ String

The Amazon Resource Name (ARN) for the source DB cluster.

Returns:

• (String)

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

class DBClusterAutomatedBackup < Struct.new(
  :engine,
  :vpc_id,
  :db_cluster_automated_backups_arn,
  :db_cluster_identifier,
  :restore_window,
  :master_username,
  :db_cluster_resource_id,
  :region,
  :license_model,
  :status,
  :iam_database_authentication_enabled,
  :cluster_create_time,
  :storage_encrypted,
  :allocated_storage,
  :engine_version,
  :db_cluster_arn,
  :backup_retention_period,
  :engine_mode,
  :availability_zones,
  :port,
  :kms_key_id,
  :storage_type,
  :iops)
  SENSITIVE = []
  include Aws::Structure
end

#db_cluster_automated_backups_arn ⇒ String

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

Returns:

• (String)

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

class DBClusterAutomatedBackup < Struct.new(
  :engine,
  :vpc_id,
  :db_cluster_automated_backups_arn,
  :db_cluster_identifier,
  :restore_window,
  :master_username,
  :db_cluster_resource_id,
  :region,
  :license_model,
  :status,
  :iam_database_authentication_enabled,
  :cluster_create_time,
  :storage_encrypted,
  :allocated_storage,
  :engine_version,
  :db_cluster_arn,
  :backup_retention_period,
  :engine_mode,
  :availability_zones,
  :port,
  :kms_key_id,
  :storage_type,
  :iops)
  SENSITIVE = []
  include Aws::Structure
end

#db_cluster_identifier ⇒ String

The identifier for the source DB cluster, 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 6661

class DBClusterAutomatedBackup < Struct.new(
  :engine,
  :vpc_id,
  :db_cluster_automated_backups_arn,
  :db_cluster_identifier,
  :restore_window,
  :master_username,
  :db_cluster_resource_id,
  :region,
  :license_model,
  :status,
  :iam_database_authentication_enabled,
  :cluster_create_time,
  :storage_encrypted,
  :allocated_storage,
  :engine_version,
  :db_cluster_arn,
  :backup_retention_period,
  :engine_mode,
  :availability_zones,
  :port,
  :kms_key_id,
  :storage_type,
  :iops)
  SENSITIVE = []
  include Aws::Structure
end

#db_cluster_resource_id ⇒ String

The resource ID for the source DB cluster, 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 6661

class DBClusterAutomatedBackup < Struct.new(
  :engine,
  :vpc_id,
  :db_cluster_automated_backups_arn,
  :db_cluster_identifier,
  :restore_window,
  :master_username,
  :db_cluster_resource_id,
  :region,
  :license_model,
  :status,
  :iam_database_authentication_enabled,
  :cluster_create_time,
  :storage_encrypted,
  :allocated_storage,
  :engine_version,
  :db_cluster_arn,
  :backup_retention_period,
  :engine_mode,
  :availability_zones,
  :port,
  :kms_key_id,
  :storage_type,
  :iops)
  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 6661

class DBClusterAutomatedBackup < Struct.new(
  :engine,
  :vpc_id,
  :db_cluster_automated_backups_arn,
  :db_cluster_identifier,
  :restore_window,
  :master_username,
  :db_cluster_resource_id,
  :region,
  :license_model,
  :status,
  :iam_database_authentication_enabled,
  :cluster_create_time,
  :storage_encrypted,
  :allocated_storage,
  :engine_version,
  :db_cluster_arn,
  :backup_retention_period,
  :engine_mode,
  :availability_zones,
  :port,
  :kms_key_id,
  :storage_type,
  :iops)
  SENSITIVE = []
  include Aws::Structure
end

#engine_mode ⇒ String

The engine mode of the database engine for the automated backup.

Returns:

• (String)

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

class DBClusterAutomatedBackup < Struct.new(
  :engine,
  :vpc_id,
  :db_cluster_automated_backups_arn,
  :db_cluster_identifier,
  :restore_window,
  :master_username,
  :db_cluster_resource_id,
  :region,
  :license_model,
  :status,
  :iam_database_authentication_enabled,
  :cluster_create_time,
  :storage_encrypted,
  :allocated_storage,
  :engine_version,
  :db_cluster_arn,
  :backup_retention_period,
  :engine_mode,
  :availability_zones,
  :port,
  :kms_key_id,
  :storage_type,
  :iops)
  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 6661

class DBClusterAutomatedBackup < Struct.new(
  :engine,
  :vpc_id,
  :db_cluster_automated_backups_arn,
  :db_cluster_identifier,
  :restore_window,
  :master_username,
  :db_cluster_resource_id,
  :region,
  :license_model,
  :status,
  :iam_database_authentication_enabled,
  :cluster_create_time,
  :storage_encrypted,
  :allocated_storage,
  :engine_version,
  :db_cluster_arn,
  :backup_retention_period,
  :engine_mode,
  :availability_zones,
  :port,
  :kms_key_id,
  :storage_type,
  :iops)
  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 6661

class DBClusterAutomatedBackup < Struct.new(
  :engine,
  :vpc_id,
  :db_cluster_automated_backups_arn,
  :db_cluster_identifier,
  :restore_window,
  :master_username,
  :db_cluster_resource_id,
  :region,
  :license_model,
  :status,
  :iam_database_authentication_enabled,
  :cluster_create_time,
  :storage_encrypted,
  :allocated_storage,
  :engine_version,
  :db_cluster_arn,
  :backup_retention_period,
  :engine_mode,
  :availability_zones,
  :port,
  :kms_key_id,
  :storage_type,
  :iops)
  SENSITIVE = []
  include Aws::Structure
end

#iops ⇒ Integer

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

This setting is only for non-Aurora Multi-AZ DB clusters.

Returns:

• (Integer)

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

class DBClusterAutomatedBackup < Struct.new(
  :engine,
  :vpc_id,
  :db_cluster_automated_backups_arn,
  :db_cluster_identifier,
  :restore_window,
  :master_username,
  :db_cluster_resource_id,
  :region,
  :license_model,
  :status,
  :iam_database_authentication_enabled,
  :cluster_create_time,
  :storage_encrypted,
  :allocated_storage,
  :engine_version,
  :db_cluster_arn,
  :backup_retention_period,
  :engine_mode,
  :availability_zones,
  :port,
  :kms_key_id,
  :storage_type,
  :iops)
  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 6661

class DBClusterAutomatedBackup < Struct.new(
  :engine,
  :vpc_id,
  :db_cluster_automated_backups_arn,
  :db_cluster_identifier,
  :restore_window,
  :master_username,
  :db_cluster_resource_id,
  :region,
  :license_model,
  :status,
  :iam_database_authentication_enabled,
  :cluster_create_time,
  :storage_encrypted,
  :allocated_storage,
  :engine_version,
  :db_cluster_arn,
  :backup_retention_period,
  :engine_mode,
  :availability_zones,
  :port,
  :kms_key_id,
  :storage_type,
  :iops)
  SENSITIVE = []
  include Aws::Structure
end

#license_model ⇒ String

The license model information for this DB cluster automated backup.

Returns:

• (String)

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

class DBClusterAutomatedBackup < Struct.new(
  :engine,
  :vpc_id,
  :db_cluster_automated_backups_arn,
  :db_cluster_identifier,
  :restore_window,
  :master_username,
  :db_cluster_resource_id,
  :region,
  :license_model,
  :status,
  :iam_database_authentication_enabled,
  :cluster_create_time,
  :storage_encrypted,
  :allocated_storage,
  :engine_version,
  :db_cluster_arn,
  :backup_retention_period,
  :engine_mode,
  :availability_zones,
  :port,
  :kms_key_id,
  :storage_type,
  :iops)
  SENSITIVE = []
  include Aws::Structure
end

#master_username ⇒ String

The master user name of the automated backup.

Returns:

• (String)

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

class DBClusterAutomatedBackup < Struct.new(
  :engine,
  :vpc_id,
  :db_cluster_automated_backups_arn,
  :db_cluster_identifier,
  :restore_window,
  :master_username,
  :db_cluster_resource_id,
  :region,
  :license_model,
  :status,
  :iam_database_authentication_enabled,
  :cluster_create_time,
  :storage_encrypted,
  :allocated_storage,
  :engine_version,
  :db_cluster_arn,
  :backup_retention_period,
  :engine_mode,
  :availability_zones,
  :port,
  :kms_key_id,
  :storage_type,
  :iops)
  SENSITIVE = []
  include Aws::Structure
end

#port ⇒ Integer

The port number that the automated backup used for connections.

Default: Inherits from the source DB cluster

Valid Values: ‘1150-65535`

Returns:

• (Integer)

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

class DBClusterAutomatedBackup < Struct.new(
  :engine,
  :vpc_id,
  :db_cluster_automated_backups_arn,
  :db_cluster_identifier,
  :restore_window,
  :master_username,
  :db_cluster_resource_id,
  :region,
  :license_model,
  :status,
  :iam_database_authentication_enabled,
  :cluster_create_time,
  :storage_encrypted,
  :allocated_storage,
  :engine_version,
  :db_cluster_arn,
  :backup_retention_period,
  :engine_mode,
  :availability_zones,
  :port,
  :kms_key_id,
  :storage_type,
  :iops)
  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 6661

class DBClusterAutomatedBackup < Struct.new(
  :engine,
  :vpc_id,
  :db_cluster_automated_backups_arn,
  :db_cluster_identifier,
  :restore_window,
  :master_username,
  :db_cluster_resource_id,
  :region,
  :license_model,
  :status,
  :iam_database_authentication_enabled,
  :cluster_create_time,
  :storage_encrypted,
  :allocated_storage,
  :engine_version,
  :db_cluster_arn,
  :backup_retention_period,
  :engine_mode,
  :availability_zones,
  :port,
  :kms_key_id,
  :storage_type,
  :iops)
  SENSITIVE = []
  include Aws::Structure
end

#restore_window ⇒ Types::RestoreWindow

Earliest and latest time an instance can be restored to:

Returns:

• (Types::RestoreWindow)

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

class DBClusterAutomatedBackup < Struct.new(
  :engine,
  :vpc_id,
  :db_cluster_automated_backups_arn,
  :db_cluster_identifier,
  :restore_window,
  :master_username,
  :db_cluster_resource_id,
  :region,
  :license_model,
  :status,
  :iam_database_authentication_enabled,
  :cluster_create_time,
  :storage_encrypted,
  :allocated_storage,
  :engine_version,
  :db_cluster_arn,
  :backup_retention_period,
  :engine_mode,
  :availability_zones,
  :port,
  :kms_key_id,
  :storage_type,
  :iops)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

A list of status information for an automated backup:

• ‘retained` - Automated backups for deleted clusters.

^

Returns:

• (String)

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

class DBClusterAutomatedBackup < Struct.new(
  :engine,
  :vpc_id,
  :db_cluster_automated_backups_arn,
  :db_cluster_identifier,
  :restore_window,
  :master_username,
  :db_cluster_resource_id,
  :region,
  :license_model,
  :status,
  :iam_database_authentication_enabled,
  :cluster_create_time,
  :storage_encrypted,
  :allocated_storage,
  :engine_version,
  :db_cluster_arn,
  :backup_retention_period,
  :engine_mode,
  :availability_zones,
  :port,
  :kms_key_id,
  :storage_type,
  :iops)
  SENSITIVE = []
  include Aws::Structure
end

#storage_encrypted ⇒ Boolean

Specifies whether the source DB cluster is encrypted.

Returns:

• (Boolean)

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

class DBClusterAutomatedBackup < Struct.new(
  :engine,
  :vpc_id,
  :db_cluster_automated_backups_arn,
  :db_cluster_identifier,
  :restore_window,
  :master_username,
  :db_cluster_resource_id,
  :region,
  :license_model,
  :status,
  :iam_database_authentication_enabled,
  :cluster_create_time,
  :storage_encrypted,
  :allocated_storage,
  :engine_version,
  :db_cluster_arn,
  :backup_retention_period,
  :engine_mode,
  :availability_zones,
  :port,
  :kms_key_id,
  :storage_type,
  :iops)
  SENSITIVE = []
  include Aws::Structure
end

#storage_type ⇒ String

The storage type associated with the DB cluster.

This setting is only for non-Aurora Multi-AZ DB clusters.

Returns:

• (String)

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

class DBClusterAutomatedBackup < Struct.new(
  :engine,
  :vpc_id,
  :db_cluster_automated_backups_arn,
  :db_cluster_identifier,
  :restore_window,
  :master_username,
  :db_cluster_resource_id,
  :region,
  :license_model,
  :status,
  :iam_database_authentication_enabled,
  :cluster_create_time,
  :storage_encrypted,
  :allocated_storage,
  :engine_version,
  :db_cluster_arn,
  :backup_retention_period,
  :engine_mode,
  :availability_zones,
  :port,
  :kms_key_id,
  :storage_type,
  :iops)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_id ⇒ String

The VPC ID associated with the DB cluster.

Returns:

• (String)

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

class DBClusterAutomatedBackup < Struct.new(
  :engine,
  :vpc_id,
  :db_cluster_automated_backups_arn,
  :db_cluster_identifier,
  :restore_window,
  :master_username,
  :db_cluster_resource_id,
  :region,
  :license_model,
  :status,
  :iam_database_authentication_enabled,
  :cluster_create_time,
  :storage_encrypted,
  :allocated_storage,
  :engine_version,
  :db_cluster_arn,
  :backup_retention_period,
  :engine_mode,
  :availability_zones,
  :port,
  :kms_key_id,
  :storage_type,
  :iops)
  SENSITIVE = []
  include Aws::Structure
end