Class StackProps.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<StackProps>
- Enclosing interface:
StackProps
StackProps
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionanalyticsReporting
(Boolean analyticsReporting) Sets the value ofStackProps.getAnalyticsReporting()
build()
Builds the configured instance.crossRegionReferences
(Boolean crossRegionReferences) Sets the value ofStackProps.getCrossRegionReferences()
description
(String description) Sets the value ofStackProps.getDescription()
env
(Environment env) Sets the value ofStackProps.getEnv()
notificationArns
(List<String> notificationArns) Sets the value ofStackProps.getNotificationArns()
permissionsBoundary
(PermissionsBoundary permissionsBoundary) Sets the value ofStackProps.getPermissionsBoundary()
Sets the value ofStackProps.getStackName()
suppressTemplateIndentation
(Boolean suppressTemplateIndentation) Sets the value ofStackProps.getSuppressTemplateIndentation()
synthesizer
(IStackSynthesizer synthesizer) Sets the value ofStackProps.getSynthesizer()
Sets the value ofStackProps.getTags()
terminationProtection
(Boolean terminationProtection) Sets the value ofStackProps.getTerminationProtection()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
analyticsReporting
Sets the value ofStackProps.getAnalyticsReporting()
- Parameters:
analyticsReporting
- Include runtime versioning information in this Stack.- Returns:
this
-
crossRegionReferences
Sets the value ofStackProps.getCrossRegionReferences()
- Parameters:
crossRegionReferences
- Enable this flag to allow native cross region stack references. Enabling this will create a CloudFormation custom resource in both the producing stack and consuming stack in order to perform the export/importThis feature is currently experimental
- Returns:
this
-
description
Sets the value ofStackProps.getDescription()
- Parameters:
description
- A description of the stack.- Returns:
this
-
env
Sets the value ofStackProps.getEnv()
- Parameters:
env
- The AWS environment (account/region) where this stack will be deployed. Set theregion
/account
fields ofenv
to either a concrete value to select the indicated environment (recommended for production stacks), or to the values of environment variablesCDK_DEFAULT_REGION
/CDK_DEFAULT_ACCOUNT
to let the target environment depend on the AWS credentials/configuration that the CDK CLI is executed under (recommended for development stacks).If the
Stack
is instantiated inside aStage
, any undefinedregion
/account
fields fromenv
will default to the same field on the encompassingStage
, if configured there.If either
region
oraccount
are not set nor inherited fromStage
, the Stack will be considered "environment-agnostic"". Environment-agnostic stacks can be deployed to any environment but may not be able to take advantage of all features of the CDK. For example, they will not be able to use environmental context lookups such asec2.Vpc.fromLookup
and will not automatically translate Service Principals to the right format based on the environment's AWS partition, and other such enhancements.- Returns:
this
-
notificationArns
Sets the value ofStackProps.getNotificationArns()
- Parameters:
notificationArns
- SNS Topic ARNs that will receive stack events.- Returns:
this
-
permissionsBoundary
@Stability(Stable) public StackProps.Builder permissionsBoundary(PermissionsBoundary permissionsBoundary) Sets the value ofStackProps.getPermissionsBoundary()
- Parameters:
permissionsBoundary
- Options for applying a permissions boundary to all IAM Roles and Users created within this Stage.- Returns:
this
-
stackName
Sets the value ofStackProps.getStackName()
- Parameters:
stackName
- Name to deploy the stack with.- Returns:
this
-
suppressTemplateIndentation
@Stability(Stable) public StackProps.Builder suppressTemplateIndentation(Boolean suppressTemplateIndentation) Sets the value ofStackProps.getSuppressTemplateIndentation()
- Parameters:
suppressTemplateIndentation
- Enable this flag to suppress indentation in generated CloudFormation templates. If not specified, the value of the@aws-cdk/core:suppressTemplateIndentation
context key will be used. If that is not specified, then the default valuefalse
will be used.- Returns:
this
-
synthesizer
Sets the value ofStackProps.getSynthesizer()
- Parameters:
synthesizer
- Synthesis method to use while deploying this stack. The Stack Synthesizer controls aspects of synthesis and deployment, like how assets are referenced and what IAM roles to use. For more information, see the README of the main CDK package.If not specified, the
defaultStackSynthesizer
fromApp
will be used. If that is not specified,DefaultStackSynthesizer
is used if@aws-cdk/core:newStyleStackSynthesis
is set totrue
or the CDK major version is v2. In CDK v1LegacyStackSynthesizer
is the default if no other synthesizer is specified.- Returns:
this
-
tags
Sets the value ofStackProps.getTags()
- Parameters:
tags
- Stack tags that will be applied to all the taggable resources and the stack itself.- Returns:
this
-
terminationProtection
Sets the value ofStackProps.getTerminationProtection()
- Parameters:
terminationProtection
- Whether to enable termination protection for this stack.- Returns:
this
-
build
Builds the configured instance.- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<StackProps>
- Returns:
- a new instance of
StackProps
- Throws:
NullPointerException
- if any required attribute was not provided
-