interface ResourceProps

Language	Type name
.NET	`Amazon.CDK.ResourceProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2#ResourceProps`
Java	`software.amazon.awscdk.ResourceProps`
Python	`aws_cdk.ResourceProps`
TypeScript (source)	`aws-cdk-lib` » `ResourceProps`

Construction properties for Resource.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cdk from 'aws-cdk-lib';
const resourceProps: cdk.ResourceProps = {
  account: 'account',
  environmentFromArn: 'environmentFromArn',
  physicalName: 'physicalName',
  region: 'region',
};

Properties

Name	Type	Description
account?	`string`	The AWS account ID this resource belongs to.
environmentFromArn?	`string`	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 AWS region this resource belongs to.

account?

Type: string (optional, default: the resource is in the same account as the stack it belongs to)

The AWS account ID this resource belongs to.

environmentFromArn?

Type: string (optional, 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.

physicalName?

Type: string (optional, default: The physical name will be allocated by CloudFormation 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 by CloudFormation 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 by CloudFormation.

region?

Type: string (optional, default: the resource is in the same region as the stack it belongs to)

The AWS region this resource belongs to.