Interface ICfnEIPProps
Properties for defining a CfnEIP.
Namespace: Amazon.CDK.AWS.EC2
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface ICfnEIPProps
Syntax (vb)
Public Interface ICfnEIPProps
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-eip.html
ExampleMetadata: infused
Examples
Instance instance;
HostedZone myZone;
var elasticIp = new CfnEIP(this, "EIP", new CfnEIPProps {
Domain = "vpc",
InstanceId = instance.InstanceId
});
new ARecord(this, "ARecord", new ARecordProps {
Zone = myZone,
Target = RecordTarget.FromIpAddresses(elasticIp.Ref)
});
Synopsis
Properties
| Address | An Elastic IP address or a carrier IP address in a Wavelength Zone. |
| Domain | The network ( |
| InstanceId | The ID of the instance. |
| IpamPoolId | The ID of an IPAM pool which has an Amazon-provided or BYOIP public IPv4 CIDR provisioned to it. |
| NetworkBorderGroup | A unique set of Availability Zones, Local Zones, or Wavelength Zones from which AWS advertises IP addresses. |
| PublicIpv4Pool | The ID of an address pool that you own. |
| Tags | Any tags assigned to the Elastic IP address. |
| TransferAddress | The Elastic IP address you are accepting for transfer. |
Properties
Address
An Elastic IP address or a carrier IP address in a Wavelength Zone.
string? Address { get; }
Property Value
Remarks
Domain
The network ( vpc ).
string? Domain { get; }
Property Value
Remarks
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
The ID of the instance.
string? InstanceId { get; }
Property Value
Remarks
Updates to the <code>InstanceId</code> property may require <em>some interruptions</em> . Updates on an EIP reassociates the address on its associated resource.
IpamPoolId
The ID of an IPAM pool which has an Amazon-provided or BYOIP public IPv4 CIDR provisioned to it.
string? IpamPoolId { get; }
Property Value
Remarks
For more information, see Allocate sequential Elastic IP addresses from an IPAM pool in the Amazon VPC IPAM User Guide .
NetworkBorderGroup
A unique set of Availability Zones, Local Zones, or Wavelength Zones from which AWS advertises IP addresses.
string? NetworkBorderGroup { get; }
Property Value
Remarks
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
The ID of an address pool that you own.
string? PublicIpv4Pool { get; }
Property Value
Remarks
Use this parameter to let Amazon EC2 select an address from the address pool.
Updates to the <code>PublicIpv4Pool</code> property may require <em>some interruptions</em> . Updates on an EIP reassociates the address on its associated resource.
Tags
Any tags assigned to the Elastic IP address.
ICfnTag[]? Tags { get; }
Property Value
ICfnTag[]
Remarks
Updates to the <code>Tags</code> property may require <em>some interruptions</em> . Updates on an EIP reassociates the address on its associated resource.
TransferAddress
The Elastic IP address you are accepting for transfer.
string? TransferAddress { get; }
Property Value
Remarks
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 .