@Generated(value="software.amazon.awssdk:codegen") public final class AwsVpcConfiguration extends Object implements SdkPojo, Serializable, ToCopyableBuilder<AwsVpcConfiguration.Builder,AwsVpcConfiguration>
This structure specifies the VPC subnets and security groups for the task, and whether a public IP address is to be
used. This structure is relevant only for ECS tasks that use the awsvpc
network mode.
Modifier and Type | Class and Description |
---|---|
static interface |
AwsVpcConfiguration.Builder |
Modifier and Type | Method and Description |
---|---|
AssignPublicIp |
assignPublicIp()
Specifies whether the task's elastic network interface receives a public IP address.
|
String |
assignPublicIpAsString()
Specifies 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()
Specifies the security groups associated with the task.
|
static Class<? extends AwsVpcConfiguration.Builder> |
serializableBuilderClass() |
List<String> |
subnets()
Specifies the subnets associated with the task.
|
AwsVpcConfiguration.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
copy
public final boolean hasSubnets()
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.public final List<String> subnets()
Specifies the subnets associated with the task. These subnets must all be in the same VPC. You can specify as many as 16 subnets.
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.
public final boolean hasSecurityGroups()
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.public final List<String> securityGroups()
Specifies the security groups associated with the task. These security groups must all be in the same VPC. You can specify as many as five security groups. If you do not specify a security group, the default security group for the VPC is used.
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.
public final AssignPublicIp assignPublicIp()
Specifies whether the task's elastic network interface receives a public IP address. You can specify
ENABLED
only when LaunchType
in EcsParameters
is set to
FARGATE
.
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()
.
ENABLED
only when LaunchType
in EcsParameters
is set to
FARGATE
.AssignPublicIp
public final String assignPublicIpAsString()
Specifies whether the task's elastic network interface receives a public IP address. You can specify
ENABLED
only when LaunchType
in EcsParameters
is set to
FARGATE
.
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()
.
ENABLED
only when LaunchType
in EcsParameters
is set to
FARGATE
.AssignPublicIp
public AwsVpcConfiguration.Builder toBuilder()
toBuilder
in interface ToCopyableBuilder<AwsVpcConfiguration.Builder,AwsVpcConfiguration>
public static AwsVpcConfiguration.Builder builder()
public static Class<? extends AwsVpcConfiguration.Builder> serializableBuilderClass()
public final boolean equalsBySdkFields(Object obj)
equalsBySdkFields
in interface SdkPojo
public final String toString()
Copyright © 2022. All rights reserved.