Skip to content

PrefixList

This class encapsulates and extends the ROS resource type ALIYUN::ECS::PrefixList, which is used to create a prefix list.

Initializers

import ros_cdk_ecs
ros_cdk_ecs.PrefixList(
  scope: Construct,
  id: str,
  address_family: typing.Union[str, IResolvable],
  max_entries: typing.Union[typing.Union[int, float], IResolvable],
  prefix_list_name: typing.Union[str, IResolvable],
  description: typing.Union[str, IResolvable] = None,
  entries: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, EntriesProperty]]] = None,
  enable_resource_property_constraint: bool = None
)
Name Type Description
scope ros_cdk_core.Construct No description.
id str No description.
address_family typing.Union[str, ros_cdk_core.IResolvable] Property addressFamily: The IP address family.
max_entries typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property maxEntries: The maximum number of entries that the prefix list can contain.
prefix_list_name typing.Union[str, ros_cdk_core.IResolvable] Property prefixListName: The name of the prefix.
description typing.Union[str, ros_cdk_core.IResolvable] Property description: The description of the prefix list.
entries typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, EntriesProperty]]] Property entries:.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

address_familyRequired

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

Property addressFamily: The IP address family.

Valid values: IPv4 IPv6


max_entriesRequired

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

Property maxEntries: The maximum number of entries that the prefix list can contain.

Valid values: 1 to 200.


prefix_list_nameRequired

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

Property prefixListName: The name of the prefix.

The name must be 2 to 128 characters in length. It must start with a letter and cannot start with http://, https://, com.aliyun, or com.alibabacloud. It can contain letters, digits, colons (:), underscores (_), periods (.), and hyphens (-).


descriptionOptional

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

Property description: The description of the prefix list.

The description must be 2 to 256 characters in length and cannot start with http:// or https://.


entriesOptional

  • Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, EntriesProperty]]]

Property entries:.


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.
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

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_ecs
ros_cdk_ecs.PrefixList.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.
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_prefix_list_id ros_cdk_core.IResolvable Attribute PrefixListId: The ID of the prefix list.

nodeRequired

node: ConstructNode
  • Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.


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_prefix_list_idRequired

attr_prefix_list_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute PrefixListId: The ID of the prefix list.