Skip to content
v2.273.0

ResourceEnvironment Struct ​

Represents the environment a given resource lives in.

Used as the return value for the IEnvironmentAware.env property.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { interfaces } from 'aws-cdk-lib';
const resourceEnvironment: interfaces.ResourceEnvironment = {
  account: 'account',
  region: 'region',
};

Properties ​

accountstringaccountstraccountStringAccountstringAccount*stringrequired#
The AWS Account ID that this resource belongs to.

Since this can be a Token (for example, when the account is CloudFormation's AWS::AccountId intrinsic), make sure to use Token.compareStrings() instead of comparing the values with direct string equality.

regionstringregionstrregionStringRegionstringRegion*stringrequired#
The AWS Region that this resource belongs to.

Since this can be a Token (for example, when the region is CloudFormation's AWS::Region intrinsic), make sure to use Token.compareStrings() instead of comparing the values with direct string equality.