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

Class DefaultStagingStackProps.Jsii$Proxy

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.app.staging.synthesizer.alpha.DefaultStagingStackProps.Jsii$Proxy
All Implemented Interfaces:
DefaultStagingStackOptions, DefaultStagingStackProps, StackProps, software.amazon.jsii.JsiiSerializable
Enclosing interface:
DefaultStagingStackProps
@Stability(Experimental) @Internal public static final class DefaultStagingStackProps.Jsii$Proxy extends software.amazon.jsii.JsiiObject implements DefaultStagingStackProps
An implementation for DefaultStagingStackProps

  • Constructor Details

    • Jsii$Proxy

      protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
      Constructor that initializes the object based on values retrieved from the JsiiObject.
      Parameters:
      objRef - Reference to the JSII managed object.

    • Jsii$Proxy

      protected Jsii$Proxy(DefaultStagingStackProps.Builder builder)
      Constructor that initializes the object based on literal property values passed by the DefaultStagingStackProps.Builder.

  • Method Details

    • getQualifier

      public final String getQualifier()
      Description copied from interface: DefaultStagingStackProps
      (experimental) The qualifier used to specialize strings.

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

      Specified by:
      getQualifier in interface DefaultStagingStackProps

    • getDeployRoleArn

      public final String getDeployRoleArn()
      Description copied from interface: DefaultStagingStackProps
      (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.

      Specified by:
      getDeployRoleArn in interface DefaultStagingStackProps

    • getAppId

      public final String getAppId()
      Description copied from interface: DefaultStagingStackOptions
      (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.

      Specified by:
      getAppId in interface DefaultStagingStackOptions

    • getStagingBucketEncryption

      public final BucketEncryption getStagingBucketEncryption()
      Description copied from interface: DefaultStagingStackOptions
      (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.

      Specified by:
      getStagingBucketEncryption in interface DefaultStagingStackOptions

    • getAutoDeleteStagingAssets

      public final Boolean getAutoDeleteStagingAssets()
      Description copied from interface: DefaultStagingStackOptions
      (experimental) Auto deletes objects in the staging S3 bucket and images in the staging ECR repositories.

      Default: true

      Specified by:
      getAutoDeleteStagingAssets in interface DefaultStagingStackOptions

    • getDeployTimeFileAssetLifetime

      public final Duration getDeployTimeFileAssetLifetime()
      Description copied from interface: DefaultStagingStackOptions
      (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)

      Specified by:
      getDeployTimeFileAssetLifetime in interface DefaultStagingStackOptions

    • getFileAssetPublishingRole

      public final BootstrapRole getFileAssetPublishingRole()
      Description copied from interface: DefaultStagingStackOptions
      (experimental) Pass in an existing role to be used as the file publishing role.

      Default: - a new role will be created

      Specified by:
      getFileAssetPublishingRole in interface DefaultStagingStackOptions

    • getImageAssetPublishingRole

      public final BootstrapRole getImageAssetPublishingRole()
      Description copied from interface: DefaultStagingStackOptions
      (experimental) Pass in an existing role to be used as the image publishing role.

      Default: - a new role will be created

      Specified by:
      getImageAssetPublishingRole in interface DefaultStagingStackOptions

    • getImageAssetVersionCount

      public final Number getImageAssetVersionCount()
      Description copied from interface: DefaultStagingStackOptions
      (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

      Specified by:
      getImageAssetVersionCount in interface DefaultStagingStackOptions

    • getStagingBucketName

      public final String getStagingBucketName()
      Description copied from interface: DefaultStagingStackOptions
      (experimental) Explicit name for the staging bucket.

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

      Specified by:
      getStagingBucketName in interface DefaultStagingStackOptions

    • getStagingStackNamePrefix

      public final String getStagingStackNamePrefix()
      Description copied from interface: DefaultStagingStackOptions
      (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'

      Specified by:
      getStagingStackNamePrefix in interface DefaultStagingStackOptions

    • getAnalyticsReporting

      public final Boolean getAnalyticsReporting()
      Description copied from interface: StackProps
      Include runtime versioning information in this Stack.

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

      Specified by:
      getAnalyticsReporting in interface StackProps

    • getCrossRegionReferences

      public final Boolean getCrossRegionReferences()
      Description copied from interface: StackProps
      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

      Specified by:
      getCrossRegionReferences in interface StackProps

    • getDescription

      public final String getDescription()
      Description copied from interface: StackProps
      A description of the stack.

      Default: - No description.

      Specified by:
      getDescription in interface StackProps

    • getEnv

      public final Environment getEnv()
      Description copied from interface: StackProps
      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");
      Specified by:
      getEnv in interface StackProps

    • getPermissionsBoundary

      public final PermissionsBoundary getPermissionsBoundary()
      Description copied from interface: StackProps
      Options for applying a permissions boundary to all IAM Roles and Users created within this Stage.

      Default: - no permissions boundary is applied

      Specified by:
      getPermissionsBoundary in interface StackProps

    • getStackName

      public final String getStackName()
      Description copied from interface: StackProps
      Name to deploy the stack with.

      Default: - Derived from construct path.

      Specified by:
      getStackName in interface StackProps

    • getSuppressTemplateIndentation

      public final Boolean getSuppressTemplateIndentation()
      Description copied from interface: StackProps
      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.

      Specified by:
      getSuppressTemplateIndentation in interface StackProps

    • getSynthesizer

      public final IStackSynthesizer getSynthesizer()
      Description copied from interface: StackProps
      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.

      Specified by:
      getSynthesizer in interface StackProps

    • getTags

      public final Map<String,String> getTags()
      Description copied from interface: StackProps
      Stack tags that will be applied to all the taggable resources and the stack itself.

      Default: {}

      Specified by:
      getTags in interface StackProps

    • getTerminationProtection

      public final Boolean getTerminationProtection()
      Description copied from interface: StackProps
      Whether to enable termination protection for this stack.

      Default: false

      Specified by:
      getTerminationProtection in interface StackProps

    • $jsii$toJson

      @Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
      Specified by:
      $jsii$toJson in interface software.amazon.jsii.JsiiSerializable

    • equals

      public final boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object