AWS CDK Reference

Appearance

v2.273.0

CliCredentialsStackSynthesizerProps Struct ​

Properties for the CliCredentialsStackSynthesizer.

Source
core/lib/stack-synthesizers/cli-credentials-synthesizer.ts
Type last changed
v2.72.0 · 29 Mar 2023

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',
};

Properties ​

bucketPrefixstringbucket_prefixstrbucketPrefixStringBucketPrefixstringBucketPrefix*string= DefaultStackSynthesizer.DEFAULT_…#
bucketPrefix to use while storing S3 Assets.
default

Default: DefaultStackSynthesizer.DEFAULT_FILE_ASSET_PREFIX

dockerTagPrefixstringdocker_tag_prefixstrdockerTagPrefixStringDockerTagPrefixstringDockerTagPrefix*string= DefaultStackSynthesizer.DEFAULT_…#
A prefix to use while tagging and uploading Docker images to ECR.

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

default

Default: DefaultStackSynthesizer.DEFAULT_DOCKER_ASSET_PREFIX

fileAssetsBucketNamestringfile_assets_bucket_namestrfileAssetsBucketNameStringFileAssetsBucketNamestringFileAssetsBucketName*string= DefaultStackSynthesizer.DEFAULT_…#
Name of the S3 bucket to hold file assets.
notes · default

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.

Default: DefaultStackSynthesizer.DEFAULT_FILE_ASSETS_BUCKET_NAME

imageAssetsRepositoryNamestringimage_assets_repository_namestrimageAssetsRepositoryNameStringImageAssetsRepositoryNamestringImageAssetsRepositoryName*string= DefaultStackSynthesizer.DEFAULT_…#
Name of the ECR repository to hold Docker Image assets.
notes · default

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.

Default: DefaultStackSynthesizer.DEFAULT_IMAGE_ASSETS_REPOSITORY_NAME

qualifierstringqualifierstrqualifierStringQualifierstringQualifier*string= Value of context key '@aws-cdk/c…#
Qualifier to disambiguate multiple environments in the same account.

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.

default

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

Used as props by ​