StateConfiguration

This class encapsulates and extends the ROS resource type ALIYUN::OOS::StateConfiguration, which is used to create a desired-state configuration.

Initializers

import ros_cdk_oos
ros_cdk_oos.StateConfiguration(
  scope: Construct,
  id: str,
  schedule_expression: typing.Union[str, IResolvable],
  schedule_type: typing.Union[str, IResolvable],
  targets: typing.Union[str, IResolvable],
  template_name: typing.Union[str, IResolvable],
  configure_mode: typing.Union[str, IResolvable] = None,
  description: typing.Union[str, IResolvable] = None,
  parameters: typing.Union[str, IResolvable] = None,
  resource_group_id: typing.Union[str, IResolvable] = None,
  tags: typing.Mapping[typing.Any] = None,
  template_version: 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.
schedule_expression	typing.Union[str, ros_cdk_core.IResolvable]	Property scheduleExpression: The schedule expression.
schedule_type	typing.Union[str, ros_cdk_core.IResolvable]	Property scheduleType: The schedule type.
targets	typing.Union[str, ros_cdk_core.IResolvable]	Property targets: The resources to be queried.
template_name	typing.Union[str, ros_cdk_core.IResolvable]	Property templateName: The name of the template.
configure_mode	typing.Union[str, ros_cdk_core.IResolvable]	Property configureMode: The configuration mode.
description	typing.Union[str, ros_cdk_core.IResolvable]	Property description: The description of the desired-state configuration.
parameters	typing.Union[str, ros_cdk_core.IResolvable]	Property parameters: The parameters.
resource_group_id	typing.Union[str, ros_cdk_core.IResolvable]	Property resourceGroupId: The resource group ID.
tags	typing.Mapping[typing.Any]	Property tags: Tag value and the key mapping, the label of the key number can be up to 20.
template_version	typing.Union[str, ros_cdk_core.IResolvable]	Property templateVersion: The version number of the template.
enable_resource_property_constraint	bool	No description.

---

scope^Required

• Type: ros_cdk_core.Construct

---

id^Required

• Type: str

---

schedule_expression^Required

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

Property scheduleExpression: The schedule expression.

The interval between two schedules must be a minimum of 30 minutes.

---

schedule_type^Required

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

Property scheduleType: The schedule type.

Set the value to rate.

---

targets^Required

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

Property targets: The resources to be queried.

---

template_name^Required

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

Property templateName: The name of the template.

The name must be 1 to 200 characters in length and can contain letters, digits, hyphens (-), and underscores (_).

---

configure_mode^Optional

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

Property configureMode: The configuration mode.

Valid values: ApplyOnce: The configuration is applied only once. After a configuration is updated, the new configuration is applied. ApplyAndMonitor: The configuration is applied only once. After the configuration is applied, the system only checks whether the configuration is migrated in the future. ApplyAndAutoCorrect: The configuration is always applied.

---

description^Optional

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

Property description: The description of the desired-state configuration.

---

parameters^Optional

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

Property parameters: The parameters.

---

resource_group_id^Optional

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

Property resourceGroupId: The resource group ID.

---

tags^Optional

• Type: typing.Mapping[typing.Any]

Property tags: Tag value and the key mapping, the label of the key number can be up to 20.

---

template_version^Optional

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

Property templateVersion: The version number of the template.

If you do not specify this parameter, the latest version of the template is used.

---

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.StateConfiguration.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_state_configuration_id	ros_cdk_core.IResolvable	Attribute StateConfigurationId: The ID of the desired-state configuration.

---

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

attr_state_configuration_id: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute StateConfigurationId: The ID of the desired-state configuration.

---