Class: Aws::RDS::Types::DescribeDBInstanceAutomatedBackupsMessage

Inherits:

Struct

• Object
• Struct
• Aws::RDS::Types::DescribeDBInstanceAutomatedBackupsMessage

Defined in:

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

Overview

Parameter input for DescribeDBInstanceAutomatedBackups.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #db_instance_automated_backups_arn ⇒ String

  The Amazon Resource Name (ARN) of the replicated automated backups, for example, arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE.

• #db_instance_identifier ⇒ String

  (Optional) The user-supplied instance identifier.

• #dbi_resource_id ⇒ String

  The resource ID of the DB instance that is the source of the automated backup.

• #filters ⇒ Array<Types::Filter>

  A filter that specifies which resources to return based on status.

• #marker ⇒ String

  The pagination token provided in the previous request.

• #max_records ⇒ Integer

  The maximum number of records to include in the response.

Instance Attribute Details

#db_instance_automated_backups_arn ⇒ String

The Amazon Resource Name (ARN) of the replicated automated backups, for example, arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE.

This setting doesn't apply to RDS Custom.

Returns:

• (String)

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

class DescribeDBInstanceAutomatedBackupsMessage < Struct.new(
  :dbi_resource_id,
  :db_instance_identifier,
  :filters,
  :max_records,
  :marker,
  :db_instance_automated_backups_arn)
  SENSITIVE = []
  include Aws::Structure
end

#db_instance_identifier ⇒ String

(Optional) The user-supplied instance identifier. If this parameter is specified, it must match the identifier of an existing DB instance. It returns information from the specific DB instance's automated backup. This parameter isn't case-sensitive.

Returns:

• (String)

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

class DescribeDBInstanceAutomatedBackupsMessage < Struct.new(
  :dbi_resource_id,
  :db_instance_identifier,
  :filters,
  :max_records,
  :marker,
  :db_instance_automated_backups_arn)
  SENSITIVE = []
  include Aws::Structure
end

#dbi_resource_id ⇒ String

The resource ID of the DB instance that is the source of the automated backup. This parameter isn't case-sensitive.

Returns:

• (String)

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

class DescribeDBInstanceAutomatedBackupsMessage < Struct.new(
  :dbi_resource_id,
  :db_instance_identifier,
  :filters,
  :max_records,
  :marker,
  :db_instance_automated_backups_arn)
  SENSITIVE = []
  include Aws::Structure
end

#filters ⇒ Array<Types::Filter>

A filter that specifies which resources to return based on status.

Supported filters are the following:

• status

  • active - Automated backups for current instances.

  • creating - Automated backups that are waiting for the first automated snapshot to be available.

  • retained - Automated backups for deleted instances and after backup replication is stopped.

• db-instance-id - Accepts DB instance identifiers and Amazon Resource Names (ARNs). The results list includes only information about the DB instance automated backups identified by these ARNs.

• dbi-resource-id - Accepts DB resource identifiers and Amazon Resource Names (ARNs). The results list includes only information about the DB instance resources identified by these ARNs.

Returns all resources by default. The status for each resource is specified in the response.

Returns:

• (Array<Types::Filter>)

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

class DescribeDBInstanceAutomatedBackupsMessage < Struct.new(
  :dbi_resource_id,
  :db_instance_identifier,
  :filters,
  :max_records,
  :marker,
  :db_instance_automated_backups_arn)
  SENSITIVE = []
  include Aws::Structure
end

#marker ⇒ String

The pagination token provided in the previous request. If this parameter is specified the response includes only records beyond the marker, up to MaxRecords.

Returns:

• (String)

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

class DescribeDBInstanceAutomatedBackupsMessage < Struct.new(
  :dbi_resource_id,
  :db_instance_identifier,
  :filters,
  :max_records,
  :marker,
  :db_instance_automated_backups_arn)
  SENSITIVE = []
  include Aws::Structure
end

#max_records ⇒ Integer

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.

Returns:

• (Integer)

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

class DescribeDBInstanceAutomatedBackupsMessage < Struct.new(
  :dbi_resource_id,
  :db_instance_identifier,
  :filters,
  :max_records,
  :marker,
  :db_instance_automated_backups_arn)
  SENSITIVE = []
  include Aws::Structure
end