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

Interface CustomFactoryOptions

All Superinterfaces:

AppStagingSynthesizerOptions, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CustomFactoryOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.112.0 (build de1bc80)",
           date="2025-05-20T23:53:05.684Z")
@Stability(Experimental)
public interface CustomFactoryOptions
extends software.amazon.jsii.JsiiSerializable, AppStagingSynthesizerOptions

(experimental) Properties for customFactory static method.

Example:

 public class CustomFactory implements IStagingResourcesFactory {
     public CustomStagingStack obtainStagingResources(Stack stack, ObtainStagingResourcesContext context) {
         Stage myApp = App.of(stack);
         return new CustomStagingStack(myApp, String.format("CustomStagingStack-%s", context.getEnvironmentString()), new CustomStagingStackProps());
     }
 }
 App app = App.Builder.create()
         .defaultStackSynthesizer(AppStagingSynthesizer.customFactory(CustomFactoryOptions.builder()
                 .factory(new CustomFactory())
                 .oncePerEnv(true)
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CustomFactoryOptions.Builder	A builder for CustomFactoryOptions
static final class	CustomFactoryOptions.Jsii$Proxy	An implementation for CustomFactoryOptions

Method Summary

Modifier and Type	Method	Description
static CustomFactoryOptions.Builder	builder()
IStagingResourcesFactory	getFactory()	(experimental) The factory that will be used to return staging resources for each stack.
default Boolean	getOncePerEnv()	(experimental) Reuse the answer from the factory for stacks in the same environment.

Methods inherited from interface software.amazon.awscdk.app.staging.synthesizer.alpha.AppStagingSynthesizerOptions

getBootstrapQualifier, getDeploymentIdentities

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getFactory

@Stability(Experimental)
@NotNull
IStagingResourcesFactory getFactory()

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

getOncePerEnv

@Stability(Experimental)
@Nullable
default Boolean getOncePerEnv()

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

Default: true

builder

@Stability(Experimental)
static CustomFactoryOptions.Builder builder()

Returns:

a CustomFactoryOptions.Builder of CustomFactoryOptions