CreateTargetGroupRequest (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.elasticloadbalancingv2.model.ElasticLoadBalancingV2Request
    - - software.amazon.awssdk.services.elasticloadbalancingv2.model.CreateTargetGroupRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<CreateTargetGroupRequest.Builder,CreateTargetGroupRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateTargetGroupRequest
extends ElasticLoadBalancingV2Request
implements ToCopyableBuilder<CreateTargetGroupRequest.Builder,CreateTargetGroupRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface CreateTargetGroupRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`CreateTargetGroupRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static CreateTargetGroupRequest.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)` Used to retrieve the value of a field from any class that extends `SdkRequest`.
`int`	`hashCode()`
`Boolean`	`healthCheckEnabled()` Indicates whether health checks are enabled.
`Integer`	`healthCheckIntervalSeconds()` The approximate amount of time, in seconds, between health checks of an individual target.
`String`	`healthCheckPath()` [HTTP/HTTPS health checks] The ping path that is the destination on the targets for health checks.
`String`	`healthCheckPort()` The port the load balancer uses when performing health checks on targets.
`ProtocolEnum`	`healthCheckProtocol()` The protocol the load balancer uses when performing health checks on targets.
`String`	`healthCheckProtocolAsString()` The protocol the load balancer uses when performing health checks on targets.
`Integer`	`healthCheckTimeoutSeconds()` The amount of time, in seconds, during which no response from a target means a failed health check.
`Integer`	`healthyThresholdCount()` The number of consecutive health checks successes required before considering an unhealthy target healthy.
`Matcher`	`matcher()` [HTTP/HTTPS health checks] The HTTP codes to use when checking for a successful response from a target.
`String`	`name()` The name of the target group.
`Integer`	`port()` The port on which the targets receive traffic.
`ProtocolEnum`	`protocol()` The protocol to use for routing traffic to the targets.
`String`	`protocolAsString()` The protocol to use for routing traffic to the targets.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends CreateTargetGroupRequest.Builder>`	`serializableBuilderClass()`
`TargetTypeEnum`	`targetType()` The type of target that you must specify when registering targets with this target group.
`String`	`targetTypeAsString()` The type of target that you must specify when registering targets with this target group.
`CreateTargetGroupRequest.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`
`Integer`	`unhealthyThresholdCount()` The number of consecutive health check failures required before considering a target unhealthy.
`String`	`vpcId()` The identifier of the virtual private cloud (VPC).

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - name
```
public String name()
```
    The name of the target group.
    
    This name must be unique per region per account, can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens, and must not begin or end with a hyphen.
    
    Returns:
    
    The name of the target group.
    
    This name must be unique per region per account, can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens, and must not begin or end with a hyphen.
  - protocol
```
public ProtocolEnum protocol()
```
    The protocol to use for routing traffic to the targets. For Application Load Balancers, the supported protocols are HTTP and HTTPS. For Network Load Balancers, the supported protocol is TCP. If the target is a Lambda function, this parameter does not apply.
    
    If the service returns an enum value that is not available in the current SDK version, protocol will return ProtocolEnum.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. For Application Load Balancers, the supported protocols are HTTP and HTTPS. For Network Load Balancers, the supported protocol is TCP. If the target is a Lambda function, this parameter does not apply.
    
    See Also:
    
    ProtocolEnum
  - protocolAsString
```
public String protocolAsString()
```
    The protocol to use for routing traffic to the targets. For Application Load Balancers, the supported protocols are HTTP and HTTPS. For Network Load Balancers, the supported protocol is TCP. If the target is a Lambda function, this parameter does not apply.
    
    If the service returns an enum value that is not available in the current SDK version, protocol will return ProtocolEnum.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. For Application Load Balancers, the supported protocols are HTTP and HTTPS. For Network Load Balancers, the supported protocol is TCP. If the target is a Lambda function, this parameter does not apply.
    
    See Also:
    
    ProtocolEnum
  - port
```
public Integer port()
```
    The port on which the targets receive traffic. This port is used unless you specify a port override when registering the target. If the target is a Lambda function, this parameter does not apply.
    
    Returns:
    
    The port on which the targets receive traffic. This port is used unless you specify a port override when registering the target. If the target is a Lambda function, this parameter does not apply.
  - vpcId
```
public String vpcId()
```
    The identifier of the virtual private cloud (VPC). If the target is a Lambda function, this parameter does not apply.
    
    Returns:
    
    The identifier of the virtual private cloud (VPC). If the target is a Lambda function, this parameter does not apply.
  - healthCheckProtocol
```
public ProtocolEnum healthCheckProtocol()
```
    The protocol the load balancer uses when performing health checks on targets. The TCP protocol is supported only if the protocol of the target group is TCP. For Application Load Balancers, the default is HTTP. For Network Load Balancers, the default is TCP.
    
    If the service returns an enum value that is not available in the current SDK version, healthCheckProtocol will return ProtocolEnum.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from healthCheckProtocolAsString().
    
    Returns:
    
    The protocol the load balancer uses when performing health checks on targets. The TCP protocol is supported only if the protocol of the target group is TCP. For Application Load Balancers, the default is HTTP. For Network Load Balancers, the default is TCP.
    
    See Also:
    
    ProtocolEnum
  - healthCheckProtocolAsString
```
public String healthCheckProtocolAsString()
```
    The protocol the load balancer uses when performing health checks on targets. The TCP protocol is supported only if the protocol of the target group is TCP. For Application Load Balancers, the default is HTTP. For Network Load Balancers, the default is TCP.
    
    If the service returns an enum value that is not available in the current SDK version, healthCheckProtocol will return ProtocolEnum.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from healthCheckProtocolAsString().
    
    Returns:
    
    The protocol the load balancer uses when performing health checks on targets. The TCP protocol is supported only if the protocol of the target group is TCP. For Application Load Balancers, the default is HTTP. For Network Load Balancers, the default is TCP.
    
    See Also:
    
    ProtocolEnum
  - healthCheckPort
```
public String healthCheckPort()
```
    The port the load balancer uses when performing health checks on targets. The default is traffic-port, which is the port on which each target receives traffic from the load balancer.
    
    Returns:
    
    The port the load balancer uses when performing health checks on targets. The default is traffic-port, which is the port on which each target receives traffic from the load balancer.
  - healthCheckEnabled
```
public Boolean healthCheckEnabled()
```
    Indicates whether health checks are enabled. If the target type is instance or ip, the default is true. If the target type is lambda, the default is false.
    
    Returns:
    
    Indicates whether health checks are enabled. If the target type is instance or ip, the default is true. If the target type is lambda, the default is false.
  - healthCheckPath
```
public String healthCheckPath()
```
    [HTTP/HTTPS health checks] The ping path that is the destination on the targets for health checks. The default is /.
    
    Returns:
    
    [HTTP/HTTPS health checks] The ping path that is the destination on the targets for health checks. The default is /.
  - healthCheckIntervalSeconds
```
public Integer healthCheckIntervalSeconds()
```
    The approximate amount of time, in seconds, between health checks of an individual target. For Application Load Balancers, the range is 5–300 seconds. For Network Load Balancers, the supported values are 10 or 30 seconds. If the target type is instance or ip, the default is 30 seconds. If the target type is lambda, the default is 35 seconds.
    
    Returns:
    
    The approximate amount of time, in seconds, between health checks of an individual target. For Application Load Balancers, the range is 5–300 seconds. For Network Load Balancers, the supported values are 10 or 30 seconds. If the target type is instance or ip, the default is 30 seconds. If the target type is lambda, the default is 35 seconds.
  - healthCheckTimeoutSeconds
```
public Integer healthCheckTimeoutSeconds()
```
    The amount of time, in seconds, during which no response from a target means a failed health check. For Application Load Balancers, the range is 2–120 seconds and the default is 5 seconds if the target type is instance or ip and 30 seconds if the target type is lambda. For Network Load Balancers, this is 10 seconds for TCP and HTTPS health checks and 6 seconds for HTTP health checks.
    
    Returns:
    
    The amount of time, in seconds, during which no response from a target means a failed health check. For Application Load Balancers, the range is 2–120 seconds and the default is 5 seconds if the target type is instance or ip and 30 seconds if the target type is lambda. For Network Load Balancers, this is 10 seconds for TCP and HTTPS health checks and 6 seconds for HTTP health checks.
  - healthyThresholdCount
```
public Integer healthyThresholdCount()
```
    The number of consecutive health checks successes required before considering an unhealthy target healthy. For Application Load Balancers, the default is 5. For Network Load Balancers, the default is 3.
    
    Returns:
    
    The number of consecutive health checks successes required before considering an unhealthy target healthy. For Application Load Balancers, the default is 5. For Network Load Balancers, the default is 3.
  - unhealthyThresholdCount
```
public Integer unhealthyThresholdCount()
```
    The number of consecutive health check failures required before considering a target unhealthy. For Application Load Balancers, the default is 2. For Network Load Balancers, this value must be the same as the healthy threshold count.
    
    Returns:
    
    The number of consecutive health check failures required before considering a target unhealthy. For Application Load Balancers, the default is 2. For Network Load Balancers, this value must be the same as the healthy threshold count.
  - matcher
```
public Matcher matcher()
```
    [HTTP/HTTPS health checks] The HTTP codes to use when checking for a successful response from a target.
    
    Returns:
    
    [HTTP/HTTPS health checks] The HTTP codes to use when checking for a successful response from a target.
  - targetType
```
public TargetTypeEnum targetType()
```
    The type of target that you must specify when registering targets with this target group. You can't specify targets for a target group using more than one target type.
    - instance - Targets are specified by instance ID. This is the default value.
    - ip - Targets are specified by IP address. You can specify IP addresses from the subnets of the virtual private cloud (VPC) for the target group, the RFC 1918 range (10.0.0.0/8, 172.16.0.0/12, and 192.168.0.0/16), and the RFC 6598 range (100.64.0.0/10). You can't specify publicly routable IP addresses.
    - lambda - The target groups contains a single Lambda function.
    If the service returns an enum value that is not available in the current SDK version, targetType will return TargetTypeEnum.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from targetTypeAsString().
    Returns:
    The type of target that you must specify when registering targets with this target group. You can't specify targets for a target group using more than one target type.
    
    instance - Targets are specified by instance ID. This is the default value.
    
    ip - Targets are specified by IP address. You can specify IP addresses from the subnets of the virtual private cloud (VPC) for the target group, the RFC 1918 range (10.0.0.0/8, 172.16.0.0/12, and 192.168.0.0/16), and the RFC 6598 range (100.64.0.0/10). You can't specify publicly routable IP addresses.
    
    lambda - The target groups contains a single Lambda function.
    See Also:
    
    TargetTypeEnum
  - targetTypeAsString
```
public String targetTypeAsString()
```
    The type of target that you must specify when registering targets with this target group. You can't specify targets for a target group using more than one target type.
    - instance - Targets are specified by instance ID. This is the default value.
    - ip - Targets are specified by IP address. You can specify IP addresses from the subnets of the virtual private cloud (VPC) for the target group, the RFC 1918 range (10.0.0.0/8, 172.16.0.0/12, and 192.168.0.0/16), and the RFC 6598 range (100.64.0.0/10). You can't specify publicly routable IP addresses.
    - lambda - The target groups contains a single Lambda function.
    If the service returns an enum value that is not available in the current SDK version, targetType will return TargetTypeEnum.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from targetTypeAsString().
    Returns:
    The type of target that you must specify when registering targets with this target group. You can't specify targets for a target group using more than one target type.
    
    instance - Targets are specified by instance ID. This is the default value.
    
    ip - Targets are specified by IP address. You can specify IP addresses from the subnets of the virtual private cloud (VPC) for the target group, the RFC 1918 range (10.0.0.0/8, 172.16.0.0/12, and 192.168.0.0/16), and the RFC 6598 range (100.64.0.0/10). You can't specify publicly routable IP addresses.
    
    lambda - The target groups contains a single Lambda function.
    See Also:
    
    TargetTypeEnum
  - toBuilder
```
public CreateTargetGroupRequest.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<CreateTargetGroupRequest.Builder,CreateTargetGroupRequest>
    
    Specified by:
    
    toBuilder in class ElasticLoadBalancingV2Request
    
    Returns:
    
    a builder for type T
  - builder
```
public static CreateTargetGroupRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CreateTargetGroupRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <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 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.

Class CreateTargetGroupRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

name

protocol

protocolAsString

port

vpcId

healthCheckProtocol

healthCheckProtocolAsString

healthCheckPort

healthCheckEnabled

healthCheckPath

healthCheckIntervalSeconds

healthCheckTimeoutSeconds

healthyThresholdCount

unhealthyThresholdCount

matcher

targetType

targetTypeAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

sdkFields