software.amazon.awscdk.services.ec2

Class CfnEIPAssociation

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.CfnEIPAssociation

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

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

A CloudFormation `AWS::EC2::EIPAssociation`.

Associates an Elastic IP address with an instance or a network interface. Before you can use an Elastic IP address, you must allocate it to your account. For more information about working with Elastic IP addresses, see Elastic IP address concepts and rules .

An Elastic IP address can be used in EC2-Classic and EC2-VPC accounts. There are differences between an Elastic IP address that you use in a VPC and one that you use in EC2-Classic. For more information, see Differences between instances in EC2-Classic and a VPC .

[EC2-VPC] You must specify AllocationId and either InstanceId , NetworkInterfaceId , or PrivateIpAddress .

[EC2-Classic] You must specify EIP and InstanceId .

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.ec2.*;
 CfnEIPAssociation cfnEIPAssociation = CfnEIPAssociation.Builder.create(this, "MyCfnEIPAssociation")
         .allocationId("allocationId")
         .eip("eip")
         .instanceId("instanceId")
         .networkInterfaceId("networkInterfaceId")
         .privateIpAddress("privateIpAddress")
         .build();
 

Nested Class Summary

Nested Classes

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

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
	CfnEIPAssociation(Construct scope, java.lang.String id) Create a new `AWS::EC2::EIPAssociation`.
	CfnEIPAssociation(Construct scope, java.lang.String id, CfnEIPAssociationProps props) Create a new `AWS::EC2::EIPAssociation`.
protected	CfnEIPAssociation(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnEIPAssociation(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAllocationId() [EC2-VPC] The allocation ID.
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.String	getEip() [EC2-Classic] The Elastic IP address to associate with the instance.
java.lang.String	getInstanceId() The ID of the instance.
java.lang.String	getNetworkInterfaceId() [EC2-VPC] The ID of the network interface.
java.lang.String	getPrivateIpAddress() [EC2-VPC] The primary or secondary private IP address to associate with the Elastic IP address.
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	setAllocationId(java.lang.String value) [EC2-VPC] The allocation ID.
void	setEip(java.lang.String value) [EC2-Classic] The Elastic IP address to associate with the instance.
void	setInstanceId(java.lang.String value) The ID of the instance.
void	setNetworkInterfaceId(java.lang.String value) [EC2-VPC] The ID of the network interface.
void	setPrivateIpAddress(java.lang.String value) [EC2-VPC] The primary or secondary private IP address to associate with the Elastic IP address.

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

CfnEIPAssociation

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

CfnEIPAssociation

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

CfnEIPAssociation

public CfnEIPAssociation(Construct scope,
                         java.lang.String id,
                         CfnEIPAssociationProps props)

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

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.

CfnEIPAssociation

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

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

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.

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getAllocationId

public java.lang.String getAllocationId()

[EC2-VPC] The allocation ID.

This is required for EC2-VPC.

setAllocationId

public void setAllocationId(java.lang.String value)

[EC2-VPC] The allocation ID.

This is required for EC2-VPC.

getEip

public java.lang.String getEip()

[EC2-Classic] The Elastic IP address to associate with the instance.

This is required for EC2-Classic.

setEip

public void setEip(java.lang.String value)

[EC2-Classic] The Elastic IP address to associate with the instance.

This is required for EC2-Classic.

getInstanceId

public java.lang.String getInstanceId()

The ID of the instance.

The instance must have exactly one attached network interface. For EC2-VPC, you can specify either the instance ID or the network interface ID, but not both. For EC2-Classic, you must specify an instance ID and the instance must be in the running state.

setInstanceId

public void setInstanceId(java.lang.String value)

The ID of the instance.

The instance must have exactly one attached network interface. For EC2-VPC, you can specify either the instance ID or the network interface ID, but not both. For EC2-Classic, you must specify an instance ID and the instance must be in the running state.

getNetworkInterfaceId

public java.lang.String getNetworkInterfaceId()

[EC2-VPC] The ID of the network interface.

If the instance has more than one network interface, you must specify a network interface ID.

For EC2-VPC, you can specify either the instance ID or the network interface ID, but not both.

setNetworkInterfaceId

public void setNetworkInterfaceId(java.lang.String value)

[EC2-VPC] The ID of the network interface.

If the instance has more than one network interface, you must specify a network interface ID.

For EC2-VPC, you can specify either the instance ID or the network interface ID, but not both.

getPrivateIpAddress

public java.lang.String getPrivateIpAddress()

[EC2-VPC] The primary or secondary private IP address to associate with the Elastic IP address.

If no private IP address is specified, the Elastic IP address is associated with the primary private IP address.

setPrivateIpAddress

public void setPrivateIpAddress(java.lang.String value)

[EC2-VPC] The primary or secondary private IP address to associate with the Elastic IP address.

If no private IP address is specified, the Elastic IP address is associated with the primary private IP address.