Package software.amazon.awscdk.services.s3outposts

Interface CfnEndpointProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnEndpointProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)",
           date="2025-10-29T11:15:47.878Z")
@Stability(Stable)
public interface CfnEndpointProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnEndpoint.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.s3outposts.*;
 CfnEndpointProps cfnEndpointProps = CfnEndpointProps.builder()
         .outpostId("outpostId")
         .securityGroupId("securityGroupId")
         .subnetId("subnetId")
         // the properties below are optional
         .accessType("accessType")
         .customerOwnedIpv4Pool("customerOwnedIpv4Pool")
         .failedReason(FailedReasonProperty.builder()
                 .errorCode("errorCode")
                 .message("message")
                 .build())
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3outposts-endpoint.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnEndpointProps.Builder	A builder for CfnEndpointProps
static final class	CfnEndpointProps.Jsii$Proxy	An implementation for CfnEndpointProps

Method Summary

Modifier and Type	Method	Description
static CfnEndpointProps.Builder	builder()
default String	getAccessType()	The container for the type of connectivity used to access the Amazon S3 on Outposts endpoint.
default String	getCustomerOwnedIpv4Pool()	The ID of the customer-owned IPv4 address pool (CoIP pool) for the endpoint.
default Object	getFailedReason()	The failure reason, if any, for a create or delete endpoint operation.
String	getOutpostId()	The ID of the Outpost.
String	getSecurityGroupId()	The ID of the security group used for the endpoint.
String	getSubnetId()	The ID of the subnet used for the endpoint.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getOutpostId

@Stability(Stable)
@NotNull
String getOutpostId()

The ID of the Outpost.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3outposts-endpoint.html#cfn-s3outposts-endpoint-outpostid

getSecurityGroupId

@Stability(Stable)
@NotNull
String getSecurityGroupId()

The ID of the security group used for the endpoint.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3outposts-endpoint.html#cfn-s3outposts-endpoint-securitygroupid

getSubnetId

@Stability(Stable)
@NotNull
String getSubnetId()

The ID of the subnet used for the endpoint.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3outposts-endpoint.html#cfn-s3outposts-endpoint-subnetid

getAccessType

@Stability(Stable)
@Nullable
default String getAccessType()

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

To use the Amazon 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.

Default: - "Private"

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3outposts-endpoint.html#cfn-s3outposts-endpoint-accesstype

getCustomerOwnedIpv4Pool

@Stability(Stable)
@Nullable
default String getCustomerOwnedIpv4Pool()

The ID of the customer-owned IPv4 address pool (CoIP pool) for the endpoint.

IP addresses are allocated from this pool for the endpoint.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3outposts-endpoint.html#cfn-s3outposts-endpoint-customerownedipv4pool

getFailedReason

@Stability(Stable)
@Nullable
default Object getFailedReason()

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

Returns union: either IResolvable or CfnEndpoint.FailedReasonProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3outposts-endpoint.html#cfn-s3outposts-endpoint-failedreason

builder

@Stability(Stable)
static CfnEndpointProps.Builder builder()

Returns:

a CfnEndpointProps.Builder of CfnEndpointProps