Skip to content

StateConfigurationProps

Properties for defining a StateConfiguration.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-oos-stateconfiguration

Initializer

import ros_cdk_oos
ros_cdk_oos.StateConfigurationProps(
  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
)

Properties

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

schedule_expressionRequired

schedule_expression: typing.Union[str, IResolvable]
  • 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_typeRequired

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

Property scheduleType: The schedule type.

Set the value to rate.


targetsRequired

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

Property targets: The resources to be queried.


template_nameRequired

template_name: typing.Union[str, IResolvable]
  • 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_modeOptional

configure_mode: typing.Union[str, IResolvable]
  • 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.


descriptionOptional

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

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


parametersOptional

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

Property parameters: The parameters.


resource_group_idOptional

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

Property resourceGroupId: The resource group ID.


tagsOptional

tags: typing.Mapping[typing.Any]
  • 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_versionOptional

template_version: typing.Union[str, IResolvable]
  • 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.