class CfnProject (construct)

Language	Type name
.NET	Amazon.CDK.AWS.CodeBuild.CfnProject
Java	software.amazon.awscdk.services.codebuild.CfnProject
Python	aws_cdk.aws_codebuild.CfnProject
TypeScript	@aws-cdk/aws-codebuild » CfnProject

Implements IConstruct, IConstruct, IDependable, IInspectable

A CloudFormation AWS::CodeBuild::Project.

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.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as codebuild from '@aws-cdk/aws-codebuild';
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',
    environmentVariables: [{
      name: 'name',
      value: 'value',

      // the properties below are optional
      type: 'type',
    }],
    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
  badgeEnabled: false,
  buildBatchConfig: {
    batchReportMode: 'batchReportMode',
    combineArtifacts: false,
    restrictions: {
      computeTypesAllowed: ['computeTypesAllowed'],
      maximumBuildsAllowed: 123,
    },
    serviceRole: 'serviceRole',
    timeoutInMins: 123,
  },
  cache: {
    type: 'type',

    // the properties below are optional
    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,
    }]],
    webhook: false,
  },
  visibility: 'visibility',
  vpcConfig: {
    securityGroupIds: ['securityGroupIds'],
    subnets: ['subnets'],
    vpcId: 'vpcId',
  },
});

Initializer

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

Parameters

• scope Construct — - scope in which this resource is defined.
• id string — - scoped id of the resource.
• props CfnProjectProps — - resource properties.

Create a new AWS::CodeBuild::Project.

Construct Props

Name	Type	Description
artifacts	IResolvable | ArtifactsProperty	Artifacts is a property of the AWS::CodeBuild::Project resource that specifies output settings for artifacts generated by an AWS CodeBuild build.
environment	IResolvable | EnvironmentProperty	The build environment settings for the project, such as the environment type or the environment variables to use for the build environment.
serviceRole	string	The ARN of the IAM role that enables AWS CodeBuild to interact with dependent AWS services on behalf of the AWS account.
source	SourceProperty | IResolvable	The source code settings for the project, such as the source code's repository type and location.
badgeEnabled?	boolean | IResolvable	Indicates whether AWS CodeBuild generates a publicly accessible URL for your project's build badge.
buildBatchConfig?	IResolvable | ProjectBuildBatchConfigProperty	A ProjectBuildBatchConfig object that defines the batch build options for the project.
cache?	IResolvable | ProjectCacheProperty	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.
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.
fileSystemLocations?	IResolvable | IResolvable | ProjectFileSystemLocationProperty[]	An array of ProjectFileSystemLocation objects for a CodeBuild build project.
logsConfig?	IResolvable | LogsConfigProperty	Information about logs for the build project.
name?	string	The name of the build project.
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 | IResolvable | ArtifactsProperty[]	A list of Artifacts objects.
secondarySourceVersions?	IResolvable | IResolvable | ProjectSourceVersionProperty[]	An array of ProjectSourceVersion objects.
secondarySources?	IResolvable | SourceProperty | IResolvable[]	An array of ProjectSource objects.
sourceVersion?	string	A version of the build input to be built for this project.
tags?	CfnTag[]	An arbitrary set of tags (key-value pairs) for the AWS CodeBuild project.
timeoutInMinutes?	number	How long, in minutes, from 5 to 480 (8 hours), for AWS CodeBuild to wait before timing out any related build that did not get marked as completed.
triggers?	ProjectTriggersProperty | IResolvable	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 | VpcConfigProperty	VpcConfig specifies settings that enable AWS CodeBuild to access resources in an Amazon VPC.

---

artifacts

Type: IResolvable | ArtifactsProperty

Artifacts is a property of the AWS::CodeBuild::Project resource that specifies output settings for artifacts generated by an AWS CodeBuild build.

---

environment

Type: IResolvable | EnvironmentProperty

The build environment settings for the project, such as the environment type or the environment variables to use for the build environment.

---

serviceRole

Type: string

The ARN of the IAM role that enables AWS CodeBuild to interact with dependent AWS services on behalf of the AWS account.

---

source

Type: SourceProperty | IResolvable

The source code settings for the project, such as the source code's repository type and location.

---

badgeEnabled?

Type: boolean | IResolvable (optional)

Indicates whether AWS CodeBuild generates a publicly accessible URL for your project's build badge.

For more information, see Build Badges Sample 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?

Type: IResolvable | ProjectBuildBatchConfigProperty (optional)

A ProjectBuildBatchConfig object that defines the batch build options for the project.

---

cache?

Type: IResolvable | ProjectCacheProperty (optional)

Settings that AWS CodeBuild uses to store and reuse build dependencies.

---

concurrentBuildLimit?

Type: number (optional)

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?

Type: string (optional)

A description that makes the build project easy to identify.

---

encryptionKey?

Type: string (optional)

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

---

fileSystemLocations?

Type: IResolvable | IResolvable | ProjectFileSystemLocationProperty[] (optional)

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?

Type: IResolvable | LogsConfigProperty (optional)

Information about logs for the build project.

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

---

name?

Type: string (optional)

The name of the build project.

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

---

queuedTimeoutInMinutes?

Type: number (optional)

The number of minutes a build is allowed to be queued before it times out.

---

resourceAccessRole?

Type: string (optional)

The ARN of the IAM role that enables CodeBuild to access the CloudWatch Logs and Amazon S3 artifacts for the project's builds.

---

secondaryArtifacts?

Type: IResolvable | IResolvable | ArtifactsProperty[] (optional)

A list of Artifacts objects.

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

---

secondarySourceVersions?

Type: IResolvable | IResolvable | ProjectSourceVersionProperty[] (optional)

An array of ProjectSourceVersion objects.

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

---

secondarySources?

Type: IResolvable | SourceProperty | IResolvable[] (optional)

An array of ProjectSource objects.

---

sourceVersion?

Type: string (optional)

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 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 in the AWS CodeBuild User Guide .

---

tags?

Type: CfnTag[] (optional)

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?

Type: number (optional)

How long, in minutes, from 5 to 480 (8 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?

Type: ProjectTriggersProperty | IResolvable (optional)

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?

Type: string (optional)

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?

Type: IResolvable | VpcConfigProperty (optional)

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 in the AWS CodeBuild User Guide .

Properties

Name	Type	Description
artifacts	IResolvable | ArtifactsProperty	Artifacts is a property of the AWS::CodeBuild::Project resource that specifies output settings for artifacts generated by an AWS CodeBuild build.
attrArn	string	The ARN of the AWS CodeBuild project, such as arn:aws:codebuild:us-west-2:123456789012:project/myProjectName .
cfnOptions	ICfnResourceOptions	Options for this resource, such as condition, update policy etc.
cfnProperties	{ [string]: any }
cfnResourceType	string	AWS resource type.
creationStack	string[]
environment	IResolvable | EnvironmentProperty	The build environment settings for the project, such as the environment type or the environment variables to use for the build environment.
logicalId	string	The logical ID for this CloudFormation stack element.
node	ConstructNode	The construct tree node associated with this construct.
ref	string	Return a string that will be resolved to a CloudFormation { Ref } for this element.
serviceRole	string	The ARN of the IAM role that enables AWS CodeBuild to interact with dependent AWS services on behalf of the AWS account.
source	SourceProperty | IResolvable	The source code settings for the project, such as the source code's repository type and location.
stack	Stack	The stack in which this element is defined.
tags	TagManager	An arbitrary set of tags (key-value pairs) for the AWS CodeBuild project.
badgeEnabled?	boolean | IResolvable	Indicates whether AWS CodeBuild generates a publicly accessible URL for your project's build badge.
buildBatchConfig?	IResolvable | ProjectBuildBatchConfigProperty	A ProjectBuildBatchConfig object that defines the batch build options for the project.
cache?	IResolvable | ProjectCacheProperty	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.
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.
fileSystemLocations?	IResolvable | IResolvable | ProjectFileSystemLocationProperty[]	An array of ProjectFileSystemLocation objects for a CodeBuild build project.
logsConfig?	IResolvable | LogsConfigProperty	Information about logs for the build project.
name?	string	The name of the build project.
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 | IResolvable | ArtifactsProperty[]	A list of Artifacts objects.
secondarySourceVersions?	IResolvable | IResolvable | ProjectSourceVersionProperty[]	An array of ProjectSourceVersion objects.
secondarySources?	IResolvable | SourceProperty | IResolvable[]	An array of ProjectSource objects.
sourceVersion?	string	A version of the build input to be built for this project.
timeoutInMinutes?	number	How long, in minutes, from 5 to 480 (8 hours), for AWS CodeBuild to wait before timing out any related build that did not get marked as completed.
triggers?	ProjectTriggersProperty | IResolvable	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 | VpcConfigProperty	VpcConfig specifies settings that enable AWS CodeBuild to access resources in an Amazon VPC.
static CFN_RESOURCE_TYPE_NAME	string	The CloudFormation resource type name for this resource class.

---

artifacts

Type: IResolvable | ArtifactsProperty

Artifacts is a property of the AWS::CodeBuild::Project resource that specifies output settings for artifacts generated by an AWS CodeBuild build.

---

attrArn

Type: string

The ARN of the AWS CodeBuild project, such as arn:aws:codebuild:us-west-2:123456789012:project/myProjectName .

---

cfnOptions

Type: ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

---

cfnProperties

Type: { [string]: any }

---

cfnResourceType

Type: string

AWS resource type.

---

creationStack

Type: string[]

---

environment

Type: IResolvable | EnvironmentProperty

The build environment settings for the project, such as the environment type or the environment variables to use for the build environment.

---

logicalId

Type: string

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

---

node

Type: ConstructNode

The construct tree node associated with this construct.

---

ref

Type: string

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

---

serviceRole

Type: string

The ARN of the IAM role that enables AWS CodeBuild to interact with dependent AWS services on behalf of the AWS account.

---

source

Type: SourceProperty | IResolvable

The source code settings for the project, such as the source code's repository type and location.

---

stack

Type: Stack

The stack in which this element is defined.

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

---

tags

Type: TagManager

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.

---

badgeEnabled?

Type: boolean | IResolvable (optional)

Indicates whether AWS CodeBuild generates a publicly accessible URL for your project's build badge.

For more information, see Build Badges Sample 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?

Type: IResolvable | ProjectBuildBatchConfigProperty (optional)

A ProjectBuildBatchConfig object that defines the batch build options for the project.

---

cache?

Type: IResolvable | ProjectCacheProperty (optional)

Settings that AWS CodeBuild uses to store and reuse build dependencies.

---

concurrentBuildLimit?

Type: number (optional)

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?

Type: string (optional)

A description that makes the build project easy to identify.

---

encryptionKey?

Type: string (optional)

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

---

fileSystemLocations?

Type: IResolvable | IResolvable | ProjectFileSystemLocationProperty[] (optional)

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?

Type: IResolvable | LogsConfigProperty (optional)

Information about logs for the build project.

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

---

name?

Type: string (optional)

The name of the build project.

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

---

queuedTimeoutInMinutes?

Type: number (optional)

The number of minutes a build is allowed to be queued before it times out.

---

resourceAccessRole?

Type: string (optional)

The ARN of the IAM role that enables CodeBuild to access the CloudWatch Logs and Amazon S3 artifacts for the project's builds.

---

secondaryArtifacts?

Type: IResolvable | IResolvable | ArtifactsProperty[] (optional)

A list of Artifacts objects.

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

---

secondarySourceVersions?

Type: IResolvable | IResolvable | ProjectSourceVersionProperty[] (optional)

An array of ProjectSourceVersion objects.

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

---

secondarySources?

Type: IResolvable | SourceProperty | IResolvable[] (optional)

An array of ProjectSource objects.

---

sourceVersion?

Type: string (optional)

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 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 in the AWS CodeBuild User Guide .

---

timeoutInMinutes?

Type: number (optional)

How long, in minutes, from 5 to 480 (8 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?

Type: ProjectTriggersProperty | IResolvable (optional)

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?

Type: string (optional)

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?

Type: IResolvable | VpcConfigProperty (optional)

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 in the AWS CodeBuild User Guide .

---

static CFN_RESOURCE_TYPE_NAME

Type: string

The CloudFormation resource type name for this resource class.

Methods

Name	Description
addDeletionOverride(path)	Syntactic sugar for addOverride(path, undefined).
addDependsOn(target)	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addMetadata(key, value)	Add a value to the CloudFormation Resource Metadata.
addOverride(path, value)	Adds an override to the synthesized CloudFormation resource.
addPropertyDeletionOverride(propertyPath)	Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride(propertyPath, value)	Adds an override to a resource property.
applyRemovalPolicy(policy?, options?)	Sets the deletion policy of the resource based on the removal policy specified.
getAtt(attributeName)	Returns a token for an runtime attribute of this resource.
getMetadata(key)	Retrieve a value value from the CloudFormation Resource Metadata.
inspect(inspector)	Examines the CloudFormation resource and discloses attributes.
overrideLogicalId(newLogicalId)	Overrides the auto-generated logical ID with a specific ID.
toString()	Returns a string representation of this construct.
protected renderProperties(props)

---

addDeletionOverride(path)

public addDeletionOverride(path: string): void

Parameters

• path string — The path of the value to delete.

Syntactic sugar for addOverride(path, undefined).

---

addDependsOn(target)

public addDependsOn(target: CfnResource): void

Parameters

• target CfnResource

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.

---

addMetadata(key, value)

public addMetadata(key: string, value: any): void

Parameters

• key string
• value any

Add a value to the CloudFormation Resource Metadata.

See also: [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

---

addOverride(path, value)

public addOverride(path: string, value: any): void

Parameters

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

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,

cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');

would add the overrides

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

---

addPropertyDeletionOverride(propertyPath)

public addPropertyDeletionOverride(propertyPath: string): void

Parameters

• propertyPath string — The path to the property.

Adds an override that deletes the value of a property from the resource definition.

---

addPropertyOverride(propertyPath, value)

public addPropertyOverride(propertyPath: string, value: any): void

Parameters

• propertyPath string — The path of the property.
• value any — The value.

Adds an override to a resource property.

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

---

applyRemovalPolicy(policy?, options?)

public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void

Parameters

• policy RemovalPolicy
• options RemovalPolicyOptions

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

---

getAtt(attributeName)

public getAtt(attributeName: string): Reference

Parameters

• attributeName string — The name of the attribute.

Returns

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

---

getMetadata(key)

public getMetadata(key: string): any

Parameters

• key string

Returns

• any

Retrieve a value value from the CloudFormation Resource Metadata.

See also: [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

---

inspect(inspector)

public inspect(inspector: TreeInspector): void

Parameters

• inspector TreeInspector — - tree inspector to collect and process attributes.

Examines the CloudFormation resource and discloses attributes.

---

overrideLogicalId(newLogicalId)

public overrideLogicalId(newLogicalId: string): void

Parameters

• newLogicalId string — The new logical ID to use for this stack element.

Overrides the auto-generated logical ID with a specific ID.

---

toString()

public toString(): string

Returns

• string

Returns a string representation of this construct.

---

protected renderProperties(props)

protected renderProperties(props: { [string]: any }): { [string]: any }

Parameters

• props { [string]: any }

Returns

• { [string]: any }