Class AwsVpcConfiguration
- All Implemented Interfaces:
Serializable
,SdkPojo
,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.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal AssignPublicIp
Specifies whether the task's elastic network interface receives a public IP address.final String
Specifies whether the task's elastic network interface receives a public IP address.static AwsVpcConfiguration.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the SecurityGroups property.final boolean
For responses, this returns true if the service returned a value for the Subnets property.Specifies the security groups associated with the task.static Class
<? extends AwsVpcConfiguration.Builder> subnets()
Specifies the subnets associated with the task.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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 theisEmpty()
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
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.- Returns:
- Specifies the subnets associated with the task. These subnets must all be in the same VPC. You can specify as many as 16 subnets.
-
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 theisEmpty()
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
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.- Returns:
- 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.
-
assignPublicIp
Specifies whether the task's elastic network interface receives a public IP address. You can specify
ENABLED
only whenLaunchType
inEcsParameters
is set toFARGATE
.If the service returns an enum value that is not available in the current SDK version,
assignPublicIp
will returnAssignPublicIp.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromassignPublicIpAsString()
.- Returns:
- Specifies whether the task's elastic network interface receives a public IP address. You can specify
ENABLED
only whenLaunchType
inEcsParameters
is set toFARGATE
. - See Also:
-
assignPublicIpAsString
Specifies whether the task's elastic network interface receives a public IP address. You can specify
ENABLED
only whenLaunchType
inEcsParameters
is set toFARGATE
.If the service returns an enum value that is not available in the current SDK version,
assignPublicIp
will returnAssignPublicIp.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromassignPublicIpAsString()
.- Returns:
- Specifies whether the task's elastic network interface receives a public IP address. You can specify
ENABLED
only whenLaunchType
inEcsParameters
is set toFARGATE
. - See Also:
-
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 interfaceToCopyableBuilder<AwsVpcConfiguration.Builder,
AwsVpcConfiguration> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-