Package software.amazon.awscdk.app.staging.synthesizer.alpha

Class AppStagingSynthesizer

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.StackSynthesizer
software.amazon.awscdk.app.staging.synthesizer.alpha.AppStagingSynthesizer
All Implemented Interfaces:
IReusableStackSynthesizer, IStackSynthesizer, software.amazon.jsii.JsiiSerializable
@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)", date="2026-03-11T13:20:06.445Z") @Stability(Experimental) public class AppStagingSynthesizer extends StackSynthesizer implements IReusableStackSynthesizer
(experimental) App Staging Synthesizer.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.app.staging.synthesizer.alpha.*;
 DeploymentIdentities deploymentIdentities;
 IStagingResourcesFactory stagingResourcesFactory;
 AppStagingSynthesizer appStagingSynthesizer = AppStagingSynthesizer.customFactory(CustomFactoryOptions.builder()
         .factory(stagingResourcesFactory)
         // the properties below are optional
         .bootstrapQualifier("bootstrapQualifier")
         .deploymentIdentities(deploymentIdentities)
         .oncePerEnv(false)
         .build());

  • Field Details

    • DEFAULT_CLOUDFORMATION_ROLE_ARN

      @Stability(Experimental) public static final String DEFAULT_CLOUDFORMATION_ROLE_ARN
      (experimental) Default CloudFormation role ARN.

    • DEFAULT_DEPLOY_ROLE_ARN

      @Stability(Experimental) public static final String DEFAULT_DEPLOY_ROLE_ARN
      (experimental) Default deploy role ARN.

    • DEFAULT_LOOKUP_ROLE_ARN

      @Stability(Experimental) public static final String DEFAULT_LOOKUP_ROLE_ARN
      (experimental) Default lookup role ARN for missing values.

    • DEFAULT_QUALIFIER

      @Stability(Experimental) public static final String DEFAULT_QUALIFIER
      (experimental) Default ARN qualifier.

  • Constructor Details

    • AppStagingSynthesizer

      protected AppStagingSynthesizer(software.amazon.jsii.JsiiObjectRef objRef)

    • AppStagingSynthesizer

      protected AppStagingSynthesizer(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

  • Method Details

    • customFactory

      @Stability(Experimental) @NotNull public static AppStagingSynthesizer customFactory(@NotNull CustomFactoryOptions options)
      (experimental) 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.

      Parameters:
      options - This parameter is required.

    • customResources

      @Stability(Experimental) @NotNull public static AppStagingSynthesizer customResources(@NotNull CustomResourcesOptions options)
      (experimental) Use these exact staging resources for every stack that this synthesizer is used for.

      Parameters:
      options - This parameter is required.

    • defaultResources

      @Stability(Experimental) @NotNull public static AppStagingSynthesizer defaultResources(@NotNull DefaultResourcesOptions options)
      (experimental) Use the Default Staging Resources, creating a single stack per environment this app is deployed in.

      Parameters:
      options - This parameter is required.

    • addDockerImageAsset

      @Stability(Experimental) @NotNull public DockerImageAssetLocation addDockerImageAsset(@NotNull DockerImageAssetSource _asset)
      (experimental) Implemented for legacy purposes;

      this will never be called.

      Specified by:
      addDockerImageAsset in interface IStackSynthesizer
      Specified by:
      addDockerImageAsset in class StackSynthesizer
      Parameters:
      _asset - This parameter is required.

    • addFileAsset

      @Stability(Experimental) @NotNull public FileAssetLocation addFileAsset(@NotNull FileAssetSource _asset)
      (experimental) Implemented for legacy purposes;

      this will never be called.

      Specified by:
      addFileAsset in interface IStackSynthesizer
      Specified by:
      addFileAsset in class StackSynthesizer
      Parameters:
      _asset - This parameter is required.

    • bind

      @Stability(Experimental) public void bind(@NotNull Stack _stack)
      (experimental) Implemented for legacy purposes;

      this will never be called.

      Specified by:
      bind in interface IStackSynthesizer
      Overrides:
      bind in class StackSynthesizer
      Parameters:
      _stack - This parameter is required.

    • reusableBind

      @Stability(Experimental) @NotNull public IBoundStackSynthesizer reusableBind(@NotNull Stack stack)
      (experimental) Returns a version of the synthesizer bound to a stack.

      Specified by:
      reusableBind in interface IReusableStackSynthesizer
      Parameters:
      stack - This parameter is required.

    • synthesize

      @Stability(Experimental) public void synthesize(@NotNull ISynthesisSession _session)
      (experimental) Implemented for legacy purposes;

      this will never be called.

      Specified by:
      synthesize in interface IStackSynthesizer
      Specified by:
      synthesize in class StackSynthesizer
      Parameters:
      _session - This parameter is required.