Class BootstraplessSynthesizer

Synthesizer that reuses bootstrap roles from a different region.

Inheritance
System.Object
StackSynthesizer
DefaultStackSynthesizer
BootstraplessSynthesizer
Inherited Members
Namespace: Amazon.CDK
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class BootstraplessSynthesizer : DefaultStackSynthesizer, IReusableStackSynthesizer, IBoundStackSynthesizer, IStackSynthesizer
Syntax (vb)
Public Class BootstraplessSynthesizer
    Inherits DefaultStackSynthesizer
    Implements IReusableStackSynthesizer, IBoundStackSynthesizer, IStackSynthesizer
Remarks

A special synthesizer that behaves similarly to DefaultStackSynthesizer, but doesn't require bootstrapping the environment it operates in. Instead, it will re-use the Roles that were created for a different region (which is possible because IAM is a global service).

However, it will not assume asset buckets or repositories have been created, and therefore does not support assets.

The name is poorly chosen -- it does still require bootstrapping, it just does not support assets.

Used by the CodePipeline construct for the support stacks needed for cross-region replication S3 buckets. App builders do not need to use this synthesizer directly.

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK;

var bootstraplessSynthesizer = new BootstraplessSynthesizer(new BootstraplessSynthesizerProps {
    CloudFormationExecutionRoleArn = "cloudFormationExecutionRoleArn",
    DeployRoleArn = "deployRoleArn"
});

Synopsis

Constructors

BootstraplessSynthesizer(IBootstraplessSynthesizerProps)
BootstraplessSynthesizer(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference
BootstraplessSynthesizer(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

Methods

AddDockerImageAsset(IDockerImageAssetSource)

Register a Docker Image Asset.
AddFileAsset(IFileAssetSource)

Register a File Asset.
Synthesize(ISynthesisSession)

Synthesize the associated stack to the session.

Constructors

BootstraplessSynthesizer(IBootstraplessSynthesizerProps)

public BootstraplessSynthesizer(IBootstraplessSynthesizerProps props = null)
Parameters
props IBootstraplessSynthesizerProps

BootstraplessSynthesizer(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected BootstraplessSynthesizer(ByRefValue reference)
Parameters
reference Amazon.JSII.Runtime.Deputy.ByRefValue

The Javascript-owned object reference

BootstraplessSynthesizer(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected BootstraplessSynthesizer(DeputyBase.DeputyProps props)
Parameters
props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps

The deputy props

Methods

AddDockerImageAsset(IDockerImageAssetSource)

Register a Docker Image Asset.

public override IDockerImageAssetLocation AddDockerImageAsset(IDockerImageAssetSource asset)
Parameters
asset IDockerImageAssetSource
Returns

IDockerImageAssetLocation

Overrides
Remarks

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(IFileAssetSource)

Register a File Asset.

public override IFileAssetLocation AddFileAsset(IFileAssetSource asset)
Parameters
asset IFileAssetSource
Returns

IFileAssetLocation

Overrides
Remarks

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.

Synthesize(ISynthesisSession)

Synthesize the associated stack to the session.

public override void Synthesize(ISynthesisSession session)
Parameters
session ISynthesisSession
Overrides

Implements