com.amazonaws.services.pipes.model

Class AwsVpcConfiguration

java.lang.Object

com.amazonaws.services.pipes.model.AwsVpcConfiguration

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AwsVpcConfiguration
extends Object
implements Serializable, Cloneable, StructuredPojo

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:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
AwsVpcConfiguration()

Method Summary

Modifier and Type	Method and Description
AwsVpcConfiguration	clone()
boolean	equals(Object obj)
String	getAssignPublicIp() Specifies whether the task's elastic network interface receives a public IP address.
List<String>	getSecurityGroups() Specifies the security groups associated with the task.
List<String>	getSubnets() Specifies the subnets associated with the task.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setAssignPublicIp(String assignPublicIp) Specifies whether the task's elastic network interface receives a public IP address.
void	setSecurityGroups(Collection<String> securityGroups) Specifies the security groups associated with the task.
void	setSubnets(Collection<String> subnets) Specifies the subnets associated with the task.
String	toString() Returns a string representation of this object.
AwsVpcConfiguration	withAssignPublicIp(AssignPublicIp assignPublicIp) Specifies whether the task's elastic network interface receives a public IP address.
AwsVpcConfiguration	withAssignPublicIp(String assignPublicIp) Specifies whether the task's elastic network interface receives a public IP address.
AwsVpcConfiguration	withSecurityGroups(Collection<String> securityGroups) Specifies the security groups associated with the task.
AwsVpcConfiguration	withSecurityGroups(String... securityGroups) Specifies the security groups associated with the task.
AwsVpcConfiguration	withSubnets(Collection<String> subnets) Specifies the subnets associated with the task.
AwsVpcConfiguration	withSubnets(String... subnets) Specifies the subnets associated with the task.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AwsVpcConfiguration

public AwsVpcConfiguration()

Method Detail

getSubnets

public List<String> getSubnets()

Specifies the subnets associated with the task. These subnets must all be in the same VPC. You can specify as many as 16 subnets.

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.

setSubnets

public void setSubnets(Collection<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.

Parameters:

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.

withSubnets

public AwsVpcConfiguration withSubnets(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.

NOTE: This method appends the values to the existing list (if any). Use setSubnets(java.util.Collection) or withSubnets(java.util.Collection) if you want to override the existing values.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

withSubnets

public AwsVpcConfiguration withSubnets(Collection<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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

getSecurityGroups

public List<String> getSecurityGroups()

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.

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.

setSecurityGroups

public void setSecurityGroups(Collection<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.

Parameters:

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.

withSecurityGroups

public AwsVpcConfiguration withSecurityGroups(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.

NOTE: This method appends the values to the existing list (if any). Use setSecurityGroups(java.util.Collection) or withSecurityGroups(java.util.Collection) if you want to override the existing values.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

withSecurityGroups

public AwsVpcConfiguration withSecurityGroups(Collection<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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

setAssignPublicIp

public void setAssignPublicIp(String 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.

Parameters:

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.

See Also:

AssignPublicIp

getAssignPublicIp

public String getAssignPublicIp()

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.

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

withAssignPublicIp

public AwsVpcConfiguration withAssignPublicIp(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

AssignPublicIp

withAssignPublicIp

public AwsVpcConfiguration withAssignPublicIp(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

AssignPublicIp

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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public AwsVpcConfiguration clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.