Namespace Amazon.CDK
Classes
- 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
Initialization props for apps.
- Aspects_
Aspects can be applied to CDK tree scopes and can operate on the tree before synthesis.
- AssetOptions
Asset hash options.
- AssetStaging
Stages a file or directory from a location on the file system into a staging directory.
- AssetStagingProps
Initialization properties for
AssetStaging.
- Aws
Accessor for pseudo parameters.
- BootstraplessSynthesizer
Synthesizer that reuses bootstrap roles from a different region.
- BootstraplessSynthesizerProps
Construction properties of {@link BootstraplessSynthesizer}.
- BundlingDockerImage
(deprecated) A Docker image used for asset bundling.
- BundlingOptions
Bundling options.
- CfnAutoScalingReplacingUpdate
Specifies whether an Auto Scaling group and the instances it contains are replaced during an update.
- CfnAutoScalingRollingUpdate
To specify how AWS CloudFormation handles rolling updates for an Auto Scaling group, use the AutoScalingRollingUpdate policy.
- CfnAutoScalingScheduledAction
With scheduled actions, the group size properties of an Auto Scaling group can change at any time.
- CfnCodeDeployBlueGreenAdditionalOptions
Additional options for the blue/green deployment.
- CfnCodeDeployBlueGreenApplication
The application actually being deployed.
- CfnCodeDeployBlueGreenApplicationTarget
Type of the {@link CfnCodeDeployBlueGreenApplication.target} property.
- CfnCodeDeployBlueGreenEcsAttributes
The attributes of the ECS Service being deployed.
- CfnCodeDeployBlueGreenHook
A CloudFormation Hook for CodeDeploy blue-green ECS deployments.
- CfnCodeDeployBlueGreenHookProps
Construction properties of {@link CfnCodeDeployBlueGreenHook}.
- CfnCodeDeployBlueGreenLifecycleEventHooks
Lifecycle events for blue-green deployments.
- CfnCodeDeployLambdaAliasUpdate
To perform an AWS CodeDeploy deployment when the version changes on an AWS::Lambda::Alias resource, use the CodeDeployLambdaAliasUpdate update policy.
- CfnCondition
Represents a CloudFormation condition, for resources which must be conditionally created and the determination must be made at deploy time.
- CfnCreationPolicy
Associate the CreationPolicy attribute with a resource to prevent its status from reaching create complete until AWS CloudFormation receives a specified number of success signals or the timeout period is exceeded.
- CfnCustomResource
A CloudFormation
AWS::CloudFormation::CustomResource.
- CfnCustomResourceProps
Properties for defining a
CfnCustomResource.
- CfnDynamicReference
References a dynamically retrieved value.
- CfnDynamicReferenceProps
Properties for a Dynamic Reference.
- CfnElement
An element of a CloudFormation stack.
- CfnHook
Represents a CloudFormation resource.
- CfnHookDefaultVersion
A CloudFormation
AWS::CloudFormation::HookDefaultVersion.
- CfnHookDefaultVersionProps
Properties for defining a
CfnHookDefaultVersion.
- CfnHookProps
Construction properties of {@link CfnHook}.
- CfnHookTypeConfig
A CloudFormation
AWS::CloudFormation::HookTypeConfig.
- CfnHookTypeConfigProps
Properties for defining a
CfnHookTypeConfig.
- CfnHookVersion
A CloudFormation
AWS::CloudFormation::HookVersion.
- CfnHookVersion.LoggingConfigProperty
The
LoggingConfigproperty type specifies logging configuration information for an extension.
- CfnHookVersionProps
Properties for defining a
CfnHookVersion.
- CfnInclude
(deprecated) Includes a CloudFormation template into a stack.
- CfnIncludeProps
(deprecated) Construction properties for {@link CfnInclude}.
- CfnJson
Captures a synthesis-time JSON object a CloudFormation reference which resolves during deployment to the resolved values of the JSON object.
- CfnMacro
A CloudFormation
AWS::CloudFormation::Macro.
- CfnMacroProps
Properties for defining a
CfnMacro.
- CfnMapping
Represents a CloudFormation mapping.
- CfnModuleDefaultVersion
A CloudFormation
AWS::CloudFormation::ModuleDefaultVersion.
- CfnModuleDefaultVersionProps
Properties for defining a
CfnModuleDefaultVersion.
- CfnModuleVersion
A CloudFormation
AWS::CloudFormation::ModuleVersion.
- CfnModuleVersionProps
Properties for defining a
CfnModuleVersion.
- CfnParameter
A CloudFormation parameter.
- CfnPublicTypeVersion
A CloudFormation
AWS::CloudFormation::PublicTypeVersion.
- CfnPublicTypeVersionProps
Properties for defining a
CfnPublicTypeVersion.
- CfnPublisher
A CloudFormation
AWS::CloudFormation::Publisher.
- CfnPublisherProps
Properties for defining a
CfnPublisher.
- CfnRefElement
Base class for referenceable CloudFormation constructs which are not Resources.
- CfnResource
Represents a CloudFormation resource.
- CfnResourceAutoScalingCreationPolicy
For an Auto Scaling group replacement update, specifies how many instances must signal success for the update to succeed.
- CfnResourceDefaultVersion
A CloudFormation
AWS::CloudFormation::ResourceDefaultVersion.
- CfnResourceDefaultVersionProps
Properties for defining a
CfnResourceDefaultVersion.
- CfnResourceSignal
When AWS CloudFormation creates the associated resource, configures the number of required success signals and the length of time that AWS CloudFormation waits for those signals.
- CfnResourceVersion
A CloudFormation
AWS::CloudFormation::ResourceVersion.
- CfnResourceVersion.LoggingConfigProperty
Logging configuration information for a resource.
- CfnResourceVersionProps
Properties for defining a
CfnResourceVersion.
- 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
A rule assertion.
- CfnRuleProps
A rule can include a RuleCondition property and must include an Assertions property.
- CfnStack
A CloudFormation
AWS::CloudFormation::Stack.
- CfnStackProps
Properties for defining a
CfnStack.
- CfnStackSet
A CloudFormation
AWS::CloudFormation::StackSet.
- CfnStackSet.AutoDeploymentProperty
[
Service-managedpermissions] Describes whether StackSets automatically deploys to AWS Organizations accounts that are added to a target organizational unit (OU).
- CfnStackSet.DeploymentTargetsProperty
The AWS OrganizationalUnitIds or Accounts for which to create stack instances in the specified Regions.
- CfnStackSet.ManagedExecutionProperty
Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting operations.
- CfnStackSet.OperationPreferencesProperty
The user-specified preferences for how AWS CloudFormation performs a stack set operation.
- CfnStackSet.ParameterProperty
The Parameter data type.
- CfnStackSet.StackInstancesProperty
Stack instances in some specific accounts and Regions.
- CfnStackSetProps
Properties for defining a
CfnStackSet.
- CfnTrafficRoute
A traffic route, representing where the traffic is being directed to.
- CfnTrafficRouting
Type of the {@link CfnCodeDeployBlueGreenEcsAttributes.trafficRouting} property.
- CfnTrafficRoutingConfig
Traffic routing configuration settings.
- CfnTrafficRoutingTimeBasedCanary
The traffic routing configuration if {@link CfnTrafficRoutingConfig.type} is {@link CfnTrafficRoutingType.TIME_BASED_CANARY}.
- CfnTrafficRoutingTimeBasedLinear
The traffic routing configuration if {@link CfnTrafficRoutingConfig.type} is {@link CfnTrafficRoutingType.TIME_BASED_LINEAR}.
- CfnTypeActivation
A CloudFormation
AWS::CloudFormation::TypeActivation.
- CfnTypeActivation.LoggingConfigProperty
Contains logging configuration information for an extension.
- CfnTypeActivationProps
Properties for defining a
CfnTypeActivation.
- CfnUpdatePolicy
Use the UpdatePolicy attribute to specify how AWS CloudFormation handles updates to the AWS::AutoScaling::AutoScalingGroup resource.
- CfnWaitCondition
A CloudFormation
AWS::CloudFormation::WaitCondition.
- CfnWaitConditionHandle
A CloudFormation
AWS::CloudFormation::WaitConditionHandle.
- CfnWaitConditionProps
Properties for defining a
CfnWaitCondition.
- CliCredentialsStackSynthesizer
A synthesizer that uses conventional asset locations, but not conventional deployment roles.
- CliCredentialsStackSynthesizerProps
Properties for the CliCredentialsStackSynthesizer.
- ConcreteDependable
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.
- ContextProvider
Base class for the model side of context providers.
- CopyOptions
Options applied when copying directories.
- CustomResource
Instantiation of a custom resource, whose implementation is provided a Provider.
- CustomResourceProps
Properties to provide a Lambda-backed custom resource.
- CustomResourceProvider
An AWS-Lambda backed custom resource provider, for CDK Construct Library constructs.
- CustomResourceProviderProps
Initialization properties for
CustomResourceProvider.
- DefaultStackSynthesizer
Uses conventionally named roles and asset storage locations.
- DefaultStackSynthesizerProps
Configuration properties for DefaultStackSynthesizer.
- DefaultTokenResolver
Default resolver implementation.
- DependableTrait
Trait for IDependable.
- Dependency
A single dependency.
- DockerBuildOptions
Docker build options.
- DockerIgnoreStrategy
Ignores file paths based on the
.dockerignore specification.
- DockerImage
A Docker image.
- DockerImageAssetLocation
The location of the published docker image.
- DockerRunOptions
Docker run options.
- DockerVolume
A Docker volume.
- Duration
Represents a length of time.
- EncodingOptions
Properties to string encodings.
- Environment
The deployment environment for a stack.
- Expiration
Represents a date of expiration.
- ExportValueOptions
Options for the
stack.exportValue()method.
- FeatureFlags
Features that are implemented behind a flag in order to preserve backwards compatibility for existing apps.
- FileAssetLocation
The location of the published file asset.
- FileAssetSource
Represents the source for a file asset.
- FileCopyOptions
Options applied when copying directories into the staging location.
- FileFingerprintOptions
Options related to calculating source hash.
- FileSystem
File system utilities.
- FingerprintOptions
Options related to calculating source hash.
- Fn
CloudFormation intrinsic functions.
- GitIgnoreStrategy
Ignores file paths based on the
.gitignore specification.
- GlobIgnoreStrategy
Ignores file paths based on simple glob patterns.
- IgnoreStrategy
Represents file path ignoring behavior.
- Intrinsic
Token subclass that represents values intrinsic to the target document language.
- IntrinsicProps
Customization properties for an Intrinsic token.
- Lazy
Lazily produce a value.
- LazyAnyValueOptions
Options for creating lazy untyped tokens.
- LazyListValueOptions
Options for creating a lazy list token.
- LazyStringValueOptions
Options for creating a lazy string token.
- LegacyStackSynthesizer
Use the CDK classic way of referencing assets.
- Names
Functions for devising unique names for constructs.
- NestedStack
A CloudFormation nested stack.
- NestedStackProps
Initialization props for the
NestedStackconstruct.
- NestedStackSynthesizer
Synthesizer 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.
- RemoveTag
The RemoveTag Aspect will handle removing tags from this node and children.
- ResolveChangeContextOptions
Options that can be changed while doing a recursive resolve.
- ResolveOptions
Options to the resolve() operation.
- Resource
A construct which represents an AWS resource.
- ResourceEnvironment
Represents the environment a given resource lives in.
- ResourceProps
Construction properties for {@link Resource}.
- ReverseOptions
Options for the 'reverse()' operation.
- ScopedAws
Accessor for scoped pseudo parameters.
- SecretValue
Work with secret values in the CDK.
- SecretsManagerSecretOptions
Options for referencing a secret value from Secrets Manager.
- Size
Represents the amount of digital storage.
- SizeConversionOptions
Options for how to convert time to a different unit.
- Stack
A root construct which represents a single CloudFormation stack.
- StackSynthesizer
Base class for implementing an IStackSynthesizer.
- Stage
An abstract application modeling unit consisting of Stacks that should be deployed together.
- StageProps
Initialization props for a stage.
- StageSynthesisOptions
Options for assembly synthesis.
- StringConcat
Converts all fragments to strings and concats those.
- SynthesisOptions
(deprecated) Options for synthesis.
- SynthesizeStackArtifactOptions
Stack artifact options.
- 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
Options to configure TagManager behavior.
- TagProps
Properties for a tag.
- Tags
Manages AWS tags for all resources within a construct scope.
- TimeConversionOptions
Options for how to convert time to a different unit.
- 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
An error returned during the validation phase.
- ValidationResult
Representation of validation results.
- ValidationResults
A collection of validation results.
Interfaces
- CfnHookVersion.ILoggingConfigProperty
The
LoggingConfigproperty type specifies logging configuration information for an extension.
- CfnResourceVersion.ILoggingConfigProperty
Logging configuration information for a resource.
- CfnStackSet.IAutoDeploymentProperty
[
Service-managedpermissions] Describes whether StackSets automatically deploys to AWS Organizations accounts that are added to a target organizational unit (OU).
- CfnStackSet.IDeploymentTargetsProperty
The AWS OrganizationalUnitIds or Accounts for which to create stack instances in the specified Regions.
- CfnStackSet.IManagedExecutionProperty
Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting operations.
- CfnStackSet.IOperationPreferencesProperty
The user-specified preferences for how AWS CloudFormation performs a stack set operation.
- CfnStackSet.IParameterProperty
The Parameter data type.
- CfnStackSet.IStackInstancesProperty
Stack instances in some specific accounts and Regions.
- CfnTypeActivation.ILoggingConfigProperty
Contains logging configuration information for an extension.
- IAnyProducer
Interface for lazy untyped value producers.
- IAppProps
Initialization props for apps.
- IAspect
Represents an Aspect.
- IAsset
Common interface for all assets.
- IAssetOptions
Asset hash options.
- IAssetStagingProps
Initialization properties for
AssetStaging.
- IBootstraplessSynthesizerProps
Construction properties of {@link BootstraplessSynthesizer}.
- IBundlingOptions
Bundling options.
- ICfnAutoScalingReplacingUpdate
Specifies whether an Auto Scaling group and the instances it contains are replaced during an update.
- ICfnAutoScalingRollingUpdate
To specify how AWS CloudFormation handles rolling updates for an Auto Scaling group, use the AutoScalingRollingUpdate policy.
- ICfnAutoScalingScheduledAction
With scheduled actions, the group size properties of an Auto Scaling group can change at any time.
- ICfnCodeDeployBlueGreenAdditionalOptions
Additional options for the blue/green deployment.
- ICfnCodeDeployBlueGreenApplication
The application actually being deployed.
- ICfnCodeDeployBlueGreenApplicationTarget
Type of the {@link CfnCodeDeployBlueGreenApplication.target} property.
- ICfnCodeDeployBlueGreenEcsAttributes
The attributes of the ECS Service being deployed.
- ICfnCodeDeployBlueGreenHookProps
Construction properties of {@link CfnCodeDeployBlueGreenHook}.
- ICfnCodeDeployBlueGreenLifecycleEventHooks
Lifecycle events for blue-green deployments.
- ICfnCodeDeployLambdaAliasUpdate
To perform an AWS CodeDeploy deployment when the version changes on an AWS::Lambda::Alias resource, use the CodeDeployLambdaAliasUpdate update policy.
- ICfnConditionExpression
Represents a CloudFormation element that can be used within a Condition.
- ICfnCreationPolicy
Associate the CreationPolicy attribute with a resource to prevent its status from reaching create complete until AWS CloudFormation receives a specified number of success signals or the timeout period is exceeded.
- ICfnCustomResourceProps
Properties for defining a
CfnCustomResource.
- ICfnDynamicReferenceProps
Properties for a Dynamic Reference.
- ICfnHookDefaultVersionProps
Properties for defining a
CfnHookDefaultVersion.
- ICfnHookProps
Construction properties of {@link CfnHook}.
- ICfnHookTypeConfigProps
Properties for defining a
CfnHookTypeConfig.
- ICfnHookVersionProps
Properties for defining a
CfnHookVersion.
- ICfnIncludeProps
(deprecated) Construction properties for {@link CfnInclude}.
- ICfnMacroProps
Properties for defining a
CfnMacro.
- ICfnModuleDefaultVersionProps
Properties for defining a
CfnModuleDefaultVersion.
- ICfnModuleVersionProps
Properties for defining a
CfnModuleVersion.
- ICfnPublicTypeVersionProps
Properties for defining a
CfnPublicTypeVersion.
- ICfnPublisherProps
Properties for defining a
CfnPublisher.
- ICfnResourceAutoScalingCreationPolicy
For an Auto Scaling group replacement update, specifies how many instances must signal success for the update to succeed.
- ICfnResourceDefaultVersionProps
Properties for defining a
CfnResourceDefaultVersion.
- ICfnResourceSignal
When AWS CloudFormation creates the associated resource, configures the number of required success signals and the length of time that AWS CloudFormation waits for those signals.
- ICfnResourceVersionProps
Properties for defining a
CfnResourceVersion.
- ICfnRuleAssertion
A rule assertion.
- ICfnRuleConditionExpression
Interface to specify certain functions as Service Catalog rule-specifc.
- ICfnRuleProps
A rule can include a RuleCondition property and must include an Assertions property.
- ICfnStackProps
Properties for defining a
CfnStack.
- ICfnStackSetProps
Properties for defining a
CfnStackSet.
- ICfnTrafficRoute
A traffic route, representing where the traffic is being directed to.
- ICfnTrafficRouting
Type of the {@link CfnCodeDeployBlueGreenEcsAttributes.trafficRouting} property.
- ICfnTrafficRoutingConfig
Traffic routing configuration settings.
- ICfnTrafficRoutingTimeBasedCanary
The traffic routing configuration if {@link CfnTrafficRoutingConfig.type} is {@link CfnTrafficRoutingType.TIME_BASED_CANARY}.
- ICfnTrafficRoutingTimeBasedLinear
The traffic routing configuration if {@link CfnTrafficRoutingConfig.type} is {@link CfnTrafficRoutingType.TIME_BASED_LINEAR}.
- ICfnTypeActivationProps
Properties for defining a
CfnTypeActivation.
- ICfnUpdatePolicy
Use the UpdatePolicy attribute to specify how AWS CloudFormation handles updates to the AWS::AutoScaling::AutoScalingGroup resource.
- ICfnWaitConditionProps
Properties for defining a
CfnWaitCondition.
- ICliCredentialsStackSynthesizerProps
Properties for the CliCredentialsStackSynthesizer.
- IConstruct
Represents a construct.
- ICopyOptions
Options applied when copying directories.
- ICustomResourceProps
Properties to provide a Lambda-backed custom resource.
- ICustomResourceProviderProps
Initialization properties for
CustomResourceProvider.
- IDefaultStackSynthesizerProps
Configuration properties for DefaultStackSynthesizer.
- IDependable
Trait marker for classes that can be depended upon.
- IDependency
A single dependency.
- IDockerBuildOptions
Docker build options.
- IDockerImageAssetLocation
The location of the published docker image.
- IDockerRunOptions
Docker run options.
- IDockerVolume
A Docker volume.
- IEncodingOptions
Properties to string encodings.
- IEnvironment
The deployment environment for a stack.
- IExportValueOptions
Options for the
stack.exportValue()method.
- IFileAssetLocation
The location of the published file asset.
- IFileAssetSource
Represents the source for a file asset.
- IFileCopyOptions
Options applied when copying directories into the staging location.
- IFileFingerprintOptions
Options related to calculating source hash.
- IFingerprintOptions
Options related to calculating source hash.
- IFragmentConcatenator
Function used to concatenate symbols in the target document language.
- IInspectable
Interface for examining a construct and exposing metadata.
- IIntrinsicProps
Customization properties for an Intrinsic token.
- ILazyAnyValueOptions
Options for creating lazy untyped tokens.
- ILazyListValueOptions
Options for creating a lazy list token.
- ILazyStringValueOptions
Options for creating a lazy string token.
- IListProducer
Interface for lazy list producers.
- ILocalBundling
Local bundling.
- INestedStackProps
Initialization props for the
NestedStackconstruct.
- 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.
- IResolveChangeContextOptions
Options that can be changed while doing a recursive resolve.
- IResolveContext
Current resolution context for tokens.
- IResolveOptions
Options to the resolve() operation.
- IResource
Interface for the Resource construct.
- IResourceEnvironment
Represents the environment a given resource lives in.
- IResourceProps
Construction properties for {@link Resource}.
- IReverseOptions
Options for the 'reverse()' operation.
- ISecretsManagerSecretOptions
Options for referencing a secret value from Secrets Manager.
- ISizeConversionOptions
Options for how to convert time to a different unit.
- 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.
- IStageProps
Initialization props for a stage.
- IStageSynthesisOptions
Options for assembly synthesis.
- IStringProducer
Interface for lazy string producers.
- ISynthesisOptions
(deprecated) Options for synthesis.
- ISynthesisSession
Represents a single session of synthesis.
- ISynthesizeStackArtifactOptions
Stack artifact options.
- ITagManagerOptions
Options to configure TagManager behavior.
- ITagProps
Properties for a tag.
- ITaggable
Interface to implement tags.
- ITemplateOptions
CloudFormation template options for a stack.
- ITimeConversionOptions
Options for how to convert time to a different unit.
- ITokenMapper
Interface to apply operation to tokens in a string.
- ITokenResolver
How to resolve tokens.
- IValidationError
An error returned during the validation phase.
Enums
- ArnFormat
An enum representing the various ARN formats that different services use.
- AssetHashType
The type of asset hash.
- BundlingOutput
The type of output that a bundling operation is producing.
- CfnCapabilities
Capabilities that affect whether CloudFormation is allowed to change IAM resources.
- CfnDeletionPolicy
With the DeletionPolicy attribute you can preserve or (in some cases) backup a resource when its stack is deleted.
- CfnDynamicReferenceService
The service to retrieve the dynamic reference from.
- CfnTrafficRoutingType
The possible types of traffic shifting for the blue-green deployment configuration.
- ConstructOrder
In what order to return constructs.
- CustomResourceProviderRuntime
The lambda runtime to use for the resource provider.
- DockerVolumeConsistency
Supported Docker volume consistency types.
- FileAssetPackaging
Packaging modes for file assets.
- IgnoreMode
Determines the ignore behavior to use.
- RemovalPolicy
Possible values for a resource's Removal Policy.
- SizeRoundingBehavior
Rounding behaviour when converting between units of
Size.
- SymlinkFollowMode
Determines how symlinks are followed.