FwSwitch
- Implements: IFwSwitch
This class encapsulates and extends the ROS resource type ALIYUN::CLOUDFW::FwSwitch.
Initializers
import ros_cdk_cloudfw
ros_cdk_cloudfw.FwSwitch(
scope: Construct,
id: str,
ipaddr_list: typing.Union[typing.List[typing.Any], IResolvable] = None,
ip_version: typing.Union[str, IResolvable] = None,
member_uid: typing.Union[str, IResolvable] = None,
region_list: typing.Union[typing.List[typing.Any], IResolvable] = None,
resource_type_list: typing.Union[typing.List[typing.Any], IResolvable] = None,
enable_resource_property_constraint: bool = None
)
| Name | Type | Description |
|---|---|---|
scope | ros_cdk_core.Construct | No description. |
id | str | No description. |
ipaddr_list | typing.Union[typing.List[typing.Any], ros_cdk_core.IResolvable] | Property ipaddrList: The IP address list. |
ip_version | typing.Union[str, ros_cdk_core.IResolvable] | Property ipVersion: The IP version number. |
member_uid | typing.Union[str, ros_cdk_core.IResolvable] | Property memberUid: The member unique identifier. |
region_list | typing.Union[typing.List[typing.Any], ros_cdk_core.IResolvable] | Property regionList: The region list. |
resource_type_list | typing.Union[typing.List[typing.Any], ros_cdk_core.IResolvable] | Property resourceTypeList: The list of asset types. |
enable_resource_property_constraint | bool | No description. |
scopeRequired
- Type: ros_cdk_core.Construct
idRequired
- Type: str
ipaddr_listOptional
- Type: typing.Union[typing.List[typing.Any], ros_cdk_core.IResolvable]
Property ipaddrList: The IP address list.
Note: The IpaddrList, RegionList, and ResourceTypeList arguments are not allowed to be empty at the same time. A value must be set for one of the three arguments.
ip_versionOptional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property ipVersion: The IP version number.
member_uidOptional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property memberUid: The member unique identifier.
region_listOptional
- Type: typing.Union[typing.List[typing.Any], ros_cdk_core.IResolvable]
Property regionList: The region list.
Note: The IpaddrList, RegionList, and ResourceTypeList arguments are not allowed to be empty at the same time. A value must be set for one of the three arguments.
resource_type_listOptional
- Type: typing.Union[typing.List[typing.Any], ros_cdk_core.IResolvable]
Property resourceTypeList: The list of asset types.
Valid values:
- BastionHostEgressIP: the egress IP address of a bastion host.
- BastionHostIngressIP: the ingress IP address of a bastion host.
- EcsEIP: the EIP of an ECS instance.
- EcsPublicIP: the public IP address of an ECS instance.
- EIP: an EIP.
- EniEIP: the EIP of an ENI.
- NatEIP: the EIP of a NAT gateway.
- SlbEIP: the EIP of an SLB instance or a CLB instance.
- SlbPublicIP: the public IP address of an SLB instance or a CLB instance.
- NatPublicIP: the public IP address of a NAT gateway.
- HAVIP: an HAVIP.
- NlbEIP: the EIP of an NLB instance.
- ApiGatewayEIP: the public IP address of an API gateway.
- AlbEIP: the EIP of an ALB instance.
- AiGatewayEIP: the public IP address of an AI gateway.
- GaEIP: the EIP of a GA instance.
- SwasEIP: the public IP address of a Simple Application Server instance.
- EcdEIP: the public IP address of an Elastic Desktop Service instance.
- BastionHostIP: the IP address of a bastion host.
You must specify at least one of the
IpaddrList,RegionList, andResourceTypeListparameters.
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.
- Type: ros_cdk_core.ISynthesisSession
The synthesis session.
add_condition
def add_condition(
condition: RosCondition
) -> None
- Type: ros_cdk_core.RosCondition
add_count
def add_count(
count: typing.Union[typing.Union[int, float], IResolvable]
) -> None
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
add_dependency
def add_dependency(
resource: Resource
) -> None
- Type: ros_cdk_core.Resource
add_resource_desc
def add_resource_desc(
desc: str
) -> None
- Type: str
apply_removal_policy
def apply_removal_policy(
policy: RemovalPolicy
) -> None
- 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
- Type: str
set_metadata
def set_metadata(
key: str,
value: typing.Any
) -> None
- Type: str
- Type: typing.Any
Static Functions
| Name | Description |
|---|---|
is_construct | Return whether the given object is a Construct. |
is_construct
import ros_cdk_cloudfw
ros_cdk_cloudfw.FwSwitch.is_construct(
x: typing.Any
)
Return whether the given object is a Construct.
- 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. |
props | FwSwitchProps | 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
propsRequired
props: FwSwitchProps
- Type: FwSwitchProps