CustomFactoryOptions

class aws_cdk.app_staging_synthesizer_alpha.CustomFactoryOptions(*, bootstrap_qualifier=None, deployment_identities=None, factory, once_per_env=None)

Bases: AppStagingSynthesizerOptions

(experimental) Properties for customFactory static method.

Parameters:

• bootstrap_qualifier (Optional[str]) – (experimental) 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. Default: - Value of context key ‘@aws-cdk/core:bootstrapQualifier’ if set, otherwise DEFAULT_QUALIFIER

• deployment_identities (Optional[DeploymentIdentities]) – (experimental) 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. Default: - The standard bootstrapped CDK roles

• factory (IStagingResourcesFactory) – (experimental) The factory that will be used to return staging resources for each stack.

• once_per_env (Optional[bool]) – (experimental) Reuse the answer from the factory for stacks in the same environment. Default: true

Stability:

experimental

ExampleMetadata:

fixture=with-custom-staging infused

Example:

@jsii.implements(IStagingResourcesFactory)
class CustomFactory:
    def obtain_staging_resources(self, stack, *, environmentString, deployRoleArn=None, qualifier):
        my_app = App.of(stack)

        return CustomStagingStack(my_app, f"CustomStagingStack-{context.environmentString}")

app = App(
    default_stack_synthesizer=AppStagingSynthesizer.custom_factory(
        factory=CustomFactory(),
        once_per_env=True
    )
)

Attributes

bootstrap_qualifier

(experimental) 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.

Default:

• Value of context key ‘@aws-cdk/core:bootstrapQualifier’ if set, otherwise DEFAULT_QUALIFIER

Stability:

experimental

deployment_identities

(experimental) 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.

Default:

• The standard bootstrapped CDK roles

Stability:

experimental

factory

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

Stability:

experimental

once_per_env

(experimental) Reuse the answer from the factory for stacks in the same environment.

Default:

true

Stability:

experimental