software.amazon.awssdk.services.ecs.model

Class AwsVpcConfiguration

java.lang.Object

software.amazon.awssdk.services.ecs.model.AwsVpcConfiguration

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<AwsVpcConfiguration.Builder,AwsVpcConfiguration>

@Generated(value="software.amazon.awssdk:codegen")
public final class AwsVpcConfiguration
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<AwsVpcConfiguration.Builder,AwsVpcConfiguration>

An object representing the networking details for a task or service.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AwsVpcConfiguration.Builder

Method Summary

Modifier and Type	Method and Description
AssignPublicIp	assignPublicIp() Whether the task's elastic network interface receives a public IP address.
String	assignPublicIpAsString() Whether the task's elastic network interface receives a public IP address.
static AwsVpcConfiguration.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasSecurityGroups() For responses, this returns true if the service returned a value for the SecurityGroups property.
boolean	hasSubnets() For responses, this returns true if the service returned a value for the Subnets property.
List<SdkField<?>>	sdkFields()
List<String>	securityGroups() The IDs of the security groups associated with the task or service.
static Class<? extends AwsVpcConfiguration.Builder>	serializableBuilderClass()
List<String>	subnets() The IDs of the subnets associated with the task or service.
AwsVpcConfiguration.Builder	toBuilder()
String	toString() Returns a string representation of this object.

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

hasSubnets

public final boolean hasSubnets()

For responses, this returns true if the service returned a value for the Subnets 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.

subnets

public final List<String> subnets()

The IDs of the subnets associated with the task or service. There's a limit of 16 subnets that can be specified per AwsVpcConfiguration.

All specified subnets must be from the same VPC.

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 hasSubnets() method.

Returns:

The IDs of the subnets associated with the task or service. There's a limit of 16 subnets that can be specified per AwsVpcConfiguration.

All specified subnets must be from the same VPC.

hasSecurityGroups

public final boolean hasSecurityGroups()

For responses, this returns true if the service returned a value for the SecurityGroups 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.

securityGroups

public final List<String> securityGroups()

The IDs of the security groups associated with the task or service. If you don't specify a security group, the default security group for the VPC is used. There's a limit of 5 security groups that can be specified per AwsVpcConfiguration.

All specified security groups must be from the same VPC.

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 hasSecurityGroups() method.

Returns:

The IDs of the security groups associated with the task or service. If you don't specify a security group, the default security group for the VPC is used. There's a limit of 5 security groups that can be specified per AwsVpcConfiguration.

All specified security groups must be from the same VPC.

assignPublicIp

public final AssignPublicIp assignPublicIp()

Whether the task's elastic network interface receives a public IP address. The default value is DISABLED.

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

Returns:

Whether the task's elastic network interface receives a public IP address. The default value is DISABLED.

See Also:

AssignPublicIp

assignPublicIpAsString

public final String assignPublicIpAsString()

Whether the task's elastic network interface receives a public IP address. The default value is DISABLED.

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

Returns:

Whether the task's elastic network interface receives a public IP address. The default value is DISABLED.

See Also:

AssignPublicIp

toBuilder

public AwsVpcConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AwsVpcConfiguration.Builder,AwsVpcConfiguration>

builder

public static AwsVpcConfiguration.Builder builder()

serializableBuilderClass

public static Class<? extends AwsVpcConfiguration.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)

Specified by:

equalsBySdkFields in interface SdkPojo

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