ModifyVpcEndpointRequest (AWS Java SDK :: Services

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>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface ModifyVpcEndpointRequest.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`List<String>`	`addRouteTableIds()` (Gateway endpoint) The IDs of the route tables to associate with the endpoint.
`List<String>`	`addSecurityGroupIds()` (Interface endpoint) The IDs of the security groups to associate with the endpoint network interfaces.
`List<String>`	`addSubnetIds()` (Interface and Gateway Load Balancer endpoints) The IDs of the subnets in which to serve the endpoint.
`static ModifyVpcEndpointRequest.Builder`	`builder()`
`DnsOptionsSpecification`	`dnsOptions()` The DNS options for the endpoint.
`Boolean`	`dryRun()` Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.
`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.
`boolean`	`hasSubnetConfigurations()` For responses, this returns true if the service returned a value for the SubnetConfigurations property.
`IpAddressType`	`ipAddressType()` The IP address type for the endpoint.
`String`	`ipAddressTypeAsString()` The IP address type for the endpoint.
`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) The IDs of the route tables to disassociate from the endpoint.
`List<String>`	`removeSecurityGroupIds()` (Interface endpoint) The IDs of the security groups to disassociate from the endpoint network interfaces.
`List<String>`	`removeSubnetIds()` (Interface endpoint) The IDs of the subnets from 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()`
`List<SubnetConfiguration>`	`subnetConfigurations()` The subnet configurations for the endpoint.
`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
  - dryRun
```
public final Boolean dryRun()
```
    Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
    
    Returns:
    
    Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
  - 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) The IDs of the route tables 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) The IDs of the route tables 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) The IDs of the route tables 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) The IDs of the route tables 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) The IDs of the subnets 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) The IDs of the subnets 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) The IDs of the subnets from 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) The IDs of the subnets from 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) The IDs of the security groups to associate with the endpoint network interfaces.
    
    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) The IDs of the security groups to associate with the endpoint network interfaces.
  - 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) The IDs of the security groups to disassociate from the endpoint network interfaces.
    
    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) The IDs of the security groups to disassociate from the endpoint network interfaces.
  - ipAddressType
```
public final IpAddressType ipAddressType()
```
    The IP address type for the endpoint.
    
    If the service returns an enum value that is not available in the current SDK version, ipAddressType will return IpAddressType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from ipAddressTypeAsString().
    
    Returns:
    
    The IP address type for the endpoint.
    
    See Also:
    
    IpAddressType
  - ipAddressTypeAsString
```
public final String ipAddressTypeAsString()
```
    The IP address type for the endpoint.
    
    If the service returns an enum value that is not available in the current SDK version, ipAddressType will return IpAddressType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from ipAddressTypeAsString().
    
    Returns:
    
    The IP address type for the endpoint.
    
    See Also:
    
    IpAddressType
  - dnsOptions
```
public final DnsOptionsSpecification dnsOptions()
```
    The DNS options for the endpoint.
    
    Returns:
    
    The DNS options for the endpoint.
  - 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.
  - hasSubnetConfigurations
```
public final boolean hasSubnetConfigurations()
```
    For responses, this returns true if the service returned a value for the SubnetConfigurations 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.
  - subnetConfigurations
```
public final List<SubnetConfiguration> subnetConfigurations()
```
    The subnet configurations for 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 hasSubnetConfigurations() method.
    
    Returns:
    
    The subnet configurations for the endpoint.
  - 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

Class ModifyVpcEndpointRequest

Nested Class Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

Method Detail

dryRun

vpcEndpointId

resetPolicy

policyDocument

hasAddRouteTableIds

addRouteTableIds

hasRemoveRouteTableIds

removeRouteTableIds

hasAddSubnetIds

addSubnetIds

hasRemoveSubnetIds

removeSubnetIds

hasAddSecurityGroupIds

addSecurityGroupIds

hasRemoveSecurityGroupIds

removeSecurityGroupIds

ipAddressType

ipAddressTypeAsString

dnsOptions

privateDnsEnabled

hasSubnetConfigurations

subnetConfigurations

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields