Package software.amazon.awscdk.cfnpropertymixins.services.s3outposts

Class CfnEndpointPropsMixin.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.s3outposts.CfnEndpointPropsMixin.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnEndpointPropsMixin>

Enclosing class:

CfnEndpointPropsMixin

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

A fluent builder for CfnEndpointPropsMixin.

Method Summary

Modifier and Type	Method	Description
CfnEndpointPropsMixin.Builder	accessType(String accessType)	The container for the type of connectivity used to access the Amazon S3 on Outposts endpoint.
CfnEndpointPropsMixin	build()
static CfnEndpointPropsMixin.Builder	create()
static CfnEndpointPropsMixin.Builder	create(CfnPropertyMixinOptions options)
CfnEndpointPropsMixin.Builder	customerOwnedIpv4Pool(String customerOwnedIpv4Pool)	The ID of the customer-owned IPv4 address pool (CoIP pool) for the endpoint.
CfnEndpointPropsMixin.Builder	failedReason(CfnEndpointPropsMixin.FailedReasonProperty failedReason)	The failure reason, if any, for a create or delete endpoint operation.
CfnEndpointPropsMixin.Builder	failedReason(IResolvable failedReason)	The failure reason, if any, for a create or delete endpoint operation.
CfnEndpointPropsMixin.Builder	outpostId(String outpostId)	The ID of the Outpost.
CfnEndpointPropsMixin.Builder	securityGroupId(String securityGroupId)	The ID of the security group used for the endpoint.
CfnEndpointPropsMixin.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 CfnEndpointPropsMixin.Builder create(CfnPropertyMixinOptions options)

Parameters:

options - Mixin options.

Returns:

a new instance of CfnEndpointPropsMixin.Builder.

create

@Stability(Stable)
public static CfnEndpointPropsMixin.Builder create()

Returns:

a new instance of CfnEndpointPropsMixin.Builder.

accessType

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

outpostId

@Stability(Stable)
public CfnEndpointPropsMixin.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 CfnEndpointPropsMixin.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 CfnEndpointPropsMixin.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

build

@Stability(Stable)
public CfnEndpointPropsMixin build()

Specified by:

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

Returns:

a newly built instance of CfnEndpointPropsMixin.