# CliCredentialsStackSynthesizer

A synthesizer that uses conventional asset locations, but not conventional deployment roles.

Instead of assuming the bootstrapped deployment roles, all stack operations will be performed
using the CLI's current credentials.

- This synthesizer does not support deploying to accounts to which the CLI does not have
  credentials. It also does not support deploying using **CDK Pipelines**. For either of those
  features, use `DefaultStackSynthesizer`.
- This synthesizer requires an S3 bucket and ECR repository with well-known names. To
  not depend on those, use `LegacyStackSynthesizer`.

Be aware that your CLI credentials must be valid for the duration of the
entire deployment. If you are using session credentials, make sure the
session lifetime is long enough.

By default, expects the environment to have been bootstrapped with just the staging resources
of the Bootstrap Stack V2 (also known as "modern bootstrap stack"). You can override
the default names using the synthesizer's construction properties.

Extends: StackSynthesizer › CliCredentialsStackSynthesizer
Implements: IBoundStackSynthesizer, IReusableStackSynthesizer, IStackSynthesizer

- Source: [`core/lib/stack-synthesizers/cli-credentials-synthesizer.ts`](https://github.com/aws/aws-cdk/blob/v2.274.0/packages/aws-cdk-lib/core/lib/stack-synthesizers/cli-credentials-synthesizer.ts#L92)
- Type last changed: v2.61.0 · 19 Jan 2023

## Example

```ts
// 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 cliCredentialsStackSynthesizer = new cdk.CliCredentialsStackSynthesizer(/* all optional props */ {
  bucketPrefix: 'bucketPrefix',
  dockerTagPrefix: 'dockerTagPrefix',
  fileAssetsBucketName: 'fileAssetsBucketName',
  imageAssetsRepositoryName: 'imageAssetsRepositoryName',
  qualifier: 'qualifier',
});
```

## Initializer

```ts
new CliCredentialsStackSynthesizer(props?: CliCredentialsStackSynthesizerProps)
```

## Properties

- `bootstrapQualifier`: string — The qualifier used to bootstrap this stack.

- `cloudFormationExecutionRole`: string — The role that is passed to CloudFormation to execute the change set.

- `lookupRole`: string — The role used to lookup for this stack.

## Methods

- `addDockerImageAsset(asset: DockerImageAssetSource): DockerImageAssetLocation` — Register a Docker Image Asset.

  Returns the parameters that can be used to refer to the asset inside the template.

  The synthesizer must rely on some out-of-band mechanism to make sure the given files
  are actually placed in the returned location before the deployment happens. This can
  be by writing the instructions to the asset manifest (for use by the `cdk-assets` tool),
  by relying on the CLI to upload files (legacy behavior), or some other operator controlled
  mechanism.

- `addFileAsset(asset: FileAssetSource): FileAssetLocation` — Register a File Asset.

  Returns the parameters that can be used to refer to the asset inside the template.

  The synthesizer must rely on some out-of-band mechanism to make sure the given files
  are actually placed in the returned location before the deployment happens. This can
  be by writing the instructions to the asset manifest (for use by the `cdk-assets` tool),
  by relying on the CLI to upload files (legacy behavior), or some other operator controlled
  mechanism.

- `bind(stack: Stack): void` — Bind to the stack this environment is going to be used on.

  Must be called before any of the other methods are called.

- `reusableBind(stack: Stack): IBoundStackSynthesizer` — Produce a bound Stack Synthesizer for the given stack.

  This method may be called more than once on the same object.

- `synthesize(session: ISynthesisSession): void` — Synthesize the associated stack to the session.