Table of Contents

Interface ICliCredentialsStackSynthesizerProps

Namespace
Amazon.CDK
Assembly
Amazon.CDK.dll

Properties for the CliCredentialsStackSynthesizer.

public interface ICliCredentialsStackSynthesizerProps

Examples

// 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"
            };

Remarks

ExampleMetadata: fixture=_generated

Properties

BucketPrefix

bucketPrefix to use while storing S3 Assets.

string? BucketPrefix { get; }

Property Value

string

Remarks

Default: - DefaultStackSynthesizer.DEFAULT_FILE_ASSET_PREFIX

DockerTagPrefix

A prefix to use while tagging and uploading Docker images to ECR.

string? DockerTagPrefix { get; }

Property Value

string

Remarks

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

Default: - DefaultStackSynthesizer.DEFAULT_DOCKER_ASSET_PREFIX

FileAssetsBucketName

Name of the S3 bucket to hold file assets.

string? FileAssetsBucketName { get; }

Property Value

string

Remarks

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

The placeholders \({Qualifier}</code>, <code>\){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

ImageAssetsRepositoryName

Name of the ECR repository to hold Docker Image assets.

string? ImageAssetsRepositoryName { get; }

Property Value

string

Remarks

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

The placeholders \({Qualifier}</code>, <code>\){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

Qualifier

Qualifier to disambiguate multiple environments in the same account.

string? Qualifier { get; }

Property Value

string

Remarks

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.

Default: - Value of context key '

Aws-cdk: /core:bootstrapQualifier' if set, otherwise DefaultStackSynthesizer.DEFAULT_QUALIFIER