software.amazon.awscdk.services.s3outposts

Interface CfnEndpointProps

All Known Implementing Classes:

CfnEndpointProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.63.2 (build a8a8833)",
           date="2022-08-09T19:16:34.681Z")
public interface CfnEndpointProps

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")
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnEndpointProps.Builder	builder()
default java.lang.String	getAccessType() The container for the type of connectivity used to access the Amazon S3 on Outposts endpoint.
default java.lang.String	getCustomerOwnedIpv4Pool() The ID of the customer-owned IPv4 address pool (CoIP pool) for the endpoint.
java.lang.String	getOutpostId() The ID of the Outpost.
java.lang.String	getSecurityGroupId() The ID of the security group to use with the endpoint.
java.lang.String	getSubnetId() The ID of the subnet.

Method Detail

getOutpostId

java.lang.String getOutpostId()

The ID of the Outpost.

getSecurityGroupId

java.lang.String getSecurityGroupId()

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

getSubnetId

java.lang.String getSubnetId()

The ID of the subnet.

getAccessType

default java.lang.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.

getCustomerOwnedIpv4Pool

default java.lang.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.

builder

static CfnEndpointProps.Builder builder()

Returns:

a CfnEndpointProps.Builder of CfnEndpointProps