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("software.amazon.awssdk:codegen") public final class ModifyVpcEndpointRequest extends Ec2Request implements ToCopyableBuilder<ModifyVpcEndpointRequest.Builder,ModifyVpcEndpointRequest>

  • Method Details

    • 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:

    • 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:

    • 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()
      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 interface ToCopyableBuilder<ModifyVpcEndpointRequest.Builder,ModifyVpcEndpointRequest>
      Specified by:
      toBuilder in class Ec2Request
      Returns:
      a builder for type T

    • 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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. 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, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      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

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.