SitePair

• Implements: ISitePair

This class encapsulates and extends the ROS resource type ALIYUN::HDR::SitePair.

Initializers

import ros_cdk_hdr
ros_cdk_hdr.SitePair(
  scope: Construct,
  id: str,
  primary_site_name: typing.Union[str, IResolvable],
  primary_site_region_id: typing.Union[str, IResolvable],
  primary_site_type: typing.Union[str, IResolvable],
  primary_site_vpc_id: typing.Union[str, IResolvable],
  secondary_site_name: typing.Union[str, IResolvable],
  secondary_site_region_id: typing.Union[str, IResolvable],
  secondary_site_type: typing.Union[str, IResolvable],
  secondary_site_vpc_id: typing.Union[str, IResolvable],
  primary_site_zone_id: typing.Union[str, IResolvable] = None,
  secondary_site_zone_id: typing.Union[str, IResolvable] = None,
  site_pair_type: typing.Union[str, IResolvable] = None,
  enable_resource_property_constraint: bool = None
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

primary_site_name^Required

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

Property primarySiteName: The name of the primary site.

primary_site_region_id^Required

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

Property primarySiteRegionId: The region ID of the primary site.

primary_site_type^Required

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

Property primarySiteType: The type of the primary site.

primary_site_vpc_id^Required

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

Property primarySiteVpcId: The VPC ID of the primary site.

secondary_site_name^Required

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

Property secondarySiteName: The name of the secondary site.

secondary_site_region_id^Required

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

Property secondarySiteRegionId: The region ID of the secondary site.

secondary_site_type^Required

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

Property secondarySiteType: The type of the secondary site.

secondary_site_vpc_id^Required

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

Property secondarySiteVpcId: The VPC ID of the secondary site.

primary_site_zone_id^Optional

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

Property primarySiteZoneId: The zone ID of the primary site.

This parameter is valid only when the site pair type is cross-zone disaster recovery.

secondary_site_zone_id^Optional

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

Property secondarySiteZoneId: The zone ID of the secondary site.

This parameter is valid only when the site pair type is cross-zone disaster recovery.

site_pair_type^Optional

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

Property sitePairType: The type of the site pair.

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_hdr
ros_cdk_hdr.SitePair.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_primary_site_id^Required

attr_primary_site_id: typing.Union[str, IResolvable]

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

Attribute PrimarySiteId: The ID of the primary site.

attr_secondary_site_id^Required

attr_secondary_site_id: typing.Union[str, IResolvable]

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

Attribute SecondarySiteId: The ID of the secondary site.

attr_site_pair_id^Required

attr_site_pair_id: typing.Union[str, IResolvable]

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

Attribute SitePairId: The ID of the site pair.

props^Required

props: SitePairProps

• Type: SitePairProps

Structs