class CfnFunction (construct)
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.Lambda.CfnFunction |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awslambda#CfnFunction |
![]() | software.amazon.awscdk.services.lambda.CfnFunction |
![]() | aws_cdk.aws_lambda.CfnFunction |
![]() | aws-cdk-lib » aws_lambda » CfnFunction |
Implements
IConstruct
, IDependable
, IInspectable
, ITaggable
The AWS::Lambda::Function
resource creates a Lambda function.
To create a function, you need a deployment package and an execution role . The deployment package is a .zip file archive or container image that contains your function code. The execution role grants the function permission to use AWS services, such as Amazon CloudWatch Logs for log streaming and AWS X-Ray for request tracing.
You set the package type to Image
if the deployment package is a container image . For these functions, include the URI of the container image in the Amazon ECR registry in the ImageUri
property of the Code
property . You do not need to specify the handler and runtime properties.
You set the package type to Zip
if the deployment package is a .zip file archive . For these functions, specify the Amazon S3 location of your .zip file in the Code
property. Alternatively, for Node.js and Python functions, you can define your function inline in the ZipFile
property of the Code
property . In both cases, you must also specify the handler and runtime properties.
You can use code signing if your deployment package is a .zip file archive. To enable code signing for this function, specify the ARN of a code-signing configuration. When a user attempts to deploy a code package with UpdateFunctionCode
, Lambda checks that the code package has a valid signature from a trusted publisher. The code-signing configuration includes a set of signing profiles, which define the trusted publishers for this function.
When you update a AWS::Lambda::Function
resource, CloudFormation calls the UpdateFunctionConfiguration and UpdateFunctionCode Lambda APIs under the hood. Because these calls happen sequentially, and invocations can happen between these calls, your function may encounter errors in the time between the calls. For example, if you remove an environment variable, and the code that references that environment variable in the same CloudFormation update, you may see invocation errors related to a missing environment variable. To work around this, you can invoke your function against a version or alias by default, rather than the $LATEST
version.
Note that you configure provisioned concurrency on a AWS::Lambda::Version
or a AWS::Lambda::Alias
.
For a complete introduction to Lambda functions, see What is Lambda? in the Lambda developer guide.
See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_lambda as lambda } from 'aws-cdk-lib';
const cfnFunction = new lambda.CfnFunction(this, 'MyCfnFunction', {
code: {
imageUri: 'imageUri',
s3Bucket: 's3Bucket',
s3Key: 's3Key',
s3ObjectVersion: 's3ObjectVersion',
sourceKmsKeyArn: 'sourceKmsKeyArn',
zipFile: 'zipFile',
},
role: 'role',
// the properties below are optional
architectures: ['architectures'],
codeSigningConfigArn: 'codeSigningConfigArn',
deadLetterConfig: {
targetArn: 'targetArn',
},
description: 'description',
environment: {
variables: {
variablesKey: 'variables',
},
},
ephemeralStorage: {
size: 123,
},
fileSystemConfigs: [{
arn: 'arn',
localMountPath: 'localMountPath',
}],
functionName: 'functionName',
handler: 'handler',
imageConfig: {
command: ['command'],
entryPoint: ['entryPoint'],
workingDirectory: 'workingDirectory',
},
kmsKeyArn: 'kmsKeyArn',
layers: ['layers'],
loggingConfig: {
applicationLogLevel: 'applicationLogLevel',
logFormat: 'logFormat',
logGroup: 'logGroup',
systemLogLevel: 'systemLogLevel',
},
memorySize: 123,
packageType: 'packageType',
recursiveLoop: 'recursiveLoop',
reservedConcurrentExecutions: 123,
runtime: 'runtime',
runtimeManagementConfig: {
updateRuntimeOn: 'updateRuntimeOn',
// the properties below are optional
runtimeVersionArn: 'runtimeVersionArn',
},
snapStart: {
applyOn: 'applyOn',
},
tags: [{
key: 'key',
value: 'value',
}],
timeout: 123,
tracingConfig: {
mode: 'mode',
},
vpcConfig: {
ipv6AllowedForDualStack: false,
securityGroupIds: ['securityGroupIds'],
subnetIds: ['subnetIds'],
},
});
Initializer
new CfnFunction(scope: Construct, id: string, props: CfnFunctionProps)
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.Function Props
Construct Props
Name | Type | Description |
---|---|---|
code | IResolvable | Code | The code for the function. You can define your function code in multiple ways:. |
role | string | The Amazon Resource Name (ARN) of the function's execution role. |
architectures? | string[] | The instruction set architecture that the function supports. |
code | string | To enable code signing for this function, specify the ARN of a code-signing configuration. |
dead | IResolvable | Dead | A dead-letter queue configuration that specifies the queue or topic where Lambda sends asynchronous events when they fail processing. |
description? | string | A description of the function. |
environment? | IResolvable | Environment | Environment variables that are accessible from function code during execution. |
ephemeral | IResolvable | Ephemeral | The size of the function's /tmp directory in MB. |
file | IResolvable | IResolvable | File [] | Connection settings for an Amazon EFS file system. |
function | string | The name of the Lambda function, up to 64 characters in length. |
handler? | string | The name of the method within your code that Lambda calls to run your function. |
image | IResolvable | Image | Configuration values that override the container image Dockerfile settings. |
kms | string | The ARN of the AWS Key Management Service ( AWS KMS ) customer managed key that's used to encrypt the following resources:. |
layers? | string[] | A list of function layers to add to the function's execution environment. Specify each layer by its ARN, including the version. |
logging | IResolvable | Logging | The function's Amazon CloudWatch Logs configuration settings. |
memory | number | The amount of memory available to the function at runtime. Increasing the function memory also increases its CPU allocation. The default value is 128 MB. The value can be any multiple of 1 MB. Note that new AWS accounts have reduced concurrency and memory quotas. AWS raises these quotas automatically based on your usage. You can also request a quota increase. |
package | string | The type of deployment package. |
recursive | string | The status of your function's recursive loop detection configuration. |
reserved | number | The number of simultaneous executions to reserve for the function. |
runtime? | string | The identifier of the function's runtime . Runtime is required if the deployment package is a .zip file archive. Specifying a runtime results in an error if you're deploying a function using a container image. |
runtime | IResolvable | Runtime | Sets the runtime management configuration for a function's version. |
snap | IResolvable | Snap | The function's AWS Lambda SnapStart setting. |
tags? | Cfn [] | A list of tags to apply to the function. |
timeout? | number | The amount of time (in seconds) that Lambda allows a function to run before stopping it. |
tracing | IResolvable | Tracing | Set Mode to Active to sample and trace a subset of incoming requests with X-Ray . |
vpc | IResolvable | Vpc | For network connectivity to AWS resources in a VPC, specify a list of security groups and subnets in the VPC. |
code
Type:
IResolvable
|
Code
The code for the function. You can define your function code in multiple ways:.
- For .zip deployment packages, you can specify the Amazon S3 location of the .zip file in the
S3Bucket
,S3Key
, andS3ObjectVersion
properties. - For .zip deployment packages, you can alternatively define the function code inline in the
ZipFile
property. This method works only for Node.js and Python functions. - For container images, specify the URI of your container image in the Amazon ECR registry in the
ImageUri
property.
role
Type:
string
The Amazon Resource Name (ARN) of the function's execution role.
architectures?
Type:
string[]
(optional)
The instruction set architecture that the function supports.
Enter a string array with one of the valid values (arm64 or x86_64). The default value is x86_64
.
codeSigningConfigArn?
Type:
string
(optional)
To enable code signing for this function, specify the ARN of a code-signing configuration.
A code-signing configuration includes a set of signing profiles, which define the trusted publishers for this function.
deadLetterConfig?
Type:
IResolvable
|
Dead
(optional)
A dead-letter queue configuration that specifies the queue or topic where Lambda sends asynchronous events when they fail processing.
For more information, see Dead-letter queues .
description?
Type:
string
(optional)
A description of the function.
environment?
Type:
IResolvable
|
Environment
(optional)
Environment variables that are accessible from function code during execution.
ephemeralStorage?
Type:
IResolvable
|
Ephemeral
(optional)
The size of the function's /tmp
directory in MB.
The default value is 512, but it can be any whole number between 512 and 10,240 MB.
fileSystemConfigs?
Type:
IResolvable
|
IResolvable
|
File
[]
(optional)
Connection settings for an Amazon EFS file system.
To connect a function to a file system, a mount target must be available in every Availability Zone that your function connects to. If your template contains an AWS::EFS::MountTarget resource, you must also specify a DependsOn
attribute to ensure that the mount target is created or updated before the function.
For more information about using the DependsOn
attribute, see DependsOn Attribute .
functionName?
Type:
string
(optional)
The name of the Lambda function, up to 64 characters in length.
If you don't specify a name, AWS CloudFormation generates one.
If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
handler?
Type:
string
(optional)
The name of the method within your code that Lambda calls to run your function.
Handler is required if the deployment package is a .zip file archive. The format includes the file name. It can also include namespaces and other qualifiers, depending on the runtime. For more information, see Lambda programming model .
imageConfig?
Type:
IResolvable
|
Image
(optional)
Configuration values that override the container image Dockerfile settings.
For more information, see Container image settings .
kmsKeyArn?
Type:
string
(optional)
The ARN of the AWS Key Management Service ( AWS KMS ) customer managed key that's used to encrypt the following resources:.
- The function's environment variables .
- The function's Lambda SnapStart snapshots.
- When used with
SourceKMSKeyArn
, the unzipped version of the .zip deployment package that's used for function invocations. For more information, see Specifying a customer managed key for Lambda . - The optimized version of the container image that's used for function invocations. Note that this is not the same key that's used to protect your container image in the Amazon Elastic Container Registry (Amazon ECR). For more information, see Function lifecycle .
If you don't provide a customer managed key, Lambda uses an AWS owned key or an AWS managed key .
layers?
Type:
string[]
(optional)
A list of function layers to add to the function's execution environment. Specify each layer by its ARN, including the version.
loggingConfig?
Type:
IResolvable
|
Logging
(optional)
The function's Amazon CloudWatch Logs configuration settings.
memorySize?
Type:
number
(optional)
The amount of memory available to the function at runtime. Increasing the function memory also increases its CPU allocation. The default value is 128 MB. The value can be any multiple of 1 MB. Note that new AWS accounts have reduced concurrency and memory quotas. AWS raises these quotas automatically based on your usage. You can also request a quota increase.
packageType?
Type:
string
(optional)
The type of deployment package.
Set to Image
for container image and set Zip
for .zip file archive.
recursiveLoop?
Type:
string
(optional)
The status of your function's recursive loop detection configuration.
When this value is set to Allow
and Lambda detects your function being invoked as part of a recursive loop, it doesn't take any action.
When this value is set to Terminate
and Lambda detects your function being invoked as part of a recursive loop, it stops your function being invoked and notifies you.
reservedConcurrentExecutions?
Type:
number
(optional)
The number of simultaneous executions to reserve for the function.
runtime?
Type:
string
(optional)
The identifier of the function's runtime . Runtime is required if the deployment package is a .zip file archive. Specifying a runtime results in an error if you're deploying a function using a container image.
The following list includes deprecated runtimes. Lambda blocks creating new functions and updating existing functions shortly after each runtime is deprecated. For more information, see Runtime use after deprecation .
For a list of all currently supported runtimes, see Supported runtimes .
runtimeManagementConfig?
Type:
IResolvable
|
Runtime
(optional)
Sets the runtime management configuration for a function's version.
For more information, see Runtime updates .
snapStart?
Type:
IResolvable
|
Snap
(optional)
The function's AWS Lambda SnapStart setting.
tags?
Type:
Cfn
[]
(optional)
A list of tags to apply to the function.
You must have the
lambda:TagResource
,lambda:UntagResource
, andlambda:ListTags
permissions for your IAM principal to manage the AWS CloudFormation stack. If you don't have these permissions, there might be unexpected behavior with stack-level tags propagating to the resource during resource creation and update.
timeout?
Type:
number
(optional)
The amount of time (in seconds) that Lambda allows a function to run before stopping it.
The default is 3 seconds. The maximum allowed value is 900 seconds. For more information, see Lambda execution environment .
tracingConfig?
Type:
IResolvable
|
Tracing
(optional)
Set Mode
to Active
to sample and trace a subset of incoming requests with X-Ray .
vpcConfig?
Type:
IResolvable
|
Vpc
(optional)
For network connectivity to AWS resources in a VPC, specify a list of security groups and subnets in the VPC.
When you connect a function to a VPC, it can access resources and the internet only through that VPC. For more information, see Configuring a Lambda function to access resources in a VPC .
Properties
Name | Type | Description |
---|---|---|
attr | string | The Amazon Resource Name (ARN) of the function. |
attr | IResolvable | The function's SnapStart setting. |
attr | string | When set to PublishedVersions , Lambda creates a snapshot of the execution environment when you publish a function version. |
attr | string | When you provide a qualified Amazon Resource Name (ARN), this response element indicates whether SnapStart is activated for the specified function version. |
cfn | ICfn | Options for this resource, such as condition, update policy etc. |
cfn | { [string]: any } | |
cfn | string | AWS resource type. |
code | IResolvable | Code | The code for the function. |
creation | string[] | |
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. |
role | string | The Amazon Resource Name (ARN) of the function's execution role. |
stack | Stack | The stack in which this element is defined. |
tags | Tag | Tag Manager which manages the tags for this resource. |
architectures? | string[] | The instruction set architecture that the function supports. |
code | string | To enable code signing for this function, specify the ARN of a code-signing configuration. |
dead | IResolvable | Dead | A dead-letter queue configuration that specifies the queue or topic where Lambda sends asynchronous events when they fail processing. |
description? | string | A description of the function. |
environment? | IResolvable | Environment | Environment variables that are accessible from function code during execution. |
ephemeral | IResolvable | Ephemeral | The size of the function's /tmp directory in MB. |
file | IResolvable | IResolvable | File [] | Connection settings for an Amazon EFS file system. |
function | string | The name of the Lambda function, up to 64 characters in length. |
handler? | string | The name of the method within your code that Lambda calls to run your function. |
image | IResolvable | Image | Configuration values that override the container image Dockerfile settings. |
kms | string | The ARN of the AWS Key Management Service ( AWS KMS ) customer managed key that's used to encrypt the following resources:. |
layers? | string[] | A list of function layers to add to the function's execution environment. Specify each layer by its ARN, including the version. |
logging | IResolvable | Logging | The function's Amazon CloudWatch Logs configuration settings. |
memory | number | The amount of memory available to the function at runtime. Increasing the function memory also increases its CPU allocation. The default value is 128 MB. The value can be any multiple of 1 MB. Note that new AWS accounts have reduced concurrency and memory quotas. AWS raises these quotas automatically based on your usage. You can also request a quota increase. |
package | string | The type of deployment package. |
recursive | string | The status of your function's recursive loop detection configuration. |
reserved | number | The number of simultaneous executions to reserve for the function. |
runtime? | string | The identifier of the function's runtime . Runtime is required if the deployment package is a .zip file archive. Specifying a runtime results in an error if you're deploying a function using a container image. |
runtime | IResolvable | Runtime | Sets the runtime management configuration for a function's version. |
snap | IResolvable | Snap | The function's AWS Lambda SnapStart setting. |
tags | Cfn [] | A list of tags to apply to the function. |
timeout? | number | The amount of time (in seconds) that Lambda allows a function to run before stopping it. |
tracing | IResolvable | Tracing | Set Mode to Active to sample and trace a subset of incoming requests with X-Ray . |
vpc | IResolvable | Vpc | For network connectivity to AWS resources in a VPC, specify a list of security groups and subnets in the VPC. |
static CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. |
attrArn
Type:
string
The Amazon Resource Name (ARN) of the function.
attrSnapStartResponse
Type:
IResolvable
The function's SnapStart setting.
attrSnapStartResponseApplyOn
Type:
string
When set to PublishedVersions
, Lambda creates a snapshot of the execution environment when you publish a function version.
attrSnapStartResponseOptimizationStatus
Type:
string
When you provide a qualified Amazon Resource Name (ARN), this response element indicates whether SnapStart is activated for the specified function version.
cfnOptions
Type:
ICfn
Options for this resource, such as condition, update policy etc.
cfnProperties
Type:
{ [string]: any }
cfnResourceType
Type:
string
AWS resource type.
code
Type:
IResolvable
|
Code
The code for the function.
You can define your function code in multiple ways:.
creationStack
Type:
string[]
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 })
.
role
Type:
string
The Amazon Resource Name (ARN) of the function's execution role.
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.
architectures?
Type:
string[]
(optional)
The instruction set architecture that the function supports.
codeSigningConfigArn?
Type:
string
(optional)
To enable code signing for this function, specify the ARN of a code-signing configuration.
deadLetterConfig?
Type:
IResolvable
|
Dead
(optional)
A dead-letter queue configuration that specifies the queue or topic where Lambda sends asynchronous events when they fail processing.
description?
Type:
string
(optional)
A description of the function.
environment?
Type:
IResolvable
|
Environment
(optional)
Environment variables that are accessible from function code during execution.
ephemeralStorage?
Type:
IResolvable
|
Ephemeral
(optional)
The size of the function's /tmp
directory in MB.
fileSystemConfigs?
Type:
IResolvable
|
IResolvable
|
File
[]
(optional)
Connection settings for an Amazon EFS file system.
functionName?
Type:
string
(optional)
The name of the Lambda function, up to 64 characters in length.
handler?
Type:
string
(optional)
The name of the method within your code that Lambda calls to run your function.
imageConfig?
Type:
IResolvable
|
Image
(optional)
Configuration values that override the container image Dockerfile settings.
kmsKeyArn?
Type:
string
(optional)
The ARN of the AWS Key Management Service ( AWS KMS ) customer managed key that's used to encrypt the following resources:.
layers?
Type:
string[]
(optional)
A list of function layers to add to the function's execution environment. Specify each layer by its ARN, including the version.
loggingConfig?
Type:
IResolvable
|
Logging
(optional)
The function's Amazon CloudWatch Logs configuration settings.
memorySize?
Type:
number
(optional)
The amount of memory available to the function at runtime. Increasing the function memory also increases its CPU allocation. The default value is 128 MB. The value can be any multiple of 1 MB. Note that new AWS accounts have reduced concurrency and memory quotas. AWS raises these quotas automatically based on your usage. You can also request a quota increase.
packageType?
Type:
string
(optional)
The type of deployment package.
recursiveLoop?
Type:
string
(optional)
The status of your function's recursive loop detection configuration.
reservedConcurrentExecutions?
Type:
number
(optional)
The number of simultaneous executions to reserve for the function.
runtime?
Type:
string
(optional)
The identifier of the function's runtime . Runtime is required if the deployment package is a .zip file archive. Specifying a runtime results in an error if you're deploying a function using a container image.
runtimeManagementConfig?
Type:
IResolvable
|
Runtime
(optional)
Sets the runtime management configuration for a function's version.
snapStart?
Type:
IResolvable
|
Snap
(optional)
The function's AWS Lambda SnapStart setting.
tagsRaw?
Type:
Cfn
[]
(optional)
A list of tags to apply to the function.
timeout?
Type:
number
(optional)
The amount of time (in seconds) that Lambda allows a function to run before stopping it.
tracingConfig?
Type:
IResolvable
|
Tracing
(optional)
Set Mode
to Active
to sample and trace a subset of incoming requests with X-Ray .
vpcConfig?
Type:
IResolvable
|
Vpc
(optional)
For network connectivity to AWS resources in a VPC, specify a list of security groups and subnets in the 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 }