software.amazon.awscdk.services.ec2

Class CfnEIP

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.ec2.CfnEIP

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:42.393Z")
public class CfnEIP
extends CfnResource
implements IInspectable

A CloudFormation `AWS::EC2::EIP`.

Specifies an Elastic IP (EIP) address and can, optionally, associate it with an Amazon EC2 instance.

You can allocate an Elastic IP address from an address pool owned by AWS or from an address pool created from a public IPv4 address range that you have brought to AWS for use with your AWS resources using bring your own IP addresses (BYOIP). For more information, see Bring Your Own IP Addresses (BYOIP) in the Amazon EC2 User Guide .

[EC2-VPC] If you release an Elastic IP address, you might be able to recover it. You cannot recover an Elastic IP address that you released after it is allocated to another AWS account. You cannot recover an Elastic IP address for EC2-Classic. To attempt to recover an Elastic IP address that you released, specify it in this operation.

An Elastic IP address is for use either in the EC2-Classic platform or in a VPC. By default, you can allocate 5 Elastic IP addresses for EC2-Classic per Region and 5 Elastic IP addresses for EC2-VPC per Region.

For more information, see Elastic IP Addresses in the Amazon EC2 User Guide .

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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnEIP.Builder A fluent builder for CfnEIP.

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnEIP(Construct scope, java.lang.String id) Create a new `AWS::EC2::EIP`.
	CfnEIP(Construct scope, java.lang.String id, CfnEIPProps props) Create a new `AWS::EC2::EIP`.
protected	CfnEIP(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnEIP(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAttrAllocationId() The ID that AWS assigns to represent the allocation of the address for use with Amazon VPC.
java.lang.String	getAttrPublicIp() The Elastic IP address.
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.String	getDomain() Indicates whether the Elastic IP address is for use with instances in a VPC or instance in EC2-Classic.
java.lang.String	getInstanceId() The ID of the instance.
java.lang.String	getNetworkBorderGroup() A unique set of Availability Zones, Local Zones, or Wavelength Zones from which AWS advertises IP addresses.
java.lang.String	getPublicIpv4Pool() The ID of an address pool that you own.
TagManager	getTags() Any tags assigned to the Elastic IP address.
java.lang.String	getTransferAddress() The Elastic IP address you are accepting for transfer.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setDomain(java.lang.String value) Indicates whether the Elastic IP address is for use with instances in a VPC or instance in EC2-Classic.
void	setInstanceId(java.lang.String value) The ID of the instance.
void	setNetworkBorderGroup(java.lang.String value) A unique set of Availability Zones, Local Zones, or Wavelength Zones from which AWS advertises IP addresses.
void	setPublicIpv4Pool(java.lang.String value) The ID of an address pool that you own.
void	setTransferAddress(java.lang.String value) The Elastic IP address you are accepting for transfer.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnEIP

protected CfnEIP(software.amazon.jsii.JsiiObjectRef objRef)

CfnEIP

protected CfnEIP(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnEIP

public CfnEIP(Construct scope,
              java.lang.String id,
              CfnEIPProps props)

Create a new `AWS::EC2::EIP`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties.

CfnEIP

public CfnEIP(Construct scope,
              java.lang.String id)

Create a new `AWS::EC2::EIP`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

Method Detail

inspect

public void inspect(TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrAllocationId

public java.lang.String getAttrAllocationId()

The ID that AWS assigns to represent the allocation of the address for use with Amazon VPC.

This is returned only for VPC elastic IP addresses. For example, eipalloc-5723d13e .

getAttrPublicIp

public java.lang.String getAttrPublicIp()

The Elastic IP address.

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

public TagManager 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.

getDomain

public java.lang.String getDomain()

Indicates whether the Elastic IP address is for use with instances in a VPC or instance in EC2-Classic.

Default: If the Region supports EC2-Classic, the default is standard . Otherwise, the default is vpc .

Use when allocating an address for use with a VPC if the Region supports EC2-Classic.

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.

setDomain

public void setDomain(java.lang.String value)

Indicates whether the Elastic IP address is for use with instances in a VPC or instance in EC2-Classic.

Default: If the Region supports EC2-Classic, the default is standard . Otherwise, the default is vpc .

Use when allocating an address for use with a VPC if the Region supports EC2-Classic.

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.

getInstanceId

public java.lang.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.

setInstanceId

public void setInstanceId(java.lang.String value)

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.

getNetworkBorderGroup

public java.lang.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.

You cannot use a network border group with EC2 Classic. If you attempt this operation on EC2 Classic, you receive an InvalidParameterCombination error.

setNetworkBorderGroup

public void setNetworkBorderGroup(java.lang.String value)

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.

You cannot use a network border group with EC2 Classic. If you attempt this operation on EC2 Classic, you receive an InvalidParameterCombination error.

getPublicIpv4Pool

public java.lang.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.

setPublicIpv4Pool

public void setPublicIpv4Pool(java.lang.String value)

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.

getTransferAddress

public java.lang.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 .

setTransferAddress

public void setTransferAddress(java.lang.String value)

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 .