AddressPool

• Implements: IAddressPool

This class encapsulates and extends the ROS resource type ALIYUN::DNS::AddressPool.

Initializers

import ros_cdk_dns
ros_cdk_dns.AddressPool(
  scope: Construct,
  id: str,
  addr: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, AddrProperty]]],
  instance_id: typing.Union[str, IResolvable],
  lba_strategy: typing.Union[str, IResolvable],
  name: typing.Union[str, IResolvable],
  type: typing.Union[str, IResolvable],
  evaluation_count: typing.Union[typing.Union[int, float], IResolvable] = None,
  interval: typing.Union[typing.Union[int, float], IResolvable] = None,
  isp_city_node: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, IspCityNodeProperty]]] = None,
  monitor_extend_info: typing.Union[IResolvable, typing.Mapping[typing.Any]] = None,
  monitor_status: typing.Union[str, IResolvable] = None,
  protocol_type: typing.Union[str, IResolvable] = None,
  timeout: typing.Union[typing.Union[int, float], IResolvable] = None,
  enable_resource_property_constraint: bool = None
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

addr^Required

• Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, AddrProperty]]]

Property addr: The list of addresses in the address pool.

instance_id^Required

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property instanceId: The ID of the GTM instance.

lba_strategy^Required

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property lbaStrategy: The load balancing policy.

Valid values:

• ALL_RR: returns all addresses.
• RATIO: returns addresses by weight.

name^Required

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property name: The name of the address pool.

type^Required

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property type: The type of the address pool.

Valid values:

• IPV4: IPv4 address
• IPV6: IPv6 address
• DOMAIN: domain name

evaluation_count^Optional

• Type: typing.Union[typing.Union[int, float], 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^Optional

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

Property interval: The interval between two consecutive health checks, in seconds.

isp_city_node^Optional

• Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, IspCityNodeProperty]]]

Property ispCityNode: The list of ISP city nodes.

monitor_extend_info^Optional

• Type: typing.Union[ros_cdk_core.IResolvable, typing.Mapping[typing.Any]]

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

monitor_status^Optional

• Type: typing.Union[str, 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

protocol_type^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property protocolType: The protocol type.

timeout^Optional

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

Property timeout: The timeout period of a health check, in seconds.

enable_resource_property_constraint^Optional

• Type: bool

Methods

to_string

def to_string() -> str

Returns a string representation of this construct.

synthesize

def synthesize(
  session: ISynthesisSession
) -> None

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.

session^Required

• Type: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition

def add_condition(
  condition: RosCondition
) -> None

condition^Required

• Type: ros_cdk_core.RosCondition

add_count

def add_count(
  count: typing.Union[typing.Union[int, float], IResolvable]
) -> None

count^Required

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

add_dependency

def add_dependency(
  resource: Resource
) -> None

resource^Required

• Type: ros_cdk_core.Resource

add_resource_desc

def add_resource_desc(
  desc: str
) -> None

desc^Required

• Type: str

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policy^Required

• Type: ros_cdk_core.RemovalPolicy

fetch_condition

def fetch_condition() -> RosCondition

fetch_dependency

def fetch_dependency() -> typing.List[str]

fetch_resource_desc

def fetch_resource_desc() -> str

get_att

def get_att(
  name: str
) -> IResolvable

name^Required

• Type: str

set_metadata

def set_metadata(
  key: str,
  value: typing.Any
) -> None

key^Required

• Type: str

value^Required

• Type: typing.Any

Static Functions

is_construct

import ros_cdk_dns
ros_cdk_dns.AddressPool.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

x^Required

• Type: typing.Any

Properties

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

env^Required

env: IResourceEnvironment

• Type: 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.

ref^Required

ref: str

• Type: str

stack^Required

stack: Stack

• Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resource^Optional

resource: RosResource

• Type: ros_cdk_core.RosResource

attr_addr_pool_id^Required

attr_addr_pool_id: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute AddrPoolId: The ID of the address pool.

props^Required

props: AddressPoolProps

• Type: AddressPoolProps