AddressPool
- Implements: IAddressPool
This class encapsulates and extends the ROS resource type ALIYUN::DNS::AddressPool.
Initializers
import com.aliyun.ros.cdk.dns.AddressPool;
AddressPool.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
.addr(IResolvable)
.addr(java.util.List<IResolvable)
.addr(AddrProperty>)
.instanceId(java.lang.String)
.instanceId(IResolvable)
.lbaStrategy(java.lang.String)
.lbaStrategy(IResolvable)
.name(java.lang.String)
.name(IResolvable)
.type(java.lang.String)
.type(IResolvable)
// .evaluationCount(java.lang.Number)
// .evaluationCount(IResolvable)
// .interval(java.lang.Number)
// .interval(IResolvable)
// .ispCityNode(IResolvable)
// .ispCityNode(java.util.List<IResolvable)
// .ispCityNode(IspCityNodeProperty>)
// .monitorExtendInfo(IResolvable)
// .monitorExtendInfo(java.util.Map<java.lang.String, java.lang.Object>)
// .monitorStatus(java.lang.String)
// .monitorStatus(IResolvable)
// .protocolType(java.lang.String)
// .protocolType(IResolvable)
// .timeout(java.lang.Number)
// .timeout(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. |
addr | com.aliyun.ros.cdk.core.IResolvable OR java.util.List | Property addr: The list of addresses in the address pool. |
instanceId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property instanceId: The ID of the GTM instance. |
lbaStrategy | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property lbaStrategy: The load balancing policy. |
name | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property name: The name of the address pool. |
type | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property type: The type of the address pool. |
evaluationCount | java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable | Property evaluationCount: The number of times that the system waits for a response from each address before it marks the address as unhealthy. |
interval | java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable | Property interval: The interval between two consecutive health checks, in seconds. |
ispCityNode | com.aliyun.ros.cdk.core.IResolvable OR java.util.List | Property ispCityNode: The list of ISP city nodes. |
monitorExtendInfo | com.aliyun.ros.cdk.core.IResolvable OR java.util.Map | Property monitorExtendInfo: The extended information. |
monitorStatus | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property monitorStatus: The status of the health check feature. |
protocolType | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property protocolType: The protocol type. |
timeout | java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable | Property timeout: The timeout period of a health check, in seconds. |
scopeRequired
- Type: com.aliyun.ros.cdk.core.Construct
idRequired
- Type: java.lang.String
enableResourcePropertyConstraintOptional
- Type: java.lang.Boolean
addrRequired
- Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List
AddrProperty>
Property addr: The list of addresses in the address pool.
instanceIdRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property instanceId: The ID of the GTM instance.
lbaStrategyRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property lbaStrategy: The load balancing policy.
Valid values:
- ALL_RR: returns all addresses.
- RATIO: returns addresses by weight.
nameRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property name: The name of the address pool.
typeRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property type: The type of the address pool.
Valid values:
- IPV4: IPv4 address
- IPV6: IPv6 address
- DOMAIN: domain name
evaluationCountOptional
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
Property evaluationCount: The number of times that the system waits for a response from each address before it marks the address as unhealthy.
intervalOptional
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
Property interval: The interval between two consecutive health checks, in seconds.
ispCityNodeOptional
- Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List
IspCityNodeProperty>
Property ispCityNode: The list of ISP city nodes.
monitorExtendInfoOptional
- Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.Map
Property monitorExtendInfo: The extended information.
This parameter is a JSON string. The required parameters vary based on the health check protocol:
- HTTP and HTTPS:
- port: The health check port.
- host: The host settings.
- path: The URL path.
- code: The return code. A response with a status code greater than this value is considered abnormal. Valid values: 400 and 500.
- failureRate: The failure rate.
- sni: Specifies whether to enable Server Name Indication (SNI). This parameter is available only for the HTTPS protocol.
- true: Enable SNI.
- Other values: Disable SNI.
- nodeType: The type of the health check node when the address pool type is DOMAIN. Valid values:
- IPV4
- IPV6
- PING:
- failureRate: The failure rate.
- packetNum: The number of ping packets.
- packetLossRate: The packet loss rate.
- nodeType: The type of the health check node when the address pool type is DOMAIN. Valid values:
- IPV4
- IPV6
- TCP:
- port: The health check port.
- failureRate: The failure rate.
- nodeType: The type of the health check node when the address pool type is DOMAIN. Valid values:
- IPV4
- IPV6
monitorStatusOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property monitorStatus: The status of the health check feature.
Default value: CLOSE. If you set this parameter to OPEN, the health check configuration is verified. Otherwise, the configuration is ignored.
- OPEN: enabled
- CLOSE: disabled
protocolTypeOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property protocolType: The protocol type.
timeoutOptional
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
Property timeout: The timeout period of a health check, in seconds.
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. |
fetchCondition | No description. |
fetchDependency | No description. |
fetchResourceDesc | 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.
- Type: com.aliyun.ros.cdk.core.ISynthesisSession
The synthesis session.
addCondition
public void addCondition(RosCondition condition)
- Type: com.aliyun.ros.cdk.core.RosCondition
addCount
public void addCount(java.lang.Number OR IResolvable count)
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
addDependency
public void addDependency(Resource resource)
- Type: com.aliyun.ros.cdk.core.Resource
addResourceDesc
public void addResourceDesc(java.lang.String desc)
- Type: java.lang.String
applyRemovalPolicy
public void applyRemovalPolicy(RemovalPolicy policy)
- Type: com.aliyun.ros.cdk.core.RemovalPolicy
fetchCondition
public RosCondition fetchCondition()
fetchDependency
public java.util.List<java.lang.String> fetchDependency()
fetchResourceDesc
public java.lang.String fetchResourceDesc()
getAtt
public IResolvable getAtt(java.lang.String name)
- Type: java.lang.String
setMetadata
public void setMetadata(java.lang.String key, java.lang.Object value)
- Type: java.lang.String
- Type: java.lang.Object
Static Functions
| Name | Description |
|---|---|
isConstruct | Return whether the given object is a Construct. |
isConstruct
import com.aliyun.ros.cdk.dns.AddressPool;
AddressPool.isConstruct(java.lang.Object x)
Return whether the given object is a Construct.
- Type: java.lang.Object
Properties
| Name | Type | Description |
|---|---|---|
node | com.aliyun.ros.cdk.core.ConstructNode | The construct tree node associated with this construct. |
env | com.aliyun.ros.cdk.core.IResourceEnvironment | The environment this resource belongs to. |
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. |
attrAddrPoolId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute AddrPoolId: The ID of the address pool. |
props | AddressPoolProps | No description. |
nodeRequired
public ConstructNode getNode();
- Type: com.aliyun.ros.cdk.core.ConstructNode
The construct tree node associated with this construct.
envRequired
public IResourceEnvironment getEnv();
- Type: com.aliyun.ros.cdk.core.IResourceEnvironment
The environment this resource belongs to.
For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.
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
attrAddrPoolIdRequired
public java.lang.Object getAttrAddrPoolId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute AddrPoolId: The ID of the address pool.
propsRequired
public AddressPoolProps getProps();
- Type: AddressPoolProps