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

Interface AppStagingSynthesizerOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

CustomFactoryOptions, CustomResourcesOptions, DefaultResourcesOptions

All Known Implementing Classes:

AppStagingSynthesizerOptions.Jsii$Proxy, CustomFactoryOptions.Jsii$Proxy, CustomResourcesOptions.Jsii$Proxy, DefaultResourcesOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-08T21:35:15.520Z")
@Stability(Experimental)
public interface AppStagingSynthesizerOptions
extends software.amazon.jsii.JsiiSerializable

(experimental) Options that apply to all AppStagingSynthesizer variants.

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;
 AppStagingSynthesizerOptions appStagingSynthesizerOptions = AppStagingSynthesizerOptions.builder()
         .bootstrapQualifier("bootstrapQualifier")
         .deploymentIdentities(deploymentIdentities)
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static AppStagingSynthesizerOptions.Builder	builder()
default String	getBootstrapQualifier()	(experimental) Qualifier to disambiguate multiple bootstrapped environments in the same account.
default DeploymentIdentities	getDeploymentIdentities()	(experimental) What roles to use to deploy applications.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getBootstrapQualifier

@Stability(Experimental)
@Nullable
default String getBootstrapQualifier()

(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`

getDeploymentIdentities

@Stability(Experimental)
@Nullable
default DeploymentIdentities getDeploymentIdentities()

(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

builder

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

Returns:

a AppStagingSynthesizerOptions.Builder of AppStagingSynthesizerOptions