Package software.amazon.awssdk.services.s3outposts.model

Class Endpoint

java.lang.Object

software.amazon.awssdk.services.s3outposts.model.Endpoint

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Endpoint.Builder,Endpoint>

@Generated("software.amazon.awssdk:codegen")
public final class Endpoint
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Endpoint.Builder,Endpoint>

Amazon S3 on Outposts Access Points simplify managing data access at scale for shared datasets in S3 on Outposts. S3 on Outposts uses endpoints to connect to Outposts buckets so that you can perform actions within your virtual private cloud (VPC). For more information, see Accessing S3 on Outposts using VPC-only access points in the Amazon Simple Storage Service User Guide.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Endpoint.Builder

Method Summary

Modifier and Type	Method	Description
EndpointAccessType	accessType()	The type of connectivity used to access the Amazon S3 on Outposts endpoint.
String	accessTypeAsString()	The type of connectivity used to access the Amazon S3 on Outposts endpoint.
static Endpoint.Builder	builder()
String	cidrBlock()	The VPC CIDR committed by this endpoint.
Instant	creationTime()	The time the endpoint was created.
String	customerOwnedIpv4Pool()	The ID of the customer-owned IPv4 address pool used for the endpoint.
String	endpointArn()	The Amazon Resource Name (ARN) of the endpoint.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
FailedReason	failedReason()	The failure reason, if any, for a create or delete endpoint operation.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasNetworkInterfaces()	For responses, this returns true if the service returned a value for the NetworkInterfaces property.
List<NetworkInterface>	networkInterfaces()	The network interface of the endpoint.
String	outpostsId()	The ID of the Outposts.
List<SdkField<?>>	sdkFields()
String	securityGroupId()	The ID of the security group used for the endpoint.
static Class<? extends Endpoint.Builder>	serializableBuilderClass()
EndpointStatus	status()	The status of the endpoint.
String	statusAsString()	The status of the endpoint.
String	subnetId()	The ID of the subnet used for the endpoint.
Endpoint.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	vpcId()	The ID of the VPC used for the endpoint.

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

endpointArn

public final String endpointArn()

The Amazon Resource Name (ARN) of the endpoint.

Returns:

The Amazon Resource Name (ARN) of the endpoint.

outpostsId

public final String outpostsId()

The ID of the Outposts.

Returns:

The ID of the Outposts.

cidrBlock

public final String cidrBlock()

The VPC CIDR committed by this endpoint.

Returns:

The VPC CIDR committed by this endpoint.

status

public final EndpointStatus status()

The status of the endpoint.

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

Returns:

The status of the endpoint.

See Also:

EndpointStatus

statusAsString

public final String statusAsString()

The status of the endpoint.

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

Returns:

The status of the endpoint.

See Also:

EndpointStatus

creationTime

public final Instant creationTime()

The time the endpoint was created.

Returns:

The time the endpoint was created.

hasNetworkInterfaces

public final boolean hasNetworkInterfaces()

For responses, this returns true if the service returned a value for the NetworkInterfaces 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.

networkInterfaces

public final List<NetworkInterface> networkInterfaces()

The network interface of 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 hasNetworkInterfaces() method.

Returns:

The network interface of the endpoint.

vpcId

public final String vpcId()

The ID of the VPC used for the endpoint.

Returns:

The ID of the VPC used for the endpoint.

subnetId

public final String subnetId()

The ID of the subnet used for the endpoint.

Returns:

The ID of the subnet used for the endpoint.

securityGroupId

public final String securityGroupId()

The ID of the security group used for the endpoint.

Returns:

The ID of the security group used for the endpoint.

accessType

public final EndpointAccessType accessType()

The type of connectivity used to access the Amazon S3 on Outposts endpoint.

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

Returns:

The type of connectivity used to access the Amazon S3 on Outposts endpoint.

See Also:

EndpointAccessType

accessTypeAsString

public final String accessTypeAsString()

The type of connectivity used to access the Amazon S3 on Outposts endpoint.

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

Returns:

The type of connectivity used to access the Amazon S3 on Outposts endpoint.

See Also:

EndpointAccessType

customerOwnedIpv4Pool

public final String customerOwnedIpv4Pool()

The ID of the customer-owned IPv4 address pool used for the endpoint.

Returns:

The ID of the customer-owned IPv4 address pool used for the endpoint.

failedReason

public final FailedReason failedReason()

The failure reason, if any, for a create or delete endpoint operation.

Returns:

The failure reason, if any, for a create or delete endpoint operation.

toBuilder

public Endpoint.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Endpoint.Builder,Endpoint>

builder

public static Endpoint.Builder builder()

serializableBuilderClass

public static Class<? extends Endpoint.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)

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)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo