CliCredentialsStackSynthesizerProps

class aws_cdk.core.CliCredentialsStackSynthesizerProps(*, bucket_prefix=None, docker_tag_prefix=None, file_assets_bucket_name=None, image_assets_repository_name=None, qualifier=None)

Bases: object

Properties for the CliCredentialsStackSynthesizer.

Parameters
  • bucket_prefix (Optional[str]) – bucketPrefix to use while storing S3 Assets. Default: - DefaultStackSynthesizer.DEFAULT_FILE_ASSET_PREFIX

  • docker_tag_prefix (Optional[str]) – 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

  • file_assets_bucket_name (Optional[str]) – 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

  • image_assets_repository_name (Optional[str]) – 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

  • qualifier (Optional[str]) – 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. Default: - Value of context key ‘

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.core as cdk

cli_credentials_stack_synthesizer_props = cdk.CliCredentialsStackSynthesizerProps(
    bucket_prefix="bucketPrefix",
    docker_tag_prefix="dockerTagPrefix",
    file_assets_bucket_name="fileAssetsBucketName",
    image_assets_repository_name="imageAssetsRepositoryName",
    qualifier="qualifier"
)

Attributes

bucket_prefix

bucketPrefix to use while storing S3 Assets.

Default
  • DefaultStackSynthesizer.DEFAULT_FILE_ASSET_PREFIX

Return type

Optional[str]

docker_tag_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.

Default
  • DefaultStackSynthesizer.DEFAULT_DOCKER_ASSET_PREFIX

Return type

Optional[str]

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.

Default

DefaultStackSynthesizer.DEFAULT_FILE_ASSETS_BUCKET_NAME

Return type

Optional[str]

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.

Default

DefaultStackSynthesizer.DEFAULT_IMAGE_ASSETS_REPOSITORY_NAME

Return type

Optional[str]

qualifier

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.

Default
  • Value of context key ‘

Aws-cdk

/core:bootstrapQualifier’ if set, otherwise DefaultStackSynthesizer.DEFAULT_QUALIFIER

Return type

Optional[str]