PrefixList
- Implements: IPrefixList
This class encapsulates and extends the ROS resource type ALIYUN::VPC::PrefixList, which is used to create a prefix list.
Initializers
import ros_cdk_vpc
ros_cdk_vpc.PrefixList(
scope: Construct,
id: str,
entries: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, EntriesProperty]]] = None,
ip_version: typing.Union[str, IResolvable] = None,
max_entries: typing.Union[typing.Union[int, float], IResolvable] = None,
prefix_list_description: typing.Union[str, IResolvable] = None,
prefix_list_name: typing.Union[str, IResolvable] = None,
resource_group_id: typing.Union[str, IResolvable] = None,
tags: typing.List[TagsProperty] = None,
enable_resource_property_constraint: bool = None
)
| Name | Type | Description |
|---|---|---|
scope | ros_cdk_core.Construct | No description. |
id | str | No description. |
entries | typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, EntriesProperty]]] | Property entries: The CIDR address block list of the prefix list. |
ip_version | typing.Union[str, ros_cdk_core.IResolvable] | Property ipVersion: The IP version of the prefix list. |
max_entries | typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] | Property maxEntries: The maximum number of entries for CIDR address blocks in the prefix list. |
prefix_list_description | typing.Union[str, ros_cdk_core.IResolvable] | Property prefixListDescription: The description of the prefix list. |
prefix_list_name | typing.Union[str, ros_cdk_core.IResolvable] | Property prefixListName: The name of the prefix list. |
resource_group_id | typing.Union[str, ros_cdk_core.IResolvable] | Property resourceGroupId: The ID of the resource group to which the VPC belongs. |
tags | typing.List[TagsProperty] | Property tags: Tags of prefix list. |
enable_resource_property_constraint | bool | No description. |
scopeRequired
- Type: ros_cdk_core.Construct
idRequired
- Type: str
entriesOptional
- Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, EntriesProperty]]]
Property entries: The CIDR address block list of the prefix list.
ip_versionOptional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property ipVersion: The IP version of the prefix list.
Value:
- IPvv4:IPv4 version.
- IPv6:IPv6.
max_entriesOptional
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
Property maxEntries: The maximum number of entries for CIDR address blocks in the prefix list.
prefix_list_descriptionOptional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property prefixListDescription: The description of the prefix list.
It must be 2 to 256 characters in length and must start with a letter or Chinese, but cannot start with http:// or https.
prefix_list_nameOptional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property prefixListName: The name of the prefix list.
resource_group_idOptional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property resourceGroupId: The ID of the resource group to which the VPC belongs.
tagsOptional
- Type: typing.List[TagsProperty]
Property tags: Tags of prefix list.
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.PrefixList.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_create_time | typing.Union[str, ros_cdk_core.IResolvable] | Attribute CreateTime: The time when the prefix list was created. |
attr_entries | typing.Union[str, ros_cdk_core.IResolvable] | Attribute Entries: The CIDR address block list of the prefix list. |
attr_ip_version | typing.Union[str, ros_cdk_core.IResolvable] | Attribute IpVersion: The IP version of the prefix list. |
attr_max_entries | typing.Union[str, ros_cdk_core.IResolvable] | Attribute MaxEntries: The maximum number of entries for CIDR address blocks in the prefix list. |
attr_owner_id | typing.Union[str, ros_cdk_core.IResolvable] | Attribute OwnerId: The Alibaba Cloud account (primary account) to which the prefix list belongs. |
attr_prefix_list_description | typing.Union[str, ros_cdk_core.IResolvable] | Attribute PrefixListDescription: The description of the prefix list. |
attr_prefix_list_id | typing.Union[str, ros_cdk_core.IResolvable] | Attribute PrefixListId: The ID of the query Prefix List. |
attr_prefix_list_name | typing.Union[str, ros_cdk_core.IResolvable] | Attribute PrefixListName: The name of the prefix list. |
attr_resource_group_id | typing.Union[str, ros_cdk_core.IResolvable] | Attribute ResourceGroupId: The ID of the resource group to which the VPC belongs. |
attr_share_type | typing.Union[str, ros_cdk_core.IResolvable] | Attribute ShareType: The share type of the prefix list. |
attr_tags | typing.Union[str, ros_cdk_core.IResolvable] | Attribute Tags: The tags of PrefixList. |
props | PrefixListProps | 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_create_timeRequired
attr_create_time: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute CreateTime: The time when the prefix list was created.
attr_entriesRequired
attr_entries: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute Entries: The CIDR address block list of the prefix list.
attr_ip_versionRequired
attr_ip_version: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute IpVersion: The IP version of the prefix list.
attr_max_entriesRequired
attr_max_entries: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute MaxEntries: The maximum number of entries for CIDR address blocks in the prefix list.
attr_owner_idRequired
attr_owner_id: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute OwnerId: The Alibaba Cloud account (primary account) to which the prefix list belongs.
attr_prefix_list_descriptionRequired
attr_prefix_list_description: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute PrefixListDescription: The description of the prefix list.
attr_prefix_list_idRequired
attr_prefix_list_id: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute PrefixListId: The ID of the query Prefix List.
attr_prefix_list_nameRequired
attr_prefix_list_name: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute PrefixListName: The name of the prefix list.
attr_resource_group_idRequired
attr_resource_group_id: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute ResourceGroupId: The ID of the resource group to which the VPC belongs.
attr_share_typeRequired
attr_share_type: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute ShareType: The share type of the prefix list.
attr_tagsRequired
attr_tags: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute Tags: The tags of PrefixList.
propsRequired
props: PrefixListProps
- Type: PrefixListProps