Skip to content

Parameter

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

Initializers 

import com.aliyun.ros.cdk.oos.Parameter;
Parameter.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .name(java.lang.String)
    .name(IResolvable)
    .type(java.lang.String)
    .type(IResolvable)
    .value(java.lang.String)
    .value(IResolvable)
//  .constraints(java.lang.String)
//  .constraints(IResolvable)
//  .description(java.lang.String)
//  .description(IResolvable)
//  .resourceGroupId(java.lang.String)
//  .resourceGroupId(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.
name java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property name: The name of the parameter.
type java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property type: The data type of the common parameter.
value java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property value: The value of the parameter.
constraints java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property constraints: The constraints of the parameter.
description java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property description: The description of the parameter.
resourceGroupId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property resourceGroupId: Resource group id.

scopeRequired

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

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

nameRequired

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

typeRequired

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

Property type: The data type of the common parameter.

Valid values: String and StringList.

valueRequired

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

Property value: The value of the parameter.

The value must be 1 to 4096 characters in length.

constraintsOptional

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

descriptionOptional

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

Property description: The description of the parameter.

The description must be 1 to 200 characters in length.

resourceGroupIdOptional

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

Property resourceGroupId: Resource group id.

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.

sessionRequired

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

The synthesis session.

addCondition 

public void addCondition(RosCondition condition)

conditionRequired

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

addCount 

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

countRequired

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

addDependency 

public void addDependency(Resource resource)

resourceRequired

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

addResourceDesc 

public void addResourceDesc(java.lang.String desc)

descRequired

  • Type: java.lang.String

applyRemovalPolicy 

public void applyRemovalPolicy(RemovalPolicy policy)

policyRequired

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

getAtt 

public IResolvable getAtt(java.lang.String name)

nameRequired

  • Type: java.lang.String

setMetadata 

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

keyRequired

  • Type: java.lang.String

valueRequired

  • Type: java.lang.Object

Static Functions

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

isConstruct 

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

Return whether the given object is a Construct.

xRequired

  • 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.
attrName com.aliyun.ros.cdk.core.IResolvable Attribute Name: The Name of the parameter.
attrValue com.aliyun.ros.cdk.core.IResolvable Attribute Value: The Value of the parameter.

nodeRequired 

public ConstructNode getNode();
  • Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.

refRequired 

public java.lang.String getRef();
  • Type: java.lang.String

stackRequired 

public Stack getStack();
  • Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.

resourceOptional 

public RosResource getResource();
  • Type: com.aliyun.ros.cdk.core.RosResource

attrNameRequired 

public IResolvable getAttrName();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute Name: The Name of the parameter.

attrValueRequired 

public IResolvable getAttrValue();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute Value: The Value of the parameter.