class CfnProject (construct)
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.CodeBuild.CfnProject |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awscodebuild#CfnProject |
![]() | software.amazon.awscdk.services.codebuild.CfnProject |
![]() | aws_cdk.aws_codebuild.CfnProject |
![]() | aws-cdk-lib » aws_codebuild » CfnProject |
Implements
IConstruct
, IDependable
, IInspectable
, ITaggable
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.
See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html
Example
// 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',
environmentVariables: [{
name: 'name',
value: 'value',
// the properties below are optional
type: 'type',
}],
fleet: {
fleetArn: 'fleetArn',
},
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
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,
}]],
scopeConfiguration: {
name: 'name',
},
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
— Construct identifier for this resource (unique in its scope). - props
Cfn
— Resource properties.Project Props
Construct Props
Name | Type | Description |
---|---|---|
artifacts | IResolvable | Artifacts | Artifacts is a property of the AWS::CodeBuild::Project resource that specifies output settings for artifacts generated by an AWS CodeBuild build. |
environment | IResolvable | Environment | The build environment settings for the project, such as the environment type or the environment variables to use for the build environment. |
service | string | The ARN of the IAM role that enables AWS CodeBuild to interact with dependent AWS services on behalf of the AWS account. |
source | IResolvable | Source | The source code settings for the project, such as the source code's repository type and location. |
auto | number | |
badge | boolean | IResolvable | Indicates whether AWS CodeBuild generates a publicly accessible URL for your project's build badge. |
build | IResolvable | Project | A ProjectBuildBatchConfig object that defines the batch build options for the project. |
cache? | IResolvable | Project | Settings that AWS CodeBuild uses to store and reuse build dependencies. |
concurrent | 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. |
encryption | string | The AWS Key Management Service customer master key (CMK) to be used for encrypting the build output artifacts. |
file | IResolvable | IResolvable | Project [] | An array of ProjectFileSystemLocation objects for a CodeBuild build project. |
logs | IResolvable | Logs | Information about logs for the build project. |
name? | string | The name of the build project. |
queued | number | The number of minutes a build is allowed to be queued before it times out. |
resource | string | The ARN of the IAM role that enables CodeBuild to access the CloudWatch Logs and Amazon S3 artifacts for the project's builds. |
secondary | IResolvable | IResolvable | Artifacts [] | A list of Artifacts objects. |
secondary | IResolvable | IResolvable | Project [] | An array of ProjectSourceVersion objects. |
secondary | IResolvable | IResolvable | Source [] | An array of ProjectSource objects. |
source | string | A version of the build input to be built for this project. |
tags? | Cfn [] | An arbitrary set of tags (key-value pairs) for the AWS CodeBuild project. |
timeout | 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 | Project | 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:. |
vpc | IResolvable | Vpc | VpcConfig specifies settings that enable AWS CodeBuild to access resources in an Amazon VPC. |
artifacts
Type:
IResolvable
|
Artifacts
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
|
Environment
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:
IResolvable
|
Source
The source code settings for the project, such as the source code's repository type and location.
autoRetryLimit?
Type:
number
(optional)
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 theSource
property, do not specify theBadgeEnabled
property.
buildBatchConfig?
Type:
IResolvable
|
Project
(optional)
A ProjectBuildBatchConfig
object that defines the batch build options for the project.
cache?
Type:
IResolvable
|
Project
(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
|
Project
[]
(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
|
Logs
(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
|
Artifacts
[]
(optional)
A list of Artifacts
objects.
Each artifacts object specifies output settings that the project generates during a build.
secondarySourceVersions?
Type:
IResolvable
|
IResolvable
|
Project
[]
(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
|
IResolvable
|
Source
[]
(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 examplepr/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 in the AWS CodeBuild User Guide .
tags?
Type:
Cfn
[]
(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 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?
Type:
IResolvable
|
Project
(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
|
Vpc
(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 | Artifacts | Artifacts is a property of the AWS::CodeBuild::Project resource that specifies output settings for artifacts generated by an AWS CodeBuild build. |
attr | string | The ARN of the AWS CodeBuild project, such as arn:aws:codebuild:us-west-2:123456789012:project/myProjectName . |
attr | string | |
cfn | ICfn | Options for this resource, such as condition, update policy etc. |
cfn | { [string]: any } | |
cfn | string | AWS resource type. |
creation | string[] | |
environment | IResolvable | Environment | The build environment settings for the project, such as the environment type or the environment variables to use for the build environment. |
logical | string | The logical ID for this CloudFormation stack element. |
node | Node | The tree node. |
ref | string | Return a string that will be resolved to a CloudFormation { Ref } for this element. |
service | string | The ARN of the IAM role that enables AWS CodeBuild to interact with dependent AWS services on behalf of the AWS account. |
source | IResolvable | Source | 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 | Tag | Tag Manager which manages the tags for this resource. |
auto | number | |
badge | boolean | IResolvable | Indicates whether AWS CodeBuild generates a publicly accessible URL for your project's build badge. |
build | IResolvable | Project | A ProjectBuildBatchConfig object that defines the batch build options for the project. |
cache? | IResolvable | Project | Settings that AWS CodeBuild uses to store and reuse build dependencies. |
concurrent | 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. |
encryption | string | The AWS Key Management Service customer master key (CMK) to be used for encrypting the build output artifacts. |
file | IResolvable | IResolvable | Project [] | An array of ProjectFileSystemLocation objects for a CodeBuild build project. |
logs | IResolvable | Logs | Information about logs for the build project. |
name? | string | The name of the build project. |
queued | number | The number of minutes a build is allowed to be queued before it times out. |
resource | string | The ARN of the IAM role that enables CodeBuild to access the CloudWatch Logs and Amazon S3 artifacts for the project's builds. |
secondary | IResolvable | IResolvable | Artifacts [] | A list of Artifacts objects. |
secondary | IResolvable | IResolvable | Project [] | An array of ProjectSourceVersion objects. |
secondary | IResolvable | IResolvable | Source [] | An array of ProjectSource objects. |
source | string | A version of the build input to be built for this project. |
tags | Cfn [] | An arbitrary set of tags (key-value pairs) for the AWS CodeBuild project. |
timeout | 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 | Project | 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. |
vpc | IResolvable | Vpc | 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
|
Artifacts
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
.
attrId
Type:
string
cfnOptions
Type:
ICfn
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
|
Environment
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:
Node
The tree node.
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:
IResolvable
|
Source
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:
Tag
Tag Manager which manages the tags for this resource.
autoRetryLimit?
Type:
number
(optional)
badgeEnabled?
Type:
boolean |
IResolvable
(optional)
Indicates whether AWS CodeBuild generates a publicly accessible URL for your project's build badge.
buildBatchConfig?
Type:
IResolvable
|
Project
(optional)
A ProjectBuildBatchConfig
object that defines the batch build options for the project.
cache?
Type:
IResolvable
|
Project
(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.
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.
fileSystemLocations?
Type:
IResolvable
|
IResolvable
|
Project
[]
(optional)
An array of ProjectFileSystemLocation
objects for a CodeBuild build project.
logsConfig?
Type:
IResolvable
|
Logs
(optional)
Information about logs for the build project.
name?
Type:
string
(optional)
The name of the build project.
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
|
Artifacts
[]
(optional)
A list of Artifacts
objects.
secondarySourceVersions?
Type:
IResolvable
|
IResolvable
|
Project
[]
(optional)
An array of ProjectSourceVersion
objects.
secondarySources?
Type:
IResolvable
|
IResolvable
|
Source
[]
(optional)
An array of ProjectSource
objects.
sourceVersion?
Type:
string
(optional)
A version of the build input to be built for this project.
tagsRaw?
Type:
Cfn
[]
(optional)
An arbitrary set of tags (key-value pairs) for the AWS CodeBuild project.
timeoutInMinutes?
Type:
number
(optional)
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?
Type:
IResolvable
|
Project
(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:.
vpcConfig?
Type:
IResolvable
|
Vpc
(optional)
VpcConfig
specifies settings that enable AWS CodeBuild to access resources in an Amazon VPC.
static CFN_RESOURCE_TYPE_NAME
Type:
string
The CloudFormation resource type name for this resource class.
Methods
Name | Description |
---|---|
add | Syntactic sugar for addOverride(path, undefined) . |
add | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. |
add | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. |
add | Add a value to the CloudFormation Resource Metadata. |
add | Adds an override to the synthesized CloudFormation resource. |
add | Adds an override that deletes the value of a property from the resource definition. |
add | Adds an override to a resource property. |
apply | Sets the deletion policy of the resource based on the removal policy specified. |
get | Returns a token for an runtime attribute of this resource. |
get | Retrieve a value value from the CloudFormation Resource Metadata. |
inspect(inspector) | Examines the CloudFormation resource and discloses attributes. |
obtain | Retrieves an array of resources this resource depends on. |
obtain | Get a shallow copy of dependencies between this resource and other resources in the same stack. |
override | Overrides the auto-generated logical ID with a specific ID. |
remove | Indicates that this resource no longer depends on another resource. |
replace | Replaces one dependency with another. |
to | Returns a string representation of this construct. |
protected render |
addDeletionOverride(path)
public addDeletionOverride(path: string): void
Parameters
- path
string
— The path of the value to delete.
Syntactic sugar for addOverride(path, undefined)
.
addDependency(target)
public addDependency(target: CfnResource): void
Parameters
- target
Cfn
Resource
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.
addDependsOn(target)
public addDependsOn(target: CfnResource): void
⚠️ Deprecated: use addDependency
Parameters
- target
Cfn
Resource
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addMetadata(key, value)
public addMetadata(key: string, value: any): void
Parameters
- key
string
- value
any
Add a value to the CloudFormation Resource Metadata.
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
Removal
Policy - options
Removal
Policy Options
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:
getAtt(attributeName, typeHint?)
public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference
Parameters
- attributeName
string
— The name of the attribute. - typeHint
Resolution
Type Hint
Returns
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.
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
Tree
— tree inspector to collect and process attributes.Inspector
Examines the CloudFormation resource and discloses attributes.
obtainDependencies()
public obtainDependencies(): Stack | CfnResource[]
Returns
Stack
|
Cfn
Resource []
Retrieves an array of resources this resource depends on.
This assembles dependencies on resources across stacks (including nested stacks) automatically.
obtainResourceDependencies()
public obtainResourceDependencies(): CfnResource[]
Returns
Get a shallow copy of dependencies between this resource and other resources in the same stack.
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.
removeDependency(target)
public removeDependency(target: CfnResource): void
Parameters
- target
Cfn
Resource
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, newTarget)
public replaceDependency(target: CfnResource, newTarget: CfnResource): void
Parameters
- target
Cfn
— The dependency to replace.Resource - newTarget
Cfn
— The new dependency to add.Resource
Replaces one dependency with another.
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 }