Skip to content

Addresses

This class encapsulates and extends the ROS resource type DATASOURCE::EIP::Addresses, which is used to query the information about elastic IP addresses (EIPs).

Initializers 

import com.aliyun.ros.cdk.vpc.datasource.Addresses;
Addresses.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
//  .addressName(java.lang.String)
//  .addressName(IResolvable)
//  .allocationId(java.lang.String)
//  .allocationId(IResolvable)
//  .instanceId(java.lang.String)
//  .instanceId(IResolvable)
//  .instanceType(java.lang.String)
//  .instanceType(IResolvable)
//  .ipAddress(java.lang.String)
//  .ipAddress(IResolvable)
//  .isp(java.lang.String)
//  .isp(IResolvable)
//  .paymentType(java.lang.String)
//  .paymentType(IResolvable)
//  .refreshOptions(java.lang.String)
//  .refreshOptions(IResolvable)
//  .resourceGroupId(java.lang.String)
//  .resourceGroupId(IResolvable)
//  .segmentInstanceId(java.lang.String)
//  .segmentInstanceId(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.
addressName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property addressName: The name of the EIP.
allocationId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property allocationId: The ID of the EIP that you want to query.
instanceId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property instanceId: The ID of the cloud resource.
instanceType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property instanceType: The type of the current bound instance.
ipAddress java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property ipAddress: The IP address pool to which the EIP that you want to query belongs.
isp java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property isp: The line type.
paymentType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property paymentType: The billing method of the EIP.
refreshOptions java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.
resourceGroupId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property resourceGroupId: The ID of the resource group to which the EIPs belong.
segmentInstanceId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property segmentInstanceId: The ID of the consecutive EIPs.

scopeRequired

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

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

addressNameOptional

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

Property addressName: The name of the EIP.

allocationIdOptional

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

Property allocationId: The ID of the EIP that you want to query.

instanceIdOptional

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

Property instanceId: The ID of the cloud resource.

instanceTypeOptional

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

Property instanceType: The type of the current bound instance.

  • EcsInstance: an ECS instance of the VPC type.
  • SlbInstance: an SLB instance of the VPC type.
  • Nat:NAT gateway.
  • HaVip: a highly available virtual IP address.
  • NetworkInterface: Secondary ENI.

ipAddressOptional

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

Property ipAddress: The IP address pool to which the EIP that you want to query belongs.

ispOptional

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

Property isp: The line type.

Valid values: BGP (default): BGP (Multi-ISP) lines. All regions support BGP (Multi-ISP) EIPs. BGP_PRO: BGP (Multi-ISP) Pro lines. Only the following regions support BGP (Multi-ISP) Pro lines: China (Hong Kong), Singapore, Malaysia (Kuala Lumpur), Philippines (Manila), Indonesia (Jakarta), and Thailand (Bangkok). For more information about BGP (Multi-ISP) and BGP (Multi-ISP) Pro, see EIP line types. If you are allowed to use single-ISP bandwidth, you can also choose one of the following values: ChinaTelecom: China Telecom ChinaUnicom: China Unicom ChinaMobile: China Mobile ChinaTelecom_L2: China Telecom L2 ChinaUnicom_L2: China Unicom L2 ChinaMobile_L2: China Mobile L2 If your services are deployed in China East 1 Finance, you must set this parameter to BGP_FinanceCloud.

paymentTypeOptional

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

Property paymentType: The billing method of the EIP.

Valid values: PrePaid: subscription PostPaid: pay-as-you-go.

refreshOptionsOptional

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

Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.

Valid values:

  • Never: Never refresh the datasource resource when the stack is updated.
  • Always: Always refresh the datasource resource when the stack is updated. Default is Never.

resourceGroupIdOptional

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

Property resourceGroupId: The ID of the resource group to which the EIPs belong.

segmentInstanceIdOptional

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

Property segmentInstanceId: The ID of the consecutive EIPs.

This parameter value is returned only if the EIP is a continuous EIP.

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.datasource.Addresses;
Addresses.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.
attrAddresses com.aliyun.ros.cdk.core.IResolvable Attribute Addresses: The details about the EIP.
attrAllocationIds com.aliyun.ros.cdk.core.IResolvable Attribute AllocationIds: The list of allocation IDs.

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

attrAddressesRequired 

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

Attribute Addresses: The details about the EIP.

attrAllocationIdsRequired 

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

Attribute AllocationIds: The list of allocation IDs.