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:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
VpcEndpoint.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static VpcEndpoint.Builder
builder()
Instant
creationTimestamp()
The date and time that the endpoint was created.List<DnsEntry>
dnsEntries()
(Interface endpoint) The DNS entries for the endpoint.DnsOptions
dnsOptions()
The DNS options for the endpoint.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
List<SecurityGroupIdentifier>
groups()
(Interface endpoint) Information about the security groups that are associated with the network interface.boolean
hasDnsEntries()
For responses, this returns true if the service returned a value for the DnsEntries property.boolean
hasGroups()
For responses, this returns true if the service returned a value for the Groups property.int
hashCode()
boolean
hasNetworkInterfaceIds()
For responses, this returns true if the service returned a value for the NetworkInterfaceIds property.boolean
hasRouteTableIds()
For responses, this returns true if the service returned a value for the RouteTableIds property.boolean
hasSubnetIds()
For responses, this returns true if the service returned a value for the SubnetIds property.boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.IpAddressType
ipAddressType()
The IP address type for the endpoint.String
ipAddressTypeAsString()
The IP address type for the endpoint.LastError
lastError()
The last error that occurred for endpoint.List<String>
networkInterfaceIds()
(Interface endpoint) The network interfaces for the endpoint.String
ownerId()
The ID of the Amazon Web Services account that owns the endpoint.String
policyDocument()
The policy document associated with the endpoint, if applicable.Boolean
privateDnsEnabled()
(Interface endpoint) Indicates whether the VPC is associated with a private hosted zone.Boolean
requesterManaged()
Indicates whether the endpoint is being managed by its service.List<String>
routeTableIds()
(Gateway endpoint) The IDs of the route tables associated with the endpoint.List<SdkField<?>>
sdkFields()
static Class<? extends VpcEndpoint.Builder>
serializableBuilderClass()
String
serviceName()
The name of the service to which the endpoint is associated.State
state()
The state of the endpoint.String
stateAsString()
The state of the endpoint.List<String>
subnetIds()
(Interface endpoint) The subnets for the endpoint.List<Tag>
tags()
The tags assigned to the endpoint.VpcEndpoint.Builder
toBuilder()
String
toString()
Returns a string representation of this object.String
vpcEndpointId()
The ID of the endpoint.VpcEndpointType
vpcEndpointType()
The type of endpoint.String
vpcEndpointTypeAsString()
The type of endpoint.String
vpcId()
The ID of the VPC to which the endpoint is associated.-
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.
-
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 returnVpcEndpointType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromvpcEndpointTypeAsString()
.- Returns:
- The type of endpoint.
- See Also:
VpcEndpointType
-
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 returnVpcEndpointType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromvpcEndpointTypeAsString()
.- Returns:
- The type of endpoint.
- See Also:
VpcEndpointType
-
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 returnState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateAsString()
.- Returns:
- The state of the endpoint.
- See Also:
State
-
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 returnState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateAsString()
.- Returns:
- The state of the endpoint.
- See Also:
State
-
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 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.
-
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 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.
-
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 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.
-
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 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:
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 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:
IpAddressType
-
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 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.
-
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 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.
-
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 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.
-
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.
-
toBuilder
public VpcEndpoint.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<VpcEndpoint.Builder,VpcEndpoint>
-
builder
public static VpcEndpoint.Builder builder()
-
serializableBuilderClass
public static Class<? extends VpcEndpoint.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
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.
-
-