Class ModifyVpcEndpointRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<ModifyVpcEndpointRequest.Builder,
ModifyVpcEndpointRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescription(Gateway endpoint) The IDs of the route tables to associate with the endpoint.(Interface endpoint) The IDs of the security groups to associate with the endpoint network interfaces.(Interface and Gateway Load Balancer endpoints) The IDs of the subnets in which to serve the endpoint.builder()
final DnsOptionsSpecification
The DNS options for the endpoint.final Boolean
dryRun()
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final boolean
For responses, this returns true if the service returned a value for the AddRouteTableIds property.final boolean
For responses, this returns true if the service returned a value for the AddSecurityGroupIds property.final boolean
For responses, this returns true if the service returned a value for the AddSubnetIds property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the RemoveRouteTableIds property.final boolean
For responses, this returns true if the service returned a value for the RemoveSecurityGroupIds property.final boolean
For responses, this returns true if the service returned a value for the RemoveSubnetIds property.final boolean
For responses, this returns true if the service returned a value for the SubnetConfigurations property.final IpAddressType
The IP address type for the endpoint.final String
The IP address type for the endpoint.final String
(Interface and gateway endpoints) A policy to attach to the endpoint that controls access to the service.final Boolean
(Interface endpoint) Indicates whether a private hosted zone is associated with the VPC.(Gateway endpoint) The IDs of the route tables to disassociate from the endpoint.(Interface endpoint) The IDs of the security groups to disassociate from the endpoint network interfaces.(Interface endpoint) The IDs of the subnets from which to remove the endpoint.final Boolean
(Gateway endpoint) Specifytrue
to reset the policy document to the default policy.static Class
<? extends ModifyVpcEndpointRequest.Builder> final List
<SubnetConfiguration> The subnet configurations for the endpoint.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
The ID of the endpoint.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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 isUnauthorizedOperation
.- 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 isUnauthorizedOperation
.
-
vpcEndpointId
The ID of the endpoint.
- Returns:
- The ID of the endpoint.
-
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
(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 theisEmpty()
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
(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 theisEmpty()
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
(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 theisEmpty()
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
(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 theisEmpty()
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
(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 theisEmpty()
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
(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 theisEmpty()
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
(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
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 returnIpAddressType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromipAddressTypeAsString()
.- Returns:
- The IP address type for the endpoint.
- See Also:
-
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 returnIpAddressType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromipAddressTypeAsString()
.- Returns:
- The IP address type for the endpoint.
- See Also:
-
dnsOptions
The DNS options for the endpoint.
- Returns:
- The DNS options for the endpoint.
-
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 theisEmpty()
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
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
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 interfaceToCopyableBuilder<ModifyVpcEndpointRequest.Builder,
ModifyVpcEndpointRequest> - Specified by:
toBuilder
in classEc2Request
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-