Interface ModifyApplicationStatusCheckRequest.Builder

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

  • Method Details

    • applicationStatusCheckId

      ModifyApplicationStatusCheckRequest.Builder applicationStatusCheckId(String applicationStatusCheckId)

      The ID of the application status check to modify.

      Parameters:
      applicationStatusCheckId - The ID of the application status check to modify.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • aggregation

      ModifyApplicationStatusCheckRequest.Builder aggregation(String aggregation)

      The aggregation setting for the application status check. When set to included, the result of this check contributes to the instance-level application status reported by DescribeApplicationStatus. When set to excluded, the check runs independently and does not affect the instance-level status. Valid values: included | excluded.

      Parameters:
      aggregation - The aggregation setting for the application status check. When set to included, the result of this check contributes to the instance-level application status reported by DescribeApplicationStatus. When set to excluded, the check runs independently and does not affect the instance-level status. Valid values: included | excluded.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • aggregation

      ModifyApplicationStatusCheckRequest.Builder aggregation(AggregationStatusEnum aggregation)

      The aggregation setting for the application status check. When set to included, the result of this check contributes to the instance-level application status reported by DescribeApplicationStatus. When set to excluded, the check runs independently and does not affect the instance-level status. Valid values: included | excluded.

      Parameters:
      aggregation - The aggregation setting for the application status check. When set to included, the result of this check contributes to the instance-level application status reported by DescribeApplicationStatus. When set to excluded, the check runs independently and does not affect the instance-level status. Valid values: included | excluded.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • healthCheckPaths

      ModifyApplicationStatusCheckRequest.Builder healthCheckPaths(Collection<HealthCheckPathRequestObject> healthCheckPaths)

      The health check paths to use for the application status check.

      Parameters:
      healthCheckPaths - The health check paths to use for the application status check.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • healthCheckPaths

      ModifyApplicationStatusCheckRequest.Builder healthCheckPaths(HealthCheckPathRequestObject... healthCheckPaths)

      The health check paths to use for the application status check.

      Parameters:
      healthCheckPaths - The health check paths to use for the application status check.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • healthCheckPaths

      ModifyApplicationStatusCheckRequest.Builder healthCheckPaths(Consumer<HealthCheckPathRequestObject.Builder>... healthCheckPaths)

      The health check paths to use for the application status check.

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

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

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

    • protocol

      ModifyApplicationStatusCheckRequest.Builder protocol(String protocol)

      The protocol to use for the health check. Valid values: http | https.

      Parameters:
      protocol - The protocol to use for the health check. Valid values: http | https.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • protocol

      ModifyApplicationStatusCheckRequest.Builder protocol(NetworkProtocolEnum protocol)

      The protocol to use for the health check. Valid values: http | https.

      Parameters:
      protocol - The protocol to use for the health check. Valid values: http | https.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • port

      ModifyApplicationStatusCheckRequest.Builder port(Integer port)

      The port to use for the health check. Valid values: 1 to 65535.

      Parameters:
      port - The port to use for the health check. Valid values: 1 to 65535.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • path

      ModifyApplicationStatusCheckRequest.Builder path(String path)

      The URL path to use for the health check HTTP request (for example, /health or /status).

      Parameters:
      path - The URL path to use for the health check HTTP request (for example, /health or /status).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • deviceIndex

      ModifyApplicationStatusCheckRequest.Builder deviceIndex(Integer deviceIndex)

      The index of the network device to use for the health check. The value must be greater than or equal to 0.

      Parameters:
      deviceIndex - The index of the network device to use for the health check. The value must be greater than or equal to 0.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • ipVersion

      ModifyApplicationStatusCheckRequest.Builder ipVersion(String ipVersion)

      The IP version to use for the health check. Valid values: ipv4 and ipv6.

      Parameters:
      ipVersion - The IP version to use for the health check. Valid values: ipv4 and ipv6.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • ipVersion

      ModifyApplicationStatusCheckRequest.Builder ipVersion(IpVersionEnum ipVersion)

      The IP version to use for the health check. Valid values: ipv4 and ipv6.

      Parameters:
      ipVersion - The IP version to use for the health check. Valid values: ipv4 and ipv6.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • ipScope

      ModifyApplicationStatusCheckRequest.Builder ipScope(String ipScope)

      The IP scope to use for the health check. Valid value: private.

      Parameters:
      ipScope - The IP scope to use for the health check. Valid value: private.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • ipScope

      ModifyApplicationStatusCheckRequest.Builder ipScope(IpScopeEnum ipScope)

      The IP scope to use for the health check. Valid value: private.

      Parameters:
      ipScope - The IP scope to use for the health check. Valid value: private.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • interval

      ModifyApplicationStatusCheckRequest.Builder interval(Integer interval)

      The interval, in seconds, between health checks. Valid value: 60.

      Parameters:
      interval - The interval, in seconds, between health checks. Valid value: 60.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • timeout

      ModifyApplicationStatusCheckRequest.Builder timeout(Integer timeout)

      The amount of time, in seconds, to wait for a health check response before considering it failed. Valid values: 1 to 30. The value must be less than Interval.

      Parameters:
      timeout - The amount of time, in seconds, to wait for a health check response before considering it failed. Valid values: 1 to 30. The value must be less than Interval.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • failureThreshold

      ModifyApplicationStatusCheckRequest.Builder failureThreshold(Integer failureThreshold)

      The number of consecutive failed health checks before the application status is considered impaired. The value must be greater than 0.

      Parameters:
      failureThreshold - The number of consecutive failed health checks before the application status is considered impaired. The value must be greater than 0.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • successThreshold

      ModifyApplicationStatusCheckRequest.Builder successThreshold(Integer successThreshold)

      The number of consecutive successful health checks before the application status is considered healthy. The value must be greater than 0.

      Parameters:
      successThreshold - The number of consecutive successful health checks before the application status is considered healthy. The value must be greater than 0.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • statusCodeMatcher

      ModifyApplicationStatusCheckRequest.Builder statusCodeMatcher(String statusCodeMatcher)

      The HTTP status codes that indicate a successful health check response. Specify a comma-separated list of individual status codes or ranges, for example, 200,202,300-399. For a range, the first value must be less than the second value. Maximum length: 64 characters.

      Parameters:
      statusCodeMatcher - The HTTP status codes that indicate a successful health check response. Specify a comma-separated list of individual status codes or ranges, for example, 200,202,300-399. For a range, the first value must be less than the second value. Maximum length: 64 characters.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • initializationGracePeriodSeconds

      ModifyApplicationStatusCheckRequest.Builder initializationGracePeriodSeconds(Integer initializationGracePeriodSeconds)

      The number of seconds to wait before starting health checks after an instance is launched. Valid values: 1 to 600.

      Parameters:
      initializationGracePeriodSeconds - The number of seconds to wait before starting health checks after an instance is launched. Valid values: 1 to 600.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • clientToken

      ModifyApplicationStatusCheckRequest.Builder clientToken(String clientToken)

      Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.

      Parameters:
      clientToken - Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dryRun

      ModifyApplicationStatusCheckRequest.Builder dryRun(Boolean dryRun)

      Checks whether you have the required permissions for the operation, 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 operation, 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

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

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