1.204.0

interface CliCredentialsStackSynthesizerProps

LanguageType name
.NETAmazon.CDK.CliCredentialsStackSynthesizerProps
Javasoftware.amazon.awscdk.core.CliCredentialsStackSynthesizerProps
Pythonaws_cdk.core.CliCredentialsStackSynthesizerProps
TypeScript (source)@aws-cdk/core » CliCredentialsStackSynthesizerProps

Properties for the CliCredentialsStackSynthesizer.

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

Properties

NameTypeDescription
bucketPrefix?stringbucketPrefix to use while storing S3 Assets.
dockerTagPrefix?stringA prefix to use while tagging and uploading Docker images to ECR.
fileAssetsBucketName?stringName of the S3 bucket to hold file assets.
imageAssetsRepositoryName?stringName of the ECR repository to hold Docker Image assets.
qualifier?stringQualifier to disambiguate multiple environments in the same account.

bucketPrefix?

Type: string (optional, default: DefaultStackSynthesizer.DEFAULT_FILE_ASSET_PREFIX)

bucketPrefix to use while storing S3 Assets.

dockerTagPrefix?

Type: string (optional, default: DefaultStackSynthesizer.DEFAULT_DOCKER_ASSET_PREFIX)

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.

fileAssetsBucketName?

Type: string (optional, default: DefaultStackSynthesizer.DEFAULT_FILE_ASSETS_BUCKET_NAME)

Name of the S3 bucket to hold file assets.

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?

Type: string (optional, default: DefaultStackSynthesizer.DEFAULT_IMAGE_ASSETS_REPOSITORY_NAME)

Name of the ECR repository to hold Docker Image assets.

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?

Type: string (optional, default: Value of context key ')

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 differnet qualifiers.

← PreviousNext →