Class: Aws::RDS::Types::DescribeDBClusterAutomatedBackupsMessage

Inherits:

Struct

• Object
• Struct
• Aws::RDS::Types::DescribeDBClusterAutomatedBackupsMessage

Includes:

Structure

Defined in:

lib/aws-sdk-rds/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #db_cluster_identifier ⇒ String

  (Optional) The user-supplied DB cluster identifier.

• #db_cluster_resource_id ⇒ String

  The resource ID of the DB cluster 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_cluster_identifier ⇒ String

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

Returns:

• (String)

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

class DescribeDBClusterAutomatedBackupsMessage < Struct.new(
  :db_cluster_resource_id,
  :db_cluster_identifier,
  :filters,
  :max_records,
  :marker)
  SENSITIVE = []
  include Aws::Structure
end

#db_cluster_resource_id ⇒ String

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

Returns:

• (String)

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

class DescribeDBClusterAutomatedBackupsMessage < Struct.new(
  :db_cluster_resource_id,
  :db_cluster_identifier,
  :filters,
  :max_records,
  :marker)
  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`

  • ‘retained` - Automated backups for deleted clusters and after backup replication is stopped.

  ^

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

• ‘db-cluster-resource-id` - Accepts DB resource identifiers and Amazon Resource Names (ARNs). The results list includes only information about the DB cluster 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 'lib/aws-sdk-rds/types.rb', line 12189

class DescribeDBClusterAutomatedBackupsMessage < Struct.new(
  :db_cluster_resource_id,
  :db_cluster_identifier,
  :filters,
  :max_records,
  :marker)
  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 'lib/aws-sdk-rds/types.rb', line 12189

class DescribeDBClusterAutomatedBackupsMessage < Struct.new(
  :db_cluster_resource_id,
  :db_cluster_identifier,
  :filters,
  :max_records,
  :marker)
  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 'lib/aws-sdk-rds/types.rb', line 12189

class DescribeDBClusterAutomatedBackupsMessage < Struct.new(
  :db_cluster_resource_id,
  :db_cluster_identifier,
  :filters,
  :max_records,
  :marker)
  SENSITIVE = []
  include Aws::Structure
end