@Stability(Stable)

Package software.constructs

Constructs

Software-defined persistent state

What are constructs?

Constructs are classes which define a "piece of system state". Constructs can be composed together to form higher-level building blocks which represent more complex state.

Constructs are often used to represent the desired state of cloud applications. For example, in the AWS CDK, which is used to define the desired state for AWS infrastructure using CloudFormation, the lowest-level construct represents a resource definition in a CloudFormation template. These resources are composed to represent higher-level logical units of a cloud application, etc.

Contributing

This project has adopted the Amazon Open Source Code of Conduct.

We welcome community contributions and pull requests. See our contribution guide for more information on how to report issues, set up a development environment and submit code.

License

This project is distributed under the Apache License, Version 2.0.

Interface Summary

Interface	Description
ConstructOptions	Options for creating constructs.
Dependency	A single dependency.
IAspect	Represents an Aspect.
IAspect.Jsii$Default	Internal default implementation for IAspect.
IConstruct	Represents a construct.
IConstruct.Jsii$Default	Internal default implementation for IConstruct.
INodeFactory	A factory for attaching Nodes to the construct.
INodeFactory.Jsii$Default	Internal default implementation for INodeFactory.
ISynthesisSession	Represents a single session of synthesis.
ISynthesisSession.Jsii$Default	Internal default implementation for ISynthesisSession.
IValidation	Implement this interface in order for the construct to be able to validate itself.
IValidation.Jsii$Default	Internal default implementation for IValidation.
MetadataEntry	An entry in the construct metadata table.
SynthesisOptions	Options for synthesis.
ValidationError	An error returned during the validation phase.

Class Summary

Class	Description
Construct	Represents the building block of the construct graph.
Construct.Builder	A fluent builder for Construct.
ConstructMetadata	Metadata keys used by constructs.
ConstructOptions.Builder	A builder for ConstructOptions
ConstructOptions.Jsii$Proxy	An implementation for ConstructOptions
Dependency.Builder	A builder for Dependency
Dependency.Jsii$Proxy	An implementation for Dependency
IAspect.Jsii$Proxy	A proxy class which represents a concrete javascript instance of this type.
IConstruct.Jsii$Proxy	A proxy class which represents a concrete javascript instance of this type.
INodeFactory.Jsii$Proxy	A proxy class which represents a concrete javascript instance of this type.
ISynthesisSession.Jsii$Proxy	A proxy class which represents a concrete javascript instance of this type.
IValidation.Jsii$Proxy	A proxy class which represents a concrete javascript instance of this type.
MetadataEntry.Builder	A builder for MetadataEntry
MetadataEntry.Jsii$Proxy	An implementation for MetadataEntry
Node	Represents the construct node in the scope tree.
SynthesisOptions.Builder	A builder for SynthesisOptions
SynthesisOptions.Jsii$Proxy	An implementation for SynthesisOptions
ValidationError.Builder	A builder for ValidationError
ValidationError.Jsii$Proxy	An implementation for ValidationError

Enum Summary

Enum	Description
ConstructOrder	In what order to return constructs.