com.amazonaws.services.opensearch.model

Class VPCOptions

java.lang.Object

com.amazonaws.services.opensearch.model.VPCOptions

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

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

Options to specify the subnets and security groups for an Amazon OpenSearch Service VPC endpoint. For more information, see Launching your Amazon OpenSearch Service domains using a VPC.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
VPCOptions()

Method Summary

Modifier and Type	Method and Description
VPCOptions	clone()
boolean	equals(Object obj)
List<String>	getSecurityGroupIds() The list of security group IDs associated with the VPC endpoints for the domain.
List<String>	getSubnetIds() A list of subnet IDs associated with the VPC endpoints for the domain.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller)
void	setSecurityGroupIds(Collection<String> securityGroupIds) The list of security group IDs associated with the VPC endpoints for the domain.
void	setSubnetIds(Collection<String> subnetIds) A list of subnet IDs associated with the VPC endpoints for the domain.
String	toString() Returns a string representation of this object.
VPCOptions	withSecurityGroupIds(Collection<String> securityGroupIds) The list of security group IDs associated with the VPC endpoints for the domain.
VPCOptions	withSecurityGroupIds(String... securityGroupIds) The list of security group IDs associated with the VPC endpoints for the domain.
VPCOptions	withSubnetIds(Collection<String> subnetIds) A list of subnet IDs associated with the VPC endpoints for the domain.
VPCOptions	withSubnetIds(String... subnetIds) A list of subnet IDs associated with the VPC endpoints for the domain.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

VPCOptions

public VPCOptions()

Method Detail

getSubnetIds

public List<String> getSubnetIds()

A list of subnet IDs associated with the VPC endpoints for the domain. If your domain uses multiple Availability Zones, you need to provide two subnet IDs, one per zone. Otherwise, provide only one.

Returns:

A list of subnet IDs associated with the VPC endpoints for the domain. If your domain uses multiple Availability Zones, you need to provide two subnet IDs, one per zone. Otherwise, provide only one.

setSubnetIds

public void setSubnetIds(Collection<String> subnetIds)

A list of subnet IDs associated with the VPC endpoints for the domain. If your domain uses multiple Availability Zones, you need to provide two subnet IDs, one per zone. Otherwise, provide only one.

Parameters:

subnetIds - A list of subnet IDs associated with the VPC endpoints for the domain. If your domain uses multiple Availability Zones, you need to provide two subnet IDs, one per zone. Otherwise, provide only one.

withSubnetIds

public VPCOptions withSubnetIds(String... subnetIds)

A list of subnet IDs associated with the VPC endpoints for the domain. If your domain uses multiple Availability Zones, you need to provide two subnet IDs, one per zone. Otherwise, provide only one.

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

Parameters:

subnetIds - A list of subnet IDs associated with the VPC endpoints for the domain. If your domain uses multiple Availability Zones, you need to provide two subnet IDs, one per zone. Otherwise, provide only one.

Returns:

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

withSubnetIds

public VPCOptions withSubnetIds(Collection<String> subnetIds)

A list of subnet IDs associated with the VPC endpoints for the domain. If your domain uses multiple Availability Zones, you need to provide two subnet IDs, one per zone. Otherwise, provide only one.

Parameters:

subnetIds - A list of subnet IDs associated with the VPC endpoints for the domain. If your domain uses multiple Availability Zones, you need to provide two subnet IDs, one per zone. Otherwise, provide only one.

Returns:

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

getSecurityGroupIds

public List<String> getSecurityGroupIds()

The list of security group IDs associated with the VPC endpoints for the domain. If you do not provide a security group ID, OpenSearch Service uses the default security group for the VPC.

Returns:

The list of security group IDs associated with the VPC endpoints for the domain. If you do not provide a security group ID, OpenSearch Service uses the default security group for the VPC.

setSecurityGroupIds

public void setSecurityGroupIds(Collection<String> securityGroupIds)

The list of security group IDs associated with the VPC endpoints for the domain. If you do not provide a security group ID, OpenSearch Service uses the default security group for the VPC.

Parameters:

securityGroupIds - The list of security group IDs associated with the VPC endpoints for the domain. If you do not provide a security group ID, OpenSearch Service uses the default security group for the VPC.

withSecurityGroupIds

public VPCOptions withSecurityGroupIds(String... securityGroupIds)

The list of security group IDs associated with the VPC endpoints for the domain. If you do not provide a security group ID, OpenSearch Service uses the default security group for the VPC.

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

Parameters:

securityGroupIds - The list of security group IDs associated with the VPC endpoints for the domain. If you do not provide a security group ID, OpenSearch Service uses the default security group for the VPC.

Returns:

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

withSecurityGroupIds

public VPCOptions withSecurityGroupIds(Collection<String> securityGroupIds)

The list of security group IDs associated with the VPC endpoints for the domain. If you do not provide a security group ID, OpenSearch Service uses the default security group for the VPC.

Parameters:

securityGroupIds - The list of security group IDs associated with the VPC endpoints for the domain. If you do not provide a security group ID, OpenSearch Service uses the default security group for the VPC.

Returns:

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

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 VPCOptions clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Specified by:

marshall in interface StructuredPojo