Package software.amazon.awscdk.cfnpropertymixins.services.ec2

Class CfnEIPPropsMixin.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.ec2.CfnEIPPropsMixin.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnEIPPropsMixin>

Enclosing class:

CfnEIPPropsMixin

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

A fluent builder for CfnEIPPropsMixin.

Method Summary

Modifier and Type	Method	Description
CfnEIPPropsMixin.Builder	address(String address)	An Elastic IP address or a carrier IP address in a Wavelength Zone.
CfnEIPPropsMixin	build()
static CfnEIPPropsMixin.Builder	create()
static CfnEIPPropsMixin.Builder	create(CfnPropertyMixinOptions options)
CfnEIPPropsMixin.Builder	domain(String domain)	The network ( vpc ).
CfnEIPPropsMixin.Builder	instanceId(String instanceId)	The ID of the instance.
CfnEIPPropsMixin.Builder	instanceId(IInstanceRef instanceId)	The ID of the instance.
CfnEIPPropsMixin.Builder	ipamPoolId(String ipamPoolId)	The ID of an IPAM pool which has an Amazon-provided or BYOIP public IPv4 CIDR provisioned to it.
CfnEIPPropsMixin.Builder	networkBorderGroup(String networkBorderGroup)	A unique set of Availability Zones, Local Zones, or Wavelength Zones from which AWS advertises IP addresses.
CfnEIPPropsMixin.Builder	publicIpv4Pool(String publicIpv4Pool)	The ID of an address pool that you own.
CfnEIPPropsMixin.Builder	tags(List<? extends CfnTag> tags)	Any tags assigned to the Elastic IP address.
CfnEIPPropsMixin.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 CfnEIPPropsMixin.Builder create(CfnPropertyMixinOptions options)

Parameters:

options - Mixin options.

Returns:

a new instance of CfnEIPPropsMixin.Builder.

create

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

Returns:

a new instance of CfnEIPPropsMixin.Builder.

address

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

instanceId

@Stability(Stable)
public CfnEIPPropsMixin.Builder instanceId(IInstanceRef 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 CfnEIPPropsMixin.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 CfnEIPPropsMixin.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 CfnEIPPropsMixin.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 CfnEIPPropsMixin.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 CfnEIPPropsMixin.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 CfnEIPPropsMixin build()

Specified by:

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

Returns:

a newly built instance of CfnEIPPropsMixin.