AwsVpcConfiguration (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.services.eventbridge.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>
```
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:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface AwsVpcConfiguration.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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)` Indicates whether some other object is "equal to" this one by SDK fields.
`<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()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()` Returns a string representation of this object.

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
  - 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()
```
    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 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()
```
    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
```
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().
    
    Returns:
    
    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.
    
    See Also:
    
    AssignPublicIp
  - assignPublicIpAsString
```
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().
    
    Returns:
    
    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.
    
    See Also:
    
    AssignPublicIp
  - toBuilder
```
public AwsVpcConfiguration.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<AwsVpcConfiguration.Builder,AwsVpcConfiguration>
    
    Returns:
    
    a builder for type T
  - 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)
```
    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 an SdkPojo class, and is generated based on a service model.
    If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.
    
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
    
    Parameters:
    
    obj - the object to be compared with
    
    Returns:
    
    true if the other object equals to this object by sdk fields, false otherwise.
  - 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
    
    Returns:
    
    List of SdkField in this POJO. May be empty list but should never be null.

AWS SDK for Java API Reference - 2.17.43

Class AwsVpcConfiguration

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

hasSubnets

subnets

hasSecurityGroups

securityGroups

assignPublicIp

assignPublicIpAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields