Skip to content

OriginPool

This class encapsulates and extends the ROS resource type ALIYUN::ESA::OriginPool.

Initializers

import ros_cdk_esa
ros_cdk_esa.OriginPool(
  scope: Construct,
  id: str,
  origin_pool_name: typing.Union[str, IResolvable],
  site_id: typing.Union[typing.Union[int, float], IResolvable],
  enabled: typing.Union[bool, IResolvable] = None,
  origins: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, OriginsProperty]]] = None,
  enable_resource_property_constraint: bool = None
)
Name Type Description
scope ros_cdk_core.Construct No description.
id str No description.
origin_pool_name typing.Union[str, ros_cdk_core.IResolvable] Property originPoolName: The source address pool name.
site_id typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property siteId: The site ID.
enabled typing.Union[bool, ros_cdk_core.IResolvable] Property enabled: Whether the source address pool is enabled: - true: Enabled;
origins typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, OriginsProperty]]] Property origins: The Source station information added to the source address pool.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

origin_pool_nameRequired

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

Property originPoolName: The source address pool name.


site_idRequired

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

Property siteId: The site ID.


enabledOptional

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

Property enabled: Whether the source address pool is enabled: - true: Enabled;

  • false: Not enabled.

originsOptional

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

Property origins: The Source station information added to the source address pool.

Multiple Source stations use arrays to transfer values.


enable_resource_property_constraintOptional

  • Type: bool

Methods

Name Description
to_string Returns a string representation of this construct.
synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
add_condition No description.
add_count No description.
add_dependency No description.
add_resource_desc No description.
apply_removal_policy No description.
fetch_condition No description.
fetch_dependency No description.
fetch_resource_desc No description.
get_att No description.
set_metadata No description.

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.

sessionRequired

  • Type: ros_cdk_core.ISynthesisSession

The synthesis session.


add_condition

def add_condition(
  condition: RosCondition
) -> None

conditionRequired

  • Type: ros_cdk_core.RosCondition

add_count

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

countRequired

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

add_dependency

def add_dependency(
  resource: Resource
) -> None

resourceRequired

  • Type: ros_cdk_core.Resource

add_resource_desc

def add_resource_desc(
  desc: str
) -> None

descRequired

  • Type: str

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policyRequired

  • 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

nameRequired

  • Type: str

set_metadata

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

keyRequired

  • Type: str

valueRequired

  • Type: typing.Any

Static Functions

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

is_construct

import ros_cdk_esa
ros_cdk_esa.OriginPool.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

xRequired

  • Type: typing.Any

Properties

Name Type Description
node ros_cdk_core.ConstructNode The construct tree node associated with this construct.
env ros_cdk_core.IResourceEnvironment The environment this resource belongs to.
ref str No description.
stack ros_cdk_core.Stack The stack in which this resource is defined.
resource ros_cdk_core.RosResource No description.
attr_enabled typing.Union[str, ros_cdk_core.IResolvable] Attribute Enabled: Whether the source address pool is enabled:.
attr_origin_pool_id typing.Union[str, ros_cdk_core.IResolvable] Attribute OriginPoolId: OriginPool Id.
attr_origin_pool_name typing.Union[str, ros_cdk_core.IResolvable] Attribute OriginPoolName: The source address pool name.
attr_origins typing.Union[str, ros_cdk_core.IResolvable] Attribute Origins: The Source station information added to the source address pool.
attr_record_name typing.Union[str, ros_cdk_core.IResolvable] Attribute RecordName: The domain name assigned to the source address pool can be used as the source address recorded under the site.
attr_reference_lb_count typing.Union[str, ros_cdk_core.IResolvable] Attribute ReferenceLBCount: How many load balancers are referenced.
attr_references typing.Union[str, ros_cdk_core.IResolvable] Attribute References: The source address pool is referred to when the source address pool is configured by the load balancer or recorded as the source station.
attr_site_id typing.Union[str, ros_cdk_core.IResolvable] Attribute SiteId: The site ID.
props OriginPoolProps No description.

nodeRequired

node: ConstructNode
  • Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.


envRequired

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.


refRequired

ref: str
  • Type: str

stackRequired

stack: Stack
  • Type: ros_cdk_core.Stack

The stack in which this resource is defined.


resourceOptional

resource: RosResource
  • Type: ros_cdk_core.RosResource

attr_enabledRequired

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

Attribute Enabled: Whether the source address pool is enabled:.


attr_origin_pool_idRequired

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

Attribute OriginPoolId: OriginPool Id.


attr_origin_pool_nameRequired

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

Attribute OriginPoolName: The source address pool name.


attr_originsRequired

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

Attribute Origins: The Source station information added to the source address pool.

Multiple Source stations use arrays to transfer values.


attr_record_nameRequired

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

Attribute RecordName: The domain name assigned to the source address pool can be used as the source address recorded under the site.


attr_reference_lb_countRequired

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

Attribute ReferenceLBCount: How many load balancers are referenced.


attr_referencesRequired

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

Attribute References: The source address pool is referred to when the source address pool is configured by the load balancer or recorded as the source station.


attr_site_idRequired

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

Attribute SiteId: The site ID.


propsRequired

props: OriginPoolProps