# CfnProject

The `AWS::CodeBuild::Project` resource configures how AWS CodeBuild builds your source code.

For example, it tells CodeBuild where to get the source code and which build environment to use.

> To unset or remove a project value via CFN, explicitly provide the attribute with value as empty input.

Extends: Construct › CfnElement › CfnRefElement › CfnResource › CfnProject
Implements: IInspectable, ITaggable, IEnvironmentAware, IProjectRef, IConstruct, IDependable

- CloudFormation: [`AWS::CodeBuild::Project`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-codebuild-project.html)
- Source: Generated code
- Type last changed: v2.252.0 · 30 Apr 2026

## Example

```ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_codebuild as codebuild } from 'aws-cdk-lib';
const cfnProject = new codebuild.CfnProject(this, 'MyCfnProject', {
  artifacts: {
    type: 'type',

    // the properties below are optional
    artifactIdentifier: 'artifactIdentifier',
    encryptionDisabled: false,
    location: 'location',
    name: 'name',
    namespaceType: 'namespaceType',
    overrideArtifactName: false,
    packaging: 'packaging',
    path: 'path',
  },
  environment: {
    computeType: 'computeType',
    image: 'image',
    type: 'type',

    // the properties below are optional
    certificate: 'certificate',
    dockerServer: {
      computeType: 'computeType',

      // the properties below are optional
      securityGroupIds: ['securityGroupIds'],
    },
    environmentVariables: [{
      name: 'name',
      value: 'value',

      // the properties below are optional
      type: 'type',
    }],
    fleet: {
      fleetArn: 'fleetArn',
    },
    hostKernel: 'hostKernel',
    imagePullCredentialsType: 'imagePullCredentialsType',
    privilegedMode: false,
    registryCredential: {
      credential: 'credential',
      credentialProvider: 'credentialProvider',
    },
  },
  serviceRole: 'serviceRole',
  source: {
    type: 'type',

    // the properties below are optional
    auth: {
      type: 'type',

      // the properties below are optional
      resource: 'resource',
    },
    buildSpec: 'buildSpec',
    buildStatusConfig: {
      context: 'context',
      targetUrl: 'targetUrl',
    },
    gitCloneDepth: 123,
    gitSubmodulesConfig: {
      fetchSubmodules: false,
    },
    insecureSsl: false,
    location: 'location',
    reportBuildStatus: false,
    sourceIdentifier: 'sourceIdentifier',
  },

  // the properties below are optional
  autoRetryLimit: 123,
  badgeEnabled: false,
  buildBatchConfig: {
    batchReportMode: 'batchReportMode',
    combineArtifacts: false,
    restrictions: {
      computeTypesAllowed: ['computeTypesAllowed'],
      maximumBuildsAllowed: 123,
    },
    serviceRole: 'serviceRole',
    timeoutInMins: 123,
  },
  cache: {
    type: 'type',

    // the properties below are optional
    cacheNamespace: 'cacheNamespace',
    location: 'location',
    modes: ['modes'],
  },
  concurrentBuildLimit: 123,
  description: 'description',
  encryptionKey: 'encryptionKey',
  fileSystemLocations: [{
    identifier: 'identifier',
    location: 'location',
    mountPoint: 'mountPoint',
    type: 'type',

    // the properties below are optional
    mountOptions: 'mountOptions',
  }],
  logsConfig: {
    cloudWatchLogs: {
      status: 'status',

      // the properties below are optional
      groupName: 'groupName',
      streamName: 'streamName',
    },
    s3Logs: {
      status: 'status',

      // the properties below are optional
      encryptionDisabled: false,
      location: 'location',
    },
  },
  name: 'name',
  queuedTimeoutInMinutes: 123,
  resourceAccessRole: 'resourceAccessRole',
  secondaryArtifacts: [{
    type: 'type',

    // the properties below are optional
    artifactIdentifier: 'artifactIdentifier',
    encryptionDisabled: false,
    location: 'location',
    name: 'name',
    namespaceType: 'namespaceType',
    overrideArtifactName: false,
    packaging: 'packaging',
    path: 'path',
  }],
  secondarySources: [{
    type: 'type',

    // the properties below are optional
    auth: {
      type: 'type',

      // the properties below are optional
      resource: 'resource',
    },
    buildSpec: 'buildSpec',
    buildStatusConfig: {
      context: 'context',
      targetUrl: 'targetUrl',
    },
    gitCloneDepth: 123,
    gitSubmodulesConfig: {
      fetchSubmodules: false,
    },
    insecureSsl: false,
    location: 'location',
    reportBuildStatus: false,
    sourceIdentifier: 'sourceIdentifier',
  }],
  secondarySourceVersions: [{
    sourceIdentifier: 'sourceIdentifier',

    // the properties below are optional
    sourceVersion: 'sourceVersion',
  }],
  sourceVersion: 'sourceVersion',
  tags: [{
    key: 'key',
    value: 'value',
  }],
  timeoutInMinutes: 123,
  triggers: {
    buildType: 'buildType',
    filterGroups: [[{
      pattern: 'pattern',
      type: 'type',

      // the properties below are optional
      excludeMatchedPattern: false,
    }]],
    pullRequestBuildPolicy: {
      requiresCommentApproval: 'requiresCommentApproval',

      // the properties below are optional
      approverRoles: ['approverRoles'],
    },
    scopeConfiguration: {
      name: 'name',

      // the properties below are optional
      domain: 'domain',
      scope: 'scope',
    },
    webhook: false,
  },
  visibility: 'visibility',
  vpcConfig: {
    securityGroupIds: ['securityGroupIds'],
    subnets: ['subnets'],
    vpcId: 'vpcId',
  },
});
```

## Initializer

```ts
new CfnProject(scope: Construct, id: string, props: CfnProjectProps)
```

## Construct Props

- `artifacts`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnProject.ArtifactsProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_codebuild.CfnProject.ArtifactsProperty.html) (required) — `Artifacts` is a property of the [AWS::CodeBuild::Project](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html) resource that specifies output settings for artifacts generated by an AWS CodeBuild build.

- `autoRetryLimit`: number

- `badgeEnabled`: boolean | [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) — Indicates whether AWS CodeBuild generates a publicly accessible URL for your project's build badge.

  For more information, see [Build Badges Sample](https://docs.aws.amazon.com/codebuild/latest/userguide/sample-build-badges.html) in the *AWS CodeBuild User Guide* .

  > Including build badges with your project is currently not supported if the source type is CodePipeline. If you specify `CODEPIPELINE` for the `Source` property, do not specify the `BadgeEnabled` property.

- `buildBatchConfig`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnProject.ProjectBuildBatchConfigProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_codebuild.CfnProject.ProjectBuildBatchConfigProperty.html) — A `ProjectBuildBatchConfig` object that defines the batch build options for the project.

- `cache`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnProject.ProjectCacheProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_codebuild.CfnProject.ProjectCacheProperty.html) — Settings that AWS CodeBuild uses to store and reuse build dependencies.

- `concurrentBuildLimit`: number — The maximum number of concurrent builds that are allowed for this project.

  New builds are only started if the current number of builds is less than or equal to this limit. If the current build count meets this limit, new builds are throttled and are not run.

- `description`: string — A description that makes the build project easy to identify.

- `encryptionKey`: string — The AWS Key Management Service customer master key (CMK) to be used for encrypting the build output artifacts.

  > You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key.

  You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using the format `alias/<alias-name>` ). If you don't specify a value, CodeBuild uses the managed CMK for Amazon Simple Storage Service (Amazon S3).

- `environment`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnProject.EnvironmentProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_codebuild.CfnProject.EnvironmentProperty.html) (required) — The build environment settings for the project, such as the environment type or the environment variables to use for the build environment.

- `fileSystemLocations`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnProject.ProjectFileSystemLocationProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_codebuild.CfnProject.ProjectFileSystemLocationProperty.html)[] — An array of `ProjectFileSystemLocation` objects for a CodeBuild build project.

  A `ProjectFileSystemLocation` object specifies the `identifier` , `location` , `mountOptions` , `mountPoint` , and `type` of a file system created using Amazon Elastic File System.

- `logsConfig`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnProject.LogsConfigProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_codebuild.CfnProject.LogsConfigProperty.html) — Information about logs for the build project.

  A project can create logs in CloudWatch Logs, an S3 bucket, or both.

- `name`: string — The name of the build project.

  The name must be unique across all of the projects in your AWS account .

- `queuedTimeoutInMinutes`: number — The number of minutes a build is allowed to be queued before it times out.

- `resourceAccessRole`: string — The ARN of the IAM role that enables CodeBuild to access the CloudWatch Logs and Amazon S3 artifacts for the project's builds.

- `secondaryArtifacts`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnProject.ArtifactsProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_codebuild.CfnProject.ArtifactsProperty.html)[] — A list of `Artifacts` objects.

  Each artifacts object specifies output settings that the project generates during a build.

- `secondarySources`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnProject.SourceProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_codebuild.CfnProject.SourceProperty.html)[] — An array of `ProjectSource` objects.

- `secondarySourceVersions`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnProject.ProjectSourceVersionProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_codebuild.CfnProject.ProjectSourceVersionProperty.html)[] — An array of `ProjectSourceVersion` objects.

  If `secondarySourceVersions` is specified at the build level, then they take over these `secondarySourceVersions` (at the project level).

- `serviceRole`: string (required) — The ARN of the IAM role that enables AWS CodeBuild to interact with dependent AWS services on behalf of the AWS account.

- `source`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnProject.SourceProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_codebuild.CfnProject.SourceProperty.html) (required) — The source code settings for the project, such as the source code's repository type and location.

- `sourceVersion`: string — A version of the build input to be built for this project.

  If not specified, the latest version is used. If specified, it must be one of:

  - For CodeCommit: the commit ID, branch, or Git tag to use.
  - For GitHub: the commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format `pr/pull-request-ID` (for example `pr/25` ). If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.
  - For GitLab: the commit ID, branch, or Git tag to use.
  - For Bitbucket: the commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.
  - For Amazon S3: the version ID of the object that represents the build input ZIP file to use.

  If `sourceVersion` is specified at the build level, then that version takes precedence over this `sourceVersion` (at the project level).

  For more information, see [Source Version Sample with CodeBuild](https://docs.aws.amazon.com/codebuild/latest/userguide/sample-source-version.html) in the *AWS CodeBuild User Guide* .

- `tags`: [CfnTag](/cdk/api/v2/docs/aws-cdk-lib.CfnTag.html)[] — An arbitrary set of tags (key-value pairs) for the AWS CodeBuild project.

  These tags are available for use by AWS services that support AWS CodeBuild build project tags.

- `timeoutInMinutes`: number — How long, in minutes, from 5 to 2160 (36 hours), for AWS CodeBuild to wait before timing out any related build that did not get marked as completed.

  The default is 60 minutes.

- `triggers`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnProject.ProjectTriggersProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_codebuild.CfnProject.ProjectTriggersProperty.html) — For an existing AWS CodeBuild build project that has its source code stored in a GitHub repository, enables AWS CodeBuild to begin automatically rebuilding the source code every time a code change is pushed to the repository.

- `visibility`: string — Specifies the visibility of the project's builds. Possible values are:.

  - **PUBLIC_READ** - The project builds are visible to the public.
  - **PRIVATE** - The project builds are not visible to the public.

- `vpcConfig`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnProject.VpcConfigProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_codebuild.CfnProject.VpcConfigProperty.html) — `VpcConfig` specifies settings that enable AWS CodeBuild to access resources in an Amazon VPC.

  For more information, see [Use AWS CodeBuild with Amazon Virtual Private Cloud](https://docs.aws.amazon.com/codebuild/latest/userguide/vpc-support.html) in the *AWS CodeBuild User Guide* .

## Properties

- `artifacts`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnProject.ArtifactsProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_codebuild.CfnProject.ArtifactsProperty.html) (required) — `Artifacts` is a property of the [AWS::CodeBuild::Project](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html) resource that specifies output settings for artifacts generated by an AWS CodeBuild build.

- `attrArn`: string (required) — The ARN of the AWS CodeBuild project, such as `arn:aws:codebuild:us-west-2:123456789012:project/myProjectName` .

- `attrId`: string (required)

- `autoRetryLimit`: number

- `badgeEnabled`: boolean | [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) — Indicates whether AWS CodeBuild generates a publicly accessible URL for your project's build badge.

- `buildBatchConfig`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnProject.ProjectBuildBatchConfigProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_codebuild.CfnProject.ProjectBuildBatchConfigProperty.html) — A `ProjectBuildBatchConfig` object that defines the batch build options for the project.

- `cache`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnProject.ProjectCacheProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_codebuild.CfnProject.ProjectCacheProperty.html) — Settings that AWS CodeBuild uses to store and reuse build dependencies.

- `CFN_RESOURCE_TYPE_NAME`: string (required) (static) — The CloudFormation resource type name for this resource class.

- `cfnOptions`: [ICfnResourceOptions](/cdk/api/v2/docs/aws-cdk-lib.ICfnResourceOptions.html) (required) — Options for this resource, such as condition, update policy etc.

- `cfnResourceType`: string (required) — AWS resource type.

- `concurrentBuildLimit`: number — The maximum number of concurrent builds that are allowed for this project.

- `creationStack`: string[] (required)

- `description`: string — A description that makes the build project easy to identify.

- `encryptionKey`: string — The AWS Key Management Service customer master key (CMK) to be used for encrypting the build output artifacts.

- `env`: [ResourceEnvironment](/cdk/api/v2/docs/aws-cdk-lib.interfaces.ResourceEnvironment.html) (required)

- `environment`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnProject.EnvironmentProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_codebuild.CfnProject.EnvironmentProperty.html) (required) — The build environment settings for the project, such as the environment type or the environment variables to use for the build environment.

- `fileSystemLocations`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnProject.ProjectFileSystemLocationProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_codebuild.CfnProject.ProjectFileSystemLocationProperty.html)[] — An array of `ProjectFileSystemLocation` objects for a CodeBuild build project.

- `logicalId`: string (required) — The logical ID for this CloudFormation stack element.

  The logical ID of the element
  is calculated from the path of the resource node in the construct tree.

  To override this value, use `overrideLogicalId(newLogicalId)`.

- `logsConfig`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnProject.LogsConfigProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_codebuild.CfnProject.LogsConfigProperty.html) — Information about logs for the build project.

- `name`: string — The name of the build project.

- `node`: [Node](/cdk/api/v2/docs/constructs.Node.html) (required) — The tree node.

- `projectRef`: [ProjectReference](/cdk/api/v2/docs/aws-cdk-lib.interfaces.aws_codebuild.ProjectReference.html) (required) — A reference to a Project resource.

- `queuedTimeoutInMinutes`: number — The number of minutes a build is allowed to be queued before it times out.

- `ref`: string (required) — Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.

  If, by any chance, the intrinsic reference of a resource is not a string, you could
  coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.

- `resourceAccessRole`: string — The ARN of the IAM role that enables CodeBuild to access the CloudWatch Logs and Amazon S3 artifacts for the project's builds.

- `secondaryArtifacts`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnProject.ArtifactsProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_codebuild.CfnProject.ArtifactsProperty.html)[] — A list of `Artifacts` objects.

- `secondarySources`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnProject.SourceProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_codebuild.CfnProject.SourceProperty.html)[] — An array of `ProjectSource` objects.

- `secondarySourceVersions`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnProject.ProjectSourceVersionProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_codebuild.CfnProject.ProjectSourceVersionProperty.html)[] — An array of `ProjectSourceVersion` objects.

- `serviceRole`: string (required) — The ARN of the IAM role that enables AWS CodeBuild to interact with dependent AWS services on behalf of the AWS account.

- `source`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnProject.SourceProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_codebuild.CfnProject.SourceProperty.html) (required) — The source code settings for the project, such as the source code's repository type and location.

- `sourceVersion`: string — A version of the build input to be built for this project.

- `stack`: [Stack](/cdk/api/v2/docs/aws-cdk-lib.Stack.html) (required) — The stack in which this element is defined.

  CfnElements must be defined within a stack scope (directly or indirectly).

- `tags`: [TagManager](/cdk/api/v2/docs/aws-cdk-lib.TagManager.html) (required) — Tag Manager which manages the tags for this resource.

- `tagsRaw`: [CfnTag](/cdk/api/v2/docs/aws-cdk-lib.CfnTag.html)[] — An arbitrary set of tags (key-value pairs) for the AWS CodeBuild project.

- `timeoutInMinutes`: number — How long, in minutes, from 5 to 2160 (36 hours), for AWS CodeBuild to wait before timing out any related build that did not get marked as completed.

- `triggers`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnProject.ProjectTriggersProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_codebuild.CfnProject.ProjectTriggersProperty.html) — For an existing AWS CodeBuild build project that has its source code stored in a GitHub repository, enables AWS CodeBuild to begin automatically rebuilding the source code every time a code change is pushed to the repository.

- `visibility`: string — Specifies the visibility of the project's builds.

  Possible values are:.

- `vpcConfig`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnProject.VpcConfigProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_codebuild.CfnProject.VpcConfigProperty.html) — `VpcConfig` specifies settings that enable AWS CodeBuild to access resources in an Amazon VPC.

## Methods

- `addDeletionOverride(path: string): void` — Syntactic sugar for `addOverride(path, undefined)`.

  **Parameters**

  - `path` — The path of the value to delete.

- `addDependency(target: CfnResource): void` — Use `addResourceDependency` instead.

  This method has been renamed to `addResourceDependency` to more clearly
  set it apart from `construct.node.addDependency`. See the documentation
  of that function for more details.

- `addDependsOn(target: CfnResource): void` — Use `addResourceDependency` instead.

  This can be used for resources across stacks (or nested stack) boundaries
  and the dependency will automatically be transferred to the relevant scope.

  This method has been renamed to `addResourceDependency`, which makes it
  more clear that this method operates at a different level from the
  construct-level `construct.node.addDependency()` mechanism.

- `addMetadata(key: string, value: any): void` — Add a value to the CloudFormation Resource Metadata.

- `addOverride(path: string, value: any): void` — Adds an override to the synthesized CloudFormation resource.

  To add a
  property override, either use `addPropertyOverride` or prefix `path` with
  "Properties." (i.e. `Properties.TopicName`).

  If the override is nested, separate each nested level using a dot (.) in the path parameter.
  If there is an array as part of the nesting, specify the index in the path.

  To include a literal `.` in the property name, prefix with a `\`. In most
  programming languages you will need to write this as `"\\."` because the
  `\` itself will need to be escaped.

  For example,
  ```typescript
  cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
  cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
  ```
  would add the overrides
  ```json
  "Properties": {
    "GlobalSecondaryIndexes": [
      {
        "Projection": {
          "NonKeyAttributes": [ "myattribute" ]
          ...
        }
        ...
      },
      {
        "ProjectionType": "INCLUDE"
        ...
      },
    ]
    ...
  }
  ```

  The `value` argument to `addOverride` will not be processed or translated
  in any way. Pass raw JSON values in here with the correct capitalization
  for CloudFormation. If you pass CDK classes or structs, they will be
  rendered with lowercased key names, and CloudFormation will reject the
  template.

  **Parameters**

  - `path` — - The path of the property, you can use dot notation to override values in complex types.
  - `value` — - The value.

- `addPropertyDeletionOverride(propertyPath: string): void` — Adds an override that deletes the value of a property from the resource definition.

  **Parameters**

  - `propertyPath` — The path to the property.

- `addPropertyOverride(propertyPath: string, value: any): void` — Adds an override to a resource property.

  Syntactic sugar for `addOverride("Properties.<...>", value)`.

  **Parameters**

  - `propertyPath` — The path of the property.
  - `value` — The value.

- `addResourceDependency(target: CfnResource, reason?: string): void` — Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

  This can be used for resources across stacks (or nested stack) boundaries
  and the dependency will automatically be transferred to the relevant scope.

  This method only adds dependencies between L1 resources. If you are
  looking for a generic construct-to-construct dependency mechanism that works
  for all constructs including L2s, use `construct.node.addDependency` instead.

- `applyCrossStackReferenceStrength(strength: ReferenceStrength): void` — Sets the cross-stack reference strength for this resource.

  When set, any cross-stack reference to this resource will use the specified
  strength instead of the global default from the consuming stack's context.

  **Parameters**

  - `strength` — - The reference strength to use for this resource.

- `applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void` — Sets the deletion policy of the resource based on the removal policy specified.

  The Removal Policy controls what happens to this resource when it stops
  being managed by CloudFormation, either because you've removed it from the
  CDK application or because you've made a change that requires the resource
  to be replaced.

  The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
  account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some
  cases, a snapshot can be taken of the resource prior to deletion
  (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
  can be found in the following link:

- `arnForProject(resource: IProjectRef): string` (static)

- `cfnPropertyName(cdkPropertyName: string): string`

- `fromProjectArn(scope: Construct, id: string, arn: string): IProjectRef` (static) — Creates a new IProjectRef from an ARN.

- `fromProjectName(scope: Construct, id: string, projectName: string): IProjectRef` (static) — Creates a new IProjectRef from a projectName.

- `getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference` — Returns a token for an runtime attribute of this resource.

  Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
  in case there is no generated attribute.

  **Parameters**

  - `attributeName` — The name of the attribute.

- `getMetadata(key: string): any` — Retrieve a value value from the CloudFormation Resource Metadata.

- `inspect(inspector: TreeInspector): void` — Examines the CloudFormation resource and discloses attributes.

  **Parameters**

  - `inspector` — tree inspector to collect and process attributes.

- `isCfnElement(x: any): boolean` (static) — Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

  Uses duck-typing instead of `instanceof` to allow stack elements from different
  versions of this library to be included in the same stack.

  **Returns:** The construct as a stack element or undefined if it is not a stack element.

- `isCfnProject(x: any): boolean` (static) — Checks whether the given object is a CfnProject.

- `isCfnResource(x: any): boolean` (static) — Check whether the given object is a CfnResource.

- `isConstruct(x: any): boolean` (static) — Checks if `x` is a construct.

  Use this method instead of `instanceof` to properly detect `Construct`
  instances, even when the construct library is symlinked.

  Explanation: in JavaScript, multiple copies of the `constructs` library on
  disk are seen as independent, completely different libraries. As a
  consequence, the class `Construct` in each copy of the `constructs` library
  is seen as a different class, and an instance of one class will not test as
  `instanceof` the other class. `npm install` will not create installations
  like this, but users may manually symlink construct libraries together or
  use a monorepo tool: in those cases, multiple copies of the `constructs`
  library can be accidentally installed, and `instanceof` will behave
  unpredictably. It is safest to avoid using `instanceof`, and using
  this type-testing method instead.

  **Parameters**

  - `x` — Any object.

  **Returns:** true if `x` is an object created from a class which extends `Construct`.

- `obtainDependencies(): Stack | CfnResource[]` — Retrieves an array of resources and stacks this resource depends on.

  For resources depended on directly, returns the `CfnResource` object. For
  dependencies on other stacks, returns the `Stack` object. The order of the
  array is not guaranteed.

- `overrideLogicalId(newLogicalId: string): void` — Overrides the auto-generated logical ID with a specific ID.

  **Parameters**

  - `newLogicalId` — The new logical ID to use for this stack element.

- `removeDependency(target: CfnResource): void` — Use `removeResourceDependency` instead

  This can be used for resources across stacks (including nested stacks)
  and the dependency will automatically be removed from the relevant scope.

- `removeResourceDependency(target: CfnResource): void` — Indicates that this resource no longer depends on another resource.

  This can be used for resources across stacks (including nested stacks)
  and the dependency will automatically be removed from the relevant scope.

- `replaceDependency(target: CfnResource, newTarget: CfnResource): void` — Replaces one dependency with another.

  **Parameters**

  - `target` — The dependency to replace.
  - `newTarget` — The new dependency to add.

- `toString(): string` — Returns a string representation of this construct.

  **Returns:** a string representation of this resource

- `with(...mixins: IMixin[]): IConstruct` — Applies one or more mixins to this construct.

  Mixins are applied in order. The list of constructs is captured at the
  start of the call, so constructs added by a mixin will not be visited.
  Use multiple `with()` calls if subsequent mixins should apply to added
  constructs.