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

interface ObtainStagingResourcesContext ๐Ÿ”น

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

Context parameters for the 'obtainStagingResources' function.

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';
const obtainStagingResourcesContext: app_staging_synthesizer_alpha.ObtainStagingResourcesContext = {
  environmentString: 'environmentString',
  qualifier: 'qualifier',

  // the properties below are optional
  deployRoleArn: 'deployRoleArn',
};

Properties

NameTypeDescription
environmentString๐Ÿ”นstringA unique string describing the environment that is guaranteed not to have tokens in it.
qualifier๐Ÿ”นstringThe qualifier passed to the synthesizer.
deployRoleArn?๐Ÿ”นstringThe ARN of the deploy action role, if given.

environmentString๐Ÿ”น

Type: string

A unique string describing the environment that is guaranteed not to have tokens in it.


qualifier๐Ÿ”น

Type: string

The qualifier passed to the synthesizer.

The staging stack shouldn't need this, but it might.


deployRoleArn?๐Ÿ”น

Type: string (optional, default: Deploy role ARN is unknown)

The ARN of the deploy action role, if given.

This role will need permissions to read from to the staging resources.