@aws-cdk_app-staging-synthesizer-alpha.AppStagingSynthesizer

class AppStagingSynthesizer ๐Ÿ”น

LanguageType name
.NETAmazon.CDK.AppStagingSynthesizer.Alpha.AppStagingSynthesizer
Javasoftware.amazon.awscdk.app.staging.synthesizer.alpha.AppStagingSynthesizer
Pythonaws_cdk.app_staging_synthesizer_alpha.AppStagingSynthesizer
TypeScript (source)@aws-cdk/app-staging-synthesizer-alpha ยป AppStagingSynthesizer

Implements IStackSynthesizer, IReusableStackSynthesizer

Extends StackSynthesizer

App Staging Synthesizer.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as app_staging_synthesizer_alpha from '@aws-cdk/app-staging-synthesizer-alpha';

declare const deploymentIdentities: app_staging_synthesizer_alpha.DeploymentIdentities;
declare const stagingResourcesFactory: app_staging_synthesizer_alpha.IStagingResourcesFactory;
const appStagingSynthesizer = app_staging_synthesizer_alpha.AppStagingSynthesizer.customFactory({
  factory: stagingResourcesFactory,

  // the properties below are optional
  bootstrapQualifier: 'bootstrapQualifier',
  deploymentIdentities: deploymentIdentities,
  oncePerEnv: false,
});

Properties

NameTypeDescription
bootstrapQualifier?๐Ÿ”นstringThe qualifier used to bootstrap this stack.
lookupRole?๐Ÿ”นstringThe role used to lookup for this stack.
static DEFAULT_CLOUDFORMATION_ROLE_ARN๐Ÿ”นstringDefault CloudFormation role ARN.
static DEFAULT_DEPLOY_ROLE_ARN๐Ÿ”นstringDefault deploy role ARN.
static DEFAULT_LOOKUP_ROLE_ARN๐Ÿ”นstringDefault lookup role ARN for missing values.
static DEFAULT_QUALIFIER๐Ÿ”นstringDefault ARN qualifier.

bootstrapQualifier?๐Ÿ”น

Type: string (optional)

The qualifier used to bootstrap this stack.


lookupRole?๐Ÿ”น

Type: string (optional)

The role used to lookup for this stack.


static DEFAULT_CLOUDFORMATION_ROLE_ARN๐Ÿ”น

Type: string

Default CloudFormation role ARN.


static DEFAULT_DEPLOY_ROLE_ARN๐Ÿ”น

Type: string

Default deploy role ARN.


static DEFAULT_LOOKUP_ROLE_ARN๐Ÿ”น

Type: string

Default lookup role ARN for missing values.


static DEFAULT_QUALIFIER๐Ÿ”น

Type: string

Default ARN qualifier.

Methods

NameDescription
addDockerImageAsset(_asset)๐Ÿ”นImplemented for legacy purposes;
addFileAsset(_asset)๐Ÿ”นImplemented for legacy purposes;
bind(_stack)๐Ÿ”นImplemented for legacy purposes;
reusableBind(stack)๐Ÿ”นReturns a version of the synthesizer bound to a stack.
synthesize(_session)๐Ÿ”นImplemented for legacy purposes;
static customFactory(options)๐Ÿ”นSupply your own stagingStackFactory method for creating an IStagingStack when a stack is bound to the synthesizer.
static customResources(options)๐Ÿ”นUse these exact staging resources for every stack that this synthesizer is used for.
static defaultResources(options)๐Ÿ”นUse the Default Staging Resources, creating a single stack per environment this app is deployed in.

addDockerImageAsset(_asset)๐Ÿ”น

public addDockerImageAsset(_asset: DockerImageAssetSource): DockerImageAssetLocation

Parameters

  • _asset DockerImageAssetSource

Returns

  • DockerImageAssetLocation

Implemented for legacy purposes;

this will never be called.


addFileAsset(_asset)๐Ÿ”น

public addFileAsset(_asset: FileAssetSource): FileAssetLocation

Parameters

  • _asset FileAssetSource

Returns

  • FileAssetLocation

Implemented for legacy purposes;

this will never be called.


bind(_stack)๐Ÿ”น

public bind(_stack: Stack): void

Parameters

  • _stack Stack

Implemented for legacy purposes;

this will never be called.


reusableBind(stack)๐Ÿ”น

public reusableBind(stack: Stack): IBoundStackSynthesizer

Parameters

  • stack Stack

Returns

  • IBoundStackSynthesizer

Returns a version of the synthesizer bound to a stack.


synthesize(_session)๐Ÿ”น

public synthesize(_session: ISynthesisSession): void

Parameters

  • _session ISynthesisSession

Implemented for legacy purposes;

this will never be called.


static customFactory(options)๐Ÿ”น

public static customFactory(options: CustomFactoryOptions): AppStagingSynthesizer

Parameters

  • options CustomFactoryOptions

Returns

  • AppStagingSynthesizer

Supply your own stagingStackFactory method for creating an IStagingStack when a stack is bound to the synthesizer.

By default, oncePerEnv = true, which means that a new instance of the IStagingStack will be created in new environments. Set oncePerEnv = false to turn off that behavior.


static customResources(options)๐Ÿ”น

public static customResources(options: CustomResourcesOptions): AppStagingSynthesizer

Parameters

  • options CustomResourcesOptions

Returns

  • AppStagingSynthesizer

Use these exact staging resources for every stack that this synthesizer is used for.


static defaultResources(options)๐Ÿ”น

public static defaultResources(options: DefaultResourcesOptions): AppStagingSynthesizer

Parameters

  • options DefaultResourcesOptions

Returns

  • AppStagingSynthesizer

Use the Default Staging Resources, creating a single stack per environment this app is deployed in.