Class: Aws::RDS::Types::DescribeDBInstanceAutomatedBackupsMessage
- Inherits:
-
Struct
- Object
- Struct
- Aws::RDS::Types::DescribeDBInstanceAutomatedBackupsMessage
- Includes:
- Structure
- Defined in:
- lib/aws-sdk-rds/types.rb
Overview
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.
Instance Attribute Summary collapse
-
#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_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’ automated backup. This parameter isn’t case-sensitive.
7207 7208 7209 7210 7211 7212 7213 7214 |
# File 'lib/aws-sdk-rds/types.rb', line 7207 class DescribeDBInstanceAutomatedBackupsMessage < Struct.new( :dbi_resource_id, :db_instance_identifier, :filters, :max_records, :marker) 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.
7207 7208 7209 7210 7211 7212 7213 7214 |
# File 'lib/aws-sdk-rds/types.rb', line 7207 class DescribeDBInstanceAutomatedBackupsMessage < Struct.new( :dbi_resource_id, :db_instance_identifier, :filters, :max_records, :marker) 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
-
‘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.
7207 7208 7209 7210 7211 7212 7213 7214 |
# File 'lib/aws-sdk-rds/types.rb', line 7207 class DescribeDBInstanceAutomatedBackupsMessage < Struct.new( :dbi_resource_id, :db_instance_identifier, :filters, :max_records, :marker) 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`.
7207 7208 7209 7210 7211 7212 7213 7214 |
# File 'lib/aws-sdk-rds/types.rb', line 7207 class DescribeDBInstanceAutomatedBackupsMessage < Struct.new( :dbi_resource_id, :db_instance_identifier, :filters, :max_records, :marker) 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 the remaining results can be retrieved.
7207 7208 7209 7210 7211 7212 7213 7214 |
# File 'lib/aws-sdk-rds/types.rb', line 7207 class DescribeDBInstanceAutomatedBackupsMessage < Struct.new( :dbi_resource_id, :db_instance_identifier, :filters, :max_records, :marker) include Aws::Structure end |