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

Class CreateEndpointRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.s3outposts.model.S3OutpostsRequest

software.amazon.awssdk.services.s3outposts.model.CreateEndpointRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateEndpointRequest.Builder,CreateEndpointRequest>

@Generated("software.amazon.awssdk:codegen")
public final class CreateEndpointRequest
extends S3OutpostsRequest
implements ToCopyableBuilder<CreateEndpointRequest.Builder,CreateEndpointRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateEndpointRequest.Builder

Method Summary

Modifier and Type	Method	Description
EndpointAccessType	accessType()	The type of access for the network connectivity for the Amazon S3 on Outposts endpoint.
String	accessTypeAsString()	The type of access for the network connectivity for the Amazon S3 on Outposts endpoint.
static CreateEndpointRequest.Builder	builder()
String	customerOwnedIpv4Pool()	The ID of the customer-owned IPv4 address pool (CoIP pool) for the endpoint.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	outpostId()	The ID of the Outposts.
List<SdkField<?>>	sdkFields()
String	securityGroupId()	The ID of the security group to use with the endpoint.
static Class<? extends CreateEndpointRequest.Builder>	serializableBuilderClass()
String	subnetId()	The ID of the subnet in the selected VPC.
CreateEndpointRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

outpostId

public final String outpostId()

The ID of the Outposts.

Returns:

The ID of the Outposts.

subnetId

public final String subnetId()

The ID of the subnet in the selected VPC. The endpoint subnet must belong to the Outpost that has Amazon S3 on Outposts provisioned.

Returns:

The ID of the subnet in the selected VPC. The endpoint subnet must belong to the Outpost that has Amazon S3 on Outposts provisioned.

securityGroupId

public final String securityGroupId()

The ID of the security group to use with the endpoint.

Returns:

The ID of the security group to use with the endpoint.

accessType

public final EndpointAccessType accessType()

The type of access for the network connectivity for the Amazon S3 on Outposts endpoint. To use the Amazon Web Services VPC, choose Private. To use the endpoint with an on-premises network, choose CustomerOwnedIp. If you choose CustomerOwnedIp, you must also provide the customer-owned IP address pool (CoIP pool).

Private is the default access type value.

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 access for the network connectivity for the Amazon S3 on Outposts endpoint. To use the Amazon Web Services VPC, choose Private. To use the endpoint with an on-premises network, choose CustomerOwnedIp. If you choose CustomerOwnedIp, you must also provide the customer-owned IP address pool (CoIP pool).

Private is the default access type value.

See Also:

EndpointAccessType

accessTypeAsString

public final String accessTypeAsString()

The type of access for the network connectivity for the Amazon S3 on Outposts endpoint. To use the Amazon Web Services VPC, choose Private. To use the endpoint with an on-premises network, choose CustomerOwnedIp. If you choose CustomerOwnedIp, you must also provide the customer-owned IP address pool (CoIP pool).

Private is the default access type value.

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 access for the network connectivity for the Amazon S3 on Outposts endpoint. To use the Amazon Web Services VPC, choose Private. To use the endpoint with an on-premises network, choose CustomerOwnedIp. If you choose CustomerOwnedIp, you must also provide the customer-owned IP address pool (CoIP pool).

Private is the default access type value.

See Also:

EndpointAccessType

customerOwnedIpv4Pool

public final String customerOwnedIpv4Pool()

The ID of the customer-owned IPv4 address pool (CoIP pool) for the endpoint. IP addresses are allocated from this pool for the endpoint.

Returns:

The ID of the customer-owned IPv4 address pool (CoIP pool) for the endpoint. IP addresses are allocated from this pool for the endpoint.

toBuilder

public CreateEndpointRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateEndpointRequest.Builder,CreateEndpointRequest>

Specified by:

toBuilder in class S3OutpostsRequest

builder

public static CreateEndpointRequest.Builder builder()

serializableBuilderClass

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

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

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

Specified by:

sdkFields in interface SdkPojo