Class DefaultStagingStackProps.Jsii$Proxy
- All Implemented Interfaces:
DefaultStagingStackOptions
,DefaultStagingStackProps
,StackProps
,software.amazon.jsii.JsiiSerializable
- Enclosing interface:
DefaultStagingStackProps
DefaultStagingStackProps
-
Nested Class Summary
Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.amazon.awscdk.app.staging.synthesizer.alpha.DefaultStagingStackProps
DefaultStagingStackProps.Builder, DefaultStagingStackProps.Jsii$Proxy
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
Constructor that initializes the object based on literal property values passed by theDefaultStagingStackProps.Builder
.protected
Jsii$Proxy
(software.amazon.jsii.JsiiObjectRef objRef) Constructor that initializes the object based on values retrieved from the JsiiObject. -
Method Summary
Modifier and TypeMethodDescriptioncom.fasterxml.jackson.databind.JsonNode
final boolean
final Boolean
Include runtime versioning information in this Stack.final String
getAppId()
(experimental) A unique identifier for the application that the staging stack belongs to.final Boolean
(experimental) Auto deletes objects in the staging S3 bucket and images in the staging ECR repositories.final Boolean
Enable this flag to allow native cross region stack references.final String
(experimental) The ARN of the deploy action role, if given.final Duration
(experimental) The lifetime for deploy time file assets.final String
A description of the stack.final Environment
getEnv()
The AWS environment (account/region) where this stack will be deployed.final BootstrapRole
(experimental) Pass in an existing role to be used as the file publishing role.final BootstrapRole
(experimental) Pass in an existing role to be used as the image publishing role.final Number
(experimental) The maximum number of image versions to store in a repository.final PermissionsBoundary
Options for applying a permissions boundary to all IAM Roles and Users created within this Stage.final String
(experimental) The qualifier used to specialize strings.final String
Name to deploy the stack with.final BucketEncryption
(experimental) Encryption type for staging bucket.final String
(experimental) Explicit name for the staging bucket.final String
(experimental) Specify a custom prefix to be used as the staging stack name and construct ID.final Boolean
Enable this flag to suppress indentation in generated CloudFormation templates.final IStackSynthesizer
Synthesis method to use while deploying this stack.getTags()
Stack tags that will be applied to all the taggable resources and the stack itself.final Boolean
Whether to enable termination protection for this stack.final int
hashCode()
Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
-
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
Constructor that initializes the object based on literal property values passed by theDefaultStagingStackProps.Builder
.
-
-
Method Details
-
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 interfaceDefaultStagingStackProps
-
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 interfaceDefaultStagingStackProps
-
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 interfaceDefaultStagingStackOptions
-
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 interfaceDefaultStagingStackOptions
-
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 interfaceDefaultStagingStackOptions
-
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 interfaceDefaultStagingStackOptions
-
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 interfaceDefaultStagingStackOptions
-
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 interfaceDefaultStagingStackOptions
-
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 interfaceDefaultStagingStackOptions
-
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 interfaceDefaultStagingStackOptions
-
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 interfaceDefaultStagingStackOptions
-
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 interfaceStackProps
-
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 interfaceStackProps
-
getDescription
Description copied from interface:StackProps
A description of the stack.Default: - No description.
- Specified by:
getDescription
in interfaceStackProps
-
getEnv
Description copied from interface:StackProps
The AWS environment (account/region) where this stack will be deployed.Set the
region
/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.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 interfaceStackProps
-
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 interfaceStackProps
-
getStackName
Description copied from interface:StackProps
Name to deploy the stack with.Default: - Derived from construct path.
- Specified by:
getStackName
in interfaceStackProps
-
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 valuefalse
will be used.Default: - the value of `@aws-cdk/core:suppressTemplateIndentation`, or `false` if that is not set.
- Specified by:
getSuppressTemplateIndentation
in interfaceStackProps
-
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
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.Default: - The synthesizer specified on `App`, or `DefaultStackSynthesizer` otherwise.
- Specified by:
getSynthesizer
in interfaceStackProps
-
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 interfaceStackProps
-
getTerminationProtection
Description copied from interface:StackProps
Whether to enable termination protection for this stack.Default: false
- Specified by:
getTerminationProtection
in interfaceStackProps
-
$jsii$toJson
@Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()- Specified by:
$jsii$toJson
in interfacesoftware.amazon.jsii.JsiiSerializable
-
equals
-
hashCode
public final int hashCode()
-