aws_cdk.core

Package Overview

Annotations

Includes API for attaching annotations such as warning messages to constructs.

App

A construct which represents an entire CDK app. This construct is normally the root of the construct tree.

AppProps

Arn

ArnComponents

Aspects

Aspects can be applied to CDK tree scopes and can operate on the tree before synthesis.

AssetHashType

The type of asset hash.

AssetOptions

AssetStaging

Stages a file or directory from a location on the file system into a staging directory.

AssetStagingProps

Aws

Accessor for pseudo parameters.

BootstraplessSynthesizer

A special synthesizer that behaves similarly to DefaultStackSynthesizer, but doesn’t require bootstrapping the environment it operates in.

BootstraplessSynthesizerProps

BundlingDockerImage

A Docker image used for asset bundling.

BundlingOptions

CfnAutoScalingReplacingUpdate

CfnAutoScalingRollingUpdate

CfnAutoScalingScheduledAction

CfnCapabilities

Capabilities that affect whether CloudFormation is allowed to change IAM resources.

CfnCodeDeployBlueGreenAdditionalOptions

CfnCodeDeployBlueGreenApplication

CfnCodeDeployBlueGreenApplicationTarget

CfnCodeDeployBlueGreenEcsAttributes

CfnCodeDeployBlueGreenHook

A CloudFormation Hook for CodeDeploy blue-green ECS deployments.

CfnCodeDeployBlueGreenHookProps

CfnCodeDeployBlueGreenLifecycleEventHooks

CfnCodeDeployLambdaAliasUpdate

CfnCondition

Represents a CloudFormation condition, for resources which must be conditionally created and the determination must be made at deploy time.

CfnConditionProps

CfnCreationPolicy

CfnCustomResource

A CloudFormation AWS::CloudFormation::CustomResource.

CfnCustomResourceProps

CfnDeletionPolicy

With the DeletionPolicy attribute you can preserve or (in some cases) backup a resource when its stack is deleted.

CfnDynamicReference

References a dynamically retrieved value.

CfnDynamicReferenceProps

CfnDynamicReferenceService

The service to retrieve the dynamic reference from.

CfnElement

An element of a CloudFormation stack.

CfnHook

Represents a CloudFormation resource.

CfnHookProps

CfnInclude

Includes a CloudFormation template into a stack.

CfnIncludeProps

CfnJson

Captures a synthesis-time JSON object a CloudFormation reference which resolves during deployment to the resolved values of the JSON object.

CfnJsonProps

CfnMacro

A CloudFormation AWS::CloudFormation::Macro.

CfnMacroProps

CfnMapping

Represents a CloudFormation mapping.

CfnMappingProps

CfnOutput

CfnOutputProps

CfnParameter

A CloudFormation parameter.

CfnParameterProps

CfnRefElement

Base class for referenceable CloudFormation constructs which are not Resources.

CfnResource

Represents a CloudFormation resource.

CfnResourceAutoScalingCreationPolicy

CfnResourceProps

CfnResourceSignal

CfnRule

The Rules that define template constraints in an AWS Service Catalog portfolio describe when end users can use the template and which values they can specify for parameters that are declared in the AWS CloudFormation template used to create the product they are attempting to use.

CfnRuleAssertion

CfnRuleProps

CfnStack

A CloudFormation AWS::CloudFormation::Stack.

CfnStackProps

CfnStackSet

A CloudFormation AWS::CloudFormation::StackSet.

CfnStackSetProps

CfnTag

CfnTrafficRoute

CfnTrafficRouting

CfnTrafficRoutingConfig

CfnTrafficRoutingTimeBasedCanary

CfnTrafficRoutingTimeBasedLinear

CfnTrafficRoutingType

The possible types of traffic shifting for the blue-green deployment configuration.

CfnUpdatePolicy

CfnWaitCondition

A CloudFormation AWS::CloudFormation::WaitCondition.

CfnWaitConditionHandle

A CloudFormation AWS::CloudFormation::WaitConditionHandle.

CfnWaitConditionProps

ConcreteDependable

(experimental) A set of constructs to be used as a dependable.

Construct

Represents the building block of the construct graph.

ConstructNode

Represents the construct node in the scope tree.

ConstructOrder

In what order to return constructs.

ContextProvider

(experimental) Base class for the model side of context providers.

CopyOptions

CustomResource

Custom resource that is implemented using a Lambda.

CustomResourceProps

CustomResourceProvider

(experimental) An AWS-Lambda backed custom resource provider.

CustomResourceProviderProps

CustomResourceProviderRuntime

(experimental) The lambda runtime to use for the resource provider.

DefaultStackSynthesizer

Uses conventionally named roles and reify asset storage locations.

DefaultStackSynthesizerProps

DefaultTokenResolver

(experimental) Default resolver implementation.

DependableTrait

(experimental) Trait for IDependable.

Dependency

DockerBuildOptions

DockerImageAssetLocation

DockerImageAssetSource

DockerRunOptions

DockerVolume

DockerVolumeConsistency

Supported Docker volume consistency types.

Duration

Represents a length of time.

EncodingOptions

Environment

Expiration

Represents a date of expiration.

FeatureFlags

Features that are implemented behind a flag in order to preserve backwards compatibility for existing apps.

FileAssetLocation

FileAssetPackaging

Packaging modes for file assets.

FileAssetSource

FileSystem

File system utilities.

FingerprintOptions

Fn

CloudFormation intrinsic functions.

GetContextKeyOptions

GetContextKeyResult

GetContextValueOptions

GetContextValueResult

IAnyProducer

Interface for lazy untyped value producers.

IAspect

Represents an Aspect.

IAsset

Common interface for all assets.

ICfnConditionExpression

Represents a CloudFormation element that can be used within a Condition.

ICfnResourceOptions

IConstruct

Represents a construct.

IDependable

Trait marker for classes that can be depended upon.

IFragmentConcatenator

(experimental) Function used to concatenate symbols in the target document language.

IInspectable

Interface for examining a construct and exposing metadata.

IListProducer

Interface for lazy list producers.

ILocalBundling

(experimental) Local bundling.

INumberProducer

Interface for lazy number producers.

IPostProcessor

A Token that can post-process the complete resolved value, after resolve() has recursed over it.

IResolvable

Interface for values that can be resolvable later.

IResolveContext

Current resolution context for tokens.

IResource

Interface for the Resource construct.

IStackSynthesizer

Encodes information how a certain Stack should be deployed.

IStringProducer

Interface for lazy string producers.

ISynthesisSession

Represents a single session of synthesis.

ITaggable

Interface to implement tags.

ITemplateOptions

CloudFormation template options for a stack.

ITokenMapper

Interface to apply operation to tokens in a string.

ITokenResolver

How to resolve tokens.

Intrinsic

(experimental) Token subclass that represents values intrinsic to the target document language.

IntrinsicProps

Lazy

Lazily produce a value.

LazyAnyValueOptions

LazyListValueOptions

LazyStringValueOptions

LegacyStackSynthesizer

Use the original deployment environment.

NestedStack

(experimental) A CloudFormation nested stack.

NestedStackProps

NestedStackSynthesizer

Deployment environment for a nested stack.

PhysicalName

Includes special markers for automatic generation of physical names.

Reference

An intrinsic Token that represents a reference to a construct.

RemovalPolicy

An enumeration.

RemovalPolicyOptions

RemoveTag

The RemoveTag Aspect will handle removing tags from this node and children.

ResolveOptions

Resource

A construct which represents an AWS resource.

ResourceEnvironment

ResourceProps

ScopedAws

Accessor for scoped pseudo parameters.

SecretValue

Work with secret values in the CDK.

SecretsManagerSecretOptions

Size

Represents the amount of digital storage.

SizeConversionOptions

SizeRoundingBehavior

Rounding behaviour when converting between units of Size.

Stack

A root construct which represents a single CloudFormation stack.

StackProps

StackSynthesizer

Base class for implementing an IStackSynthesizer.

Stage

An abstract application modeling unit consisting of Stacks that should be deployed together.

StageProps

StageSynthesisOptions

StringConcat

Converts all fragments to strings and concats those.

SymlinkFollowMode

Determines how symlinks are followed.

SynthesisOptions

SynthesizeStackArtifactOptions

Tag

The Tag Aspect will handle adding a tag to this node and cascading tags to children.

TagManager

TagManager facilitates a common implementation of tagging for Constructs.

TagManagerOptions

TagProps

TagType

An enumeration.

Tags

Manages AWS tags for all resources within a construct scope.

TimeConversionOptions

Token

Represents a special or lazily-evaluated value.

TokenComparison

An enum-like class that represents the result of comparing two Tokens.

Tokenization

Less oft-needed functions to manipulate Tokens.

TokenizedStringFragments

Fragments of a concatenated string containing stringified Tokens.

TreeInspector

Inspector that maintains an attribute bag.

ValidationError

ValidationResult

Representation of validation results.

ValidationResults

A collection of validation results.