$ A B C D E F G H I J M N O P S T V W

$

$jsii$toJson() - Method in class software.constructs.ConstructOptions.Jsii$Proxy

$jsii$toJson() - Method in class software.constructs.Dependency.Jsii$Proxy

$jsii$toJson() - Method in class software.constructs.MetadataEntry.Jsii$Proxy

$jsii$toJson() - Method in class software.constructs.SynthesisOptions.Jsii$Proxy

$jsii$toJson() - Method in class software.constructs.ValidationError.Jsii$Proxy

A

addDependency(IConstruct...) - Method in class software.constructs.Node

Add an ordering dependency on another Construct.

addError(String) - Method in class software.constructs.Node

Adds an { "error": } metadata entry to this construct.

addInfo(String) - Method in class software.constructs.Node

Adds a { "info": } metadata entry to this construct.

addMetadata(String, Object, Object) - Method in class software.constructs.Node

Adds a metadata entry to this construct.

addMetadata(String, Object) - Method in class software.constructs.Node

Adds a metadata entry to this construct.

addValidation(IValidation) - Method in class software.constructs.Node

Adds a validation to this construct.

addWarning(String) - Method in class software.constructs.Node

Adds a { "warning": } metadata entry to this construct.

applyAspect(IAspect) - Method in class software.constructs.Node

Applies the aspect to this Constructs node.

B

build() - Method in class software.constructs.Construct.Builder

build() - Method in class software.constructs.ConstructOptions.Builder

Builds the configured instance.

build() - Method in class software.constructs.Dependency.Builder

Builds the configured instance.

build() - Method in class software.constructs.MetadataEntry.Builder

Builds the configured instance.

build() - Method in class software.constructs.SynthesisOptions.Builder

Builds the configured instance.

build() - Method in class software.constructs.ValidationError.Builder

Builds the configured instance.

builder() - Static method in interface software.constructs.ConstructOptions

Builder() - Constructor for class software.constructs.ConstructOptions.Builder

builder() - Static method in interface software.constructs.Dependency

Builder() - Constructor for class software.constructs.Dependency.Builder

builder() - Static method in interface software.constructs.MetadataEntry

Builder() - Constructor for class software.constructs.MetadataEntry.Builder

builder() - Static method in interface software.constructs.SynthesisOptions

Builder() - Constructor for class software.constructs.SynthesisOptions.Builder

builder() - Static method in interface software.constructs.ValidationError

Builder() - Constructor for class software.constructs.ValidationError.Builder

C

Construct - Class in software.constructs

Represents the building block of the construct graph.

Construct(JsiiObjectRef) - Constructor for class software.constructs.Construct

Construct(JsiiObject.InitializationMode) - Constructor for class software.constructs.Construct

Construct(Construct, String, ConstructOptions) - Constructor for class software.constructs.Construct

Creates a new construct node.

Construct(Construct, String) - Constructor for class software.constructs.Construct

Creates a new construct node.

Construct.Builder - Class in software.constructs

A fluent builder for Construct.

ConstructMetadata - Class in software.constructs

Metadata keys used by constructs.

ConstructMetadata(JsiiObjectRef) - Constructor for class software.constructs.ConstructMetadata

ConstructMetadata(JsiiObject.InitializationMode) - Constructor for class software.constructs.ConstructMetadata

ConstructOptions - Interface in software.constructs

Options for creating constructs.

ConstructOptions.Builder - Class in software.constructs

A builder for ConstructOptions

ConstructOptions.Jsii$Proxy - Class in software.constructs

An implementation for ConstructOptions

ConstructOrder - Enum in software.constructs

In what order to return constructs.

create(Construct, String) - Static method in class software.constructs.Construct.Builder

createNode(Construct, IConstruct, String) - Method in interface software.constructs.INodeFactory

Returns a new `Node` associated with `host`.

createNode(Construct, IConstruct, String) - Method in interface software.constructs.INodeFactory.Jsii$Default

Returns a new `Node` associated with `host`.

createNode(Construct, IConstruct, String) - Method in class software.constructs.INodeFactory.Jsii$Proxy

Returns a new `Node` associated with `host`.

D

data(Object) - Method in class software.constructs.MetadataEntry.Builder

Sets the value of MetadataEntry.getData()

Dependency - Interface in software.constructs

A single dependency.

Dependency.Builder - Class in software.constructs

A builder for Dependency

Dependency.Jsii$Proxy - Class in software.constructs

An implementation for Dependency

DISABLE_STACK_TRACE_IN_METADATA - Static variable in class software.constructs.ConstructMetadata

If set in the construct's context, omits stack traces from metadata entries.

E

equals(Object) - Method in class software.constructs.ConstructOptions.Jsii$Proxy

equals(Object) - Method in class software.constructs.Dependency.Jsii$Proxy

equals(Object) - Method in class software.constructs.MetadataEntry.Jsii$Proxy

equals(Object) - Method in class software.constructs.SynthesisOptions.Jsii$Proxy

equals(Object) - Method in class software.constructs.ValidationError.Jsii$Proxy

ERROR_METADATA_KEY - Static variable in class software.constructs.ConstructMetadata

Context type for error level messages.

F

findAll(ConstructOrder) - Method in class software.constructs.Node

Return this construct and all of its children in the given order.

findAll() - Method in class software.constructs.Node

Return this construct and all of its children in the given order.

findChild(String) - Method in class software.constructs.Node

Return a direct child by id.

G

getAddr() - Method in class software.constructs.Node

Returns an opaque tree-unique address for this construct.

getChildren() - Method in class software.constructs.Node

All direct children of this construct.

getData() - Method in interface software.constructs.MetadataEntry

The data.

getData() - Method in class software.constructs.MetadataEntry.Jsii$Proxy

getDefaultChild() - Method in class software.constructs.Node

Returns the child construct that has the id `Default` or `Resource"`.

getDependencies() - Method in class software.constructs.Node

Return all dependencies registered on this node or any of its children.

getId() - Method in class software.constructs.Node

The id of this construct within the current scope.

getLocked() - Method in class software.constructs.Node

Returns true if this construct or the scopes in which it is defined are locked.

getMessage() - Method in interface software.constructs.ValidationError

The error message.

getMessage() - Method in class software.constructs.ValidationError.Jsii$Proxy

getMetadata() - Method in class software.constructs.Node

An immutable array of metadata objects associated with this construct.

getNodeFactory() - Method in interface software.constructs.ConstructOptions

A factory for attaching `Node`s to the construct.

getNodeFactory() - Method in class software.constructs.ConstructOptions.Jsii$Proxy

getOutdir() - Method in interface software.constructs.ISynthesisSession

The output directory for this synthesis session.

getOutdir() - Method in interface software.constructs.ISynthesisSession.Jsii$Default

The output directory for this synthesis session.

getOutdir() - Method in class software.constructs.ISynthesisSession.Jsii$Proxy

The output directory for this synthesis session.

getOutdir() - Method in interface software.constructs.SynthesisOptions

The output directory into which to synthesize the cloud assembly.

getOutdir() - Method in class software.constructs.SynthesisOptions.Jsii$Proxy

getPath() - Method in class software.constructs.Node

The full, absolute path of this construct in the tree.

getRoot() - Method in class software.constructs.Node

Returns the root of the construct tree.

getScope() - Method in class software.constructs.Node

Returns the scope in which this construct is defined.

getScopes() - Method in class software.constructs.Node

All parent scopes of this construct.

getSessionContext() - Method in interface software.constructs.SynthesisOptions

Additional context passed into the synthesis session object when `construct.synth` is called.

getSessionContext() - Method in class software.constructs.SynthesisOptions.Jsii$Proxy

getSkipValidation() - Method in interface software.constructs.SynthesisOptions

Whether synthesis should skip the validation phase.

getSkipValidation() - Method in class software.constructs.SynthesisOptions.Jsii$Proxy

getSource() - Method in interface software.constructs.Dependency

Source the dependency.

getSource() - Method in class software.constructs.Dependency.Jsii$Proxy

getSource() - Method in interface software.constructs.ValidationError

The construct which emitted the error.

getSource() - Method in class software.constructs.ValidationError.Jsii$Proxy

getTarget() - Method in interface software.constructs.Dependency

Target of the dependency.

getTarget() - Method in class software.constructs.Dependency.Jsii$Proxy

getTrace() - Method in interface software.constructs.MetadataEntry

Stack trace.

getTrace() - Method in class software.constructs.MetadataEntry.Jsii$Proxy

getType() - Method in interface software.constructs.MetadataEntry

The metadata entry type.

getType() - Method in class software.constructs.MetadataEntry.Jsii$Proxy

getUniqueId() - Method in class software.constructs.Node

Deprecated.

please avoid using this property and use `uid` instead. This algorithm uses MD5, which is not FIPS-complient and also excludes the identity of the root construct from the calculation.

H

hashCode() - Method in class software.constructs.ConstructOptions.Jsii$Proxy

hashCode() - Method in class software.constructs.Dependency.Jsii$Proxy

hashCode() - Method in class software.constructs.MetadataEntry.Jsii$Proxy

hashCode() - Method in class software.constructs.SynthesisOptions.Jsii$Proxy

hashCode() - Method in class software.constructs.ValidationError.Jsii$Proxy

I

IAspect - Interface in software.constructs

Represents an Aspect.

IAspect.Jsii$Default - Interface in software.constructs

Internal default implementation for IAspect.

IAspect.Jsii$Proxy - Class in software.constructs

A proxy class which represents a concrete javascript instance of this type.

IConstruct - Interface in software.constructs

Represents a construct.

IConstruct.Jsii$Default - Interface in software.constructs

Internal default implementation for IConstruct.

IConstruct.Jsii$Proxy - Class in software.constructs

A proxy class which represents a concrete javascript instance of this type.

INFO_METADATA_KEY - Static variable in class software.constructs.ConstructMetadata

Context type for info level messages.

INodeFactory - Interface in software.constructs

A factory for attaching `Node`s to the construct.

INodeFactory.Jsii$Default - Interface in software.constructs

Internal default implementation for INodeFactory.

INodeFactory.Jsii$Proxy - Class in software.constructs

A proxy class which represents a concrete javascript instance of this type.

ISynthesisSession - Interface in software.constructs

Represents a single session of synthesis.

ISynthesisSession.Jsii$Default - Interface in software.constructs

Internal default implementation for ISynthesisSession.

ISynthesisSession.Jsii$Proxy - Class in software.constructs

A proxy class which represents a concrete javascript instance of this type.

IValidation - Interface in software.constructs

Implement this interface in order for the construct to be able to validate itself.

IValidation.Jsii$Default - Interface in software.constructs

Internal default implementation for IValidation.

IValidation.Jsii$Proxy - Class in software.constructs

A proxy class which represents a concrete javascript instance of this type.

J

Jsii$Proxy(JsiiObjectRef) - Constructor for class software.constructs.ConstructOptions.Jsii$Proxy

Constructor that initializes the object based on values retrieved from the JsiiObject.

Jsii$Proxy(INodeFactory) - Constructor for class software.constructs.ConstructOptions.Jsii$Proxy

Constructor that initializes the object based on literal property values passed by the ConstructOptions.Builder.

Jsii$Proxy(JsiiObjectRef) - Constructor for class software.constructs.Dependency.Jsii$Proxy

Constructor that initializes the object based on values retrieved from the JsiiObject.

Jsii$Proxy(IConstruct, IConstruct) - Constructor for class software.constructs.Dependency.Jsii$Proxy

Constructor that initializes the object based on literal property values passed by the Dependency.Builder.

Jsii$Proxy(JsiiObjectRef) - Constructor for class software.constructs.IAspect.Jsii$Proxy

Jsii$Proxy(JsiiObjectRef) - Constructor for class software.constructs.IConstruct.Jsii$Proxy

Jsii$Proxy(JsiiObjectRef) - Constructor for class software.constructs.INodeFactory.Jsii$Proxy

Jsii$Proxy(JsiiObjectRef) - Constructor for class software.constructs.ISynthesisSession.Jsii$Proxy

Jsii$Proxy(JsiiObjectRef) - Constructor for class software.constructs.IValidation.Jsii$Proxy

Jsii$Proxy(JsiiObjectRef) - Constructor for class software.constructs.MetadataEntry.Jsii$Proxy

Constructor that initializes the object based on values retrieved from the JsiiObject.

Jsii$Proxy(Object, String, List<String>) - Constructor for class software.constructs.MetadataEntry.Jsii$Proxy

Constructor that initializes the object based on literal property values passed by the MetadataEntry.Builder.

Jsii$Proxy(JsiiObjectRef) - Constructor for class software.constructs.SynthesisOptions.Jsii$Proxy

Constructor that initializes the object based on values retrieved from the JsiiObject.

Jsii$Proxy(String, Map<String, ? extends Object>, Boolean) - Constructor for class software.constructs.SynthesisOptions.Jsii$Proxy

Constructor that initializes the object based on literal property values passed by the SynthesisOptions.Builder.

Jsii$Proxy(JsiiObjectRef) - Constructor for class software.constructs.ValidationError.Jsii$Proxy

Constructor that initializes the object based on values retrieved from the JsiiObject.

Jsii$Proxy(String, Construct) - Constructor for class software.constructs.ValidationError.Jsii$Proxy

Constructor that initializes the object based on literal property values passed by the ValidationError.Builder.

M

message(String) - Method in class software.constructs.ValidationError.Builder

Sets the value of ValidationError.getMessage()

MetadataEntry - Interface in software.constructs

An entry in the construct metadata table.

MetadataEntry.Builder - Class in software.constructs

A builder for MetadataEntry

MetadataEntry.Jsii$Proxy - Class in software.constructs

An implementation for MetadataEntry

N

Node - Class in software.constructs

Represents the construct node in the scope tree.

Node(JsiiObjectRef) - Constructor for class software.constructs.Node

Node(JsiiObject.InitializationMode) - Constructor for class software.constructs.Node

Node(Construct, IConstruct, String) - Constructor for class software.constructs.Node

nodeFactory(INodeFactory) - Method in class software.constructs.Construct.Builder

A factory for attaching `Node`s to the construct.

nodeFactory(INodeFactory) - Method in class software.constructs.ConstructOptions.Builder

Sets the value of ConstructOptions.getNodeFactory()

O

of(IConstruct) - Static method in class software.constructs.Node

Returns the node associated with a construct.

onPrepare() - Method in class software.constructs.Construct

Perform final modifications before synthesis.

onSynthesize(ISynthesisSession) - Method in class software.constructs.Construct

Allows this construct to emit artifacts into the cloud assembly during synthesis.

onValidate() - Method in class software.constructs.Construct

Deprecated.

use `Node.addValidation()` to subscribe validation functions on this construct instead of overriding this method.

outdir(String) - Method in class software.constructs.SynthesisOptions.Builder

Sets the value of SynthesisOptions.getOutdir()

P

PATH_SEP - Static variable in class software.constructs.Node

Separator used to delimit construct path components.

prepare() - Method in class software.constructs.Node

Invokes "prepare" on all constructs (depth-first, post-order) in the tree under `node`.

S

sessionContext(Map<String, ? extends Object>) - Method in class software.constructs.SynthesisOptions.Builder

Sets the value of SynthesisOptions.getSessionContext()

setContext(String, Object) - Method in class software.constructs.Node

This can be used to set contextual values.

setDefaultChild(IConstruct) - Method in class software.constructs.Node

Returns the child construct that has the id `Default` or `Resource"`.

skipValidation(Boolean) - Method in class software.constructs.SynthesisOptions.Builder

Sets the value of SynthesisOptions.getSkipValidation()

software.constructs - package software.constructs

Constructs Programming Model

source(IConstruct) - Method in class software.constructs.Dependency.Builder

Sets the value of Dependency.getSource()

source(Construct) - Method in class software.constructs.ValidationError.Builder

Sets the value of ValidationError.getSource()

SynthesisOptions - Interface in software.constructs

Options for synthesis.

SynthesisOptions.Builder - Class in software.constructs

A builder for SynthesisOptions

SynthesisOptions.Jsii$Proxy - Class in software.constructs

An implementation for SynthesisOptions

synthesize(SynthesisOptions) - Method in class software.constructs.Node

Synthesizes a CloudAssembly from a construct tree.

T

target(IConstruct) - Method in class software.constructs.Dependency.Builder

Sets the value of Dependency.getTarget()

toString() - Method in class software.constructs.Construct

Returns a string representation of this construct.

trace(List<String>) - Method in class software.constructs.MetadataEntry.Builder

Sets the value of MetadataEntry.getTrace()

tryFindChild(String) - Method in class software.constructs.Node

Return a direct child by id, or undefined.

tryGetContext(String) - Method in class software.constructs.Node

Retrieves a value from tree context.

tryRemoveChild(String) - Method in class software.constructs.Node

(experimental) Remove the child with the given name, if present.

type(String) - Method in class software.constructs.MetadataEntry.Builder

Sets the value of MetadataEntry.getType()

V

validate() - Method in interface software.constructs.IValidation.Jsii$Default

Validate the current construct.

validate() - Method in class software.constructs.IValidation.Jsii$Proxy

Validate the current construct.

validate() - Method in interface software.constructs.IValidation

Validate the current construct.

validate() - Method in class software.constructs.Node

Validates tree (depth-first, pre-order) and returns the list of all errors.

ValidationError - Interface in software.constructs

An error returned during the validation phase.

ValidationError.Builder - Class in software.constructs

A builder for ValidationError

ValidationError.Jsii$Proxy - Class in software.constructs

An implementation for ValidationError

valueOf(String) - Static method in enum software.constructs.ConstructOrder

Returns the enum constant of this type with the specified name.

values() - Static method in enum software.constructs.ConstructOrder

Returns an array containing the constants of this enum type, in the order they are declared.

visit(IConstruct) - Method in interface software.constructs.IAspect.Jsii$Default

All aspects can visit an IConstruct.

visit(IConstruct) - Method in class software.constructs.IAspect.Jsii$Proxy

All aspects can visit an IConstruct.

visit(IConstruct) - Method in interface software.constructs.IAspect

All aspects can visit an IConstruct.

W

WARNING_METADATA_KEY - Static variable in class software.constructs.ConstructMetadata

Context type for warning level messages.

$ A B C D E F G H I J M N O P S T V W