Class VpcEndpoint

java.lang.Object
software.amazon.awssdk.services.ec2.model.VpcEndpoint
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<VpcEndpoint.Builder,VpcEndpoint>
@Generated("software.amazon.awssdk:codegen") public final class VpcEndpoint extends Object implements SdkPojo, Serializable, ToCopyableBuilder<VpcEndpoint.Builder,VpcEndpoint>

Describes a VPC endpoint.

See Also:

  • Method Details

    • vpcEndpointId

      public final String vpcEndpointId()

      The ID of the endpoint.

      Returns:
      The ID of the endpoint.

    • vpcEndpointType

      public final VpcEndpointType vpcEndpointType()

      The type of endpoint.

      If the service returns an enum value that is not available in the current SDK version, vpcEndpointType will return VpcEndpointType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from vpcEndpointTypeAsString().

      Returns:
      The type of endpoint.
      See Also:

    • vpcEndpointTypeAsString

      public final String vpcEndpointTypeAsString()

      The type of endpoint.

      If the service returns an enum value that is not available in the current SDK version, vpcEndpointType will return VpcEndpointType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from vpcEndpointTypeAsString().

      Returns:
      The type of endpoint.
      See Also:

    • vpcId

      public final String vpcId()

      The ID of the VPC to which the endpoint is associated.

      Returns:
      The ID of the VPC to which the endpoint is associated.

    • serviceName

      public final String serviceName()

      The name of the service to which the endpoint is associated.

      Returns:
      The name of the service to which the endpoint is associated.

    • state

      public final State state()

      The state of the endpoint.

      If the service returns an enum value that is not available in the current SDK version, state will return State.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

      Returns:
      The state of the endpoint.
      See Also:

    • stateAsString

      public final String stateAsString()

      The state of the endpoint.

      If the service returns an enum value that is not available in the current SDK version, state will return State.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

      Returns:
      The state of the endpoint.
      See Also:

    • policyDocument

      public final String policyDocument()

      The policy document associated with the endpoint, if applicable.

      Returns:
      The policy document associated with the endpoint, if applicable.

    • hasRouteTableIds

      public final boolean hasRouteTableIds()
      For responses, this returns true if the service returned a value for the RouteTableIds 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.

    • routeTableIds

      public final List<String> routeTableIds()

      (Gateway endpoint) The IDs of the route tables associated 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 hasRouteTableIds() method.

      Returns:
      (Gateway endpoint) The IDs of the route tables associated with the endpoint.

    • hasSubnetIds

      public final boolean hasSubnetIds()
      For responses, this returns true if the service returned a value for the SubnetIds 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.

    • subnetIds

      public final List<String> subnetIds()

      (Interface endpoint) The subnets 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 hasSubnetIds() method.

      Returns:
      (Interface endpoint) The subnets for the endpoint.

    • hasGroups

      public final boolean hasGroups()
      For responses, this returns true if the service returned a value for the Groups 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.

    • groups

      public final List<SecurityGroupIdentifier> groups()

      (Interface endpoint) Information about the security groups that are associated 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 hasGroups() method.

      Returns:
      (Interface endpoint) Information about the security groups that are associated with the network interface.

    • 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 DnsOptions dnsOptions()

      The DNS options for the endpoint.

      Returns:
      The DNS options for the endpoint.

    • privateDnsEnabled

      public final Boolean privateDnsEnabled()

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

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

    • requesterManaged

      public final Boolean requesterManaged()

      Indicates whether the endpoint is being managed by its service.

      Returns:
      Indicates whether the endpoint is being managed by its service.

    • hasNetworkInterfaceIds

      public final boolean hasNetworkInterfaceIds()
      For responses, this returns true if the service returned a value for the NetworkInterfaceIds 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.

    • networkInterfaceIds

      public final List<String> networkInterfaceIds()

      (Interface endpoint) The network interfaces 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 hasNetworkInterfaceIds() method.

      Returns:
      (Interface endpoint) The network interfaces for the endpoint.

    • hasDnsEntries

      public final boolean hasDnsEntries()
      For responses, this returns true if the service returned a value for the DnsEntries 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.

    • dnsEntries

      public final List<DnsEntry> dnsEntries()

      (Interface endpoint) The DNS entries 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 hasDnsEntries() method.

      Returns:
      (Interface endpoint) The DNS entries for the endpoint.

    • creationTimestamp

      public final Instant creationTimestamp()

      The date and time that the endpoint was created.

      Returns:
      The date and time that the endpoint was created.

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags 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.

    • tags

      public final List<Tag> tags()

      The tags assigned to 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 hasTags() method.

      Returns:
      The tags assigned to the endpoint.

    • ownerId

      public final String ownerId()

      The ID of the Amazon Web Services account that owns the endpoint.

      Returns:
      The ID of the Amazon Web Services account that owns the endpoint.

    • lastError

      public final LastError lastError()

      The last error that occurred for endpoint.

      Returns:
      The last error that occurred for endpoint.

    • hasIpv4Prefixes

      public final boolean hasIpv4Prefixes()
      For responses, this returns true if the service returned a value for the Ipv4Prefixes 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.

    • ipv4Prefixes

      public final List<SubnetIpPrefixes> ipv4Prefixes()

      Array of IPv4 prefixes.

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

      Returns:
      Array of IPv4 prefixes.

    • hasIpv6Prefixes

      public final boolean hasIpv6Prefixes()
      For responses, this returns true if the service returned a value for the Ipv6Prefixes 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.

    • ipv6Prefixes

      public final List<SubnetIpPrefixes> ipv6Prefixes()

      Array of IPv6 prefixes.

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

      Returns:
      Array of IPv6 prefixes.

    • failureReason

      public final String failureReason()

      Reason for the failure.

      Returns:
      Reason for the failure.

    • serviceNetworkArn

      public final String serviceNetworkArn()

      The Amazon Resource Name (ARN) of the service network.

      Returns:
      The Amazon Resource Name (ARN) of the service network.

    • resourceConfigurationArn

      public final String resourceConfigurationArn()

      The Amazon Resource Name (ARN) of the resource configuration.

      Returns:
      The Amazon Resource Name (ARN) of the resource configuration.

    • serviceRegion

      public final String serviceRegion()

      The Region where the service is hosted.

      Returns:
      The Region where the service is hosted.

    • toBuilder

      public VpcEndpoint.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<VpcEndpoint.Builder,VpcEndpoint>
      Returns:
      a builder for type T

    • builder

      public static VpcEndpoint.Builder builder()

    • serializableBuilderClass

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

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

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

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.