class BootstraplessSynthesizer
Language | Type name |
---|---|
.NET | Amazon.CDK.BootstraplessSynthesizer |
Java | software.amazon.awscdk.core.BootstraplessSynthesizer |
Python | aws_cdk.core.BootstraplessSynthesizer |
TypeScript (source) | @aws-cdk/core » BootstraplessSynthesizer |
Implements
IStack
Extends
Default
Synthesizer that reuses bootstrap roles from a different region.
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.
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.
Example
// 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/core';
const bootstraplessSynthesizer = new cdk.BootstraplessSynthesizer({
cloudFormationExecutionRoleArn: 'cloudFormationExecutionRoleArn',
deployRoleArn: 'deployRoleArn',
});
Initializer
new BootstraplessSynthesizer(props: BootstraplessSynthesizerProps)
Parameters
Properties
Name | Type | Description |
---|---|---|
cloud | string | Returns the ARN of the CFN execution Role. |
deploy | string | Returns the ARN of the deploy Role. |
cloudFormationExecutionRoleArn
Type:
string
Returns the ARN of the CFN execution Role.
deployRoleArn
Type:
string
Returns the ARN of the deploy Role.
Methods
Name | Description |
---|---|
add | Register a Docker Image Asset. |
add | Register a File Asset. |
bind(stack) | Bind to the stack this environment is going to be used on. |
synthesize(session) | Synthesize the associated stack to the session. |
DockerImageAsset(_asset)
addpublic addDockerImageAsset(_asset: DockerImageAssetSource): DockerImageAssetLocation
Parameters
- _asset
Docker
Image Asset Source
Returns
Register a Docker Image Asset.
Returns the parameters that can be used to refer to the asset inside the template.
FileAsset(_asset)
addpublic addFileAsset(_asset: FileAssetSource): FileAssetLocation
Parameters
- _asset
File
Asset Source
Returns
Register a File Asset.
Returns the parameters that can be used to refer to the asset inside the template.
bind(stack)
public bind(stack: Stack): void
Parameters
- 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.
synthesize(session)
public synthesize(session: ISynthesisSession): void
Parameters
- session
ISynthesis
Session
Synthesize the associated stack to the session.