Skip to content

Parameter

  • Implements: @alicloud/ros-cdk-oos.datasource.IParameter

This class encapsulates and extends the ROS resource type DATASOURCE::OOS::Parameter.

Initializers

import { datasource } from '@alicloud/ros-cdk-oos'
new datasource.Parameter(scope: Construct, id: string, props: ParameterProps, enableResourcePropertyConstraint?: boolean)
Name Type Description
scope @alicloud/ros-cdk-core.Construct No description.
id string No description.
props ParameterProps No description.
enableResourcePropertyConstraint boolean No description.

scopeRequired

  • Type: @alicloud/ros-cdk-core.Construct

idRequired

  • Type: string

propsRequired


enableResourcePropertyConstraintOptional

  • Type: boolean

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.
fetchCondition No description.
fetchDependency No description.
fetchResourceDesc No description.
getAtt No description.
setMetadata No description.

toString

public toString(): string

Returns a string representation of this construct.

synthesize

public synthesize(session: ISynthesisSession): void

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: @alicloud/ros-cdk-core.ISynthesisSession

The synthesis session.


addCondition

public addCondition(condition: RosCondition): void

conditionRequired

  • Type: @alicloud/ros-cdk-core.RosCondition

addCount

public addCount(count: number | IResolvable): void

countRequired

  • Type: number | @alicloud/ros-cdk-core.IResolvable

addDependency

public addDependency(resource: Resource): void

resourceRequired

  • Type: @alicloud/ros-cdk-core.Resource

addResourceDesc

public addResourceDesc(desc: string): void

descRequired

  • Type: string

applyRemovalPolicy

public applyRemovalPolicy(policy: RemovalPolicy): void

policyRequired

  • Type: @alicloud/ros-cdk-core.RemovalPolicy

fetchCondition

public fetchCondition(): RosCondition

fetchDependency

public fetchDependency(): string[]

fetchResourceDesc

public fetchResourceDesc(): string

getAtt

public getAtt(name: string): IResolvable

nameRequired

  • Type: string

setMetadata

public setMetadata(key: string, value: any): void

keyRequired

  • Type: string

valueRequired

  • Type: any

Static Functions

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

isConstruct

import { datasource } from '@alicloud/ros-cdk-oos'
datasource.Parameter.isConstruct(x: any)

Return whether the given object is a Construct.

xRequired

  • Type: any

Properties

Name Type Description
node @alicloud/ros-cdk-core.ConstructNode The construct tree node associated with this construct.
env @alicloud/ros-cdk-core.IResourceEnvironment The environment this resource belongs to.
ref string No description.
stack @alicloud/ros-cdk-core.Stack The stack in which this resource is defined.
resource @alicloud/ros-cdk-core.RosResource No description.
attrConstraints string | @alicloud/ros-cdk-core.IResolvable Attribute Constraints: The constraints of the common parameter.
attrCreatedBy string | @alicloud/ros-cdk-core.IResolvable Attribute CreatedBy: The user who created the common parameter.
attrCreatedDate string | @alicloud/ros-cdk-core.IResolvable Attribute CreatedDate: The time when the common parameter was created.
attrDescription string | @alicloud/ros-cdk-core.IResolvable Attribute Description: The description of the common parameter.
attrParameterId string | @alicloud/ros-cdk-core.IResolvable Attribute ParameterId: The ID of the common parameter.
attrParameterVersion string | @alicloud/ros-cdk-core.IResolvable Attribute ParameterVersion: The version number of the common parameter.
attrShareType string | @alicloud/ros-cdk-core.IResolvable Attribute ShareType: The share type of the common parameter.
attrTags string | @alicloud/ros-cdk-core.IResolvable Attribute Tags: The tags of the common parameter.
attrType string | @alicloud/ros-cdk-core.IResolvable Attribute Type: The data type of the common parameter.
attrUpdatedBy string | @alicloud/ros-cdk-core.IResolvable Attribute UpdatedBy: The user who last updated the common parameter.
attrUpdatedDate string | @alicloud/ros-cdk-core.IResolvable Attribute UpdatedDate: The time when the common parameter was last updated.
attrValue string | @alicloud/ros-cdk-core.IResolvable Attribute Value: The value of the common parameter.
props ParameterProps No description.

nodeRequired

public readonly node: ConstructNode;
  • Type: @alicloud/ros-cdk-core.ConstructNode

The construct tree node associated with this construct.


envRequired

public readonly env: IResourceEnvironment;
  • Type: @alicloud/ros-cdk-core.IResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.


refRequired

public readonly ref: string;
  • Type: string

stackRequired

public readonly stack: Stack;
  • Type: @alicloud/ros-cdk-core.Stack

The stack in which this resource is defined.


resourceOptional

public readonly resource: RosResource;
  • Type: @alicloud/ros-cdk-core.RosResource

attrConstraintsRequired

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

Attribute Constraints: The constraints of the common parameter.


attrCreatedByRequired

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

Attribute CreatedBy: The user who created the common parameter.


attrCreatedDateRequired

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

Attribute CreatedDate: The time when the common parameter was created.


attrDescriptionRequired

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

Attribute Description: The description of the common parameter.


attrParameterIdRequired

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

Attribute ParameterId: The ID of the common parameter.


attrParameterVersionRequired

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

Attribute ParameterVersion: The version number of the common parameter.


attrShareTypeRequired

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

Attribute ShareType: The share type of the common parameter.


attrTagsRequired

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

Attribute Tags: The tags of the common parameter.


attrTypeRequired

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

Attribute Type: The data type of the common parameter.


attrUpdatedByRequired

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

Attribute UpdatedBy: The user who last updated the common parameter.


attrUpdatedDateRequired

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

Attribute UpdatedDate: The time when the common parameter was last updated.


attrValueRequired

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

Attribute Value: The value of the common parameter.


propsRequired

public readonly props: ParameterProps;