aws_cdk

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
ArnFormat	An enum representing the various ARN formats that different services use.
AspectApplication	Object respresenting an Aspect application.
AspectOptions
AspectPriority	Default Priority values for Aspects.
Aspects	Aspects can be applied to CDK tree scopes and can operate on the tree before synthesis.
AssetHashType	The type of asset hash.
AssetManifestBuilder	Build an asset manifest from assets added to a stack.
AssetManifestDockerImageDestination
AssetManifestFileDestination
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	Synthesizer that reuses bootstrap roles from a different region.
BootstraplessSynthesizerProps
BundlingFileAccess	The access mechanism used to make source files available to the bundling container and to return the bundling output back to the host.
BundlingOptions
BundlingOutput	The type of output that a bundling operation is producing.
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	In a CloudFormation template, you use the AWS::CloudFormation::CustomResource or Custom:: *String* resource type to specify custom resources.
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.
CfnGuardHook	The AWS::CloudFormation::GuardHook resource creates a Guard Hook with the specified attributes within your CloudFormation template.
CfnGuardHookProps
CfnHook	Represents a CloudFormation resource.
CfnHookDefaultVersion	The HookDefaultVersion resource specifies the default version of the Hook.
CfnHookDefaultVersionProps
CfnHookProps
CfnHookTypeConfig	The HookTypeConfig resource specifies the configuration of a Hook.
CfnHookTypeConfigProps
CfnHookVersion	The HookVersion resource publishes new or first Hook version to the AWS CloudFormation registry.
CfnHookVersionProps
CfnJson	Captures a synthesis-time JSON object a CloudFormation reference which resolves during deployment to the resolved values of the JSON object.
CfnJsonProps
CfnLambdaHook	The AWS::CloudFormation::LambdaHook resource creates a Lambda Hook with the specified attributes within your CloudFormation template.
CfnLambdaHookProps
CfnMacro	The AWS::CloudFormation::Macro resource is a CloudFormation resource type that creates a CloudFormation macro to perform custom processing on CloudFormation templates.
CfnMacroProps
CfnMapping	Represents a CloudFormation mapping.
CfnMappingProps
CfnModuleDefaultVersion	Specifies the default version of a module.
CfnModuleDefaultVersionProps
CfnModuleVersion	Registers the specified version of the module with the CloudFormation service.
CfnModuleVersionProps
CfnOutput
CfnOutputProps
CfnParameter	A CloudFormation parameter.
CfnParameterProps
CfnPublicTypeVersion	Tests and publishes a registered extension as a public, third-party extension.
CfnPublicTypeVersionProps
CfnPublisher	Registers your account as a publisher of public extensions in the CloudFormation registry.
CfnPublisherProps
CfnRefElement	Base class for referencable CloudFormation constructs which are not Resources.
CfnResource	Represents a CloudFormation resource.
CfnResourceAutoScalingCreationPolicy
CfnResourceDefaultVersion	Specifies the default version of a resource.
CfnResourceDefaultVersionProps
CfnResourceProps
CfnResourceSignal
CfnResourceVersion	Registers a resource version with the CloudFormation service.
CfnResourceVersionProps
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	The AWS::CloudFormation::Stack resource nests a stack as a resource in a top-level template.
CfnStackProps
CfnStackSet	The AWS::CloudFormation::StackSet enables you to provision stacks into AWS accounts and across Regions by using a single CloudFormation template.
CfnStackSetProps
CfnTag
CfnTrafficRoute
CfnTrafficRouting
CfnTrafficRoutingConfig
CfnTrafficRoutingTimeBasedCanary
CfnTrafficRoutingTimeBasedLinear
CfnTrafficRoutingType	The possible types of traffic shifting for the blue-green deployment configuration.
CfnTypeActivation	Activates a public third-party extension, making it available for use in stack templates.
CfnTypeActivationProps
CfnUpdatePolicy
CfnWaitCondition
CfnWaitConditionHandle
CfnWaitConditionHandleProps
CfnWaitConditionProps
CliCredentialsStackSynthesizer	A synthesizer that uses conventional asset locations, but not conventional deployment roles.
CliCredentialsStackSynthesizerProps
ContextProvider	Base class for the model side of context providers.
CopyOptions
CustomResource	Instantiation of a custom resource, whose implementation is provided a Provider.
CustomResourceProps
CustomResourceProvider	An AWS-Lambda backed custom resource provider, for CDK Construct Library constructs.
CustomResourceProviderBase	Base class for creating a custom resource provider.
CustomResourceProviderBaseProps
CustomResourceProviderOptions
CustomResourceProviderProps
CustomResourceProviderRuntime	The lambda runtime to use for the resource provider.
DefaultStackSynthesizer	Uses conventionally named roles and asset storage locations.
DefaultStackSynthesizerProps
DefaultTokenResolver	Default resolver implementation.
DockerBuildOptions
DockerBuildSecret	Methods to build Docker CLI arguments for builds using secrets.
DockerCacheOption
DockerIgnoreStrategy	Ignores file paths based on the `.dockerignore specification <https://docs.docker.com/engine/reference/builder/#dockerignore-file>`_.
DockerImage	A Docker image.
DockerImageAssetLocation
DockerImageAssetSource
DockerRunOptions
DockerVolume
DockerVolumeConsistency	Supported Docker volume consistency types.
Duration	Represents a length of time.
EncodingOptions
Environment
Errors	Helper to check if an error is a SynthesisErrors.
Expiration	Represents a date of expiration.
ExportValueOptions
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
FileCopyOptions
FileFingerprintOptions
FileSystem	File system utilities.
FingerprintOptions
Fn	CloudFormation intrinsic functions.
GetContextKeyOptions
GetContextKeyResult
GetContextValueOptions
GetContextValueResult
GitIgnoreStrategy	Ignores file paths based on the `.gitignore specification <https://git-scm.com/docs/gitignore>`_.
GlobIgnoreStrategy	Ignores file paths based on simple glob patterns.
IAnyProducer	Interface for lazy untyped value producers.
IAspect	Represents an Aspect.
IAsset	Common interface for all assets.
IBoundStackSynthesizer	A Stack Synthesizer, obtained from IReusableStackSynthesizer..
ICfnConditionExpression	Represents a CloudFormation element that can be used within a Condition.
ICfnResourceOptions
ICfnRuleConditionExpression	Interface to specify certain functions as Service Catalog rule-specific.
IFragmentConcatenator	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	Local bundling.
INumberProducer	Interface for lazy number producers.
IPolicyValidationContextBeta1	Context available to the validation plugin.
IPolicyValidationPluginBeta1	Represents a validation plugin that will be executed during synthesis.
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.
IReusableStackSynthesizer	Interface for Stack Synthesizers that can be used for more than one stack.
IStableAnyProducer	Interface for (stable) lazy untyped value producers.
IStableListProducer	Interface for (stable) lazy list producers.
IStableNumberProducer	Interface for (stable) lazy number producers.
IStableStringProducer	Interface for (stable) lazy string producers.
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.
ITaggableV2	Modernized version of ITaggable.
ITemplateOptions	CloudFormation template options for a stack.
ITokenMapper	Interface to apply operation to tokens in a string.
ITokenResolver	How to resolve tokens.
IgnoreMode	Determines the ignore behavior to use.
IgnoreStrategy	Represents file path ignoring behavior.
Intrinsic	Token subclass that represents values intrinsic to the target document language.
IntrinsicProps
JsonNull	An object which serializes to the JSON null literal, and which can safely be passed across languages where undefined and null are not different.
Lazy	Lazily produce a value.
LazyAnyValueOptions
LazyListValueOptions
LazyStringValueOptions
LegacyStackSynthesizer	Use the CDK classic way of referencing assets.
Names	Functions for devising unique names for constructs.
NestedStack	A CloudFormation nested stack.
NestedStackProps
NestedStackSynthesizer	Synthesizer for a nested stack.
PermissionsBoundary	Apply a permissions boundary to all IAM Roles and Users within a specific scope.
PermissionsBoundaryBindOptions
PhysicalName	Includes special markers for automatic generation of physical names.
PolicyValidationPluginReportBeta1
PolicyValidationReportStatusBeta1	The final status of the validation report.
PolicyViolatingResourceBeta1
PolicyViolationBeta1
Reference	An intrinsic Token that represents a reference to a construct.
RemovalPolicy	Possible values for a resource’s Removal Policy.
RemovalPolicyOptions
RemoveTag	The RemoveTag Aspect will handle removing tags from this node and children.
ResolutionTypeHint	Type hints for resolved values.
ResolveChangeContextOptions
ResolveOptions
Resource	A construct which represents an AWS resource.
ResourceEnvironment
ResourceProps
ReverseOptions
RoleOptions
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.
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
Tags	Manages AWS tags for all resources within a construct scope.
TimeConversionOptions
TimeZone	Canonical names of the IANA time zones, derived from the IANA Time Zone Database.
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.
UniqueResourceNameOptions
ValidationResult	Representation of validation results.
ValidationResults	A collection of validation results.