Namespace Amazon.CDK

AWSEventMetadataProps

Properties for AWS EventBridge event metadata.

AddDockerImageAssetOptions

Options for the addDockerImageAsset operation.

AddFileAssetOptions

Options for the addFileAsset operation.

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.

Arn ArnComponents AspectApplication

Object respresenting an Aspect application.

AspectOptions

Options when Applying an Aspect.

AspectPriority

Default Priority values for Aspects.

Aspects

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

AssetManifestBuilder

Build an asset manifest from assets added to a stack.

AssetManifestDockerImageDestination

The destination for a docker image asset, when it is given to the AssetManifestBuilder.

AssetManifestFileDestination

The destination for a file asset, when it is given to the AssetManifestBuilder.

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 BootstraplessSynthesizer.

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 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 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.

CfnConditionProps 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

The AWS::CloudFormation::CustomResource resource creates a custom resource.

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.

CfnGuardHook

The AWS::CloudFormation::GuardHook resource creates and activates a Guard Hook.

CfnGuardHook.HookTargetProperty

Hook targets are the destination where hooks will be invoked against.

CfnGuardHook.OptionsProperty

Specifies the input parameters for a Guard Hook.

CfnGuardHook.S3LocationProperty

Specifies the S3 location where your Guard rules or input parameters are located.

CfnGuardHook.StackFiltersProperty

The StackFilters property type specifies stack level filters for a Hook.

CfnGuardHook.StackNamesProperty

Specifies the stack names for the StackFilters property type to include or exclude specific stacks from Hook invocations.

CfnGuardHook.StackRolesProperty

Specifies the stack roles for the StackFilters property type to include or exclude specific stacks from Hook invocations based on their associated IAM roles.

CfnGuardHook.TargetFiltersProperty

The TargetFilters property type specifies the target filters for the Hook.

CfnGuardHookProps

Properties for defining a CfnGuardHook.

CfnHook

Represents a CloudFormation resource.

CfnHookDefaultVersion

The AWS::CloudFormation::HookDefaultVersion resource specifies the default version of a Hook.

CfnHookDefaultVersionProps

Properties for defining a CfnHookDefaultVersion.

CfnHookProps

Construction properties of CfnHook.

CfnHookTypeConfig

The AWS::CloudFormation::HookTypeConfig resource specifies the configuration of an activated Hook.

CfnHookTypeConfigProps

Properties for defining a CfnHookTypeConfig.

CfnHookVersion

The AWS::CloudFormation::HookVersion resource publishes new or first version of a Hook to the CloudFormation registry.

CfnHookVersion.LoggingConfigProperty

The LoggingConfig property type specifies logging configuration information for an extension.

CfnHookVersionProps

Properties for defining a CfnHookVersion.

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 and activates a Lambda Hook.

CfnLambdaHook.HookTargetProperty

Hook targets are the destination where hooks will be invoked against.

CfnLambdaHook.StackFiltersProperty

The StackFilters property type specifies stack level filters for a Hook.

CfnLambdaHook.StackNamesProperty

Specifies the stack names for the StackFilters property type to include or exclude specific stacks from Hook invocations.

CfnLambdaHook.StackRolesProperty

Specifies the stack roles for the StackFilters property type to include or exclude specific stacks from Hook invocations based on their associated IAM roles.

CfnLambdaHook.TargetFiltersProperty

The TargetFilters property type specifies the target filters for the Hook.

CfnLambdaHookProps

Properties for defining a CfnLambdaHook.

CfnMacro

The AWS::CloudFormation::Macro resource is a CloudFormation resource type that creates a CloudFormation macro to perform custom processing on CloudFormation templates.

CfnMacroProps

Properties for defining a CfnMacro.

CfnMapping

Represents a CloudFormation mapping.

CfnMappingProps CfnModuleDefaultVersion

Specifies the default version of a module.

CfnModuleDefaultVersionProps

Properties for defining a CfnModuleDefaultVersion.

CfnModuleVersion

The AWS::CloudFormation::ModuleVersion resource registers the specified version of the module with the CloudFormation registry.

CfnModuleVersionProps

Properties for defining a CfnModuleVersion.

CfnOutput CfnOutputProps CfnParameter

A CloudFormation parameter.

CfnParameterProps CfnPublicTypeVersion

The AWS::CloudFormation::PublicTypeVersion resource tests and publishes a registered extension as a public, third-party extension.

CfnPublicTypeVersionProps

Properties for defining a CfnPublicTypeVersion.

CfnPublisher

The AWS::CloudFormation::Publisher resource registers your account as a publisher of public extensions in the CloudFormation registry.

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

The AWS::CloudFormation::ResourceDefaultVersion resource specifies the default version of a resource.

CfnResourceDefaultVersionProps

Properties for defining a CfnResourceDefaultVersion.

CfnResourceProps 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

The AWS::CloudFormation::ResourceVersion resource registers a resource version with the CloudFormation registry.

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

The AWS::CloudFormation::Stack resource nests a stack as a resource in a top-level template.

CfnStack.OutputProperty

The Output data type.

CfnStackProps

Properties for defining a CfnStack.

CfnStackSet

The AWS::CloudFormation::StackSet resource contains information about a StackSet.

CfnStackSet.AutoDeploymentProperty

Describes whether StackSets automatically deploys to AWS Organizations accounts that are added to a target organization or organizational unit (OU).

CfnStackSet.DeploymentTargetsProperty

The AWS Organizations accounts or AWS accounts to deploy stacks to 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 CloudFormation performs a StackSet operation.

CfnStackSet.ParameterProperty

The Parameter data type.

CfnStackSet.StackInstancesProperty

Stack instances in some specific accounts and Regions.

CfnStackSetProps

Properties for defining a CfnStackSet.

CfnTag CfnTrafficRoute

A traffic route, representing where the traffic is being directed to.

CfnTrafficRouting

Type of the CfnCodeDeployBlueGreenEcsAttributes.trafficRouting property.

CfnTrafficRoutingConfig

Traffic routing configuration settings.

CfnTrafficRoutingTimeBasedCanary

The traffic routing configuration if CfnTrafficRoutingConfig.type is CfnTrafficRoutingType.TIME_BASED_CANARY.

CfnTrafficRoutingTimeBasedLinear

The traffic routing configuration if CfnTrafficRoutingConfig.type is CfnTrafficRoutingType.TIME_BASED_LINEAR.

CfnTypeActivation

The AWS::CloudFormation::TypeActivation resource activates a public third-party extension, making it available for use in stack templates.

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

The AWS::CloudFormation::WaitCondition resource provides a way to coordinate stack resource creation with configuration actions that are external to the stack creation or to track the status of a configuration process.

CfnWaitConditionHandle

The AWS::CloudFormation::WaitConditionHandle type has no properties.

CfnWaitConditionHandleProps

Properties for defining a CfnWaitConditionHandle.

CfnWaitConditionProps

Properties for defining a CfnWaitCondition.

CliCredentialsStackSynthesizer

A synthesizer that uses conventional asset locations, but not conventional deployment roles.

CliCredentialsStackSynthesizerProps

Properties for the CliCredentialsStackSynthesizer.

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.

CustomResourceProviderBase

Base class for creating a custom resource provider.

CustomResourceProviderBaseProps

Initialization properties for CustomResourceProviderBase.

CustomResourceProviderOptions

Initialization options for custom resource providers.

CustomResourceProviderProps

Initialization properties for CustomResourceProvider.

DefaultStackSynthesizer

Uses conventionally named roles and asset storage locations.

DefaultStackSynthesizerProps

Configuration properties for DefaultStackSynthesizer.

DefaultTokenResolver

Default resolver implementation.

DockerBuildOptions

Docker build options.

DockerBuildSecret

Methods to build Docker CLI arguments for builds using secrets.

DockerCacheOption

Options for configuring the Docker cache backend.

DockerIgnoreStrategy

Ignores file paths based on the .dockerignore specification.

DockerImage

A Docker image.

DockerImageAssetLocation

The location of the published docker image.

DockerImageAssetSource 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.

Errors

Helper to check if an error is of a certain type.

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.

CloudFormation intrinsic functions.

GetContextKeyOptions GetContextKeyResult GetContextValueOptions GetContextValueResult GitIgnoreStrategy

Ignores file paths based on the .gitignore specification.

GlobIgnoreStrategy

Ignores file paths based on simple glob patterns.

IgnoreStrategy

Represents file path ignoring behavior.

InjectionContext

This defines the values needed for Injection.

Intrinsic

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

IntrinsicProps

Customization properties for an Intrinsic token.

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

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.

MissingRemovalPolicies

Manages removal policies for resources without existing policies within a construct scope.

Names

Functions for devising unique names for constructs.

NestedStack

A CloudFormation nested stack.

NestedStackProps

Initialization props for the NestedStack construct.

NestedStackSynthesizer

Synthesizer for a nested stack.

PermissionsBoundary

Apply a permissions boundary to all IAM Roles and Users within a specific scope.

PermissionsBoundaryBindOptions

Options for binding a Permissions Boundary to a construct scope.

PhysicalName

Includes special markers for automatic generation of physical names.

PolicyValidationPluginReportBeta1

The report emitted by the plugin after evaluation.

PolicyViolatingResourceBeta1

Resource violating a specific rule.

PolicyViolationBeta1

Violation produced by the validation plugin.

PropertyInjectors

This is a collection of ProjectInjectors assigned to this scope.

Reference

An intrinsic Token that represents a reference to a construct.

RemovalPolicies

Manages removal policies for all resources within a construct scope, overriding any existing policies by default.

RemovalPolicyOptions RemovalPolicyProps

Properties for applying a removal policy.

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

An L2 construct which represents an AWS resource.

ResourceProps

Construction properties for Resource.

ReverseOptions

Options for the 'reverse()' operation.

RoleOptions

Options for specifying a role.

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.

StackProps 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.

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.