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

Interface DescribeDBSnapshotsRequest.Builder

All Superinterfaces:

CopyableBuilder<DescribeDBSnapshotsRequest.Builder,DescribeDBSnapshotsRequest>, SdkBuilder<DescribeDBSnapshotsRequest.Builder,DescribeDBSnapshotsRequest>

Enclosing class:

DescribeDBSnapshotsRequest

public static interface DescribeDBSnapshotsRequest.Builder
extends CopyableBuilder<DescribeDBSnapshotsRequest.Builder,DescribeDBSnapshotsRequest>

Method Summary

Modifier and Type	Method	Description
DescribeDBSnapshotsRequest.Builder	dbInstanceIdentifier(String dbInstanceIdentifier)	The ID of the DB instance to retrieve the list of DB snapshots for.
DescribeDBSnapshotsRequest.Builder	dbSnapshotIdentifier(String dbSnapshotIdentifier)	A specific DB snapshot identifier to describe.
DescribeDBSnapshotsRequest.Builder	filters(Collection<Filter> filters)	This parameter is not currently supported.
DescribeDBSnapshotsRequest.Builder	filters(Filter... filters)	This parameter is not currently supported.
DescribeDBSnapshotsRequest.Builder	includePublic(Boolean includePublic)	Set this value to true to include manual DB snapshots that are public and can be copied or restored by any AWS account, otherwise set this value to false.
DescribeDBSnapshotsRequest.Builder	includeShared(Boolean includeShared)	Set this value to true to include shared manual DB snapshots from other AWS accounts that this AWS account has been given permission to copy or restore, otherwise set this value to false.
DescribeDBSnapshotsRequest.Builder	marker(String marker)	An optional pagination token provided by a previous DescribeDBSnapshots request.
DescribeDBSnapshotsRequest.Builder	maxRecords(Integer maxRecords)	The maximum number of records to include in the response.
DescribeDBSnapshotsRequest.Builder	snapshotType(String snapshotType)	The type of snapshots to be returned.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

apply, build

Method Detail

dbInstanceIdentifier

DescribeDBSnapshotsRequest.Builder dbInstanceIdentifier(String dbInstanceIdentifier)

The ID of the DB instance to retrieve the list of DB snapshots for. This parameter cannot be used in conjunction with DBSnapshotIdentifier. 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

Parameters:

dbInstanceIdentifier - The ID of the DB instance to retrieve the list of DB snapshots for. This parameter cannot be used in conjunction with DBSnapshotIdentifier. 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:

Returns a reference to this object so that method calls can be chained together.

dbSnapshotIdentifier

DescribeDBSnapshotsRequest.Builder dbSnapshotIdentifier(String dbSnapshotIdentifier)

A specific DB snapshot identifier to describe. This parameter cannot be used in conjunction with DBInstanceIdentifier. 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.

Parameters:

dbSnapshotIdentifier - A specific DB snapshot identifier to describe. This parameter cannot be used in conjunction with DBInstanceIdentifier. 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:

Returns a reference to this object so that method calls can be chained together.

snapshotType

DescribeDBSnapshotsRequest.Builder snapshotType(String snapshotType)

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

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

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

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

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

If you don't specify a SnapshotType value, then both automated and manual snapshots are returned. Shared and public DB snapshots are not included in the returned results by default. You can include shared snapshots with these results by setting the IncludeShared parameter to true. You can include public 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.

Parameters:

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

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

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

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

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

If you don't specify a SnapshotType value, then both automated and manual snapshots are returned. Shared and public DB snapshots are not included in the returned results by default. You can include shared snapshots with these results by setting the IncludeShared parameter to true. You can include public 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:

Returns a reference to this object so that method calls can be chained together.

filters

DescribeDBSnapshotsRequest.Builder filters(Collection<Filter> filters)

This parameter is not currently supported.

Parameters:

filters - This parameter is not currently supported.

Returns:

Returns a reference to this object so that method calls can be chained together.

filters

DescribeDBSnapshotsRequest.Builder filters(Filter... filters)

This parameter is not currently supported.

NOTE: This method appends the values to the existing list (if any). Use #setFilters(java.util.Collection) or #withFilters(java.util.Collection) if you want to override the existing values.

Parameters:

filters - This parameter is not currently supported.

Returns:

Returns a reference to this object so that method calls can be chained together.

maxRecords

DescribeDBSnapshotsRequest.Builder maxRecords(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

marker

DescribeDBSnapshotsRequest.Builder marker(String marker)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

includeShared

DescribeDBSnapshotsRequest.Builder includeShared(Boolean includeShared)

Set this value to true to include shared manual DB 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 snapshot from another AWS account by using the ModifyDBSnapshotAttribute API action.

Parameters:

includeShared - Set this value to true to include shared manual DB 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 snapshot from another AWS account by using the ModifyDBSnapshotAttribute API action.

Returns:

Returns a reference to this object so that method calls can be chained together.

includePublic

DescribeDBSnapshotsRequest.Builder includePublic(Boolean includePublic)

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

You can share a manual DB snapshot as public by using the ModifyDBSnapshotAttribute API.

Parameters:

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

You can share a manual DB snapshot as public by using the ModifyDBSnapshotAttribute API.

Returns:

Returns a reference to this object so that method calls can be chained together.