SnatEntry
- Implements: ISnatEntry
This class encapsulates and extends the ROS resource type ALIYUN::VPC::SnatEntry.
Initializers
import ros_cdk_vpc
ros_cdk_vpc.SnatEntry(
scope: Construct,
id: str,
snat_ip: typing.Union[str, IResolvable],
snat_table_id: typing.Union[str, IResolvable],
eip_affinity: typing.Union[typing.Union[int, float], IResolvable] = None,
network_interface_id: typing.Union[str, IResolvable] = None,
snat_entry_name: typing.Union[str, IResolvable] = None,
source_cidr: typing.Union[str, IResolvable] = None,
source_v_switch_ids: typing.Union[IResolvable, typing.List[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. |
snat_ip | typing.Union[str, ros_cdk_core.IResolvable] | Property snatIp: The public IP address. |
snat_table_id | typing.Union[str, ros_cdk_core.IResolvable] | Property snatTableId: The ID of the SNAT table. |
eip_affinity | typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] | Property eipAffinity: Specifies whether to enable EIP affinity. |
network_interface_id | typing.Union[str, ros_cdk_core.IResolvable] | Property networkInterfaceId: The ID of the elastic network interface. |
snat_entry_name | typing.Union[str, ros_cdk_core.IResolvable] | Property snatEntryName: he name of the SNAT rule is 2-128 characters long and must start with a letter or Chinese, but cannot begin with HTTP:\/\/ or https:\/\/. |
source_cidr | typing.Union[str, ros_cdk_core.IResolvable] | Property sourceCidr: Specifies the network segment of the switch. |
source_v_switch_ids | typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]] | Property sourceVSwitchIds: The ID of the VSwitch to access the Internet. |
enable_resource_property_constraint | bool | No description. |
scopeRequired
- Type: ros_cdk_core.Construct
idRequired
- Type: str
snat_ipRequired
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property snatIp: The public IP address.
Separate multiple EIPs with commas.
snat_table_idRequired
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property snatTableId: The ID of the SNAT table.
eip_affinityOptional
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
Property eipAffinity: Specifies whether to enable EIP affinity.
Valid values: 0: no 1: yes If EIP affinity is enabled and the SNAT entry is associated with multiple EIPs, a client uses the same EIP to access the Internet. Otherwise, the client uses an EIP selected from the associated EIPs to access the Internet.
network_interface_idOptional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property networkInterfaceId: The ID of the elastic network interface.
The IPv4 addresses of the elastic network interface will be used as the SNAT IP addresses.
snat_entry_nameOptional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property snatEntryName: he name of the SNAT rule is 2-128 characters long and must start with a letter or Chinese, but cannot begin with HTTP:\/\/ or https:\/\/.
source_cidrOptional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property sourceCidr: Specifies the network segment of the switch.
For example, 10.0.0.1/24. This parameter and the SourceVSwtichId parameter are mutually exclusive and cannot appear at the same time.
source_v_switch_idsOptional
- Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]]
Property sourceVSwitchIds: The ID of the VSwitch to access the Internet.
When updating this list parameter, a new item will lead to a creation of new Snat Entry with latest properties, a removed item will lead to a deletion of the attached SnatEntry
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_vpc
ros_cdk_vpc.SnatEntry.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. |
attr_snat_entry_ids | typing.Union[str, ros_cdk_core.IResolvable] | Attribute SnatEntryIds: The IDS of the SNAT entry. |
props | SnatEntryProps | 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_snat_entry_idsRequired
attr_snat_entry_ids: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute SnatEntryIds: The IDS of the SNAT entry.
propsRequired
props: SnatEntryProps
- Type: SnatEntryProps