Interface DescribeInstanceSqlHaStatesRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<DescribeInstanceSqlHaStatesRequest.Builder,DescribeInstanceSqlHaStatesRequest>, Ec2Request.Builder, SdkBuilder<DescribeInstanceSqlHaStatesRequest.Builder,DescribeInstanceSqlHaStatesRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
DescribeInstanceSqlHaStatesRequest
@Mutable @NotThreadSafe public static interface DescribeInstanceSqlHaStatesRequest.Builder extends Ec2Request.Builder, SdkPojo, CopyableBuilder<DescribeInstanceSqlHaStatesRequest.Builder,DescribeInstanceSqlHaStatesRequest>

  • Method Details

    • instanceIds

      DescribeInstanceSqlHaStatesRequest.Builder instanceIds(Collection<String> instanceIds)

      The IDs of the SQL Server High Availability instances to describe. If omitted, the API returns SQL Server High Availability states for all SQL Server High Availability instances.

      Parameters:
      instanceIds - The IDs of the SQL Server High Availability instances to describe. If omitted, the API returns SQL Server High Availability states for all SQL Server High Availability instances.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • instanceIds

      DescribeInstanceSqlHaStatesRequest.Builder instanceIds(String... instanceIds)

      The IDs of the SQL Server High Availability instances to describe. If omitted, the API returns SQL Server High Availability states for all SQL Server High Availability instances.

      Parameters:
      instanceIds - The IDs of the SQL Server High Availability instances to describe. If omitted, the API returns SQL Server High Availability states for all SQL Server High Availability instances.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • nextToken

      DescribeInstanceSqlHaStatesRequest.Builder nextToken(String nextToken)

      The token to use to retrieve the next page of results.

      Parameters:
      nextToken - The token to use to retrieve the next page of results.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • maxResults

      DescribeInstanceSqlHaStatesRequest.Builder maxResults(Integer maxResults)

      The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value.

      Parameters:
      maxResults - The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • filters

      DescribeInstanceSqlHaStatesRequest.Builder filters(Collection<Filter> filters)

      One or more filters to apply to the results. Supported filters include:

      • tag:<key> - The tag key and value pair assigned to the instance. For example, to find all instances tagged with Owner:TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

      • tag-key - The tag key assigned to the instance.

      • haStatus - The SQL Server High Availability status of the SQL Server High Availability instance (processing | active | standby | invalid).

      • sqlServerLicenseUsage - The license type for the SQL Server license (full | waived).

      Parameters:
      filters - One or more filters to apply to the results. Supported filters include:

      • tag:<key> - The tag key and value pair assigned to the instance. For example, to find all instances tagged with Owner:TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

      • tag-key - The tag key assigned to the instance.

      • haStatus - The SQL Server High Availability status of the SQL Server High Availability instance (processing | active | standby | invalid ).

      • sqlServerLicenseUsage - The license type for the SQL Server license (full | waived).

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

    • filters

      DescribeInstanceSqlHaStatesRequest.Builder filters(Filter... filters)

      One or more filters to apply to the results. Supported filters include:

      • tag:<key> - The tag key and value pair assigned to the instance. For example, to find all instances tagged with Owner:TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

      • tag-key - The tag key assigned to the instance.

      • haStatus - The SQL Server High Availability status of the SQL Server High Availability instance (processing | active | standby | invalid).

      • sqlServerLicenseUsage - The license type for the SQL Server license (full | waived).

      Parameters:
      filters - One or more filters to apply to the results. Supported filters include:

      • tag:<key> - The tag key and value pair assigned to the instance. For example, to find all instances tagged with Owner:TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

      • tag-key - The tag key assigned to the instance.

      • haStatus - The SQL Server High Availability status of the SQL Server High Availability instance (processing | active | standby | invalid ).

      • sqlServerLicenseUsage - The license type for the SQL Server license (full | waived).

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

    • filters

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

      One or more filters to apply to the results. Supported filters include:

      • tag:<key> - The tag key and value pair assigned to the instance. For example, to find all instances tagged with Owner:TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

      • tag-key - The tag key assigned to the instance.

      • haStatus - The SQL Server High Availability status of the SQL Server High Availability instance (processing | active | standby | invalid).

      • sqlServerLicenseUsage - The license type for the SQL Server license (full | waived).

      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:

    • dryRun

      DescribeInstanceSqlHaStatesRequest.Builder dryRun(Boolean dryRun)

      Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

      Parameters:
      dryRun - Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

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

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