Package software.amazon.awscdk.services.ec2

Class CfnEIP

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.CfnEIP
All Implemented Interfaces:
IEnvironmentAware, IInspectable, ITaggable, IEIPRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)", date="2025-11-10T13:40:02.864Z") @Stability(Stable) public class CfnEIP extends CfnResource implements IInspectable, IEIPRef, ITaggable
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 .

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

Example: 

 Listener listener;
 CfnEIP eip;
 listener.addEndpointGroup("Group", EndpointGroupOptions.builder()
         .endpoints(List.of(
             CfnEipEndpoint.Builder.create(eip)
                     .weight(128)
                     .build()))
         .build());

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnEIP

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

    • CfnEIP

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

    • CfnEIP

      @Stability(Stable) public CfnEIP(@NotNull software.constructs.Construct scope, @NotNull String id, @Nullable CfnEIPProps 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.

    • CfnEIP

      @Stability(Stable) public CfnEIP(@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

      @Stability(Stable) public void inspect(@NotNull 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

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrAllocationId

      @Stability(Stable) @NotNull public 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

      @Stability(Stable) @NotNull public String getAttrPublicIp()
      The Elastic IP address.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getEipRef

      @Stability(Stable) @NotNull public EIPReference getEipRef()
      A reference to a EIP resource.
      Specified by:
      getEipRef in interface IEIPRef

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getAddress

      @Stability(Stable) @Nullable public String getAddress()
      An Elastic IP address or a carrier IP address in a Wavelength Zone.

    • setAddress

      @Stability(Stable) public void setAddress(@Nullable String value)
      An Elastic IP address or a carrier IP address in a Wavelength Zone.

    • getDomain

      @Stability(Stable) @Nullable public String getDomain()
      The network ( vpc ).

    • setDomain

      @Stability(Stable) public void setDomain(@Nullable String value)
      The network ( vpc ).

    • getInstanceId

      @Stability(Stable) @Nullable public String getInstanceId()
      The ID of the instance.

    • setInstanceId

      @Stability(Stable) public void setInstanceId(@Nullable String value)
      The ID of the instance.

    • getIpamPoolId

      @Stability(Stable) @Nullable public String getIpamPoolId()
      The ID of an IPAM pool which has an Amazon-provided or BYOIP public IPv4 CIDR provisioned to it.

    • setIpamPoolId

      @Stability(Stable) public void setIpamPoolId(@Nullable String value)
      The ID of an IPAM pool which has an Amazon-provided or BYOIP public IPv4 CIDR provisioned to it.

    • getNetworkBorderGroup

      @Stability(Stable) @Nullable public String getNetworkBorderGroup()
      A unique set of Availability Zones, Local Zones, or Wavelength Zones from which AWS advertises IP addresses.

    • setNetworkBorderGroup

      @Stability(Stable) public void setNetworkBorderGroup(@Nullable String value)
      A unique set of Availability Zones, Local Zones, or Wavelength Zones from which AWS advertises IP addresses.

    • getPublicIpv4Pool

      @Stability(Stable) @Nullable public String getPublicIpv4Pool()
      The ID of an address pool that you own.

    • setPublicIpv4Pool

      @Stability(Stable) public void setPublicIpv4Pool(@Nullable String value)
      The ID of an address pool that you own.

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      Any tags assigned to the Elastic IP address.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      Any tags assigned to the Elastic IP address.

    • getTransferAddress

      @Stability(Stable) @Nullable public String getTransferAddress()
      The Elastic IP address you are accepting for transfer.

    • setTransferAddress

      @Stability(Stable) public void setTransferAddress(@Nullable String value)
      The Elastic IP address you are accepting for transfer.