class EnvironmentPlaceholders
Language | Type name |
---|---|
![]() | Amazon.CDK.CXAPI.EnvironmentPlaceholders |
![]() | software.amazon.awscdk.cxapi.EnvironmentPlaceholders |
![]() | aws_cdk.cx_api.EnvironmentPlaceholders |
![]() | @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
Name | Type | Description |
---|---|---|
static CURRENT_ACCOUNT | string | Insert this into the destination fields to be replaced with the current account. |
static CURRENT_PARTITION | string | Insert this into the destination fields to be replaced with the current partition. |
static CURRENT_REGION | string | Insert 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
Name | Description |
---|---|
static replace(object, values) | Replace the environment placeholders in all strings found in a complex object. |
static replace | Like 'replace', but asynchronous. |
static replace(object, values)
public static replace(object: any, values: EnvironmentPlaceholderValues): any
Parameters
- object
any
- values
Environment
Placeholder Values
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
IEnvironment
Placeholder Provider
Returns
any
Like 'replace', but asynchronous.