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

Interface DescribeDbSnapshotsRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<DescribeDbSnapshotsRequest.Builder,DescribeDbSnapshotsRequest>, RdsRequest.Builder, SdkBuilder<DescribeDbSnapshotsRequest.Builder,DescribeDbSnapshotsRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
DescribeDbSnapshotsRequest
public static interface DescribeDbSnapshotsRequest.Builder extends RdsRequest.Builder, SdkPojo, CopyableBuilder<DescribeDbSnapshotsRequest.Builder,DescribeDbSnapshotsRequest>

  • Method Details

    • dbInstanceIdentifier

      DescribeDbSnapshotsRequest.Builder dbInstanceIdentifier(String dbInstanceIdentifier)

      The ID of the DB instance to retrieve the list of DB snapshots for. This parameter isn't 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 isn't 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 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 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 Amazon Web Services account.

      • manual - Return all DB snapshots that have been taken by my Amazon Web Services account.

      • shared - Return all manual DB snapshots that have been shared to my Amazon Web Services account.

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

      • awsbackup - Return the DB snapshots managed by the Amazon Web Services Backup service.

        For information about Amazon Web Services Backup, see the Amazon Web Services Backup Developer Guide.

        The awsbackup type does not apply to Aurora.

      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 enabling the IncludeShared parameter. You can include public snapshots with these results by enabling the IncludePublic parameter.

      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 Amazon Web Services account.

      • manual - Return all DB snapshots that have been taken by my Amazon Web Services account.

      • shared - Return all manual DB snapshots that have been shared to my Amazon Web Services account.

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

      • awsbackup - Return the DB snapshots managed by the Amazon Web Services Backup service.

        For information about Amazon Web Services Backup, see the Amazon Web Services Backup Developer Guide.

        The awsbackup type does not apply to Aurora.

      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 enabling the IncludeShared parameter. You can include public snapshots with these results by enabling the IncludePublic parameter.

      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)

      A filter that specifies one or more DB snapshots to describe.

      Supported filters:

      • db-instance-id - Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs).

      • db-snapshot-id - Accepts DB snapshot identifiers.

      • dbi-resource-id - Accepts identifiers of source DB instances.

      • snapshot-type - Accepts types of DB snapshots.

      • engine - Accepts names of database engines.

      Parameters:
      filters - A filter that specifies one or more DB snapshots to describe.

      Supported filters:

      • db-instance-id - Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs).

      • db-snapshot-id - Accepts DB snapshot identifiers.

      • dbi-resource-id - Accepts identifiers of source DB instances.

      • snapshot-type - Accepts types of DB snapshots.

      • engine - Accepts names of database engines.

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

    • filters

      DescribeDbSnapshotsRequest.Builder filters(Filter... filters)

      A filter that specifies one or more DB snapshots to describe.

      Supported filters:

      • db-instance-id - Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs).

      • db-snapshot-id - Accepts DB snapshot identifiers.

      • dbi-resource-id - Accepts identifiers of source DB instances.

      • snapshot-type - Accepts types of DB snapshots.

      • engine - Accepts names of database engines.

      Parameters:
      filters - A filter that specifies one or more DB snapshots to describe.

      Supported filters:

      • db-instance-id - Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs).

      • db-snapshot-id - Accepts DB snapshot identifiers.

      • dbi-resource-id - Accepts identifiers of source DB instances.

      • snapshot-type - Accepts types of DB snapshots.

      • engine - Accepts names of database engines.

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

    • filters

      DescribeDbSnapshotsRequest.Builder filters(Consumer<Filter.Builder>... filters)

      A filter that specifies one or more DB snapshots to describe.

      Supported filters:

      • db-instance-id - Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs).

      • db-snapshot-id - Accepts DB snapshot identifiers.

      • dbi-resource-id - Accepts identifiers of source DB instances.

      • snapshot-type - Accepts types of DB snapshots.

      • engine - Accepts names of database engines.

      This is a convenience method that creates an instance of the Filter.Builder avoiding the need to create one manually via Filter.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to filters(List<Filter>).

      Parameters:
      filters - a consumer that will call methods on Filter.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • 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 you can retrieve the remaining results.

      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 you can retrieve the remaining results.

      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)

      Specifies whether to include shared manual DB cluster snapshots from other Amazon Web Services accounts that this Amazon Web Services account has been given permission to copy or restore. By default, these snapshots are not included.

      You can give an Amazon Web Services account permission to restore a manual DB snapshot from another Amazon Web Services account by using the ModifyDBSnapshotAttribute API action.

      This setting doesn't apply to RDS Custom.

      Parameters:
      includeShared - Specifies whether to include shared manual DB cluster snapshots from other Amazon Web Services accounts that this Amazon Web Services account has been given permission to copy or restore. By default, these snapshots are not included.

      You can give an Amazon Web Services account permission to restore a manual DB snapshot from another Amazon Web Services account by using the ModifyDBSnapshotAttribute API action.

      This setting doesn't apply to RDS Custom.

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

    • includePublic

      DescribeDbSnapshotsRequest.Builder includePublic(Boolean includePublic)

      Specifies whether to include manual DB cluster snapshots that are public and can be copied or restored by any Amazon Web Services account. By default, the public snapshots are not included.

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

      This setting doesn't apply to RDS Custom.

      Parameters:
      includePublic - Specifies whether to include manual DB cluster snapshots that are public and can be copied or restored by any Amazon Web Services account. By default, the public snapshots are not included.

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

      This setting doesn't apply to RDS Custom.

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

    • dbiResourceId

      DescribeDbSnapshotsRequest.Builder dbiResourceId(String dbiResourceId)

      A specific DB resource ID to describe.

      Parameters:
      dbiResourceId - A specific DB resource ID to describe.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      DescribeDbSnapshotsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      DescribeDbSnapshotsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.