software.amazon.awscdk.services.s3outposts

Class CfnEndpoint

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.s3outposts.CfnEndpoint

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:41.839Z")
 @Stability(value=Stable)
public class CfnEndpoint
extends CfnResource
implements IInspectable

A CloudFormation `AWS::S3Outposts::Endpoint`.

This AWS::S3Outposts::Endpoint resource specifies an endpoint and associates it with the specified Outpost.

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 S3 on 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 .

It can take up to 5 minutes for this resource to be created.

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.*;
 CfnEndpoint cfnEndpoint = CfnEndpoint.Builder.create(this, "MyCfnEndpoint")
         .outpostId("outpostId")
         .securityGroupId("securityGroupId")
         .subnetId("subnetId")
         // the properties below are optional
         .accessType("accessType")
         .customerOwnedIpv4Pool("customerOwnedIpv4Pool")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnEndpoint.Builder A fluent builder for CfnEndpoint.
static interface	CfnEndpoint.NetworkInterfaceProperty The container for the network interface.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnEndpoint(software.constructs.Construct scope, String id, CfnEndpointProps props) Create a new `AWS::S3Outposts::Endpoint`.
protected	CfnEndpoint(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnEndpoint(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAccessType() The container for the type of connectivity used to access the Amazon S3 on Outposts endpoint.
String	getAttrArn() The ARN of the endpoint.
String	getAttrCidrBlock() The VPC CIDR block committed by this endpoint.
String	getAttrCreationTime() The time the endpoint was created.
String	getAttrId() The ID of the endpoint.
IResolvable	getAttrNetworkInterfaces() The network interface of the endpoint.
String	getAttrStatus() The status of the endpoint.
protected Map<String,Object>	getCfnProperties()
String	getCustomerOwnedIpv4Pool() The ID of the customer-owned IPv4 address pool (CoIP pool) for the endpoint.
String	getOutpostId() The ID of the Outpost.
String	getSecurityGroupId() The ID of the security group to use with the endpoint.
String	getSubnetId() The ID of the subnet.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAccessType(String value) The container for the type of connectivity used to access the Amazon S3 on Outposts endpoint.
void	setCustomerOwnedIpv4Pool(String value) The ID of the customer-owned IPv4 address pool (CoIP pool) for the endpoint.
void	setOutpostId(String value) The ID of the Outpost.
void	setSecurityGroupId(String value) The ID of the security group to use with the endpoint.
void	setSubnetId(String value) The ID of the subnet.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnEndpoint

protected CfnEndpoint(software.amazon.jsii.JsiiObjectRef objRef)

CfnEndpoint

protected CfnEndpoint(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnEndpoint

@Stability(value=Stable)
public CfnEndpoint(@NotNull
                                            software.constructs.Construct scope,
                                            @NotNull
                                            String id,
                                            @NotNull
                                            CfnEndpointProps props)

Create a new `AWS::S3Outposts::Endpoint`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

@Stability(value=Stable)
 @NotNull
public String getAttrArn()

The ARN of the endpoint.

getAttrCidrBlock

@Stability(value=Stable)
 @NotNull
public String getAttrCidrBlock()

The VPC CIDR block committed by this endpoint.

getAttrCreationTime

@Stability(value=Stable)
 @NotNull
public String getAttrCreationTime()

The time the endpoint was created.

getAttrId

@Stability(value=Stable)
 @NotNull
public String getAttrId()

The ID of the endpoint.

getAttrNetworkInterfaces

@Stability(value=Stable)
 @NotNull
public IResolvable getAttrNetworkInterfaces()

The network interface of the endpoint.

getAttrStatus

@Stability(value=Stable)
 @NotNull
public String getAttrStatus()

The status of the endpoint.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getOutpostId

@Stability(value=Stable)
 @NotNull
public String getOutpostId()

The ID of the Outpost.

setOutpostId

@Stability(value=Stable)
public void setOutpostId(@NotNull
                                                  String value)

The ID of the Outpost.

getSecurityGroupId

@Stability(value=Stable)
 @NotNull
public String getSecurityGroupId()

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

setSecurityGroupId

@Stability(value=Stable)
public void setSecurityGroupId(@NotNull
                                                        String value)

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

getSubnetId

@Stability(value=Stable)
 @NotNull
public String getSubnetId()

The ID of the subnet.

setSubnetId

@Stability(value=Stable)
public void setSubnetId(@NotNull
                                                 String value)

The ID of the subnet.

getAccessType

@Stability(value=Stable)
 @Nullable
public 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.

setAccessType

@Stability(value=Stable)
public void setAccessType(@Nullable
                                                   String value)

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

@Stability(value=Stable)
 @Nullable
public 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.

setCustomerOwnedIpv4Pool

@Stability(value=Stable)
public void setCustomerOwnedIpv4Pool(@Nullable
                                                              String value)

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

IP addresses are allocated from this pool for the endpoint.