software.amazon.awscdk

Class CliCredentialsStackSynthesizer

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.StackSynthesizer

software.amazon.awscdk.CliCredentialsStackSynthesizer

All Implemented Interfaces:

IStackSynthesizer, software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:35.879Z")
 @Stability(value=Stable)
public class CliCredentialsStackSynthesizer
extends StackSynthesizer

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.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.*;
 CliCredentialsStackSynthesizer cliCredentialsStackSynthesizer = CliCredentialsStackSynthesizer.Builder.create()
         .bucketPrefix("bucketPrefix")
         .dockerTagPrefix("dockerTagPrefix")
         .fileAssetsBucketName("fileAssetsBucketName")
         .imageAssetsRepositoryName("imageAssetsRepositoryName")
         .qualifier("qualifier")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CliCredentialsStackSynthesizer.Builder A fluent builder for CliCredentialsStackSynthesizer.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IStackSynthesizer

IStackSynthesizer.Jsii$Default

Constructor Summary

Constructors

Modifier	Constructor and Description
	CliCredentialsStackSynthesizer()
	CliCredentialsStackSynthesizer(CliCredentialsStackSynthesizerProps props)
protected	CliCredentialsStackSynthesizer(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CliCredentialsStackSynthesizer(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
DockerImageAssetLocation	addDockerImageAsset(DockerImageAssetSource asset) Register a Docker Image Asset.
FileAssetLocation	addFileAsset(FileAssetSource asset) Register a File Asset.
void	bind(Stack stack) Bind to the stack this environment is going to be used on.
void	synthesize(ISynthesisSession session) Synthesize the associated stack to the session.

Methods inherited from class software.amazon.awscdk.StackSynthesizer

emitStackArtifact, emitStackArtifact, synthesizeStackTemplate

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

CliCredentialsStackSynthesizer

protected CliCredentialsStackSynthesizer(software.amazon.jsii.JsiiObjectRef objRef)

CliCredentialsStackSynthesizer

protected CliCredentialsStackSynthesizer(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CliCredentialsStackSynthesizer

@Stability(value=Stable)
public CliCredentialsStackSynthesizer(@Nullable
                                                               CliCredentialsStackSynthesizerProps props)

Parameters:

props -

CliCredentialsStackSynthesizer

@Stability(value=Stable)
public CliCredentialsStackSynthesizer()

Method Detail

addDockerImageAsset

@Stability(value=Stable)
 @NotNull
public DockerImageAssetLocation addDockerImageAsset(@NotNull
                                                                                       DockerImageAssetSource asset)

Register a Docker Image Asset.

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

Specified by:

addDockerImageAsset in interface IStackSynthesizer

Specified by:

addDockerImageAsset in class StackSynthesizer

Parameters:

asset - This parameter is required.

addFileAsset

@Stability(value=Stable)
 @NotNull
public FileAssetLocation addFileAsset(@NotNull
                                                                         FileAssetSource asset)

Register a File Asset.

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

Specified by:

addFileAsset in interface IStackSynthesizer

Specified by:

addFileAsset in class StackSynthesizer

Parameters:

asset - This parameter is required.

bind

@Stability(value=Stable)
public void bind(@NotNull
                                          Stack stack)

Bind to the stack this environment is going to be used on.

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

Specified by:

bind in interface IStackSynthesizer

Specified by:

bind in class StackSynthesizer

Parameters:

stack - This parameter is required.

synthesize

@Stability(value=Stable)
public void synthesize(@NotNull
                                                ISynthesisSession session)

Synthesize the associated stack to the session.

Specified by:

synthesize in interface IStackSynthesizer

Specified by:

synthesize in class StackSynthesizer

Parameters:

session - This parameter is required.