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

Interface DefaultStagingStackProps

All Superinterfaces:

DefaultStagingStackOptions, software.amazon.jsii.JsiiSerializable, StackProps

All Known Implementing Classes:

DefaultStagingStackProps.Jsii$Proxy

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

(experimental) Default Staging Stack Properties.

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.*;
 import software.amazon.awscdk.*;
 import software.amazon.awscdk.services.s3.*;
 BootstrapRole bootstrapRole;
 PermissionsBoundary permissionsBoundary;
 StackSynthesizer stackSynthesizer;
 DefaultStagingStackProps defaultStagingStackProps = DefaultStagingStackProps.builder()
         .appId("appId")
         .qualifier("qualifier")
         .stagingBucketEncryption(BucketEncryption.UNENCRYPTED)
         // the properties below are optional
         .analyticsReporting(false)
         .autoDeleteStagingAssets(false)
         .crossRegionReferences(false)
         .deployRoleArn("deployRoleArn")
         .deployTimeFileAssetLifetime(Duration.minutes(30))
         .description("description")
         .env(Environment.builder()
                 .account("account")
                 .region("region")
                 .build())
         .fileAssetPublishingRole(bootstrapRole)
         .imageAssetPublishingRole(bootstrapRole)
         .imageAssetVersionCount(123)
         .permissionsBoundary(permissionsBoundary)
         .stackName("stackName")
         .stagingBucketName("stagingBucketName")
         .stagingStackNamePrefix("stagingStackNamePrefix")
         .suppressTemplateIndentation(false)
         .synthesizer(stackSynthesizer)
         .tags(Map.of(
                 "tagsKey", "tags"))
         .terminationProtection(false)
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static DefaultStagingStackProps.Builder	builder()
default String	getDeployRoleArn()	(experimental) The ARN of the deploy action role, if given.
String	getQualifier()	(experimental) The qualifier used to specialize strings.

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

getAppId, getAutoDeleteStagingAssets, getDeployTimeFileAssetLifetime, getFileAssetPublishingRole, getImageAssetPublishingRole, getImageAssetVersionCount, getStagingBucketEncryption, getStagingBucketName, getStagingStackNamePrefix

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Methods inherited from interface software.amazon.awscdk.StackProps

getAnalyticsReporting, getCrossRegionReferences, getDescription, getEnv, getPermissionsBoundary, getStackName, getSuppressTemplateIndentation, getSynthesizer, getTags, getTerminationProtection

Method Details

getQualifier

@Stability(Experimental)
@NotNull
String getQualifier()

(experimental) The qualifier used to specialize strings.

Shouldn't be necessary but who knows what people might do.

getDeployRoleArn

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

(experimental) The ARN of the deploy action role, if given.

This role will need permissions to read from to the staging resources.

Default: - The CLI credentials are assumed, no additional permissions are granted.

builder

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

Returns:

a DefaultStagingStackProps.Builder of DefaultStagingStackProps