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

Interface DescribeDbSnapshotTenantDatabasesRequest.Builder

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

  • Method Details

    • dbInstanceIdentifier

      DescribeDbSnapshotTenantDatabasesRequest.Builder dbInstanceIdentifier(String dbInstanceIdentifier)

      The ID of the DB instance used to create the DB snapshots. 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 used to create the DB snapshots. 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

      DescribeDbSnapshotTenantDatabasesRequest.Builder dbSnapshotIdentifier(String dbSnapshotIdentifier)

      The ID of a DB snapshot that contains the tenant databases to describe. This value is stored as a lowercase string.

      Constraints:

      • If you specify this parameter, the value must match the ID of an existing DB snapshot.

      • If you specify an automatic snapshot, you must also specify SnapshotType.

      Parameters:
      dbSnapshotIdentifier - The ID of a DB snapshot that contains the tenant databases to describe. This value is stored as a lowercase string.

      Constraints:

      • If you specify this parameter, the value must match the ID of an existing DB snapshot.

      • If you specify an automatic snapshot, you must also specify SnapshotType.

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

    • snapshotType

      DescribeDbSnapshotTenantDatabasesRequest.Builder snapshotType(String snapshotType)

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

      • automated – All DB snapshots that have been automatically taken by Amazon RDS for my Amazon Web Services account.

      • manual – All DB snapshots that have been taken by my Amazon Web Services account.

      • shared – All manual DB snapshots that have been shared to my Amazon Web Services account.

      • public – All DB snapshots that have been marked as public.

      • awsbackup – All DB snapshots managed by the Amazon Web Services Backup service.

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

      • automated – All DB snapshots that have been automatically taken by Amazon RDS for my Amazon Web Services account.

      • manual – All DB snapshots that have been taken by my Amazon Web Services account.

      • shared – All manual DB snapshots that have been shared to my Amazon Web Services account.

      • public – All DB snapshots that have been marked as public.

      • awsbackup – All DB snapshots managed by the Amazon Web Services Backup service.

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

    • filters

      DescribeDbSnapshotTenantDatabasesRequest.Builder filters(Collection<Filter> filters)

      A filter that specifies one or more tenant databases to describe.

      Supported filters:

      • tenant-db-name - Tenant database names. The results list only includes information about the tenant databases that match these tenant DB names.

      • tenant-database-resource-id - Tenant database resource identifiers. The results list only includes information about the tenant databases contained within the DB snapshots.

      • dbi-resource-id - DB instance resource identifiers. The results list only includes information about snapshots containing tenant databases contained within the DB instances identified by these resource identifiers.

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

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

      • snapshot-type - Accepts types of DB snapshots.

      Parameters:
      filters - A filter that specifies one or more tenant databases to describe.

      Supported filters:

      • tenant-db-name - Tenant database names. The results list only includes information about the tenant databases that match these tenant DB names.

      • tenant-database-resource-id - Tenant database resource identifiers. The results list only includes information about the tenant databases contained within the DB snapshots.

      • dbi-resource-id - DB instance resource identifiers. The results list only includes information about snapshots containing tenant databases contained within the DB instances identified by these resource identifiers.

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

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

      • snapshot-type - Accepts types of DB snapshots.

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

    • filters

      DescribeDbSnapshotTenantDatabasesRequest.Builder filters(Filter... filters)

      A filter that specifies one or more tenant databases to describe.

      Supported filters:

      • tenant-db-name - Tenant database names. The results list only includes information about the tenant databases that match these tenant DB names.

      • tenant-database-resource-id - Tenant database resource identifiers. The results list only includes information about the tenant databases contained within the DB snapshots.

      • dbi-resource-id - DB instance resource identifiers. The results list only includes information about snapshots containing tenant databases contained within the DB instances identified by these resource identifiers.

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

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

      • snapshot-type - Accepts types of DB snapshots.

      Parameters:
      filters - A filter that specifies one or more tenant databases to describe.

      Supported filters:

      • tenant-db-name - Tenant database names. The results list only includes information about the tenant databases that match these tenant DB names.

      • tenant-database-resource-id - Tenant database resource identifiers. The results list only includes information about the tenant databases contained within the DB snapshots.

      • dbi-resource-id - DB instance resource identifiers. The results list only includes information about snapshots containing tenant databases contained within the DB instances identified by these resource identifiers.

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

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

      • snapshot-type - Accepts types of DB snapshots.

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

    • filters

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

      A filter that specifies one or more tenant databases to describe.

      Supported filters:

      • tenant-db-name - Tenant database names. The results list only includes information about the tenant databases that match these tenant DB names.

      • tenant-database-resource-id - Tenant database resource identifiers. The results list only includes information about the tenant databases contained within the DB snapshots.

      • dbi-resource-id - DB instance resource identifiers. The results list only includes information about snapshots containing tenant databases contained within the DB instances identified by these resource identifiers.

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

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

      • snapshot-type - Accepts types of DB snapshots.

      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

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

      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • marker

      DescribeDbSnapshotTenantDatabasesRequest.Builder marker(String marker)

      An optional pagination token provided by a previous DescribeDBSnapshotTenantDatabases 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 DescribeDBSnapshotTenantDatabases 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.

    • dbiResourceId

      DescribeDbSnapshotTenantDatabasesRequest.Builder dbiResourceId(String dbiResourceId)

      A specific DB resource identifier to describe.

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

    • overrideConfiguration

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

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