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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-rds/types.rb

Overview

Note:

When making an API call, you may pass DescribeDBInstanceAutomatedBackupsMessage data as a hash:

{
  dbi_resource_id: "String",
  db_instance_identifier: "String",
  filters: [
    {
      name: "String", # required
      values: ["String"], # required
    },
  ],
  max_records: 1,
  marker: "String",
  db_instance_automated_backups_arn: "String",
}

Parameter input for DescribeDBInstanceAutomatedBackups.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#db_instance_automated_backups_arnString

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

Returns:

  • (String)

9906
9907
9908
9909
9910
9911
9912
9913
9914
9915
# File 'lib/aws-sdk-rds/types.rb', line 9906

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_identifierString

(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' automated backup. This parameter isn't case-sensitive.

Returns:

  • (String)

9906
9907
9908
9909
9910
9911
9912
9913
9914
9915
# File 'lib/aws-sdk-rds/types.rb', line 9906

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_idString

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

Returns:

  • (String)

9906
9907
9908
9909
9910
9911
9912
9913
9914
9915
# File 'lib/aws-sdk-rds/types.rb', line 9906

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

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

    • `retained` - automated backups for deleted instances and after backup replication is stopped

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

  • `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:


9906
9907
9908
9909
9910
9911
9912
9913
9914
9915
# File 'lib/aws-sdk-rds/types.rb', line 9906

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

#markerString

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)

9906
9907
9908
9909
9910
9911
9912
9913
9914
9915
# File 'lib/aws-sdk-rds/types.rb', line 9906

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_recordsInteger

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)

9906
9907
9908
9909
9910
9911
9912
9913
9914
9915
# File 'lib/aws-sdk-rds/types.rb', line 9906

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