software.amazon.awssdk.services.ec2.model

Class ModifyVpcEndpointRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.ec2.model.Ec2Request

software.amazon.awssdk.services.ec2.model.ModifyVpcEndpointRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ModifyVpcEndpointRequest.Builder,ModifyVpcEndpointRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class ModifyVpcEndpointRequest
extends Ec2Request
implements ToCopyableBuilder<ModifyVpcEndpointRequest.Builder,ModifyVpcEndpointRequest>

Contains the parameters for ModifyVpcEndpoint.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ModifyVpcEndpointRequest.Builder

Method Summary

Modifier and Type	Method and Description
List<String>	addRouteTableIds() (Gateway endpoint) One or more route tables IDs to associate with the endpoint.
List<String>	addSecurityGroupIds() (Interface endpoint) One or more security group IDs to associate with the network interface.
List<String>	addSubnetIds() (Interface and Gateway Load Balancer endpoints) One or more subnet IDs in which to serve the endpoint.
static ModifyVpcEndpointRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAddRouteTableIds() For responses, this returns true if the service returned a value for the AddRouteTableIds property.
boolean	hasAddSecurityGroupIds() For responses, this returns true if the service returned a value for the AddSecurityGroupIds property.
boolean	hasAddSubnetIds() For responses, this returns true if the service returned a value for the AddSubnetIds property.
int	hashCode()
boolean	hasRemoveRouteTableIds() For responses, this returns true if the service returned a value for the RemoveRouteTableIds property.
boolean	hasRemoveSecurityGroupIds() For responses, this returns true if the service returned a value for the RemoveSecurityGroupIds property.
boolean	hasRemoveSubnetIds() For responses, this returns true if the service returned a value for the RemoveSubnetIds property.
String	policyDocument() (Interface and gateway endpoints) A policy to attach to the endpoint that controls access to the service.
Boolean	privateDnsEnabled() (Interface endpoint) Indicates whether a private hosted zone is associated with the VPC.
List<String>	removeRouteTableIds() (Gateway endpoint) One or more route table IDs to disassociate from the endpoint.
List<String>	removeSecurityGroupIds() (Interface endpoint) One or more security group IDs to disassociate from the network interface.
List<String>	removeSubnetIds() (Interface endpoint) One or more subnets IDs in which to remove the endpoint.
Boolean	resetPolicy() (Gateway endpoint) Specify true to reset the policy document to the default policy.
List<SdkField<?>>	sdkFields()
static Class<? extends ModifyVpcEndpointRequest.Builder>	serializableBuilderClass()
ModifyVpcEndpointRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	vpcEndpointId() The ID of the endpoint.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

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

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

copy

Method Detail

vpcEndpointId

public final String vpcEndpointId()

The ID of the endpoint.

Returns:

The ID of the endpoint.

resetPolicy

public final Boolean resetPolicy()

(Gateway endpoint) Specify true to reset the policy document to the default policy. The default policy allows full access to the service.

Returns:

(Gateway endpoint) Specify true to reset the policy document to the default policy. The default policy allows full access to the service.

policyDocument

public final String policyDocument()

(Interface and gateway endpoints) A policy to attach to the endpoint that controls access to the service. The policy must be in valid JSON format.

Returns:

(Interface and gateway endpoints) A policy to attach to the endpoint that controls access to the service. The policy must be in valid JSON format.

hasAddRouteTableIds

public final boolean hasAddRouteTableIds()

For responses, this returns true if the service returned a value for the AddRouteTableIds 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.

addRouteTableIds

public final List<String> addRouteTableIds()

(Gateway endpoint) One or more route tables IDs to associate with the endpoint.

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 hasAddRouteTableIds() method.

Returns:

(Gateway endpoint) One or more route tables IDs to associate with the endpoint.

hasRemoveRouteTableIds

public final boolean hasRemoveRouteTableIds()

For responses, this returns true if the service returned a value for the RemoveRouteTableIds 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.

removeRouteTableIds

public final List<String> removeRouteTableIds()

(Gateway endpoint) One or more route table IDs to disassociate from the endpoint.

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 hasRemoveRouteTableIds() method.

Returns:

(Gateway endpoint) One or more route table IDs to disassociate from the endpoint.

hasAddSubnetIds

public final boolean hasAddSubnetIds()

For responses, this returns true if the service returned a value for the AddSubnetIds 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.

addSubnetIds

public final List<String> addSubnetIds()

(Interface and Gateway Load Balancer endpoints) One or more subnet IDs in which to serve the endpoint. For a Gateway Load Balancer endpoint, you can specify only one subnet.

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 hasAddSubnetIds() method.

Returns:

(Interface and Gateway Load Balancer endpoints) One or more subnet IDs in which to serve the endpoint. For a Gateway Load Balancer endpoint, you can specify only one subnet.

hasRemoveSubnetIds

public final boolean hasRemoveSubnetIds()

For responses, this returns true if the service returned a value for the RemoveSubnetIds 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.

removeSubnetIds

public final List<String> removeSubnetIds()

(Interface endpoint) One or more subnets IDs in which to remove the endpoint.

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 hasRemoveSubnetIds() method.

Returns:

(Interface endpoint) One or more subnets IDs in which to remove the endpoint.

hasAddSecurityGroupIds

public final boolean hasAddSecurityGroupIds()

For responses, this returns true if the service returned a value for the AddSecurityGroupIds 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.

addSecurityGroupIds

public final List<String> addSecurityGroupIds()

(Interface endpoint) One or more security group IDs to associate with the network interface.

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 hasAddSecurityGroupIds() method.

Returns:

(Interface endpoint) One or more security group IDs to associate with the network interface.

hasRemoveSecurityGroupIds

public final boolean hasRemoveSecurityGroupIds()

For responses, this returns true if the service returned a value for the RemoveSecurityGroupIds 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.

removeSecurityGroupIds

public final List<String> removeSecurityGroupIds()

(Interface endpoint) One or more security group IDs to disassociate from the network interface.

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 hasRemoveSecurityGroupIds() method.

Returns:

(Interface endpoint) One or more security group IDs to disassociate from the network interface.

privateDnsEnabled

public final Boolean privateDnsEnabled()

(Interface endpoint) Indicates whether a private hosted zone is associated with the VPC.

Returns:

(Interface endpoint) Indicates whether a private hosted zone is associated with the VPC.

toBuilder

public ModifyVpcEndpointRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ModifyVpcEndpointRequest.Builder,ModifyVpcEndpointRequest>

Specified by:

toBuilder in class Ec2Request

builder

public static ModifyVpcEndpointRequest.Builder builder()

serializableBuilderClass

public static Class<? extends ModifyVpcEndpointRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo