Package software.amazon.awscdk

Interface CliCredentialsStackSynthesizerProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CliCredentialsStackSynthesizerProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.102.0 (build e354887)",
           date="2024-09-10T01:10:03.709Z")
@Stability(Stable)
public interface CliCredentialsStackSynthesizerProps
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.*;
 CliCredentialsStackSynthesizerProps cliCredentialsStackSynthesizerProps = CliCredentialsStackSynthesizerProps.builder()
         .bucketPrefix("bucketPrefix")
         .dockerTagPrefix("dockerTagPrefix")
         .fileAssetsBucketName("fileAssetsBucketName")
         .imageAssetsRepositoryName("imageAssetsRepositoryName")
         .qualifier("qualifier")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CliCredentialsStackSynthesizerProps.Builder	A builder for CliCredentialsStackSynthesizerProps
static final class	CliCredentialsStackSynthesizerProps.Jsii$Proxy	An implementation for CliCredentialsStackSynthesizerProps

Method Summary

Modifier and Type	Method	Description
static CliCredentialsStackSynthesizerProps.Builder	builder()
default String	getBucketPrefix()	bucketPrefix to use while storing S3 Assets.
default String	getDockerTagPrefix()	A prefix to use while tagging and uploading Docker images to ECR.
default String	getFileAssetsBucketName()	Name of the S3 bucket to hold file assets.
default String	getImageAssetsRepositoryName()	Name of the ECR repository to hold Docker Image assets.
default String	getQualifier()	Qualifier to disambiguate multiple environments in the same account.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getBucketPrefix

@Stability(Stable)
@Nullable
default String getBucketPrefix()

bucketPrefix to use while storing S3 Assets.

Default: - DefaultStackSynthesizer.DEFAULT_FILE_ASSET_PREFIX

getDockerTagPrefix

@Stability(Stable)
@Nullable
default String getDockerTagPrefix()

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: - DefaultStackSynthesizer.DEFAULT_DOCKER_ASSET_PREFIX

getFileAssetsBucketName

@Stability(Stable)
@Nullable
default String getFileAssetsBucketName()

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.

Default: DefaultStackSynthesizer.DEFAULT_FILE_ASSETS_BUCKET_NAME

getImageAssetsRepositoryName

@Stability(Stable)
@Nullable
default String getImageAssetsRepositoryName()

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.

Default: DefaultStackSynthesizer.DEFAULT_IMAGE_ASSETS_REPOSITORY_NAME

getQualifier

@Stability(Stable)
@Nullable
default String getQualifier()

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: - Value of context key '@aws-cdk/core:bootstrapQualifier' if set, otherwise `DefaultStackSynthesizer.DEFAULT_QUALIFIER`

builder

@Stability(Stable)
static CliCredentialsStackSynthesizerProps.Builder builder()

Returns:

a CliCredentialsStackSynthesizerProps.Builder of CliCredentialsStackSynthesizerProps