@aws-cdk/cx-api

Reference

Environment (interface)

class _aws-cdk_cx-api.Environment

Models an AWS execution environment, for use within the CDK toolkit.

name

The arbitrary name of this environment (user-set, or at least user-meaningful)

Type:string
account

The 12-digit AWS account ID for the account this environment deploys into

Type:string
region

The AWS region name where this environment deploys into

Type:string

ListStacksRequest (interface)

class _aws-cdk_cx-api.ListStacksRequest
type
Type:string
context
Type:any or None

ListStacksResponse (interface)

class _aws-cdk_cx-api.ListStacksResponse
stacks
Type:StackInfo

MetadataEntry (interface)

class _aws-cdk_cx-api.MetadataEntry

An metadata entry in the construct.

type

The type of the metadata entry.

Type:string
data

The data.

Type:any or None
trace

A stack trace for when the entry was created.

Type:string

MissingContext (interface)

class _aws-cdk_cx-api.MissingContext

Represents a missing piece of context. (should have been an interface, but jsii still doesn’t have support for structs).

provider
Type:string
scope
Type:string
args
Type:string

StackId (interface)

class _aws-cdk_cx-api.StackId

Identifies a single stack

name
Type:string

StackInfo (interface)

class _aws-cdk_cx-api.StackInfo

Identifies and contains metadata about a stack

Extends:StackId
environment
Type:Environment or None

SynthesizeRequest (interface)

class _aws-cdk_cx-api.SynthesizeRequest
type
Type:string
stacks
Type:string
context
Type:any or None

SynthesizeResponse (interface)

class _aws-cdk_cx-api.SynthesizeResponse
stacks
Type:SynthesizedStack

SynthesizedStack (interface)

class _aws-cdk_cx-api.SynthesizedStack

A complete synthesized stack

Extends:StackInfo
missing
Type:MissingContext or None
metadata
Type:MetadataEntry
template
Type:any