software.amazon.awssdk.services.rds.model

Interface DescribeDBSnapshotsRequest.Builder

All Superinterfaces:

AwsRequest.Builder, CopyableBuilder<DescribeDBSnapshotsRequest.Builder,DescribeDBSnapshotsRequest>, RDSRequest.Builder, SdkBuilder<DescribeDBSnapshotsRequest.Builder,DescribeDBSnapshotsRequest>, SdkRequest.Builder

Enclosing class:

DescribeDBSnapshotsRequest

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

Method Summary

Modifier and Type	Method and 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(Consumer<Filter.Builder>... filters) This parameter is not currently supported.
DescribeDBSnapshotsRequest.Builder	filters(Filter... filters) This parameter is not currently supported.
DescribeDBSnapshotsRequest.Builder	includePublic(Boolean includePublic) True to include manual DB snapshots that are public and can be copied or restored by any AWS account, and otherwise false.
DescribeDBSnapshotsRequest.Builder	includeShared(Boolean includeShared) True to include shared manual DB snapshots from other AWS accounts that this AWS account has been given permission to copy or restore, and otherwise 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	requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig) Add an optional request override configuration.
DescribeDBSnapshotsRequest.Builder	requestOverrideConfig(Consumer<AwsRequestOverrideConfig.Builder> builderConsumer) Add an optional request override configuration.
DescribeDBSnapshotsRequest.Builder	snapshotType(String snapshotType) The type of snapshots to be returned.

Methods inherited from interface software.amazon.awssdk.services.rds.model.RDSRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

requestOverrideConfig

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 can't be used in conjunction with DBSnapshotIdentifier. This parameter is not case-sensitive.

Constraints:

• If supplied, must match the identifier of an existing DBInstance.

Parameters:

dbInstanceIdentifier - The ID of the DB instance to retrieve the list of DB snapshots for. This parameter can't be used in conjunction with DBSnapshotIdentifier. This parameter is not case-sensitive.

Constraints:

• If supplied, must match the identifier of an existing DBInstance.

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 can't be used in conjunction with DBInstanceIdentifier. This value is stored as a lowercase string.

Constraints:

• If supplied, must match the identifier of an existing DBSnapshot.

• 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 can't be used in conjunction with DBInstanceIdentifier. This value is stored as a lowercase string.

Constraints:

• If supplied, must match the identifier of an existing DBSnapshot.

• 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.

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(Consumer<Filter.Builder>... filters)

This parameter is not currently supported.

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #filters(List).

Parameters:

filters - a consumer that will call methods on List.Builder

Returns:

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

See Also:

#filters(List)

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)

True to include shared manual DB snapshots from other AWS accounts that this AWS account has been given permission to copy or restore, and otherwise 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 - True to include shared manual DB snapshots from other AWS accounts that this AWS account has been given permission to copy or restore, and otherwise 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)

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

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

Parameters:

includePublic - True to include manual DB snapshots that are public and can be copied or restored by any AWS account, and otherwise 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.

requestOverrideConfig

DescribeDBSnapshotsRequest.Builder requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

requestOverrideConfig in interface AwsRequest.Builder

Parameters:

awsRequestOverrideConfig - The override configuration.

Returns:

This object for method chaining.

requestOverrideConfig

DescribeDBSnapshotsRequest.Builder requestOverrideConfig(Consumer<AwsRequestOverrideConfig.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

requestOverrideConfig in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfig.Builder will be given.

Returns:

This object for method chaining.