Class TargetGroupConfig

java.lang.Object
software.amazon.awssdk.services.vpclattice.model.TargetGroupConfig
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<TargetGroupConfig.Builder,TargetGroupConfig>
@Generated("software.amazon.awssdk:codegen") public final class TargetGroupConfig extends Object implements SdkPojo, Serializable, ToCopyableBuilder<TargetGroupConfig.Builder,TargetGroupConfig>

Describes the configuration of a target group.

For more information, see Target groups in the Amazon VPC Lattice User Guide.

See Also:

  • Method Details

    • healthCheck

      public final HealthCheckConfig healthCheck()

      The health check configuration. Not supported if the target group type is LAMBDA or ALB .

      Returns:
      The health check configuration. Not supported if the target group type is LAMBDA or ALB.

    • ipAddressType

      public final IpAddressType ipAddressType()

      The type of IP address used for the target group. Supported only if the target group type is IP. The default is IPV4.

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

      Returns:
      The type of IP address used for the target group. Supported only if the target group type is IP. The default is IPV4.
      See Also:

    • ipAddressTypeAsString

      public final String ipAddressTypeAsString()

      The type of IP address used for the target group. Supported only if the target group type is IP. The default is IPV4.

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

      Returns:
      The type of IP address used for the target group. Supported only if the target group type is IP. The default is IPV4.
      See Also:

    • lambdaEventStructureVersion

      public final LambdaEventStructureVersion lambdaEventStructureVersion()

      The version of the event structure that your Lambda function receives. Supported only if the target group type is LAMBDA. The default is V1.

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

      Returns:
      The version of the event structure that your Lambda function receives. Supported only if the target group type is LAMBDA. The default is V1.
      See Also:

    • lambdaEventStructureVersionAsString

      public final String lambdaEventStructureVersionAsString()

      The version of the event structure that your Lambda function receives. Supported only if the target group type is LAMBDA. The default is V1.

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

      Returns:
      The version of the event structure that your Lambda function receives. Supported only if the target group type is LAMBDA. The default is V1.
      See Also:

    • port

      public final Integer port()

      The port on which the targets are listening. For HTTP, the default is 80. For HTTPS, the default is 443. Not supported if the target group type is LAMBDA.

      Returns:
      The port on which the targets are listening. For HTTP, the default is 80. For HTTPS, the default is 443. Not supported if the target group type is LAMBDA.

    • protocol

      public final TargetGroupProtocol protocol()

      The protocol to use for routing traffic to the targets. The default is the protocol of the target group. Not supported if the target group type is LAMBDA.

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

      Returns:
      The protocol to use for routing traffic to the targets. The default is the protocol of the target group. Not supported if the target group type is LAMBDA.
      See Also:

    • protocolAsString

      public final String protocolAsString()

      The protocol to use for routing traffic to the targets. The default is the protocol of the target group. Not supported if the target group type is LAMBDA.

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

      Returns:
      The protocol to use for routing traffic to the targets. The default is the protocol of the target group. Not supported if the target group type is LAMBDA.
      See Also:

    • protocolVersion

      public final TargetGroupProtocolVersion protocolVersion()

      The protocol version. The default is HTTP1. Not supported if the target group type is LAMBDA.

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

      Returns:
      The protocol version. The default is HTTP1. Not supported if the target group type is LAMBDA.
      See Also:

    • protocolVersionAsString

      public final String protocolVersionAsString()

      The protocol version. The default is HTTP1. Not supported if the target group type is LAMBDA.

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

      Returns:
      The protocol version. The default is HTTP1. Not supported if the target group type is LAMBDA.
      See Also:

    • vpcIdentifier

      public final String vpcIdentifier()

      The ID of the VPC. Not supported if the target group type is LAMBDA.

      Returns:
      The ID of the VPC. Not supported if the target group type is LAMBDA.

    • toBuilder

      public TargetGroupConfig.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<TargetGroupConfig.Builder,TargetGroupConfig>
      Returns:
      a builder for type T

    • builder

      public static TargetGroupConfig.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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)

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