Skip to content

Eip

This class encapsulates and extends the ROS resource type ALIYUN::VPC::EIP, which is used to apply for an elastic IP address (EIP).

Initializers 

import com.aliyun.ros.cdk.vpc.Eip;
Eip.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
//  .autoPay(java.lang.Boolean)
//  .autoPay(IResolvable)
//  .bandwidth(java.lang.Number)
//  .bandwidth(IResolvable)
//  .deletionProtection(java.lang.Boolean)
//  .deletionProtection(IResolvable)
//  .description(java.lang.String)
//  .description(IResolvable)
//  .instanceChargeType(java.lang.String)
//  .instanceChargeType(IResolvable)
//  .internetChargeType(java.lang.String)
//  .internetChargeType(IResolvable)
//  .isp(java.lang.String)
//  .isp(IResolvable)
//  .name(java.lang.String)
//  .name(IResolvable)
//  .netmode(java.lang.String)
//  .netmode(IResolvable)
//  .period(java.lang.Number)
//  .period(IResolvable)
//  .pricingCycle(java.lang.String)
//  .pricingCycle(IResolvable)
//  .publicIpAddressPoolId(java.lang.String)
//  .publicIpAddressPoolId(IResolvable)
//  .resourceGroupId(java.lang.String)
//  .resourceGroupId(IResolvable)
//  .securityProtectionTypes(IResolvable)
//  .securityProtectionTypes(java.util.List<java.lang.String)
//  .securityProtectionTypes(IResolvable>)
//  .tags(java.util.List<TagsProperty>)
//  .zone(java.lang.String)
//  .zone(IResolvable)
    .build();
Name Type Description
scope com.aliyun.ros.cdk.core.Construct No description.
id java.lang.String No description.
enableResourcePropertyConstraint java.lang.Boolean No description.
autoPay java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property autoPay: Automatic Payment.
bandwidth java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property bandwidth: Bandwidth for the output network.
deletionProtection java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property deletionProtection: Whether to enable deletion protection.
description java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property description: Optional.
instanceChargeType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property instanceChargeType: The resource charge type.
internetChargeType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property internetChargeType: The network charge type.
isp java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property isp: The line type.
name java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property name: The name of the EIP.
netmode java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property netmode: The network type.
period java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property period: Prepaid time period.
pricingCycle java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property pricingCycle: Price cycle of the resource.
publicIpAddressPoolId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property publicIpAddressPoolId: The ID of the IP address pool.
resourceGroupId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property resourceGroupId: Resource group id.
securityProtectionTypes com.aliyun.ros.cdk.core.IResolvable OR java.util.List Property securityProtectionTypes: The edition of Anti-DDoS.
tags java.util.List<TagsProperty> Property tags: Tags to attach to eip.
zone java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property zone: Availability zone of the elastic public network IP.

scopeRequired

  • Type: com.aliyun.ros.cdk.core.Construct

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

autoPayOptional

  • Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

Property autoPay: Automatic Payment.

Default is true.

bandwidthOptional

  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property bandwidth: Bandwidth for the output network.

Default is 5MB.

deletionProtectionOptional

  • Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

Property deletionProtection: Whether to enable deletion protection.

Default to False.

descriptionOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property description: Optional.

The description of the EIP. The description must be 2 to 256 characters in length. It must start with a letter. It cannot start with http:// or https://.

instanceChargeTypeOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property instanceChargeType: The resource charge type.

Default value is Postpaid

internetChargeTypeOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property internetChargeType: The network charge type.

Support 'PayByBandwidth' and 'PayByTraffic' only. Default is PayByBandwidth. PayByTraffic will charge by hour, PayByBandwidth will charge by day.

ispOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property isp: The line type.

You can set this parameter only when you create a pay-as-you-go EIP. Valid values: BGP: BGP (Multi-ISP) lines. Up to 89 high-quality BGP lines are available worldwide. Direct connections with multiple Internet Service Providers (ISPs), including Telecom, Unicom, Mobile, Railcom, Netcom, CERNET, China Broadcast Network, Dr. Peng, and Founder, can be established in all regions in mainland China. BGP_PRO: BGP (Multi-ISP) Pro lines. BGP (Multi-ISP) Pro lines optimize data transmission to China and improve connection quality for international services. Compared with traditional BGP (Multi-ISP) lines, BGP (Multi-ISP) Pro lines can be used to establish direct connections without using international ISP services. Therefore, BGP (Multi-ISP) Pro lines reduce network latency.

nameOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property name: The name of the EIP.

The name must be 2 to 128 characters in length. It must start with a letter. It can contain numbers, periods (.), underscores (_), and hyphens (-). It cannot start with http:// or https://

netmodeOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property netmode: The network type.

Valid value: public (public network).

periodOptional

  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property period: Prepaid time period.

While choose by pay by month, it could be from 1 to 9 or 12, 24, 36. While choose pay by year, it could be from 1 to 3.

pricingCycleOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property pricingCycle: Price cycle of the resource.

This property has no default value. If ChargeType is specified as Postpaid, this value will be ignore.

publicIpAddressPoolIdOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property publicIpAddressPoolId: The ID of the IP address pool.

The EIP is allocated from the IP address pool.

resourceGroupIdOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property resourceGroupId: Resource group id.

securityProtectionTypesOptional

  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List

Property securityProtectionTypes: The edition of Anti-DDoS.

If you do not set this parameter, Anti-DDoS Origin Basic is used. If you set the value to AntiDDoS_Enhanced, Anti-DDoS Pro/Premium is used.

tagsOptional

Property tags: Tags to attach to eip.

Max support 20 tags to add during create eip. Each tag with two properties Key and Value, and Key is required.

zoneOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property zone: Availability zone of the elastic public network IP.

Methods

Name Description
toString Returns a string representation of this construct.
synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
addCondition No description.
addCount No description.
addDependency No description.
addResourceDesc No description.
applyRemovalPolicy No description.
getAtt No description.
setMetadata No description.

toString 

public java.lang.String toString()

Returns a string representation of this construct.

synthesize 

public void synthesize(ISynthesisSession session)

Allows this construct to emit artifacts into the cloud assembly during synthesis.

This method is usually implemented by framework-level constructs such as Stack and Asset as they participate in synthesizing the cloud assembly.

sessionRequired

  • Type: com.aliyun.ros.cdk.core.ISynthesisSession

The synthesis session.

addCondition 

public void addCondition(RosCondition condition)

conditionRequired

  • Type: com.aliyun.ros.cdk.core.RosCondition

addCount 

public void addCount(java.lang.Number OR IResolvable count)

countRequired

  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

addDependency 

public void addDependency(Resource resource)

resourceRequired

  • Type: com.aliyun.ros.cdk.core.Resource

addResourceDesc 

public void addResourceDesc(java.lang.String desc)

descRequired

  • Type: java.lang.String

applyRemovalPolicy 

public void applyRemovalPolicy(RemovalPolicy policy)

policyRequired

  • Type: com.aliyun.ros.cdk.core.RemovalPolicy

getAtt 

public IResolvable getAtt(java.lang.String name)

nameRequired

  • Type: java.lang.String

setMetadata 

public void setMetadata(java.lang.String key, java.lang.Object value)

keyRequired

  • Type: java.lang.String

valueRequired

  • Type: java.lang.Object

Static Functions

Name Description
isConstruct Return whether the given object is a Construct.

isConstruct 

import com.aliyun.ros.cdk.vpc.Eip;
Eip.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

xRequired

  • Type: java.lang.Object

Properties

Name Type Description
node com.aliyun.ros.cdk.core.ConstructNode The construct tree node associated with this construct.
ref java.lang.String No description.
stack com.aliyun.ros.cdk.core.Stack The stack in which this resource is defined.
resource com.aliyun.ros.cdk.core.RosResource No description.
attrAllocationId com.aliyun.ros.cdk.core.IResolvable Attribute AllocationId: ID that Aliyun assigns to represent the allocation of the address for use with VPC.
attrEipAddress com.aliyun.ros.cdk.core.IResolvable Attribute EipAddress: IP address of created EIP.
attrIsp com.aliyun.ros.cdk.core.IResolvable Attribute Isp: The line type.
attrOrderId com.aliyun.ros.cdk.core.IResolvable Attribute OrderId: Order ID of prepaid EIP instance.

nodeRequired 

public ConstructNode getNode();
  • Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.

refRequired 

public java.lang.String getRef();
  • Type: java.lang.String

stackRequired 

public Stack getStack();
  • Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.

resourceOptional 

public RosResource getResource();
  • Type: com.aliyun.ros.cdk.core.RosResource

attrAllocationIdRequired 

public IResolvable getAttrAllocationId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute AllocationId: ID that Aliyun assigns to represent the allocation of the address for use with VPC.

Returned only for VPC elastic IP addresses.

attrEipAddressRequired 

public IResolvable getAttrEipAddress();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute EipAddress: IP address of created EIP.

attrIspRequired 

public IResolvable getAttrIsp();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute Isp: The line type.

attrOrderIdRequired 

public IResolvable getAttrOrderId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute OrderId: Order ID of prepaid EIP instance.