Package software.amazon.awscdk.services.s3outposts

Class CfnEndpoint.Builder

java.lang.Object

software.amazon.awscdk.services.s3outposts.CfnEndpoint.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnEndpoint>

Enclosing class:

CfnEndpoint

@Stability(Stable)
public static final class CfnEndpoint.Builder
extends Object
implements software.amazon.jsii.Builder<CfnEndpoint>

A fluent builder for CfnEndpoint.

Method Summary

Modifier and Type	Method	Description
CfnEndpoint.Builder	accessType(String accessType)	The container for the type of connectivity used to access the Amazon S3 on Outposts endpoint.
CfnEndpoint	build()
static CfnEndpoint.Builder	create(software.constructs.Construct scope, String id)
CfnEndpoint.Builder	customerOwnedIpv4Pool(String customerOwnedIpv4Pool)	The ID of the customer-owned IPv4 address pool (CoIP pool) for the endpoint.
CfnEndpoint.Builder	failedReason(IResolvable failedReason)	The failure reason, if any, for a create or delete endpoint operation.
CfnEndpoint.Builder	failedReason(CfnEndpoint.FailedReasonProperty failedReason)	The failure reason, if any, for a create or delete endpoint operation.
CfnEndpoint.Builder	outpostId(String outpostId)	The ID of the Outpost.
CfnEndpoint.Builder	securityGroupId(String securityGroupId)	The ID of the security group used for the endpoint.
CfnEndpoint.Builder	subnetId(String subnetId)	The ID of the subnet used for the endpoint.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Stable)
public static CfnEndpoint.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

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

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnEndpoint.Builder.

outpostId

@Stability(Stable)
public CfnEndpoint.Builder outpostId(String outpostId)

The ID of the Outpost.

Parameters:

outpostId - The ID of the Outpost. This parameter is required.

Returns:

this

See Also:

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

securityGroupId

@Stability(Stable)
public CfnEndpoint.Builder securityGroupId(String securityGroupId)

The ID of the security group used for the endpoint.

Parameters:

securityGroupId - The ID of the security group used for the endpoint. This parameter is required.

Returns:

this

See Also:

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

subnetId

@Stability(Stable)
public CfnEndpoint.Builder subnetId(String subnetId)

The ID of the subnet used for the endpoint.

Parameters:

subnetId - The ID of the subnet used for the endpoint. This parameter is required.

Returns:

this

See Also:

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

accessType

@Stability(Stable)
public CfnEndpoint.Builder accessType(String accessType)

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"

Parameters:

accessType - The container for the type of connectivity used to access the Amazon S3 on Outposts endpoint. This parameter is required.

Returns:

this

See Also:

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

customerOwnedIpv4Pool

@Stability(Stable)
public CfnEndpoint.Builder customerOwnedIpv4Pool(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.

Parameters:

customerOwnedIpv4Pool - The ID of the customer-owned IPv4 address pool (CoIP pool) for the endpoint. This parameter is required.

Returns:

this

See Also:

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

failedReason

@Stability(Stable)
public CfnEndpoint.Builder failedReason(IResolvable failedReason)

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

Parameters:

failedReason - The failure reason, if any, for a create or delete endpoint operation. This parameter is required.

Returns:

this

See Also:

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

failedReason

@Stability(Stable)
public CfnEndpoint.Builder failedReason(CfnEndpoint.FailedReasonProperty failedReason)

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

Parameters:

failedReason - The failure reason, if any, for a create or delete endpoint operation. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnEndpoint build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnEndpoint>

Returns:

a newly built instance of CfnEndpoint.