Skip to content

ParameterProps

Properties for defining a Parameter.

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

Initializer

import { ParameterProps } from '@alicloud/ros-cdk-oos'
const parameterProps: ParameterProps = { ... }

Properties

Name Type Description
name string | @alicloud/ros-cdk-core.IResolvable Property name: The name of the parameter.
type string | @alicloud/ros-cdk-core.IResolvable Property type: The data type of the common parameter.
value string | @alicloud/ros-cdk-core.IResolvable Property value: The value of the parameter.
constraints string | @alicloud/ros-cdk-core.IResolvable Property constraints: The constraints of the parameter.
description string | @alicloud/ros-cdk-core.IResolvable Property description: The description of the parameter.
resourceGroupId string | @alicloud/ros-cdk-core.IResolvable Property resourceGroupId: Resource group id.

nameRequired

public readonly name: string | IResolvable;
  • Type: string | @alicloud/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

public readonly type: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property type: The data type of the common parameter.

Valid values: String and StringList.


valueRequired

public readonly value: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property value: The value of the parameter.

The value must be 1 to 4096 characters in length.


constraintsOptional

public readonly constraints: string | IResolvable;
  • Type: string | @alicloud/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

public readonly description: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property description: The description of the parameter.

The description must be 1 to 200 characters in length.


resourceGroupIdOptional

public readonly resourceGroupId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property resourceGroupId: Resource group id.