Parameter

This class encapsulates and extends the ROS resource type ALIYUN::OOS::Parameter, which is used to create a common parameter.

Initializers

import ros_cdk_oos
ros_cdk_oos.Parameter(
  scope: Construct,
  id: str,
  name: typing.Union[str, IResolvable],
  type: typing.Union[str, IResolvable],
  value: typing.Union[str, IResolvable],
  constraints: typing.Union[str, IResolvable] = None,
  description: typing.Union[str, IResolvable] = None,
  resource_group_id: 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.
name	typing.Union[str, ros_cdk_core.IResolvable]	Property name: The name of the parameter.
type	typing.Union[str, ros_cdk_core.IResolvable]	Property type: The data type of the common parameter.
value	typing.Union[str, ros_cdk_core.IResolvable]	Property value: The value of the parameter.
constraints	typing.Union[str, ros_cdk_core.IResolvable]	Property constraints: The constraints of the parameter.
description	typing.Union[str, ros_cdk_core.IResolvable]	Property description: The description of the parameter.
resource_group_id	typing.Union[str, ros_cdk_core.IResolvable]	Property resourceGroupId: Resource group id.
enable_resource_property_constraint	bool	No description.

---

scope^Required

• Type: ros_cdk_core.Construct

---

id^Required

• Type: str

---

name^Required

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

Property name: The name of the parameter.

The name must be 1 to 200 characters in length,and can contain letters, digits, hyphens (-), and underscores (_). It cannot start with ALIYUN, ACS, ALIBABA, ALICLOUD, or OOS.

---

type^Required

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

Property type: The data type of the common parameter.

Valid values: String and StringList.

---

value^Required

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

Property value: The value of the parameter.

The value must be 1 to 4096 characters in length.

---

constraints^Optional

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

Property constraints: The constraints of the parameter.

By default, this parameter is null. Valid values: AllowedValues: The value that is allowed for the parameter. It must be an array string. AllowedPattern: The pattern that is allowed for the parameter. It must be a regular expression. MinLength: The minimum length of the parameter. MaxLength: The maximum length of the parameter.

---

description^Optional

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

Property description: The description of the parameter.

The description must be 1 to 200 characters in length.

---

resource_group_id^Optional

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

Property resourceGroupId: Resource group id.

---

enable_resource_property_constraint^Optional

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

session^Required

• Type: ros_cdk_core.ISynthesisSession

The synthesis session.

---

add_condition

def add_condition(
  condition: RosCondition
) -> None

condition^Required

• Type: ros_cdk_core.RosCondition

---

add_count

def add_count(
  count: typing.Union[typing.Union[int, float], IResolvable]
) -> None

count^Required

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

---

add_dependency

def add_dependency(
  resource: Resource
) -> None

resource^Required

• Type: ros_cdk_core.Resource

---

add_resource_desc

def add_resource_desc(
  desc: str
) -> None

desc^Required

• Type: str

---

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policy^Required

• Type: ros_cdk_core.RemovalPolicy

---

get_att

def get_att(
  name: str
) -> IResolvable

name^Required

• Type: str

---

set_metadata

def set_metadata(
  key: str,
  value: typing.Any
) -> None

key^Required

• Type: str

---

value^Required

• Type: typing.Any

---

Static Functions

Name	Description
is_construct	Return whether the given object is a Construct.

---

is_construct

import ros_cdk_oos
ros_cdk_oos.Parameter.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

x^Required

• 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_name	ros_cdk_core.IResolvable	Attribute Name: The Name of the parameter.
attr_value	ros_cdk_core.IResolvable	Attribute Value: The Value of the parameter.

---

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

---

ref^Required

ref: str

• Type: str

---

stack^Required

stack: Stack

• Type: ros_cdk_core.Stack

The stack in which this resource is defined.

---

resource^Optional

resource: RosResource

• Type: ros_cdk_core.RosResource

---

attr_name^Required

attr_name: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute Name: The Name of the parameter.

---

attr_value^Required

attr_value: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute Value: The Value of the parameter.

---