Package software.amazon.awssdk.services.rds.model

Class DescribeDBClusterSnapshotsRequest

java.lang.Object

software.amazon.awssdk.AmazonWebServiceRequest

software.amazon.awssdk.services.rds.model.DescribeDBClusterSnapshotsRequest

All Implemented Interfaces:

Cloneable, ReadLimitInfo, ToCopyableBuilder<DescribeDBClusterSnapshotsRequest.Builder,DescribeDBClusterSnapshotsRequest>

@Generated("software.amazon.awssdk:codegen")
public class DescribeDBClusterSnapshotsRequest
extends AmazonWebServiceRequest
implements ToCopyableBuilder<DescribeDBClusterSnapshotsRequest.Builder,DescribeDBClusterSnapshotsRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeDBClusterSnapshotsRequest.Builder

Field Summary

Fields inherited from class software.amazon.awssdk.AmazonWebServiceRequest

NOOP

Method Summary

Modifier and Type	Method	Description
static DescribeDBClusterSnapshotsRequest.Builder	builder()
String	dbClusterIdentifier()	The ID of the DB cluster to retrieve the list of DB cluster snapshots for.
String	dbClusterSnapshotIdentifier()	A specific DB cluster snapshot identifier to describe.
boolean	equals(Object obj)
List<Filter>	filters()	This parameter is not currently supported.
int	hashCode()
Boolean	includePublic()	Set this value to true to include manual DB cluster snapshots that are public and can be copied or restored by any AWS account, otherwise set this value to false.
Boolean	includeShared()	Set this value to true to include shared manual DB cluster snapshots from other AWS accounts that this AWS account has been given permission to copy or restore, otherwise set this value to false.
String	marker()	An optional pagination token provided by a previous DescribeDBClusterSnapshots request.
Integer	maxRecords()	The maximum number of records to include in the response.
static Class<? extends DescribeDBClusterSnapshotsRequest.Builder>	serializableBuilderClass()
String	snapshotType()	The type of DB cluster snapshots to be returned.
DescribeDBClusterSnapshotsRequest.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class software.amazon.awssdk.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

dbClusterIdentifier

public String dbClusterIdentifier()

The ID of the DB cluster to retrieve the list of DB cluster snapshots for. This parameter cannot be used in conjunction with the DBClusterSnapshotIdentifier parameter. This parameter is not case-sensitive.

Constraints:

• Must contain from 1 to 63 alphanumeric characters or hyphens

• First character must be a letter

• Cannot end with a hyphen or contain two consecutive hyphens

Returns:

The ID of the DB cluster to retrieve the list of DB cluster snapshots for. This parameter cannot be used in conjunction with the DBClusterSnapshotIdentifier parameter. This parameter is not case-sensitive.

Constraints:

• Must contain from 1 to 63 alphanumeric characters or hyphens

• First character must be a letter

• Cannot end with a hyphen or contain two consecutive hyphens

dbClusterSnapshotIdentifier

public String dbClusterSnapshotIdentifier()

A specific DB cluster snapshot identifier to describe. This parameter cannot be used in conjunction with the DBClusterIdentifier parameter. This value is stored as a lowercase string.

Constraints:

• Must be 1 to 255 alphanumeric characters

• First character must be a letter

• Cannot end with a hyphen or contain two consecutive hyphens

• If this identifier is for an automated snapshot, the SnapshotType parameter must also be specified.

Returns:

A specific DB cluster snapshot identifier to describe. This parameter cannot be used in conjunction with the DBClusterIdentifier parameter. This value is stored as a lowercase string.

Constraints:

• Must be 1 to 255 alphanumeric characters

• First character must be a letter

• Cannot end with a hyphen or contain two consecutive hyphens

• If this identifier is for an automated snapshot, the SnapshotType parameter must also be specified.

snapshotType

public String snapshotType()

The type of DB cluster snapshots to be returned. You can specify one of the following values:

• automated - Return all DB cluster snapshots that have been automatically taken by Amazon RDS for my AWS account.

• manual - Return all DB cluster snapshots that have been taken by my AWS account.

• shared - Return all manual DB cluster snapshots that have been shared to my AWS account.

• public - Return all DB cluster snapshots that have been marked as public.

If you don't specify a SnapshotType value, then both automated and manual DB cluster snapshots are returned. You can include shared DB cluster snapshots with these results by setting the IncludeShared parameter to true. You can include public DB cluster snapshots with these results by setting the IncludePublic parameter to true.

The IncludeShared and IncludePublic parameters don't apply for SnapshotType values of manual or automated. The IncludePublic parameter doesn't apply when SnapshotType is set to shared. The IncludeShared parameter doesn't apply when SnapshotType is set to public.

Returns:

The type of DB cluster snapshots to be returned. You can specify one of the following values:

• automated - Return all DB cluster snapshots that have been automatically taken by Amazon RDS for my AWS account.

• manual - Return all DB cluster snapshots that have been taken by my AWS account.

• shared - Return all manual DB cluster snapshots that have been shared to my AWS account.

• public - Return all DB cluster snapshots that have been marked as public.

If you don't specify a SnapshotType value, then both automated and manual DB cluster snapshots are returned. You can include shared DB cluster snapshots with these results by setting the IncludeShared parameter to true. You can include public DB cluster snapshots with these results by setting the IncludePublic parameter to true.

The IncludeShared and IncludePublic parameters don't apply for SnapshotType values of manual or automated. The IncludePublic parameter doesn't apply when SnapshotType is set to shared. The IncludeShared parameter doesn't apply when SnapshotType is set to public.

filters

public List<Filter> filters()

This parameter is not currently supported.

Returns:

This parameter is not currently supported.

maxRecords

public Integer maxRecords()

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.

Default: 100

Constraints: Minimum 20, maximum 100.

Returns:

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.

Default: 100

Constraints: Minimum 20, maximum 100.

marker

public String marker()

An optional pagination token provided by a previous DescribeDBClusterSnapshots request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Returns:

An optional pagination token provided by a previous DescribeDBClusterSnapshots request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

includeShared

public Boolean includeShared()

Set this value to true to include shared manual DB cluster snapshots from other AWS accounts that this AWS account has been given permission to copy or restore, otherwise set this value to false. The default is false.

You can give an AWS account permission to restore a manual DB cluster snapshot from another AWS account by the ModifyDBClusterSnapshotAttribute API action.

Returns:

Set this value to true to include shared manual DB cluster snapshots from other AWS accounts that this AWS account has been given permission to copy or restore, otherwise set this value to false. The default is false.

You can give an AWS account permission to restore a manual DB cluster snapshot from another AWS account by the ModifyDBClusterSnapshotAttribute API action.

includePublic

public Boolean includePublic()

Set this value to true to include manual DB cluster snapshots that are public and can be copied or restored by any AWS account, otherwise set this value to false. The default is false. The default is false.

You can share a manual DB cluster snapshot as public by using the ModifyDBClusterSnapshotAttribute API action.

Returns:

Set this value to true to include manual DB cluster snapshots that are public and can be copied or restored by any AWS account, otherwise set this value to false. The default is false. The default is false.

You can share a manual DB cluster snapshot as public by using the ModifyDBClusterSnapshotAttribute API action.

toBuilder

public DescribeDBClusterSnapshotsRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeDBClusterSnapshotsRequest.Builder,DescribeDBClusterSnapshotsRequest>

Returns:

a builder for type T

builder

public static DescribeDBClusterSnapshotsRequest.Builder builder()

serializableBuilderClass

public static Class<? extends DescribeDBClusterSnapshotsRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object