Package software.amazon.awssdk.services.ec2.model

Interface DescribeInstanceTopologyRequest.Builder

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

  • Method Details

    • dryRun

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

    • nextToken

      DescribeInstanceTopologyRequest.Builder nextToken(String nextToken)

      The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

      Parameters:
      nextToken - The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • maxResults

      DescribeInstanceTopologyRequest.Builder maxResults(Integer maxResults)

      The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.

      You can't specify this parameter and the instance IDs parameter in the same request.

      Default: 20

      Parameters:
      maxResults - The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.

      You can't specify this parameter and the instance IDs parameter in the same request.

      Default: 20

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

    • instanceIds

      DescribeInstanceTopologyRequest.Builder instanceIds(Collection<String> instanceIds)

      The instance IDs.

      Default: Describes all your instances.

      Constraints: Maximum 100 explicitly specified instance IDs.

      Parameters:
      instanceIds - The instance IDs.

      Default: Describes all your instances.

      Constraints: Maximum 100 explicitly specified instance IDs.

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

    • instanceIds

      DescribeInstanceTopologyRequest.Builder instanceIds(String... instanceIds)

      The instance IDs.

      Default: Describes all your instances.

      Constraints: Maximum 100 explicitly specified instance IDs.

      Parameters:
      instanceIds - The instance IDs.

      Default: Describes all your instances.

      Constraints: Maximum 100 explicitly specified instance IDs.

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

    • groupNames

      DescribeInstanceTopologyRequest.Builder groupNames(Collection<String> groupNames)

      The name of the placement group that each instance is in.

      Constraints: Maximum 100 explicitly specified placement group names.

      Parameters:
      groupNames - The name of the placement group that each instance is in.

      Constraints: Maximum 100 explicitly specified placement group names.

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

    • groupNames

      DescribeInstanceTopologyRequest.Builder groupNames(String... groupNames)

      The name of the placement group that each instance is in.

      Constraints: Maximum 100 explicitly specified placement group names.

      Parameters:
      groupNames - The name of the placement group that each instance is in.

      Constraints: Maximum 100 explicitly specified placement group names.

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

    • filters

      DescribeInstanceTopologyRequest.Builder filters(Collection<Filter> filters)

      The filters.

      • availability-zone - The name of the Availability Zone (for example, us-west-2a) or Local Zone (for example, us-west-2-lax-1b) that the instance is in.

      • instance-type - The instance type (for example, p4d.24xlarge) or instance family (for example, p4d*). You can use the * wildcard to match zero or more characters, or the ? wildcard to match zero or one character.

      • zone-id - The ID of the Availability Zone (for example, usw2-az2) or Local Zone (for example, usw2-lax1-az1) that the instance is in.

      Parameters:
      filters - The filters.

      • availability-zone - The name of the Availability Zone (for example, us-west-2a) or Local Zone (for example, us-west-2-lax-1b) that the instance is in.

      • instance-type - The instance type (for example, p4d.24xlarge) or instance family (for example, p4d*). You can use the * wildcard to match zero or more characters, or the ? wildcard to match zero or one character.

      • zone-id - The ID of the Availability Zone (for example, usw2-az2) or Local Zone (for example, usw2-lax1-az1) that the instance is in.

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

    • filters

      DescribeInstanceTopologyRequest.Builder filters(Filter... filters)

      The filters.

      • availability-zone - The name of the Availability Zone (for example, us-west-2a) or Local Zone (for example, us-west-2-lax-1b) that the instance is in.

      • instance-type - The instance type (for example, p4d.24xlarge) or instance family (for example, p4d*). You can use the * wildcard to match zero or more characters, or the ? wildcard to match zero or one character.

      • zone-id - The ID of the Availability Zone (for example, usw2-az2) or Local Zone (for example, usw2-lax1-az1) that the instance is in.

      Parameters:
      filters - The filters.

      • availability-zone - The name of the Availability Zone (for example, us-west-2a) or Local Zone (for example, us-west-2-lax-1b) that the instance is in.

      • instance-type - The instance type (for example, p4d.24xlarge) or instance family (for example, p4d*). You can use the * wildcard to match zero or more characters, or the ? wildcard to match zero or one character.

      • zone-id - The ID of the Availability Zone (for example, usw2-az2) or Local Zone (for example, usw2-lax1-az1) that the instance is in.

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

    • filters

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

      The filters.

      • availability-zone - The name of the Availability Zone (for example, us-west-2a) or Local Zone (for example, us-west-2-lax-1b) that the instance is in.

      • instance-type - The instance type (for example, p4d.24xlarge) or instance family (for example, p4d*). You can use the * wildcard to match zero or more characters, or the ? wildcard to match zero or one character.

      • zone-id - The ID of the Availability Zone (for example, usw2-az2) or Local Zone (for example, usw2-lax1-az1) that the instance is in.

      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:

    • overrideConfiguration

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

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