CliCredentialsStackSynthesizer Class
A synthesizer that uses conventional asset locations, but not conventional deployment roles.
Instead of assuming the bootstrapped deployment roles, all stack operations will be performed using the CLI's current credentials.
- This synthesizer does not support deploying to accounts to which the CLI does not have credentials. It also does not support deploying using CDK Pipelines. For either of those features, use
DefaultStackSynthesizer. - This synthesizer requires an S3 bucket and ECR repository with well-known names. To not depend on those, use
LegacyStackSynthesizer.
Be aware that your CLI credentials must be valid for the duration of the entire deployment. If you are using session credentials, make sure the session lifetime is long enough.
By default, expects the environment to have been bootstrapped with just the staging resources of the Bootstrap Stack V2 (also known as "modern bootstrap stack"). You can override the default names using the synthesizer's construction properties.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cdk from 'aws-cdk-lib';
const cliCredentialsStackSynthesizer = new cdk.CliCredentialsStackSynthesizer(/* all optional props */ {
bucketPrefix: 'bucketPrefix',
dockerTagPrefix: 'dockerTagPrefix',
fileAssetsBucketName: 'fileAssetsBucketName',
imageAssetsRepositoryName: 'imageAssetsRepositoryName',
qualifier: 'qualifier',
});
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk as cdk
cli_credentials_stack_synthesizer = cdk.CliCredentialsStackSynthesizer(
bucket_prefix="bucketPrefix",
docker_tag_prefix="dockerTagPrefix",
file_assets_bucket_name="fileAssetsBucketName",
image_assets_repository_name="imageAssetsRepositoryName",
qualifier="qualifier"
)
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.*;
CliCredentialsStackSynthesizer cliCredentialsStackSynthesizer = CliCredentialsStackSynthesizer.Builder.create()
.bucketPrefix("bucketPrefix")
.dockerTagPrefix("dockerTagPrefix")
.fileAssetsBucketName("fileAssetsBucketName")
.imageAssetsRepositoryName("imageAssetsRepositoryName")
.qualifier("qualifier")
.build();
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK;
var cliCredentialsStackSynthesizer = new CliCredentialsStackSynthesizer(new CliCredentialsStackSynthesizerProps {
BucketPrefix = "bucketPrefix",
DockerTagPrefix = "dockerTagPrefix",
FileAssetsBucketName = "fileAssetsBucketName",
ImageAssetsRepositoryName = "imageAssetsRepositoryName",
Qualifier = "qualifier"
});
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
cliCredentialsStackSynthesizer := cdk.NewCliCredentialsStackSynthesizer(&CliCredentialsStackSynthesizerProps{
BucketPrefix: jsii.String("bucketPrefix"),
DockerTagPrefix: jsii.String("dockerTagPrefix"),
FileAssetsBucketName: jsii.String("fileAssetsBucketName"),
ImageAssetsRepositoryName: jsii.String("imageAssetsRepositoryName"),
Qualifier: jsii.String("qualifier"),
})
Initializer
new CliCredentialsStackSynthesizer(props?: CliCredentialsStackSynthesizerProps)
CliCredentialsStackSynthesizer(props: typing.Optional[CliCredentialsStackSynthesizerProps] = None)
new CliCredentialsStackSynthesizer(CliCredentialsStackSynthesizerProps props)
new CliCredentialsStackSynthesizer(CliCredentialsStackSynthesizerProps? props = null)
NewCliCredentialsStackSynthesizer(Props CliCredentialsStackSynthesizerProps)
Properties
bootstrapQualifierstringbootstrap_qualifierstrbootstrapQualifierStringBootstrapQualifierstringBootstrapQualifier*string#cloudFormationExecutionRolestringcloud_formation_execution_rolestrcloudFormationExecutionRoleStringCloudFormationExecutionRolestringCloudFormationExecutionRole*string#Methods
addDockerImageAsset(asset: DockerImageAssetSource): DockerImageAssetLocationdef add_docker_image_asset(self, asset: DockerImageAssetSource) -> DockerImageAssetLocationpublic DockerImageAssetLocation addDockerImageAsset(DockerImageAssetSource asset)public DockerImageAssetLocation AddDockerImageAsset(DockerImageAssetSource asset)func AddDockerImageAsset(Asset DockerImageAssetSource) DockerImageAssetLocation#notes
Returns the parameters that can be used to refer to the asset inside the template.
The synthesizer must rely on some out-of-band mechanism to make sure the given files are actually placed in the returned location before the deployment happens. This can be by writing the instructions to the asset manifest (for use by the cdk-assets tool), by relying on the CLI to upload files (legacy behavior), or some other operator controlled mechanism.
addFileAsset(asset: FileAssetSource): FileAssetLocationdef add_file_asset(self, asset: FileAssetSource) -> FileAssetLocationpublic FileAssetLocation addFileAsset(FileAssetSource asset)public FileAssetLocation AddFileAsset(FileAssetSource asset)func AddFileAsset(Asset FileAssetSource) FileAssetLocation#notes
Returns the parameters that can be used to refer to the asset inside the template.
The synthesizer must rely on some out-of-band mechanism to make sure the given files are actually placed in the returned location before the deployment happens. This can be by writing the instructions to the asset manifest (for use by the cdk-assets tool), by relying on the CLI to upload files (legacy behavior), or some other operator controlled mechanism.
bind(stack: Stack): voiddef bind(self, stack: Stack) -> Nonepublic void bind(Stack stack)public void Bind(Stack stack)func Bind(Stack Stack)#Must be called before any of the other methods are called.
reusableBind(stack: Stack): IBoundStackSynthesizerdef reusable_bind(self, stack: Stack) -> IBoundStackSynthesizerpublic IBoundStackSynthesizer reusableBind(Stack stack)public IBoundStackSynthesizer ReusableBind(Stack stack)func ReusableBind(Stack Stack) IBoundStackSynthesizer#This method may be called more than once on the same object.
synthesize(session: ISynthesisSession): voiddef synthesize(self, session: ISynthesisSession) -> Nonepublic void synthesize(ISynthesisSession session)public void Synthesize(ISynthesisSession session)func Synthesize(Session ISynthesisSession)#