StageProps Struct
Initialization props for a stage.
Example
declare const app: App;
new Stage(app, 'DevStage');
new Stage(app, 'BetaStage', {
permissionsBoundary: PermissionsBoundary.fromName('beta-permissions-boundary'),
});
new Stage(app, 'GammaStage', {
permissionsBoundary: PermissionsBoundary.fromName('prod-permissions-boundary'),
});
new Stage(app, 'ProdStage', {
permissionsBoundary: PermissionsBoundary.fromName('prod-permissions-boundary'),
});
Properties
envoptionalEnvironmentenvoptionalEnvironmentenvoptionalEnvironmentEnvoptionalEnvironmentEnvoptionalEnvironment#Default: The environments should be configured on the Stacks.
notes · example
Stacks defined inside this Stage with either region or account missing from its env will use the corresponding field given here.
If either region or accountis is not configured for Stack (either on the Stack itself or on the containing Stage), the Stack will be environment-agnostic.
Environment-agnostic stacks can be deployed to any environment, may not be able to take advantage of all features of the CDK. For example, they will not be able to use environmental context lookups, will not automatically translate Service Principals to the right format based on the environment's AWS partition, and other such enhancements.
// Use a concrete account and region to deploy this Stage to
new Stage(app, 'Stage1', {
env: { account: '123456789012', region: 'us-east-1' },
});
// Use the CLI's current credentials to determine the target environment
new Stage(app, 'Stage2', {
env: { account: process.env.CDK_DEFAULT_ACCOUNT, region: process.env.CDK_DEFAULT_REGION },
});
Default: for nested stages, outdir will be determined as a relative directory to the outdir of the app. For apps, if outdir is not specified, a temporary directory will be created.
Can only be specified if this stage is the root stage (the app). If this is specified and this stage is nested within another stage, an error will be thrown.
permissionsBoundaryoptionalPermissionsBoundarypermissions_boundaryoptionalPermissionsBoundarypermissionsBoundaryoptionalPermissionsBoundaryPermissionsBoundaryoptionalPermissionsBoundaryPermissionsBoundaryoptionalPermissionsBoundary#Default: no permissions boundary is applied
notes
Be aware that this feature uses Aspects, and the Aspects are applied at the Stack level with a priority of MUTATING (if the feature flag @aws-cdk/core:aspectPrioritiesMutating is set) or DEFAULT (if the flag is not set). This is relevant if you are both using your own Aspects to assign Permissions Boundaries, as well as specifying this property. The Aspect added by this property will overwrite the Permissions Boundary assigned by your own Aspect if both: (a) your Aspect has a lower or equal priority to the automatic Aspect, and (b) your Aspect is applied above the Stack level. If either of those conditions are not true, your own Aspect will win.
We recommend assigning Permissions Boundaries only using the provided APIs, and not using custom Aspects.
policyValidationBeta1optionalIPolicyValidationPluginBeta1[]policy_validation_beta1optionaltyping.List[IPolicyValidationPluginBeta1]policyValidationBeta1optionalList<IPolicyValidationPluginBeta1>PolicyValidationBeta1optionalIPolicyValidationPluginBeta1[]PolicyValidationBeta1optional*[]IPolicyValidationPluginBeta1deprecated#Default: no validation plugins are used
If any plugin reports any violation, synthesis will be interrupted and the report displayed to the user.
propertyInjectorsoptionalIPropertyInjector[]property_injectorsoptionaltyping.List[IPropertyInjector]propertyInjectorsoptionalList<IPropertyInjector>PropertyInjectorsoptionalIPropertyInjector[]PropertyInjectorsoptional*[]IPropertyInjector#Default: no PropertyInjectors
stageNameoptionalstringstage_nameoptionalstrstageNameoptionalStringStageNameoptionalstringStageNameoptional*string#Default: Derived from the id.