DefaultStackSynthesizer.Builder (software.amazon.awscdk:aws-cdk-lib 2.42.1 API)

java.lang.Object
- software.amazon.awscdk.DefaultStackSynthesizer.Builder

All Implemented Interfaces:: software.amazon.jsii.Builder<DefaultStackSynthesizer>

Enclosing class:: DefaultStackSynthesizer

@Stability(value=Stable)
public static final class DefaultStackSynthesizer.Builder
extends Object
implements software.amazon.jsii.Builder<DefaultStackSynthesizer>

A fluent builder for DefaultStackSynthesizer.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DefaultStackSynthesizer.Builder`	`bootstrapStackVersionSsmParameter(String bootstrapStackVersionSsmParameter)` Bootstrap stack version SSM parameter.
`DefaultStackSynthesizer.Builder`	`bucketPrefix(String bucketPrefix)` bucketPrefix to use while storing S3 Assets.
`DefaultStackSynthesizer`	`build()`
`DefaultStackSynthesizer.Builder`	`cloudFormationExecutionRole(String cloudFormationExecutionRole)` The role CloudFormation will assume when deploying the Stack.
`static DefaultStackSynthesizer.Builder`	`create()`
`DefaultStackSynthesizer.Builder`	`deployRoleArn(String deployRoleArn)` The role to assume to initiate a deployment in this environment.
`DefaultStackSynthesizer.Builder`	`deployRoleExternalId(String deployRoleExternalId)` External ID to use when assuming role for cloudformation deployments.
`DefaultStackSynthesizer.Builder`	`dockerTagPrefix(String dockerTagPrefix)` A prefix to use while tagging and uploading Docker images to ECR.
`DefaultStackSynthesizer.Builder`	`fileAssetPublishingExternalId(String fileAssetPublishingExternalId)` External ID to use when assuming role for file asset publishing.
`DefaultStackSynthesizer.Builder`	`fileAssetPublishingRoleArn(String fileAssetPublishingRoleArn)` The role to use to publish file assets to the S3 bucket in this environment.
`DefaultStackSynthesizer.Builder`	`fileAssetsBucketName(String fileAssetsBucketName)` Name of the S3 bucket to hold file assets.
`DefaultStackSynthesizer.Builder`	`generateBootstrapVersionRule(Boolean generateBootstrapVersionRule)` Whether to add a Rule to the stack template verifying the bootstrap stack version.
`DefaultStackSynthesizer.Builder`	`imageAssetPublishingExternalId(String imageAssetPublishingExternalId)` External ID to use when assuming role for image asset publishing.
`DefaultStackSynthesizer.Builder`	`imageAssetPublishingRoleArn(String imageAssetPublishingRoleArn)` The role to use to publish image assets to the ECR repository in this environment.
`DefaultStackSynthesizer.Builder`	`imageAssetsRepositoryName(String imageAssetsRepositoryName)` Name of the ECR repository to hold Docker Image assets.
`DefaultStackSynthesizer.Builder`	`lookupRoleArn(String lookupRoleArn)` The role to use to look up values from the target AWS account during synthesis.
`DefaultStackSynthesizer.Builder`	`lookupRoleExternalId(String lookupRoleExternalId)` External ID to use when assuming lookup role.
`DefaultStackSynthesizer.Builder`	`qualifier(String qualifier)` Qualifier to disambiguate multiple environments in the same account.
`DefaultStackSynthesizer.Builder`	`useLookupRoleForStackOperations(Boolean useLookupRoleForStackOperations)` Use the bootstrapped lookup role for (read-only) stack operations.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - create
```
@Stability(value=Stable)
public static DefaultStackSynthesizer.Builder create()
```
    Returns:
    
    a new instance of DefaultStackSynthesizer.Builder.
  - bootstrapStackVersionSsmParameter
```
@Stability(value=Stable)
public DefaultStackSynthesizer.Builder bootstrapStackVersionSsmParameter(String bootstrapStackVersionSsmParameter)
```
    Bootstrap stack version SSM parameter.
    The placeholder ${Qualifier} will be replaced with the value of qualifier.
    Default: DefaultStackSynthesizer.DEFAULT_BOOTSTRAP_STACK_VERSION_SSM_PARAMETER
    
    Parameters:
    
    bootstrapStackVersionSsmParameter - Bootstrap stack version SSM parameter. This parameter is required.
    
    Returns:
    
    this
  - bucketPrefix
```
@Stability(value=Stable)
public DefaultStackSynthesizer.Builder bucketPrefix(String bucketPrefix)
```
    bucketPrefix to use while storing S3 Assets.
    Default: - DefaultStackSynthesizer.DEFAULT_FILE_ASSET_PREFIX
    
    Parameters:
    
    bucketPrefix - bucketPrefix to use while storing S3 Assets. This parameter is required.
    
    Returns:
    
    this
  - cloudFormationExecutionRole
```
@Stability(value=Stable)
public DefaultStackSynthesizer.Builder cloudFormationExecutionRole(String cloudFormationExecutionRole)
```
    The role CloudFormation will assume when deploying the Stack.
    You must supply this if you have given a non-standard name to the execution role.
    The placeholders ${Qualifier}, ${AWS::AccountId} and ${AWS::Region} will be replaced with the values of qualifier and the stack's account and region, respectively.
    Default: DefaultStackSynthesizer.DEFAULT_CLOUDFORMATION_ROLE_ARN
    
    Parameters:
    
    cloudFormationExecutionRole - The role CloudFormation will assume when deploying the Stack. This parameter is required.
    
    Returns:
    
    this
  - deployRoleArn
```
@Stability(value=Stable)
public DefaultStackSynthesizer.Builder deployRoleArn(String deployRoleArn)
```
    The role to assume to initiate a deployment in this environment.
    You must supply this if you have given a non-standard name to the publishing role.
    The placeholders ${Qualifier}, ${AWS::AccountId} and ${AWS::Region} will be replaced with the values of qualifier and the stack's account and region, respectively.
    Default: DefaultStackSynthesizer.DEFAULT_DEPLOY_ROLE_ARN
    
    Parameters:
    
    deployRoleArn - The role to assume to initiate a deployment in this environment. This parameter is required.
    
    Returns:
    
    this
  - deployRoleExternalId
```
@Stability(value=Stable)
public DefaultStackSynthesizer.Builder deployRoleExternalId(String deployRoleExternalId)
```
    External ID to use when assuming role for cloudformation deployments.
    Default: - No external ID
    
    Parameters:
    
    deployRoleExternalId - External ID to use when assuming role for cloudformation deployments. This parameter is required.
    
    Returns:
    
    this
  - dockerTagPrefix
```
@Stability(value=Stable)
public DefaultStackSynthesizer.Builder dockerTagPrefix(String dockerTagPrefix)
```
    A prefix to use while tagging and uploading Docker images to ECR.
    This does not add any separators - the source hash will be appended to this string directly.
    Default: - DefaultStackSynthesizer.DEFAULT_DOCKER_ASSET_PREFIX
    
    Parameters:
    
    dockerTagPrefix - A prefix to use while tagging and uploading Docker images to ECR. This parameter is required.
    
    Returns:
    
    this
  - fileAssetPublishingExternalId
```
@Stability(value=Stable)
public DefaultStackSynthesizer.Builder fileAssetPublishingExternalId(String fileAssetPublishingExternalId)
```
    External ID to use when assuming role for file asset publishing.
    Default: - No external ID
    
    Parameters:
    
    fileAssetPublishingExternalId - External ID to use when assuming role for file asset publishing. This parameter is required.
    
    Returns:
    
    this
  - fileAssetPublishingRoleArn
```
@Stability(value=Stable)
public DefaultStackSynthesizer.Builder fileAssetPublishingRoleArn(String fileAssetPublishingRoleArn)
```
    The role to use to publish file assets to the S3 bucket in this environment.
    You must supply this if you have given a non-standard name to the publishing role.
    The placeholders ${Qualifier}, ${AWS::AccountId} and ${AWS::Region} will be replaced with the values of qualifier and the stack's account and region, respectively.
    Default: DefaultStackSynthesizer.DEFAULT_FILE_ASSET_PUBLISHING_ROLE_ARN
    
    Parameters:
    
    fileAssetPublishingRoleArn - The role to use to publish file assets to the S3 bucket in this environment. This parameter is required.
    
    Returns:
    
    this
  - fileAssetsBucketName
```
@Stability(value=Stable)
public DefaultStackSynthesizer.Builder fileAssetsBucketName(String fileAssetsBucketName)
```
    Name of the S3 bucket to hold file assets.
    You must supply this if you have given a non-standard name to the staging bucket.
    The placeholders ${Qualifier}, ${AWS::AccountId} and ${AWS::Region} will be replaced with the values of qualifier and the stack's account and region, respectively.
    Default: DefaultStackSynthesizer.DEFAULT_FILE_ASSETS_BUCKET_NAME
    
    Parameters:
    
    fileAssetsBucketName - Name of the S3 bucket to hold file assets. This parameter is required.
    
    Returns:
    
    this
  - generateBootstrapVersionRule
```
@Stability(value=Stable)
public DefaultStackSynthesizer.Builder generateBootstrapVersionRule(Boolean generateBootstrapVersionRule)
```
    Whether to add a Rule to the stack template verifying the bootstrap stack version.
    This generally should be left set to true, unless you explicitly want to be able to deploy to an unbootstrapped environment.
    Default: true
    
    Parameters:
    
    generateBootstrapVersionRule - Whether to add a Rule to the stack template verifying the bootstrap stack version. This parameter is required.
    
    Returns:
    
    this
  - imageAssetPublishingExternalId
```
@Stability(value=Stable)
public DefaultStackSynthesizer.Builder imageAssetPublishingExternalId(String imageAssetPublishingExternalId)
```
    External ID to use when assuming role for image asset publishing.
    Default: - No external ID
    
    Parameters:
    
    imageAssetPublishingExternalId - External ID to use when assuming role for image asset publishing. This parameter is required.
    
    Returns:
    
    this
  - imageAssetPublishingRoleArn
```
@Stability(value=Stable)
public DefaultStackSynthesizer.Builder imageAssetPublishingRoleArn(String imageAssetPublishingRoleArn)
```
    The role to use to publish image assets to the ECR repository in this environment.
    You must supply this if you have given a non-standard name to the publishing role.
    The placeholders ${Qualifier}, ${AWS::AccountId} and ${AWS::Region} will be replaced with the values of qualifier and the stack's account and region, respectively.
    Default: DefaultStackSynthesizer.DEFAULT_IMAGE_ASSET_PUBLISHING_ROLE_ARN
    
    Parameters:
    
    imageAssetPublishingRoleArn - The role to use to publish image assets to the ECR repository in this environment. This parameter is required.
    
    Returns:
    
    this
  - imageAssetsRepositoryName
```
@Stability(value=Stable)
public DefaultStackSynthesizer.Builder imageAssetsRepositoryName(String imageAssetsRepositoryName)
```
    Name of the ECR repository to hold Docker Image assets.
    You must supply this if you have given a non-standard name to the ECR repository.
    The placeholders ${Qualifier}, ${AWS::AccountId} and ${AWS::Region} will be replaced with the values of qualifier and the stack's account and region, respectively.
    Default: DefaultStackSynthesizer.DEFAULT_IMAGE_ASSETS_REPOSITORY_NAME
    
    Parameters:
    
    imageAssetsRepositoryName - Name of the ECR repository to hold Docker Image assets. This parameter is required.
    
    Returns:
    
    this
  - lookupRoleArn
```
@Stability(value=Stable)
public DefaultStackSynthesizer.Builder lookupRoleArn(String lookupRoleArn)
```
    The role to use to look up values from the target AWS account during synthesis.
    Default: - None
    
    Parameters:
    
    lookupRoleArn - The role to use to look up values from the target AWS account during synthesis. This parameter is required.
    
    Returns:
    
    this
  - lookupRoleExternalId
```
@Stability(value=Stable)
public DefaultStackSynthesizer.Builder lookupRoleExternalId(String lookupRoleExternalId)
```
    External ID to use when assuming lookup role.
    Default: - No external ID
    
    Parameters:
    
    lookupRoleExternalId - External ID to use when assuming lookup role. This parameter is required.
    
    Returns:
    
    this
  - qualifier
```
@Stability(value=Stable)
public DefaultStackSynthesizer.Builder qualifier(String qualifier)
```
    Qualifier to disambiguate multiple environments in the same account.
    You can use this and leave the other naming properties empty if you have deployed the bootstrap environment with standard names but only differnet qualifiers.
    Default: - Value of context key '
    
    Parameters:
    
    qualifier - Qualifier to disambiguate multiple environments in the same account. This parameter is required.
    
    Returns:
    
    this
  - useLookupRoleForStackOperations
```
@Stability(value=Stable)
public DefaultStackSynthesizer.Builder useLookupRoleForStackOperations(Boolean useLookupRoleForStackOperations)
```
    Use the bootstrapped lookup role for (read-only) stack operations.
    Use the lookup role when performing a cdk diff. If set to false, the deploy role credentials will be used to perform a cdk diff.
    Requires bootstrap stack version 8.
    Default: true
    
    Parameters:
    
    useLookupRoleForStackOperations - Use the bootstrapped lookup role for (read-only) stack operations. This parameter is required.
    
    Returns:
    
    this
  - build
```
@Stability(value=Stable)
public DefaultStackSynthesizer build()
```
    Specified by:
    
    build in interface software.amazon.jsii.Builder<DefaultStackSynthesizer>

Class DefaultStackSynthesizer.Builder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

create

bootstrapStackVersionSsmParameter

bucketPrefix

cloudFormationExecutionRole

deployRoleArn

deployRoleExternalId

dockerTagPrefix

fileAssetPublishingExternalId

fileAssetPublishingRoleArn

fileAssetsBucketName

generateBootstrapVersionRule

imageAssetPublishingExternalId

imageAssetPublishingRoleArn

imageAssetsRepositoryName

lookupRoleArn

lookupRoleExternalId

qualifier

useLookupRoleForStackOperations

build