@aws-cdk_cx-api.EnvironmentPlaceholders

class EnvironmentPlaceholders

LanguageType name
.NETAmazon.CDK.CXAPI.EnvironmentPlaceholders
Javasoftware.amazon.awscdk.cxapi.EnvironmentPlaceholders
Pythonaws_cdk.cx_api.EnvironmentPlaceholders
TypeScript (source)@aws-cdk/cx-api » EnvironmentPlaceholders

Placeholders which can be used manifests.

These can occur both in the Asset Manifest as well as the general Cloud Assembly manifest.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cx_api from '@aws-cdk/cx-api';
const environmentPlaceholders = new cx_api.EnvironmentPlaceholders();

Initializer

new EnvironmentPlaceholders()

Properties

NameTypeDescription
static CURRENT_ACCOUNTstringInsert this into the destination fields to be replaced with the current account.
static CURRENT_PARTITIONstringInsert this into the destination fields to be replaced with the current partition.
static CURRENT_REGIONstringInsert this into the destination fields to be replaced with the current region.

static CURRENT_ACCOUNT

Type: string

Insert this into the destination fields to be replaced with the current account.


static CURRENT_PARTITION

Type: string

Insert this into the destination fields to be replaced with the current partition.


static CURRENT_REGION

Type: string

Insert this into the destination fields to be replaced with the current region.

Methods

NameDescription
static replace(object, values)Replace the environment placeholders in all strings found in a complex object.
static replaceAsync(object, provider)Like 'replace', but asynchronous.

static replace(object, values)

public static replace(object: any, values: EnvironmentPlaceholderValues): any

Parameters

  • object any
  • values EnvironmentPlaceholderValues

Returns

  • any

Replace the environment placeholders in all strings found in a complex object.

Duplicated between cdk-assets and aws-cdk CLI because we don't have a good single place to put it (they're nominally independent tools).


static replaceAsync(object, provider)

public static replaceAsync(object: any, provider: IEnvironmentPlaceholderProvider): any

Parameters

  • object any
  • provider IEnvironmentPlaceholderProvider

Returns

  • any

Like 'replace', but asynchronous.