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

interface CustomFactoryOptions ๐Ÿ”น

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

Properties for customFactory static method.

Example

class CustomFactory implements IStagingResourcesFactory {
  public obtainStagingResources(stack: Stack, context: ObtainStagingResourcesContext) {
    const myApp = App.of(stack);

    return new CustomStagingStack(myApp!, `CustomStagingStack-${context.environmentString}`, {});
  }
}

const app = new App({
  defaultStackSynthesizer: AppStagingSynthesizer.customFactory({
    factory: new CustomFactory(),
    oncePerEnv: true, // by default
  }),
});

Properties

NameTypeDescription
factory๐Ÿ”นIStagingResourcesFactoryThe factory that will be used to return staging resources for each stack.
bootstrapQualifier?๐Ÿ”นstringQualifier to disambiguate multiple bootstrapped environments in the same account.
deploymentIdentities?๐Ÿ”นDeploymentIdentitiesWhat roles to use to deploy applications.
oncePerEnv?๐Ÿ”นbooleanReuse the answer from the factory for stacks in the same environment.

factory๐Ÿ”น

Type: IStagingResourcesFactory

The factory that will be used to return staging resources for each stack.


bootstrapQualifier?๐Ÿ”น

Type: string (optional, default: Value of context key '@aws-cdk/core:bootstrapQualifier' if set, otherwise DEFAULT_QUALIFIER)

Qualifier to disambiguate multiple bootstrapped environments in the same account.

This qualifier is only used to reference bootstrapped resources. It will not be used in the creation of app-specific staging resources: appId is used for that instead.


deploymentIdentities?๐Ÿ”น

Type: DeploymentIdentities (optional, default: The standard bootstrapped CDK roles)

What roles to use to deploy applications.

These are the roles that have permissions to interact with CloudFormation on your behalf. By default these are the standard bootstrapped CDK roles, but you can customize them or turn them off and use the CLI credentials to deploy.


oncePerEnv?๐Ÿ”น

Type: boolean (optional, default: true)

Reuse the answer from the factory for stacks in the same environment.