interface CfnEIPProps

Language	Type name
.NET	`Amazon.CDK.AWS.EC2.CfnEIPProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsec2#CfnEIPProps`
Java	`software.amazon.awscdk.services.ec2.CfnEIPProps`
Python	`aws_cdk.aws_ec2.CfnEIPProps`
TypeScript	`aws-cdk-lib` » `aws_ec2` » `CfnEIPProps`

Properties for defining a CfnEIP.

Example

declare const instance: ec2.Instance;

const elasticIp = new ec2.CfnEIP(this, 'EIP', {
  domain: 'vpc',
  instanceId: instance.instanceId,
});

declare const myZone: route53.HostedZone;
new route53.ARecord(this, 'ARecord', {
  zone: myZone,
  target: route53.RecordTarget.fromIpAddresses(elasticIp.ref),
});

Properties

Name	Type	Description
address?	`string`	An Elastic IP address or a carrier IP address in a Wavelength Zone.
domain?	`string`	The network ( `vpc` ).
instanceId?	`string`	The ID of the instance.
ipamPoolId?	`string`	The ID of an IPAM pool which has an Amazon-provided or BYOIP public IPv4 CIDR provisioned to it.
networkBorderGroup?	`string`	A unique set of Availability Zones, Local Zones, or Wavelength Zones from which AWS advertises IP addresses.
publicIpv4Pool?	`string`	The ID of an address pool that you own.
tags?	`CfnTag[]`	Any tags assigned to the Elastic IP address.
transferAddress?	`string`	The Elastic IP address you are accepting for transfer.

address?

Type: string (optional)

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

domain?

Type: string (optional)

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.

instanceId?

Type: string (optional)

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.

ipamPoolId?

Type: string (optional)

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 .

networkBorderGroup?

Type: string (optional)

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.

publicIpv4Pool?

Type: string (optional)

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.

tags?

Type: CfnTag[] (optional)

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.

transferAddress?

Type: string (optional)

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 .