Package software.amazon.awscdk.services.ec2

Interface CfnEIPProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnEIPProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)",
           date="2025-10-29T11:15:36.790Z")
@Stability(Stable)
public interface CfnEIPProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnEIP.

Example:

 Instance instance;
 HostedZone myZone;
 CfnEIP elasticIp = CfnEIP.Builder.create(this, "EIP")
         .domain("vpc")
         .instanceId(instance.getInstanceId())
         .build();
 ARecord.Builder.create(this, "ARecord")
         .zone(myZone)
         .target(RecordTarget.fromIpAddresses(elasticIp.getRef()))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnEIPProps.Builder	A builder for CfnEIPProps
static final class	CfnEIPProps.Jsii$Proxy	An implementation for CfnEIPProps

Method Summary

Modifier and Type	Method	Description
static CfnEIPProps.Builder	builder()
default String	getAddress()	An Elastic IP address or a carrier IP address in a Wavelength Zone.
default String	getDomain()	The network ( vpc ).
default String	getInstanceId()	The ID of the instance.
default String	getIpamPoolId()	The ID of an IPAM pool which has an Amazon-provided or BYOIP public IPv4 CIDR provisioned to it.
default String	getNetworkBorderGroup()	A unique set of Availability Zones, Local Zones, or Wavelength Zones from which AWS advertises IP addresses.
default String	getPublicIpv4Pool()	The ID of an address pool that you own.
default List<CfnTag>	getTags()	Any tags assigned to the Elastic IP address.
default String	getTransferAddress()	The Elastic IP address you are accepting for transfer.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAddress

@Stability(Stable)
@Nullable
default String getAddress()

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

See Also:

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

getDomain

@Stability(Stable)
@Nullable
default String getDomain()

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.

See Also:

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

getInstanceId

@Stability(Stable)
@Nullable
default String getInstanceId()

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.

See Also:

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

getIpamPoolId

@Stability(Stable)
@Nullable
default String getIpamPoolId()

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 .

See Also:

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

getNetworkBorderGroup

@Stability(Stable)
@Nullable
default String getNetworkBorderGroup()

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.

See Also:

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

getPublicIpv4Pool

@Stability(Stable)
@Nullable
default String getPublicIpv4Pool()

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.

See Also:

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

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

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.

See Also:

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

getTransferAddress

@Stability(Stable)
@Nullable
default String getTransferAddress()

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 .

See Also:

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

builder

@Stability(Stable)
static CfnEIPProps.Builder builder()

Returns:

a CfnEIPProps.Builder of CfnEIPProps