software.amazon.awssdk.services.elasticloadbalancingv2.model

Class CreateLoadBalancerRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateLoadBalancerRequest.Builder,CreateLoadBalancerRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateLoadBalancerRequest.Builder

Method Summary

Modifier and Type	Method and Description
static CreateLoadBalancerRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
IpAddressType	ipAddressType() [Application Load Balancers] The type of IP addresses used by the subnets for your load balancer.
String	ipAddressTypeAsString() [Application Load Balancers] The type of IP addresses used by the subnets for your load balancer.
String	name() The name of the load balancer.
LoadBalancerSchemeEnum	scheme() The nodes of an Internet-facing load balancer have public IP addresses.
String	schemeAsString() The nodes of an Internet-facing load balancer have public IP addresses.
List<SdkField<?>>	sdkFields()
List<String>	securityGroups() [Application Load Balancers] The IDs of the security groups for the load balancer.
static Class<? extends CreateLoadBalancerRequest.Builder>	serializableBuilderClass()
List<SubnetMapping>	subnetMappings() The IDs of the public subnets.
List<String>	subnets() The IDs of the public subnets.
List<Tag>	tags() One or more tags to assign to the load balancer.
CreateLoadBalancerRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
LoadBalancerTypeEnum	type() The type of load balancer.
String	typeAsString() The type of load balancer.

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

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, 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 load balancer.

This name must be unique per region per account, can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens, must not begin or end with a hyphen, and must not begin with "internal-".

Returns:

The name of the load balancer.

This name must be unique per region per account, can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens, must not begin or end with a hyphen, and must not begin with "internal-".

subnets

public List<String> subnets()

The IDs of the public subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings.

[Application Load Balancers] You must specify subnets from at least two Availability Zones.

[Network Load Balancers] You can specify subnets from one or more Availability Zones.

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

Returns:

The IDs of the public subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings.

[Application Load Balancers] You must specify subnets from at least two Availability Zones.

[Network Load Balancers] You can specify subnets from one or more Availability Zones.

subnetMappings

public List<SubnetMapping> subnetMappings()

The IDs of the public subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings.

[Application Load Balancers] You must specify subnets from at least two Availability Zones. You cannot specify Elastic IP addresses for your subnets.

[Network Load Balancers] You can specify subnets from one or more Availability Zones. You can specify one Elastic IP address per subnet if you need static IP addresses for your load balancer.

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

Returns:

The IDs of the public subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings.

[Application Load Balancers] You must specify subnets from at least two Availability Zones. You cannot specify Elastic IP addresses for your subnets.

[Network Load Balancers] You can specify subnets from one or more Availability Zones. You can specify one Elastic IP address per subnet if you need static IP addresses for your load balancer.

securityGroups

public List<String> securityGroups()

[Application Load Balancers] The IDs of the security groups for the load balancer.

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

Returns:

[Application Load Balancers] The IDs of the security groups for the load balancer.

scheme

public LoadBalancerSchemeEnum scheme()

The nodes of an Internet-facing load balancer have public IP addresses. The DNS name of an Internet-facing load balancer is publicly resolvable to the public IP addresses of the nodes. Therefore, Internet-facing load balancers can route requests from clients over the internet.

The nodes of an internal load balancer have only private IP addresses. The DNS name of an internal load balancer is publicly resolvable to the private IP addresses of the nodes. Therefore, internal load balancers can only route requests from clients with access to the VPC for the load balancer.

The default is an Internet-facing load balancer.

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

Returns:

The nodes of an Internet-facing load balancer have public IP addresses. The DNS name of an Internet-facing load balancer is publicly resolvable to the public IP addresses of the nodes. Therefore, Internet-facing load balancers can route requests from clients over the internet.

The nodes of an internal load balancer have only private IP addresses. The DNS name of an internal load balancer is publicly resolvable to the private IP addresses of the nodes. Therefore, internal load balancers can only route requests from clients with access to the VPC for the load balancer.

The default is an Internet-facing load balancer.

See Also:

LoadBalancerSchemeEnum

schemeAsString

public String schemeAsString()

The nodes of an Internet-facing load balancer have public IP addresses. The DNS name of an Internet-facing load balancer is publicly resolvable to the public IP addresses of the nodes. Therefore, Internet-facing load balancers can route requests from clients over the internet.

The nodes of an internal load balancer have only private IP addresses. The DNS name of an internal load balancer is publicly resolvable to the private IP addresses of the nodes. Therefore, internal load balancers can only route requests from clients with access to the VPC for the load balancer.

The default is an Internet-facing load balancer.

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

Returns:

The nodes of an Internet-facing load balancer have public IP addresses. The DNS name of an Internet-facing load balancer is publicly resolvable to the public IP addresses of the nodes. Therefore, Internet-facing load balancers can route requests from clients over the internet.

The nodes of an internal load balancer have only private IP addresses. The DNS name of an internal load balancer is publicly resolvable to the private IP addresses of the nodes. Therefore, internal load balancers can only route requests from clients with access to the VPC for the load balancer.

The default is an Internet-facing load balancer.

See Also:

LoadBalancerSchemeEnum

tags

public List<Tag> tags()

One or more tags to assign to the load balancer.

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

Returns:

One or more tags to assign to the load balancer.

type

public LoadBalancerTypeEnum type()

The type of load balancer. The default is application.

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

Returns:

The type of load balancer. The default is application.

See Also:

LoadBalancerTypeEnum

typeAsString

public String typeAsString()

The type of load balancer. The default is application.

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

Returns:

The type of load balancer. The default is application.

See Also:

LoadBalancerTypeEnum

ipAddressType

public IpAddressType ipAddressType()

[Application Load Balancers] The type of IP addresses used by the subnets for your load balancer. The possible values are ipv4 (for IPv4 addresses) and dualstack (for IPv4 and IPv6 addresses). Internal load balancers must use 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:

[Application Load Balancers] The type of IP addresses used by the subnets for your load balancer. The possible values are ipv4 (for IPv4 addresses) and dualstack (for IPv4 and IPv6 addresses). Internal load balancers must use ipv4.

See Also:

IpAddressType

ipAddressTypeAsString

public String ipAddressTypeAsString()

[Application Load Balancers] The type of IP addresses used by the subnets for your load balancer. The possible values are ipv4 (for IPv4 addresses) and dualstack (for IPv4 and IPv6 addresses). Internal load balancers must use 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:

[Application Load Balancers] The type of IP addresses used by the subnets for your load balancer. The possible values are ipv4 (for IPv4 addresses) and dualstack (for IPv4 and IPv6 addresses). Internal load balancers must use ipv4.

See Also:

IpAddressType

toBuilder

public CreateLoadBalancerRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateLoadBalancerRequest.Builder,CreateLoadBalancerRequest>

Specified by:

toBuilder in class ElasticLoadBalancingV2Request

builder

public static CreateLoadBalancerRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo