Skip to content

Resource

A construct which represents a resource.

Initializers

import { Resource } from '@alicloud/ros-cdk-core'
new Resource(scope: Construct, id: string, props?: ResourceProps)
Name Type Description
scope Construct No description.
id string No description.
props ResourceProps No description.

scopeRequired


idRequired

  • Type: string

propsOptional


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

The synthesis session.


addCondition

public addCondition(condition: RosCondition): void

conditionRequired


addCount

public addCount(count: number | IResolvable): void

countRequired


addDependency

public addDependency(resource: Resource): void

resourceRequired


addResourceDesc

public addResourceDesc(desc: string): void

descRequired

  • Type: string

applyRemovalPolicy

public applyRemovalPolicy(policy: RemovalPolicy): void

policyRequired


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 { Resource } from '@alicloud/ros-cdk-core'
Resource.isConstruct(x: any)

Return whether the given object is a Construct.

xRequired

  • Type: any

Properties

Name Type Description
node ConstructNode The construct tree node associated with this construct.
env IResourceEnvironment The environment this resource belongs to.
ref string No description.
stack Stack The stack in which this resource is defined.
resource RosResource No description.

nodeRequired

public readonly node: ConstructNode;

The construct tree node associated with this construct.


envRequired

public readonly env: 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;

The stack in which this resource is defined.


resourceOptional

public readonly resource: RosResource;