Skip to content

ResourceProps

Construction properties for {@link Resource}.

Initializer

import { ResourceProps } from '@alicloud/ros-cdk-core'
const resourceProps: ResourceProps = { ... }

Properties

Name Type Description
account string The Alibaba Cloud account ID this resource belongs to.
environmentFromArn string | IResolvable ARN to deduce region and account from.
physicalName string The value passed in by users to the physical name prop of the resource.
region string The Alibaba Cloud region this resource belongs to.

accountOptional

public readonly account: string;
  • Type: string
  • Default: the resource is in the same account as the stack it belongs to

The Alibaba Cloud account ID this resource belongs to.


environmentFromArnOptional

public readonly environmentFromArn: string | IResolvable;
  • Type: string | IResolvable
  • Default: take environment from account, region parameters, or use Stack environment.

ARN to deduce region and account from.

The ARN is parsed and the account and region are taken from the ARN. This should be used for imported resources.

Cannot be supplied together with either account or region.


physicalNameOptional

public readonly physicalName: string;
  • Type: string
  • Default: The physical name will be allocated at deployment time

The value passed in by users to the physical name prop of the resource.

undefined implies that a physical name will be allocated during deployment. - a concrete value implies a specific physical name - PhysicalName.GENERATE_IF_NEEDED is a marker that indicates that a physical will only be generated by the CDK if it is needed for cross-environment references. Otherwise, it will be allocated.


regionOptional

public readonly region: string;
  • Type: string
  • Default: the resource is in the same region as the stack it belongs to

The Alibaba Cloud region this resource belongs to.