Configuration

This class encapsulates and extends the ROS resource type ALIYUN::ACM::Configuration, which is used to create a configuration.

Initializers

import ros_cdk_acm
ros_cdk_acm.Configuration(
  scope: Construct,
  id: str,
  content: typing.Union[str, IResolvable],
  data_id: typing.Union[str, IResolvable],
  namespace_id: typing.Union[str, IResolvable],
  app_name: typing.Union[str, IResolvable] = None,
  desc: typing.Union[str, IResolvable] = None,
  group: typing.Union[str, IResolvable] = None,
  tags: str = None,
  type: 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.
content	typing.Union[str, ros_cdk_core.IResolvable]	Property content: The contents of the configuration.
data_id	typing.Union[str, ros_cdk_core.IResolvable]	Property dataId: The ID of the configuration.
namespace_id	typing.Union[str, ros_cdk_core.IResolvable]	Property namespaceId: ID of namespace.
app_name	typing.Union[str, ros_cdk_core.IResolvable]	Property appName: Configuration application name.
desc	typing.Union[str, ros_cdk_core.IResolvable]	Property desc: Configuration description explains.
group	typing.Union[str, ros_cdk_core.IResolvable]	Property group: Group.
tags	str	Property tags: Label configurations, such as the presence of a plurality of tags, separated by commas.
type	typing.Union[str, ros_cdk_core.IResolvable]	Property type: Provisioning content format, optional values as follows: text, json, xml, yaml, text\/html, properties.
enable_resource_property_constraint	bool	No description.

---

scope^Required

• Type: ros_cdk_core.Construct

---

id^Required

• Type: str

---

content^Required

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

Property content: The contents of the configuration.

---

data_id^Required

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

Property dataId: The ID of the configuration.

Allowed characters are upper and lower case letters, numbers, decimal points (.), Colons (:), asterisks (*), underscores (_), and underscores (-). When the ID prefix is the following value, ACM will automatically use KMS service to encrypt this configuration: The prefix is cipher-: the KMS service is called to encrypt and decrypt the configuration. The size of the encrypted data does not exceed 4 KB, and the maximum does not exceed 6 KB. Special symbols such as and (&) will decrypt errors and are not recommended. The prefix is cipher-kms-aes-128-: using KMS's envelope encryption and decryption method, the configuration content can exceed 6 KB, up to 100 KB. The plain text data of the configuration content will not be transmitted to the KMS system, which is more secure and recommended.

---

namespace_id^Required

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

Property namespaceId: ID of namespace.

---

app_name^Optional

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

Property appName: Configuration application name.

---

desc^Optional

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

Property desc: Configuration description explains.

---

group^Optional

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

Property group: Group.

---

tags^Optional

• Type: str

Property tags: Label configurations, such as the presence of a plurality of tags, separated by commas.

---

type^Optional

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

Property type: Provisioning content format, optional values as follows: text, json, xml, yaml, text\/html, properties.

---

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_acm
ros_cdk_acm.Configuration.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_data_id	ros_cdk_core.IResolvable	Attribute DataId: The ID of the configuration.
attr_group	ros_cdk_core.IResolvable	Attribute Group: Group.
attr_namespace_id	ros_cdk_core.IResolvable	Attribute NamespaceId: ID of namespace.

---

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_data_id^Required

attr_data_id: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute DataId: The ID of the configuration.

---

attr_group^Required

attr_group: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute Group: Group.

---

attr_namespace_id^Required

attr_namespace_id: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute NamespaceId: ID of namespace.

---