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

Class DefaultStagingStack.Builder

java.lang.Object
software.amazon.awscdk.app.staging.synthesizer.alpha.DefaultStagingStack.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<DefaultStagingStack>
Enclosing class:
DefaultStagingStack
@Stability(Experimental) public static final class DefaultStagingStack.Builder extends Object implements software.amazon.jsii.Builder<DefaultStagingStack>
(experimental) A fluent builder for DefaultStagingStack.

  • Method Details

    • create

      @Stability(Experimental) public static DefaultStagingStack.Builder create(App scope, String id)
      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      Returns:
      a new instance of DefaultStagingStack.Builder.

    • appId

      @Stability(Experimental) public DefaultStagingStack.Builder appId(String appId)
      (experimental) A unique identifier for the application that the staging stack belongs to.

      This identifier will be used in the name of staging resources created for this application, and should be unique across CDK apps.

      The identifier should include lowercase characters and dashes ('-') only and have a maximum of 20 characters.

      Parameters:
      appId - A unique identifier for the application that the staging stack belongs to. This parameter is required.
      Returns:
      this

    • stagingBucketEncryption

      @Stability(Experimental) public DefaultStagingStack.Builder stagingBucketEncryption(BucketEncryption stagingBucketEncryption)
      (experimental) Encryption type for staging bucket.

      In future versions of this package, the default will be BucketEncryption.S3_MANAGED.

      In previous versions of this package, the default was to use KMS encryption for the staging bucket. KMS keys cost $1/month, which could result in unexpected costs for users who are not aware of this. As we stabilize this module we intend to make the default S3-managed encryption, which is free. However, the migration path from KMS to S3 managed encryption for existing buckets is not straightforward. Therefore, for now, this property is required.

      If you have an existing staging bucket encrypted with a KMS key, you will likely want to set this property to BucketEncryption.KMS. If you are creating a new staging bucket, you can set this property to BucketEncryption.S3_MANAGED to avoid the cost of a KMS key.

      Parameters:
      stagingBucketEncryption - Encryption type for staging bucket. This parameter is required.
      Returns:
      this

    • autoDeleteStagingAssets

      @Stability(Experimental) public DefaultStagingStack.Builder autoDeleteStagingAssets(Boolean autoDeleteStagingAssets)
      (experimental) Auto deletes objects in the staging S3 bucket and images in the staging ECR repositories.

      Default: true

      Parameters:
      autoDeleteStagingAssets - Auto deletes objects in the staging S3 bucket and images in the staging ECR repositories. This parameter is required.
      Returns:
      this

    • deployTimeFileAssetLifetime

      @Stability(Experimental) public DefaultStagingStack.Builder deployTimeFileAssetLifetime(Duration deployTimeFileAssetLifetime)
      (experimental) The lifetime for deploy time file assets.

      Assets that are only necessary at deployment time (for instance, CloudFormation templates and Lambda source code bundles) will be automatically deleted after this many days. Assets that may be read from the staging bucket during your application's run time will not be deleted.

      Set this to the length of time you wish to be able to roll back to previous versions of your application without having to do a new cdk synth and re-upload of assets.

      Default: - Duration.days(30)

      Parameters:
      deployTimeFileAssetLifetime - The lifetime for deploy time file assets. This parameter is required.
      Returns:
      this

    • fileAssetPublishingRole

      @Stability(Experimental) public DefaultStagingStack.Builder fileAssetPublishingRole(BootstrapRole fileAssetPublishingRole)
      (experimental) Pass in an existing role to be used as the file publishing role.

      Default: - a new role will be created

      Parameters:
      fileAssetPublishingRole - Pass in an existing role to be used as the file publishing role. This parameter is required.
      Returns:
      this

    • imageAssetPublishingRole

      @Stability(Experimental) public DefaultStagingStack.Builder imageAssetPublishingRole(BootstrapRole imageAssetPublishingRole)
      (experimental) Pass in an existing role to be used as the image publishing role.

      Default: - a new role will be created

      Parameters:
      imageAssetPublishingRole - Pass in an existing role to be used as the image publishing role. This parameter is required.
      Returns:
      this

    • imageAssetVersionCount

      @Stability(Experimental) public DefaultStagingStack.Builder imageAssetVersionCount(Number imageAssetVersionCount)
      (experimental) The maximum number of image versions to store in a repository.

      Previous versions of an image can be stored for rollback purposes. Once a repository has more than 3 image versions stored, the oldest version will be discarded. This allows for sensible garbage collection while maintaining a few previous versions for rollback scenarios.

      Default: - up to 3 versions stored

      Parameters:
      imageAssetVersionCount - The maximum number of image versions to store in a repository. This parameter is required.
      Returns:
      this

    • stagingBucketName

      @Stability(Experimental) public DefaultStagingStack.Builder stagingBucketName(String stagingBucketName)
      (experimental) Explicit name for the staging bucket.

      Default: - a well-known name unique to this app/env.

      Parameters:
      stagingBucketName - Explicit name for the staging bucket. This parameter is required.
      Returns:
      this

    • stagingStackNamePrefix

      @Stability(Experimental) public DefaultStagingStack.Builder stagingStackNamePrefix(String stagingStackNamePrefix)
      (experimental) Specify a custom prefix to be used as the staging stack name and construct ID.

      The prefix will be appended before the appId, which is required to be part of the stack name and construct ID to ensure uniqueness.

      Default: 'StagingStack'

      Parameters:
      stagingStackNamePrefix - Specify a custom prefix to be used as the staging stack name and construct ID. This parameter is required.
      Returns:
      this

    • analyticsReporting

      @Stability(Stable) public DefaultStagingStack.Builder analyticsReporting(Boolean analyticsReporting)
      Include runtime versioning information in this Stack.

      Default: `analyticsReporting` setting of containing `App`, or value of 'aws:cdk:version-reporting' context key

      Parameters:
      analyticsReporting - Include runtime versioning information in this Stack. This parameter is required.
      Returns:
      this

    • crossRegionReferences

      @Stability(Stable) public DefaultStagingStack.Builder crossRegionReferences(Boolean 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/import

      This feature is currently experimental

      Default: false

      Parameters:
      crossRegionReferences - Enable this flag to allow native cross region stack references. This parameter is required.
      Returns:
      this

    • description

      @Stability(Stable) public DefaultStagingStack.Builder description(String description)
      A description of the stack.

      Default: - No description.

      Parameters:
      description - A description of the stack. This parameter is required.
      Returns:
      this

    • env

      @Stability(Stable) public DefaultStagingStack.Builder env(Environment env)
      The AWS environment (account/region) where this stack will be deployed.

      Set the region/account fields of env to either a concrete value to select the indicated environment (recommended for production stacks), or to the values of environment variables CDK_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 a Stage, any undefined region/account fields from env will default to the same field on the encompassing Stage, if configured there.

      If either region or account are not set nor inherited from Stage, 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 as ec2.Vpc.fromLookup and will not automatically translate Service Principals to the right format based on the environment's AWS partition, and other such enhancements.

      Default: - The environment of the containing `Stage` if available, otherwise create the stack will be environment-agnostic.

      Example: 

       // Use a concrete account and region to deploy this stack to:
 // `.account` and `.region` will simply return these values.
 // Use a concrete account and region to deploy this stack to:
 // `.account` and `.region` will simply return these values.
 Stack.Builder.create(app, "Stack1")
         .env(Environment.builder()
                 .account("123456789012")
                 .region("us-east-1")
                 .build())
         .build();
 // Use the CLI's current credentials to determine the target environment:
 // `.account` and `.region` will reflect the account+region the CLI
 // is configured to use (based on the user CLI credentials)
 // Use the CLI's current credentials to determine the target environment:
 // `.account` and `.region` will reflect the account+region the CLI
 // is configured to use (based on the user CLI credentials)
 Stack.Builder.create(app, "Stack2")
         .env(Environment.builder()
                 .account(process.getEnv().getCDK_DEFAULT_ACCOUNT())
                 .region(process.getEnv().getCDK_DEFAULT_REGION())
                 .build())
         .build();
 // Define multiple stacks stage associated with an environment
 Stage myStage = Stage.Builder.create(app, "MyStage")
         .env(Environment.builder()
                 .account("123456789012")
                 .region("us-east-1")
                 .build())
         .build();
 // both of these stacks will use the stage's account/region:
 // `.account` and `.region` will resolve to the concrete values as above
 // both of these stacks will use the stage's account/region:
 // `.account` and `.region` will resolve to the concrete values as above
 new MyStack(myStage, "Stack1");
 new YourStack(myStage, "Stack2");
 // Define an environment-agnostic stack:
 // `.account` and `.region` will resolve to `{ "Ref": "AWS::AccountId" }` and `{ "Ref": "AWS::Region" }` respectively.
 // which will only resolve to actual values by CloudFormation during deployment.
 // Define an environment-agnostic stack:
 // `.account` and `.region` will resolve to `{ "Ref": "AWS::AccountId" }` and `{ "Ref": "AWS::Region" }` respectively.
 // which will only resolve to actual values by CloudFormation during deployment.
 new MyStack(app, "Stack1");

      Parameters:
      env - The AWS environment (account/region) where this stack will be deployed. This parameter is required.
      Returns:
      this

    • notificationArns

      @Stability(Stable) public DefaultStagingStack.Builder notificationArns(List<String> notificationArns)
      SNS Topic ARNs that will receive stack events.

      Default: - no notfication arns.

      Parameters:
      notificationArns - SNS Topic ARNs that will receive stack events. This parameter is required.
      Returns:
      this

    • permissionsBoundary

      @Stability(Stable) public DefaultStagingStack.Builder permissionsBoundary(PermissionsBoundary permissionsBoundary)
      Options for applying a permissions boundary to all IAM Roles and Users created within this Stage.

      Default: - no permissions boundary is applied

      Parameters:
      permissionsBoundary - Options for applying a permissions boundary to all IAM Roles and Users created within this Stage. This parameter is required.
      Returns:
      this

    • stackName

      @Stability(Stable) public DefaultStagingStack.Builder stackName(String stackName)
      Name to deploy the stack with.

      Default: - Derived from construct path.

      Parameters:
      stackName - Name to deploy the stack with. This parameter is required.
      Returns:
      this

    • suppressTemplateIndentation

      @Stability(Stable) public DefaultStagingStack.Builder suppressTemplateIndentation(Boolean 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 value false will be used.

      Default: - the value of `@aws-cdk/core:suppressTemplateIndentation`, or `false` if that is not set.

      Parameters:
      suppressTemplateIndentation - Enable this flag to suppress indentation in generated CloudFormation templates. This parameter is required.
      Returns:
      this

    • synthesizer

      @Stability(Stable) public DefaultStagingStack.Builder synthesizer(IStackSynthesizer 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 from App will be used. If that is not specified, DefaultStackSynthesizer is used if @aws-cdk/core:newStyleStackSynthesis is set to true or the CDK major version is v2. In CDK v1 LegacyStackSynthesizer is the default if no other synthesizer is specified.

      Default: - The synthesizer specified on `App`, or `DefaultStackSynthesizer` otherwise.

      Parameters:
      synthesizer - Synthesis method to use while deploying this stack. This parameter is required.
      Returns:
      this

    • tags

      @Stability(Stable) public DefaultStagingStack.Builder tags(Map<String,String> tags)
      Stack tags that will be applied to all the taggable resources and the stack itself.

      Default: {}

      Parameters:
      tags - Stack tags that will be applied to all the taggable resources and the stack itself. This parameter is required.
      Returns:
      this

    • terminationProtection

      @Stability(Stable) public DefaultStagingStack.Builder terminationProtection(Boolean terminationProtection)
      Whether to enable termination protection for this stack.

      Default: false

      Parameters:
      terminationProtection - Whether to enable termination protection for this stack. This parameter is required.
      Returns:
      this

    • qualifier

      @Stability(Experimental) public DefaultStagingStack.Builder qualifier(String qualifier)
      (experimental) The qualifier used to specialize strings.

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

      Parameters:
      qualifier - The qualifier used to specialize strings. This parameter is required.
      Returns:
      this

    • deployRoleArn

      @Stability(Experimental) public DefaultStagingStack.Builder deployRoleArn(String deployRoleArn)
      (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.

      Parameters:
      deployRoleArn - The ARN of the deploy action role, if given. This parameter is required.
      Returns:
      this

    • build

      @Stability(Experimental) public DefaultStagingStack build()
      Specified by:
      build in interface software.amazon.jsii.Builder<DefaultStagingStack>
      Returns:
      a newly built instance of DefaultStagingStack.