aws-cdk-lib.CliCredentialsStackSynthesizerProps

CliCredentialsStackSynthesizerProps Struct

Properties for the CliCredentialsStackSynthesizer.

CliCredentialsStackSynthesizerProps

used as props by

• CliCredentialsStackSynthesizer

Source

core/lib/stack-synthesizers/cli-credentials-synthesizer.ts

Type last changed

v2.72.0 · 29 Mar 2023

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 cliCredentialsStackSynthesizerProps: cdk.CliCredentialsStackSynthesizerProps = {
  bucketPrefix: 'bucketPrefix',
  dockerTagPrefix: 'dockerTagPrefix',
  fileAssetsBucketName: 'fileAssetsBucketName',
  imageAssetsRepositoryName: 'imageAssetsRepositoryName',
  qualifier: 'qualifier',
};

Properties

bucketPrefix?optionalstringbucket_prefix?optionalstrbucketPrefix?optionalStringBucketPrefix?optionalstringBucketPrefix?optional*string#

bucketPrefix to use while storing S3 Assets.

Default: DefaultStackSynthesizer.DEFAULT_FILE_ASSET_PREFIX

dockerTagPrefix?optionalstringdocker_tag_prefix?optionalstrdockerTagPrefix?optionalStringDockerTagPrefix?optionalstringDockerTagPrefix?optional*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.

fileAssetsBucketName?optionalstringfile_assets_bucket_name?optionalstrfileAssetsBucketName?optionalStringFileAssetsBucketName?optionalstringFileAssetsBucketName?optional*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.

imageAssetsRepositoryName?optionalstringimage_assets_repository_name?optionalstrimageAssetsRepositoryName?optionalStringImageAssetsRepositoryName?optionalstringImageAssetsRepositoryName?optional*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.

qualifier?optionalstringqualifier?optionalstrqualifier?optionalStringQualifier?optionalstringQualifier?optional*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.