StateConfiguration

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

Initializers

import com.aliyun.ros.cdk.oos.StateConfiguration;
StateConfiguration.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .scheduleExpression(java.lang.String)
    .scheduleExpression(IResolvable)
    .scheduleType(java.lang.String)
    .scheduleType(IResolvable)
    .targets(java.lang.String)
    .targets(IResolvable)
    .templateName(java.lang.String)
    .templateName(IResolvable)
//  .configureMode(java.lang.String)
//  .configureMode(IResolvable)
//  .description(java.lang.String)
//  .description(IResolvable)
//  .parameters(java.lang.String)
//  .parameters(IResolvable)
//  .resourceGroupId(java.lang.String)
//  .resourceGroupId(IResolvable)
//  .tags(java.util.Map<java.lang.String, java.lang.Object>)
//  .templateVersion(java.lang.String)
//  .templateVersion(IResolvable)
    .build();

Name	Type	Description
scope	com.aliyun.ros.cdk.core.Construct	No description.
id	java.lang.String	No description.
enableResourcePropertyConstraint	java.lang.Boolean	No description.
scheduleExpression	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property scheduleExpression: The schedule expression.
scheduleType	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property scheduleType: The schedule type.
targets	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property targets: The resources to be queried.
templateName	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property templateName: The name of the template.
configureMode	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property configureMode: The configuration mode.
description	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property description: The description of the desired-state configuration.
parameters	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property parameters: The parameters.
resourceGroupId	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property resourceGroupId: The resource group ID.
tags	java.util.Map	Property tags: Tag value and the key mapping, the label of the key number can be up to 20.
templateVersion	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property templateVersion: The version number of the template.

---

scope^Required

• Type: com.aliyun.ros.cdk.core.Construct

---

id^Required

• Type: java.lang.String

---

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

---

scheduleExpression^Required

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property scheduleExpression: The schedule expression.

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

---

scheduleType^Required

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property scheduleType: The schedule type.

Set the value to rate.

---

targets^Required

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property targets: The resources to be queried.

---

templateName^Required

• Type: java.lang.String OR com.aliyun.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 (_).

---

configureMode^Optional

• Type: java.lang.String OR com.aliyun.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: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

---

parameters^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property parameters: The parameters.

---

resourceGroupId^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property resourceGroupId: The resource group ID.

---

tags^Optional

• Type: java.util.Map

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

---

templateVersion^Optional

• Type: java.lang.String OR com.aliyun.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.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
synthesize	Allows this construct to emit artifacts into the cloud assembly during synthesis.
addCondition	No description.
addCount	No description.
addDependency	No description.
addResourceDesc	No description.
applyRemovalPolicy	No description.
getAtt	No description.
setMetadata	No description.

---

toString

public java.lang.String toString()

Returns a string representation of this construct.

synthesize

public void synthesize(ISynthesisSession session)

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: com.aliyun.ros.cdk.core.ISynthesisSession

The synthesis session.

---

addCondition

public void addCondition(RosCondition condition)

condition^Required

• Type: com.aliyun.ros.cdk.core.RosCondition

---

addCount

public void addCount(java.lang.Number OR IResolvable count)

count^Required

• Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

---

addDependency

public void addDependency(Resource resource)

resource^Required

• Type: com.aliyun.ros.cdk.core.Resource

---

addResourceDesc

public void addResourceDesc(java.lang.String desc)

desc^Required

• Type: java.lang.String

---

applyRemovalPolicy

public void applyRemovalPolicy(RemovalPolicy policy)

policy^Required

• Type: com.aliyun.ros.cdk.core.RemovalPolicy

---

getAtt

public IResolvable getAtt(java.lang.String name)

name^Required

• Type: java.lang.String

---

setMetadata

public void setMetadata(java.lang.String key, java.lang.Object value)

key^Required

• Type: java.lang.String

---

value^Required

• Type: java.lang.Object

---

Static Functions

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

---

isConstruct

import com.aliyun.ros.cdk.oos.StateConfiguration;
StateConfiguration.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

x^Required

• Type: java.lang.Object

---

Properties

Name	Type	Description
node	com.aliyun.ros.cdk.core.ConstructNode	The construct tree node associated with this construct.
ref	java.lang.String	No description.
stack	com.aliyun.ros.cdk.core.Stack	The stack in which this resource is defined.
resource	com.aliyun.ros.cdk.core.RosResource	No description.
attrStateConfigurationId	com.aliyun.ros.cdk.core.IResolvable	Attribute StateConfigurationId: The ID of the desired-state configuration.

---

node^Required

public ConstructNode getNode();

• Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.

---

ref^Required

public java.lang.String getRef();

• Type: java.lang.String

---

stack^Required

public Stack getStack();

• Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.

---

resource^Optional

public RosResource getResource();

• Type: com.aliyun.ros.cdk.core.RosResource

---

attrStateConfigurationId^Required

public IResolvable getAttrStateConfigurationId();

• Type: com.aliyun.ros.cdk.core.IResolvable

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

---