Skip to content
v2.277.0

CliCredentialsStackSynthesizerProps Struct ​

Properties for the CliCredentialsStackSynthesizer.

Example ​

ts
// 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 cliCredentialsStackSynthesizerProps: cdk.CliCredentialsStackSynthesizerProps = {
  bucketPrefix: 'bucketPrefix',
  dockerTagPrefix: 'dockerTagPrefix',
  fileAssetsBucketName: 'fileAssetsBucketName',
  imageAssetsRepositoryName: 'imageAssetsRepositoryName',
  qualifier: 'qualifier',
};
python
# 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_props = cdk.CliCredentialsStackSynthesizerProps(
    bucket_prefix="bucketPrefix",
    docker_tag_prefix="dockerTagPrefix",
    file_assets_bucket_name="fileAssetsBucketName",
    image_assets_repository_name="imageAssetsRepositoryName",
    qualifier="qualifier"
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.*;

CliCredentialsStackSynthesizerProps cliCredentialsStackSynthesizerProps = CliCredentialsStackSynthesizerProps.builder()
        .bucketPrefix("bucketPrefix")
        .dockerTagPrefix("dockerTagPrefix")
        .fileAssetsBucketName("fileAssetsBucketName")
        .imageAssetsRepositoryName("imageAssetsRepositoryName")
        .qualifier("qualifier")
        .build();
csharp
// 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 cliCredentialsStackSynthesizerProps = new CliCredentialsStackSynthesizerProps {
    BucketPrefix = "bucketPrefix",
    DockerTagPrefix = "dockerTagPrefix",
    FileAssetsBucketName = "fileAssetsBucketName",
    ImageAssetsRepositoryName = "imageAssetsRepositoryName",
    Qualifier = "qualifier"
};
go
// 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"

cliCredentialsStackSynthesizerProps := &CliCredentialsStackSynthesizerProps{
	BucketPrefix: jsii.String("bucketPrefix"),
	DockerTagPrefix: jsii.String("dockerTagPrefix"),
	FileAssetsBucketName: jsii.String("fileAssetsBucketName"),
	ImageAssetsRepositoryName: jsii.String("imageAssetsRepositoryName"),
	Qualifier: jsii.String("qualifier"),
}

Properties ​

bucketPrefixoptionalstringbucket_prefixoptionalstrbucketPrefixoptionalStringBucketPrefixoptionalstringBucketPrefixoptional*string #
bucketPrefix to use while storing S3 Assets.

Default: DefaultStackSynthesizer.DEFAULT_FILE_ASSET_PREFIX

dockerTagPrefixoptionalstringdocker_tag_prefixoptionalstrdockerTagPrefixoptionalStringDockerTagPrefixoptionalstringDockerTagPrefixoptional*string #
A prefix to use while tagging and uploading Docker images to ECR.

Default: DefaultStackSynthesizer.DEFAULT_DOCKER_ASSET_PREFIX

This does not add any separators - the source hash will be appended to this string directly.

fileAssetsBucketNameoptionalstringfile_assets_bucket_nameoptionalstrfileAssetsBucketNameoptionalStringFileAssetsBucketNameoptionalstringFileAssetsBucketNameoptional*string #
Name of the S3 bucket to hold file assets.

Default: DefaultStackSynthesizer.DEFAULT_FILE_ASSETS_BUCKET_NAME

notes

You must supply this if you have given a non-standard name to the staging bucket.

The placeholders ${Qualifier}, ${AWS::AccountId} and ${AWS::Region} will be replaced with the values of qualifier and the stack's account and region, respectively.

imageAssetsRepositoryNameoptionalstringimage_assets_repository_nameoptionalstrimageAssetsRepositoryNameoptionalStringImageAssetsRepositoryNameoptionalstringImageAssetsRepositoryNameoptional*string #
Name of the ECR repository to hold Docker Image assets.

Default: DefaultStackSynthesizer.DEFAULT_IMAGE_ASSETS_REPOSITORY_NAME

notes

You must supply this if you have given a non-standard name to the ECR repository.

The placeholders ${Qualifier}, ${AWS::AccountId} and ${AWS::Region} will be replaced with the values of qualifier and the stack's account and region, respectively.

qualifieroptionalstringqualifieroptionalstrqualifieroptionalStringQualifieroptionalstringQualifieroptional*string #
Qualifier to disambiguate multiple environments in the same account.

Default: Value of context key '@aws-cdk/core:bootstrapQualifier' if set, otherwise DefaultStackSynthesizer.DEFAULT_QUALIFIER

You can use this and leave the other naming properties empty if you have deployed the bootstrap environment with standard names but only different qualifiers.