Skip to content

Gateway

This class encapsulates and extends the ROS resource type ALIYUN::MSE::Gateway.

Initializers

import ros_cdk_mse
ros_cdk_mse.Gateway(
  scope: Construct,
  id: str,
  replica: typing.Union[typing.Union[int, float], IResolvable],
  spec: typing.Union[str, IResolvable],
  vpc_id: typing.Union[str, IResolvable],
  v_switch_id: typing.Union[str, IResolvable],
  backup_v_switch_id: typing.Union[str, IResolvable] = None,
  enterprise_security_group: typing.Union[str, IResolvable] = None,
  internet_slb_spec: typing.Union[str, IResolvable] = None,
  name: typing.Union[str, IResolvable] = None,
  slb_spec: typing.Union[str, IResolvable] = None,
  enable_resource_property_constraint: bool = None
)
Name Type Description
scope ros_cdk_core.Construct No description.
id str No description.
replica typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property replica: Gateway Node Number.
spec typing.Union[str, ros_cdk_core.IResolvable] Property spec: Gateway Node Specifications.
vpc_id typing.Union[str, ros_cdk_core.IResolvable] Property vpcId: VpcId.
v_switch_id typing.Union[str, ros_cdk_core.IResolvable] Property vSwitchId: VSwitchId.
backup_v_switch_id typing.Union[str, ros_cdk_core.IResolvable] Property backupVSwitchId: VSwitchId For Backup.
enterprise_security_group typing.Union[str, ros_cdk_core.IResolvable] Property enterpriseSecurityGroup:.
internet_slb_spec typing.Union[str, ros_cdk_core.IResolvable] Property internetSlbSpec:.
name typing.Union[str, ros_cdk_core.IResolvable] Property name:.
slb_spec typing.Union[str, ros_cdk_core.IResolvable] Property slbSpec:.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

replicaRequired

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

Property replica: Gateway Node Number.


specRequired

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

Property spec: Gateway Node Specifications.


vpc_idRequired

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

Property vpcId: VpcId.


v_switch_idRequired

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

Property vSwitchId: VSwitchId.


backup_v_switch_idOptional

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

Property backupVSwitchId: VSwitchId For Backup.


enterprise_security_groupOptional

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

Property enterpriseSecurityGroup:.


internet_slb_specOptional

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

Property internetSlbSpec:.


nameOptional

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

Property name:.


slb_specOptional

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

Property slbSpec:.


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_mse
ros_cdk_mse.Gateway.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_backup_v_switch_id typing.Union[str, ros_cdk_core.IResolvable] Attribute BackupVSwitchId: VSwitchId For Backup.
attr_gateway_unique_id typing.Union[str, ros_cdk_core.IResolvable] Attribute GatewayUniqueId: Gateway unique identification.
attr_payment_type typing.Union[str, ros_cdk_core.IResolvable] Attribute PaymentType: The payment type of the resource.
attr_replica typing.Union[str, ros_cdk_core.IResolvable] Attribute Replica: Gateway Node Number.
attr_spec typing.Union[str, ros_cdk_core.IResolvable] Attribute Spec: Gateway Node Specifications.
attr_vpc_id typing.Union[str, ros_cdk_core.IResolvable] Attribute VpcId: VpcId.
attr_v_switch_id typing.Union[str, ros_cdk_core.IResolvable] Attribute VSwitchId: VSwitchId.
props GatewayProps 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_backup_v_switch_idRequired

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

Attribute BackupVSwitchId: VSwitchId For Backup.


attr_gateway_unique_idRequired

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

Attribute GatewayUniqueId: Gateway unique identification.


attr_payment_typeRequired

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

Attribute PaymentType: The payment type of the resource.


attr_replicaRequired

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

Attribute Replica: Gateway Node Number.


attr_specRequired

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

Attribute Spec: Gateway Node Specifications.


attr_vpc_idRequired

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

Attribute VpcId: VpcId.


attr_v_switch_idRequired

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

Attribute VSwitchId: VSwitchId.


propsRequired

props: GatewayProps