Class CfnEIPAssociation
java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.ec2.CfnEIPAssociation
- All Implemented Interfaces:
IInspectable
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
,software.constructs.IDependable
@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
date="2024-10-04T00:39:30.862Z")
@Stability(Stable)
public class CfnEIPAssociation
extends CfnResource
implements IInspectable
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 .
You must specify AllocationId
and either InstanceId
, NetworkInterfaceId
, or PrivateIpAddress
.
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();
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ModifierConstructorDescriptionprotected
CfnEIPAssociation
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnEIPAssociation
(software.amazon.jsii.JsiiObjectRef objRef) CfnEIPAssociation
(software.constructs.Construct scope, String id) CfnEIPAssociation
(software.constructs.Construct scope, String id, CfnEIPAssociationProps props) -
Method Summary
Modifier and TypeMethodDescriptionThe allocation ID.The ID of the association.getEip()
Deprecated.this property has been deprecatedThe ID of the instance.The ID of the network interface.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.renderProperties
(Map<String, Object> props) void
setAllocationId
(String value) The allocation ID.void
Deprecated.this property has been deprecatedvoid
setInstanceId
(String value) The ID of the instance.void
setNetworkInterfaceId
(String value) The ID of the network interface.void
setPrivateIpAddress
(String value) The primary or secondary private IP address to associate with the Elastic IP address.Methods inherited from class software.amazon.awscdk.CfnResource
addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties
Methods inherited from class software.amazon.awscdk.CfnRefElement
getRef
Methods inherited from class software.amazon.awscdk.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
Methods inherited from class software.constructs.Construct
getNode, isConstruct
Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Field Details
-
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
-
-
Constructor Details
-
CfnEIPAssociation
protected CfnEIPAssociation(software.amazon.jsii.JsiiObjectRef objRef) -
CfnEIPAssociation
protected CfnEIPAssociation(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
CfnEIPAssociation
@Stability(Stable) public CfnEIPAssociation(@NotNull software.constructs.Construct scope, @NotNull String id, @Nullable CfnEIPAssociationProps props) - Parameters:
scope
- Scope in which this resource is defined. This parameter is required.id
- Construct identifier for this resource (unique in its scope). This parameter is required.props
- Resource properties.
-
CfnEIPAssociation
@Stability(Stable) public CfnEIPAssociation(@NotNull software.constructs.Construct scope, @NotNull String id) - Parameters:
scope
- Scope in which this resource is defined. This parameter is required.id
- Construct identifier for this resource (unique in its scope). This parameter is required.
-
-
Method Details
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- Parameters:
inspector
- tree inspector to collect and process attributes. This parameter is required.
-
renderProperties
@Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String, Object> props) - Overrides:
renderProperties
in classCfnResource
- Parameters:
props
- This parameter is required.
-
getAttrId
The ID of the association. -
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getAllocationId
The allocation ID. -
setAllocationId
The allocation ID. -
getEip
Deprecated.this property has been deprecated -
setEip
Deprecated.this property has been deprecated -
getInstanceId
The ID of the instance. -
setInstanceId
The ID of the instance. -
getNetworkInterfaceId
The ID of the network interface. -
setNetworkInterfaceId
The ID of the network interface. -
getPrivateIpAddress
The primary or secondary private IP address to associate with the Elastic IP address. -
setPrivateIpAddress
The primary or secondary private IP address to associate with the Elastic IP address.
-