Package software.amazon.awscdk.services.ec2

Class CfnEIP.Builder

java.lang.Object

software.amazon.awscdk.services.ec2.CfnEIP.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnEIP>

Enclosing class:

CfnEIP

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

A fluent builder for CfnEIP.

Method Summary

Modifier and Type	Method	Description
CfnEIP.Builder	address(String address)	An Elastic IP address or a carrier IP address in a Wavelength Zone.
CfnEIP	build()
static CfnEIP.Builder	create(software.constructs.Construct scope, String id)
CfnEIP.Builder	domain(String domain)	The network ( vpc ).
CfnEIP.Builder	instanceId(String instanceId)	The ID of the instance.
CfnEIP.Builder	ipamPoolId(String ipamPoolId)	The ID of an IPAM pool which has an Amazon-provided or BYOIP public IPv4 CIDR provisioned to it.
CfnEIP.Builder	networkBorderGroup(String networkBorderGroup)	A unique set of Availability Zones, Local Zones, or Wavelength Zones from which AWS advertises IP addresses.
CfnEIP.Builder	publicIpv4Pool(String publicIpv4Pool)	The ID of an address pool that you own.
CfnEIP.Builder	tags(List<? extends CfnTag> tags)	Any tags assigned to the Elastic IP address.
CfnEIP.Builder	transferAddress(String transferAddress)	The Elastic IP address you are accepting for transfer.

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 CfnEIP.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 CfnEIP.Builder.

address

@Stability(Stable)
public CfnEIP.Builder address(String address)

An Elastic IP address or a carrier IP address in a Wavelength Zone.

Parameters:

address - An Elastic IP address or a carrier IP address in a Wavelength Zone. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-eip.html#cfn-ec2-eip-address

domain

@Stability(Stable)
public CfnEIP.Builder domain(String domain)

The network ( vpc ).

If you define an Elastic IP address and associate it with a VPC that is defined in the same template, you must declare a dependency on the VPC-gateway attachment by using the DependsOn Attribute on this resource.

Parameters:

domain - The network ( vpc ). This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-eip.html#cfn-ec2-eip-domain

instanceId

@Stability(Stable)
public CfnEIP.Builder instanceId(String instanceId)

The ID of the instance.

Updates to the InstanceId property may require some interruptions . Updates on an EIP reassociates the address on its associated resource.

Parameters:

instanceId - The ID of the instance. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-eip.html#cfn-ec2-eip-instanceid

ipamPoolId

@Stability(Stable)
public CfnEIP.Builder ipamPoolId(String ipamPoolId)

The ID of an IPAM pool which has an Amazon-provided or BYOIP public IPv4 CIDR provisioned to it.

For more information, see Allocate sequential Elastic IP addresses from an IPAM pool in the Amazon VPC IPAM User Guide .

Parameters:

ipamPoolId - The ID of an IPAM pool which has an Amazon-provided or BYOIP public IPv4 CIDR provisioned to it. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-eip.html#cfn-ec2-eip-ipampoolid

networkBorderGroup

@Stability(Stable)
public CfnEIP.Builder networkBorderGroup(String networkBorderGroup)

A unique set of Availability Zones, Local Zones, or Wavelength Zones from which AWS advertises IP addresses.

Use this parameter to limit the IP address to this location. IP addresses cannot move between network border groups.

Use DescribeAvailabilityZones to view the network border groups.

Parameters:

networkBorderGroup - A unique set of Availability Zones, Local Zones, or Wavelength Zones from which AWS advertises IP addresses. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-eip.html#cfn-ec2-eip-networkbordergroup

publicIpv4Pool

@Stability(Stable)
public CfnEIP.Builder publicIpv4Pool(String publicIpv4Pool)

The ID of an address pool that you own.

Use this parameter to let Amazon EC2 select an address from the address pool.

Updates to the PublicIpv4Pool property may require some interruptions . Updates on an EIP reassociates the address on its associated resource.

Parameters:

publicIpv4Pool - The ID of an address pool that you own. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-eip.html#cfn-ec2-eip-publicipv4pool

tags

@Stability(Stable)
public CfnEIP.Builder tags(List<? extends CfnTag> tags)

Any tags assigned to the Elastic IP address.

Updates to the Tags property may require some interruptions . Updates on an EIP reassociates the address on its associated resource.

Parameters:

tags - Any tags assigned to the Elastic IP address. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-eip.html#cfn-ec2-eip-tags

transferAddress

@Stability(Stable)
public CfnEIP.Builder transferAddress(String transferAddress)

The Elastic IP address you are accepting for transfer.

You can only accept one transferred address. For more information on Elastic IP address transfers, see Transfer Elastic IP addresses in the Amazon Virtual Private Cloud User Guide .

Parameters:

transferAddress - The Elastic IP address you are accepting for transfer. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-eip.html#cfn-ec2-eip-transferaddress

build

@Stability(Stable)
public CfnEIP build()

Specified by:

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

Returns:

a newly built instance of CfnEIP.