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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-rds/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",
}

Parameter input for DescribeDBInstanceAutomatedBackups.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

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


9232
9233
9234
9235
9236
9237
9238
9239
9240
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 9232

class DescribeDBInstanceAutomatedBackupsMessage < Struct.new(
  :dbi_resource_id,
  :db_instance_identifier,
  :filters,
  :max_records,
  :marker)
  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)


9232
9233
9234
9235
9236
9237
9238
9239
9240
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 9232

class DescribeDBInstanceAutomatedBackupsMessage < Struct.new(
  :dbi_resource_id,
  :db_instance_identifier,
  :filters,
  :max_records,
  :marker)
  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

    • 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) for DB instances. The results list includes only information about the DB instance automated backupss identified by these ARNs.

  • dbi-resource-id - Accepts DB instance resource identifiers and DB Amazon Resource Names (ARNs) for DB instances. 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:



9232
9233
9234
9235
9236
9237
9238
9239
9240
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 9232

class DescribeDBInstanceAutomatedBackupsMessage < Struct.new(
  :dbi_resource_id,
  :db_instance_identifier,
  :filters,
  :max_records,
  :marker)
  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)


9232
9233
9234
9235
9236
9237
9238
9239
9240
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 9232

class DescribeDBInstanceAutomatedBackupsMessage < Struct.new(
  :dbi_resource_id,
  :db_instance_identifier,
  :filters,
  :max_records,
  :marker)
  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)


9232
9233
9234
9235
9236
9237
9238
9239
9240
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 9232

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