Class ModifyApplicationStatusCheckRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.ec2.model.Ec2Request
software.amazon.awssdk.services.ec2.model.ModifyApplicationStatusCheckRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<ModifyApplicationStatusCheckRequest.Builder,ModifyApplicationStatusCheckRequest>
@Generated("software.amazon.awssdk:codegen") public final class ModifyApplicationStatusCheckRequest extends Ec2Request implements ToCopyableBuilder<ModifyApplicationStatusCheckRequest.Builder,ModifyApplicationStatusCheckRequest>

  • Method Details

    • applicationStatusCheckId

      public final String applicationStatusCheckId()

      The ID of the application status check to modify.

      Returns:
      The ID of the application status check to modify.

    • aggregation

      public final 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.

      If the service returns an enum value that is not available in the current SDK version, aggregation will return AggregationStatusEnum.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from aggregationAsString().

      Returns:
      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.
      See Also:

    • aggregationAsString

      public final String aggregationAsString()

      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.

      If the service returns an enum value that is not available in the current SDK version, aggregation will return AggregationStatusEnum.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from aggregationAsString().

      Returns:
      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.
      See Also:

    • hasHealthCheckPaths

      public final boolean hasHealthCheckPaths()
      For responses, this returns true if the service returned a value for the HealthCheckPaths property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • healthCheckPaths

      public final List<HealthCheckPathRequestObject> healthCheckPaths()

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

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasHealthCheckPaths() method.

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

    • protocol

      public final NetworkProtocolEnum protocol()

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

      If the service returns an enum value that is not available in the current SDK version, protocol will return NetworkProtocolEnum.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from protocolAsString().

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

    • protocolAsString

      public final String protocolAsString()

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

      If the service returns an enum value that is not available in the current SDK version, protocol will return NetworkProtocolEnum.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from protocolAsString().

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

    • port

      public final Integer port()

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

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

    • path

      public final String path()

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

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

    • deviceIndex

      public final Integer deviceIndex()

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

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

    • ipVersion

      public final IpVersionEnum ipVersion()

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

      If the service returns an enum value that is not available in the current SDK version, ipVersion will return IpVersionEnum.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from ipVersionAsString().

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

    • ipVersionAsString

      public final String ipVersionAsString()

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

      If the service returns an enum value that is not available in the current SDK version, ipVersion will return IpVersionEnum.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from ipVersionAsString().

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

    • ipScope

      public final IpScopeEnum ipScope()

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

      If the service returns an enum value that is not available in the current SDK version, ipScope will return IpScopeEnum.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from ipScopeAsString().

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

    • ipScopeAsString

      public final String ipScopeAsString()

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

      If the service returns an enum value that is not available in the current SDK version, ipScope will return IpScopeEnum.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from ipScopeAsString().

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

    • interval

      public final Integer interval()

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

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

    • timeout

      public final 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.

      Returns:
      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.

    • failureThreshold

      public final Integer failureThreshold()

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

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

    • successThreshold

      public final Integer successThreshold()

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

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

    • statusCodeMatcher

      public final 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.

      Returns:
      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.

    • initializationGracePeriodSeconds

      public final Integer initializationGracePeriodSeconds()

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

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

    • clientToken

      public final String clientToken()

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

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

    • dryRun

      public final 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.

      Returns:
      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.

    • toBuilder

      public ModifyApplicationStatusCheckRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<ModifyApplicationStatusCheckRequest.Builder,ModifyApplicationStatusCheckRequest>
      Specified by:
      toBuilder in class Ec2Request
      Returns:
      a builder for type T

    • builder

      public static ModifyApplicationStatusCheckRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ModifyApplicationStatusCheckRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.