software.amazon.awscdk.services.s3outposts

Class CfnEndpoint

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.s3outposts.CfnEndpoint

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.58.0 (build f8ba112)",
           date="2022-05-20T22:19:56.646Z")
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 interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

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

Methods inherited from class software.amazon.awscdk.core.CfnResource

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

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

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

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.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

public CfnEndpoint(Construct scope,
                   java.lang.String id,
                   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

public void inspect(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

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

public java.lang.String getAttrArn()

The ARN of the endpoint.

getAttrCidrBlock

public java.lang.String getAttrCidrBlock()

The VPC CIDR block committed by this endpoint.

getAttrCreationTime

public java.lang.String getAttrCreationTime()

The time the endpoint was created.

getAttrId

public java.lang.String getAttrId()

The ID of the endpoint.

getAttrNetworkInterfaces

public IResolvable getAttrNetworkInterfaces()

The network interface of the endpoint.

getAttrStatus

public java.lang.String getAttrStatus()

The status of the endpoint.

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getOutpostId

public java.lang.String getOutpostId()

The ID of the Outpost.

setOutpostId

public void setOutpostId(java.lang.String value)

The ID of the Outpost.

getSecurityGroupId

public java.lang.String getSecurityGroupId()

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

setSecurityGroupId

public void setSecurityGroupId(java.lang.String value)

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

getSubnetId

public java.lang.String getSubnetId()

The ID of the subnet.

setSubnetId

public void setSubnetId(java.lang.String value)

The ID of the subnet.

getAccessType

public 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.

setAccessType

public void setAccessType(java.lang.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

public 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.

setCustomerOwnedIpv4Pool

public void setCustomerOwnedIpv4Pool(java.lang.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.