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

Interface DescribeDbInstanceAutomatedBackupsRequest.Builder

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

  • Method Details

    • dbiResourceId

      DescribeDbInstanceAutomatedBackupsRequest.Builder dbiResourceId(String dbiResourceId)

      The resource ID of the DB instance that is the source of the automated backup. This parameter isn't case-sensitive.

      Parameters:
      dbiResourceId - The resource ID of the DB instance that is the source of the automated backup. This parameter isn't case-sensitive.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dbInstanceIdentifier

      DescribeDbInstanceAutomatedBackupsRequest.Builder dbInstanceIdentifier(String dbInstanceIdentifier)

      (Optional) The user-supplied instance identifier. If this parameter is specified, it must match the identifier of an existing DB instance. It returns information from the specific DB instance's automated backup. This parameter isn't case-sensitive.

      Parameters:
      dbInstanceIdentifier - (Optional) The user-supplied instance identifier. If this parameter is specified, it must match the identifier of an existing DB instance. It returns information from the specific DB instance's automated backup. This parameter isn't case-sensitive.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • filters

      DescribeDbInstanceAutomatedBackupsRequest.Builder filters(Collection<Filter> filters)

      A filter that specifies which resources to return based on status.

      Supported filters are the following:

      • status

        • active - Automated backups for current instances.

        • creating - Automated backups that are waiting for the first automated snapshot to be available.

        • retained - Automated backups for deleted instances and after backup replication is stopped.

      • db-instance-id - Accepts DB instance identifiers and Amazon Resource Names (ARNs). The results list includes only information about the DB instance automated backups identified by these ARNs.

      • dbi-resource-id - Accepts DB resource identifiers and Amazon Resource Names (ARNs). The results list includes only information about the DB instance resources identified by these ARNs.

      Returns all resources by default. The status for each resource is specified in the response.

      Parameters:
      filters - A filter that specifies which resources to return based on status.

      Supported filters are the following:

      • status

        • active - Automated backups for current instances.

        • creating - Automated backups that are waiting for the first automated snapshot to be available.

        • retained - Automated backups for deleted instances and after backup replication is stopped.

      • db-instance-id - Accepts DB instance identifiers and Amazon Resource Names (ARNs). The results list includes only information about the DB instance automated backups identified by these ARNs.

      • dbi-resource-id - Accepts DB resource identifiers and Amazon Resource Names (ARNs). The results list includes only information about the DB instance resources identified by these ARNs.

      Returns all resources by default. The status for each resource is specified in the response.

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

    • filters

      DescribeDbInstanceAutomatedBackupsRequest.Builder filters(Filter... filters)

      A filter that specifies which resources to return based on status.

      Supported filters are the following:

      • status

        • active - Automated backups for current instances.

        • creating - Automated backups that are waiting for the first automated snapshot to be available.

        • retained - Automated backups for deleted instances and after backup replication is stopped.

      • db-instance-id - Accepts DB instance identifiers and Amazon Resource Names (ARNs). The results list includes only information about the DB instance automated backups identified by these ARNs.

      • dbi-resource-id - Accepts DB resource identifiers and Amazon Resource Names (ARNs). The results list includes only information about the DB instance resources identified by these ARNs.

      Returns all resources by default. The status for each resource is specified in the response.

      Parameters:
      filters - A filter that specifies which resources to return based on status.

      Supported filters are the following:

      • status

        • active - Automated backups for current instances.

        • creating - Automated backups that are waiting for the first automated snapshot to be available.

        • retained - Automated backups for deleted instances and after backup replication is stopped.

      • db-instance-id - Accepts DB instance identifiers and Amazon Resource Names (ARNs). The results list includes only information about the DB instance automated backups identified by these ARNs.

      • dbi-resource-id - Accepts DB resource identifiers and Amazon Resource Names (ARNs). The results list includes only information about the DB instance resources identified by these ARNs.

      Returns all resources by default. The status for each resource is specified in the response.

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

    • filters

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

      A filter that specifies which resources to return based on status.

      Supported filters are the following:

      • status

        • active - Automated backups for current instances.

        • creating - Automated backups that are waiting for the first automated snapshot to be available.

        • retained - Automated backups for deleted instances and after backup replication is stopped.

      • db-instance-id - Accepts DB instance identifiers and Amazon Resource Names (ARNs). The results list includes only information about the DB instance automated backups identified by these ARNs.

      • dbi-resource-id - Accepts DB resource identifiers and Amazon Resource Names (ARNs). The results list includes only information about the DB instance resources identified by these ARNs.

      Returns all resources by default. The status for each resource is specified in the response.

      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

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

      DescribeDbInstanceAutomatedBackupsRequest.Builder marker(String marker)

      The pagination token provided in the previous request. If this parameter is specified the response includes only records beyond the marker, up to MaxRecords.

      Parameters:
      marker - The pagination token provided in the previous request. If this parameter is specified the response includes only records beyond the marker, up to MaxRecords.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dbInstanceAutomatedBackupsArn

      DescribeDbInstanceAutomatedBackupsRequest.Builder dbInstanceAutomatedBackupsArn(String dbInstanceAutomatedBackupsArn)

      The Amazon Resource Name (ARN) of the replicated automated backups, for example, arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE.

      This setting doesn't apply to RDS Custom.

      Parameters:
      dbInstanceAutomatedBackupsArn - The Amazon Resource Name (ARN) of the replicated automated backups, for example, arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE.

      This setting doesn't apply to RDS Custom.

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

    • overrideConfiguration

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

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