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

Class DefaultResourcesOptions.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • bootstrapQualifier

      @Stability(Experimental) public DefaultResourcesOptions.Builder bootstrapQualifier(String bootstrapQualifier)
      Sets the value of AppStagingSynthesizerOptions.getBootstrapQualifier()
      Parameters:
      bootstrapQualifier - 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.
      Returns:
      this

    • deploymentIdentities

      @Stability(Experimental) public DefaultResourcesOptions.Builder deploymentIdentities(DeploymentIdentities deploymentIdentities)
      Sets the value of AppStagingSynthesizerOptions.getDeploymentIdentities()
      Parameters:
      deploymentIdentities - 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.
      Returns:
      this

    • appId

      @Stability(Experimental) public DefaultResourcesOptions.Builder appId(String appId)
      Sets the value of DefaultStagingStackOptions.getAppId()
      Parameters:
      appId - A unique identifier for the application that the staging stack belongs to. This parameter is required. 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.

      Returns:
      this

    • stagingBucketEncryption

      @Stability(Experimental) public DefaultResourcesOptions.Builder stagingBucketEncryption(BucketEncryption stagingBucketEncryption)
      Sets the value of DefaultStagingStackOptions.getStagingBucketEncryption()
      Parameters:
      stagingBucketEncryption - Encryption type for staging bucket. This parameter is required. 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.

      Returns:
      this

    • autoDeleteStagingAssets

      @Stability(Experimental) public DefaultResourcesOptions.Builder autoDeleteStagingAssets(Boolean autoDeleteStagingAssets)
      Sets the value of DefaultStagingStackOptions.getAutoDeleteStagingAssets()
      Parameters:
      autoDeleteStagingAssets - Auto deletes objects in the staging S3 bucket and images in the staging ECR repositories.
      Returns:
      this

    • deployTimeFileAssetLifetime

      @Stability(Experimental) public DefaultResourcesOptions.Builder deployTimeFileAssetLifetime(Duration deployTimeFileAssetLifetime)
      Sets the value of DefaultStagingStackOptions.getDeployTimeFileAssetLifetime()
      Parameters:
      deployTimeFileAssetLifetime - 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.

      Returns:
      this

    • fileAssetPublishingRole

      @Stability(Experimental) public DefaultResourcesOptions.Builder fileAssetPublishingRole(BootstrapRole fileAssetPublishingRole)
      Sets the value of DefaultStagingStackOptions.getFileAssetPublishingRole()
      Parameters:
      fileAssetPublishingRole - Pass in an existing role to be used as the file publishing role.
      Returns:
      this

    • imageAssetPublishingRole

      @Stability(Experimental) public DefaultResourcesOptions.Builder imageAssetPublishingRole(BootstrapRole imageAssetPublishingRole)
      Sets the value of DefaultStagingStackOptions.getImageAssetPublishingRole()
      Parameters:
      imageAssetPublishingRole - Pass in an existing role to be used as the image publishing role.
      Returns:
      this

    • imageAssetVersionCount

      @Stability(Experimental) public DefaultResourcesOptions.Builder imageAssetVersionCount(Number imageAssetVersionCount)
      Sets the value of DefaultStagingStackOptions.getImageAssetVersionCount()
      Parameters:
      imageAssetVersionCount - 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.
      Returns:
      this

    • stagingBucketName

      @Stability(Experimental) public DefaultResourcesOptions.Builder stagingBucketName(String stagingBucketName)
      Sets the value of DefaultStagingStackOptions.getStagingBucketName()
      Parameters:
      stagingBucketName - Explicit name for the staging bucket.
      Returns:
      this

    • stagingStackNamePrefix

      @Stability(Experimental) public DefaultResourcesOptions.Builder stagingStackNamePrefix(String stagingStackNamePrefix)
      Sets the value of DefaultStagingStackOptions.getStagingStackNamePrefix()
      Parameters:
      stagingStackNamePrefix - 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.
      Returns:
      this

    • build

      @Stability(Experimental) public DefaultResourcesOptions build()
      Builds the configured instance.
      Specified by:
      build in interface software.amazon.jsii.Builder<DefaultResourcesOptions>
      Returns:
      a new instance of DefaultResourcesOptions
      Throws:
      NullPointerException - if any required attribute was not provided