1.204.0

class CfnFunction (construct)

This page is available in another version. Click here for the v2 documentation.

LanguageType name
.NETAmazon.CDK.AWS.Lambda.CfnFunction
Javasoftware.amazon.awscdk.services.lambda.CfnFunction
Pythonaws_cdk.aws_lambda.CfnFunction
TypeScript @aws-cdk/aws-lambda » CfnFunction

Implements IConstruct, IConstruct, IDependable, IInspectable

A CloudFormation AWS::Lambda::Function.

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 a container image, the code property must include the URI of a container image in the Amazon ECR registry. 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 a .zip file archive, the code property specifies the location of the .zip file. You must also specify the handler and runtime properties. For a Python example, see Deploy Python Lambda functions with .zip file archives .

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.

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.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as lambda from '@aws-cdk/aws-lambda';
const cfnFunction = new lambda.CfnFunction(this, 'MyCfnFunction', {
  code: {
    imageUri: 'imageUri',
    s3Bucket: 's3Bucket',
    s3Key: 's3Key',
    s3ObjectVersion: 's3ObjectVersion',
    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'],
  memorySize: 123,
  packageType: 'packageType',
  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: {
    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 — - scoped id of the resource.
  • props CfnFunctionProps — - resource properties.

Create a new AWS::Lambda::Function.

Construct Props

NameTypeDescription
codeIResolvable | CodePropertyThe code for the function.
rolestringThe Amazon Resource Name (ARN) of the function's execution role.
architectures?string[]The instruction set architecture that the function supports.
codeSigningConfigArn?stringTo enable code signing for this function, specify the ARN of a code-signing configuration.
deadLetterConfig?IResolvable | DeadLetterConfigPropertyA dead-letter queue configuration that specifies the queue or topic where Lambda sends asynchronous events when they fail processing.
description?stringA description of the function.
environment?IResolvable | EnvironmentPropertyEnvironment variables that are accessible from function code during execution.
ephemeralStorage?IResolvable | EphemeralStoragePropertyThe size of the function's /tmp directory in MB.
fileSystemConfigs?IResolvable | IResolvable | FileSystemConfigProperty[]Connection settings for an Amazon EFS file system.
functionName?stringThe name of the Lambda function, up to 64 characters in length.
handler?stringThe name of the method within your code that Lambda calls to run your function.
imageConfig?IResolvable | ImageConfigPropertyConfiguration values that override the container image Dockerfile settings.
kmsKeyArn?stringThe ARN of the AWS Key Management Service ( AWS KMS ) customer managed key that's used to encrypt your function's environment variables . When Lambda SnapStart is activated, Lambda also uses this key is to encrypt your function's snapshot. If you deploy your function using a container image, Lambda also uses this key to encrypt your function when it's deployed. Note that this is not the same key that's used to protect your container image in the Amazon Elastic Container Registry (Amazon ECR). If you don't provide a customer managed key, Lambda uses a default service key.
layers?string[]A list of function layers to add to the function's execution environment. Specify each layer by its ARN, including the version.
memorySize?numberThe 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.
packageType?stringThe type of deployment package.
reservedConcurrentExecutions?numberThe number of simultaneous executions to reserve for the function.
runtime?stringThe identifier of the function's runtime . Runtime is required if the deployment package is a .zip file archive.
runtimeManagementConfig?IResolvable | RuntimeManagementConfigPropertySets the runtime management configuration for a function's version.
snapStart?IResolvable | SnapStartPropertyThe function's AWS Lambda SnapStart setting.
tags?CfnTag[]A list of tags to apply to the function.
timeout?numberThe amount of time (in seconds) that Lambda allows a function to run before stopping it.
tracingConfig?IResolvable | TracingConfigPropertySet Mode to Active to sample and trace a subset of incoming requests with X-Ray .
vpcConfig?IResolvable | VpcConfigPropertyFor network connectivity to AWS resources in a VPC, specify a list of security groups and subnets in the VPC.

code

Type: IResolvable | CodeProperty

The code for the function.

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 | DeadLetterConfigProperty (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 | EnvironmentProperty (optional)

Environment variables that are accessible from function code during execution.

ephemeralStorage?

Type: IResolvable | EphemeralStorageProperty (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 | FileSystemConfigProperty[] (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 | ImageConfigProperty (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 your function's environment variables . When Lambda SnapStart is activated, Lambda also uses this key is to encrypt your function's snapshot. If you deploy your function using a container image, Lambda also uses this key to encrypt your function when it's deployed. Note that this is not the same key that's used to protect your container image in the Amazon Elastic Container Registry (Amazon ECR). If you don't provide a customer managed key, Lambda uses a default service 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.

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.

packageType?

Type: string (optional)

The type of deployment package.

Set to Image for container image and set Zip for .zip file archive.

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.

The following list includes deprecated runtimes. For more information, see Runtime deprecation policy .

runtimeManagementConfig?

Type: IResolvable | RuntimeManagementConfigProperty (optional)

Sets the runtime management configuration for a function's version.

For more information, see Runtime updates .

snapStart?

Type: IResolvable | SnapStartProperty (optional)

The function's AWS Lambda SnapStart setting.

tags?

Type: CfnTag[] (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.

The default is 3 seconds. The maximum allowed value is 900 seconds. For more information, see Lambda execution environment .

tracingConfig?

Type: IResolvable | TracingConfigProperty (optional)

Set Mode to Active to sample and trace a subset of incoming requests with X-Ray .

vpcConfig?

Type: IResolvable | VpcConfigProperty (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

NameTypeDescription
attrArnstringThe Amazon Resource Name (ARN) of the function.
attrSnapStartResponseApplyOnstring
attrSnapStartResponseOptimizationStatusstring
cfnOptionsICfnResourceOptionsOptions for this resource, such as condition, update policy etc.
cfnProperties{ [string]: any }
cfnResourceTypestringAWS resource type.
codeIResolvable | CodePropertyThe code for the function.
creationStackstring[]
logicalIdstringThe logical ID for this CloudFormation stack element.
nodeConstructNodeThe construct tree node associated with this construct.
refstringReturn a string that will be resolved to a CloudFormation { Ref } for this element.
rolestringThe Amazon Resource Name (ARN) of the function's execution role.
stackStackThe stack in which this element is defined.
tagsTagManagerA list of tags to apply to the function.
architectures?string[]The instruction set architecture that the function supports.
codeSigningConfigArn?stringTo enable code signing for this function, specify the ARN of a code-signing configuration.
deadLetterConfig?IResolvable | DeadLetterConfigPropertyA dead-letter queue configuration that specifies the queue or topic where Lambda sends asynchronous events when they fail processing.
description?stringA description of the function.
environment?IResolvable | EnvironmentPropertyEnvironment variables that are accessible from function code during execution.
ephemeralStorage?IResolvable | EphemeralStoragePropertyThe size of the function's /tmp directory in MB.
fileSystemConfigs?IResolvable | IResolvable | FileSystemConfigProperty[]Connection settings for an Amazon EFS file system.
functionName?stringThe name of the Lambda function, up to 64 characters in length.
handler?stringThe name of the method within your code that Lambda calls to run your function.
imageConfig?IResolvable | ImageConfigPropertyConfiguration values that override the container image Dockerfile settings.
kmsKeyArn?stringThe ARN of the AWS Key Management Service ( AWS KMS ) customer managed key that's used to encrypt your function's environment variables . When Lambda SnapStart is activated, Lambda also uses this key is to encrypt your function's snapshot. If you deploy your function using a container image, Lambda also uses this key to encrypt your function when it's deployed. Note that this is not the same key that's used to protect your container image in the Amazon Elastic Container Registry (Amazon ECR). If you don't provide a customer managed key, Lambda uses a default service key.
layers?string[]A list of function layers to add to the function's execution environment. Specify each layer by its ARN, including the version.
memorySize?numberThe 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.
packageType?stringThe type of deployment package.
reservedConcurrentExecutions?numberThe number of simultaneous executions to reserve for the function.
runtime?stringThe identifier of the function's runtime . Runtime is required if the deployment package is a .zip file archive.
runtimeManagementConfig?IResolvable | RuntimeManagementConfigPropertySets the runtime management configuration for a function's version.
snapStart?IResolvable | SnapStartPropertyThe function's AWS Lambda SnapStart setting.
timeout?numberThe amount of time (in seconds) that Lambda allows a function to run before stopping it.
tracingConfig?IResolvable | TracingConfigPropertySet Mode to Active to sample and trace a subset of incoming requests with X-Ray .
vpcConfig?IResolvable | VpcConfigPropertyFor network connectivity to AWS resources in a VPC, specify a list of security groups and subnets in the VPC.
static CFN_RESOURCE_TYPE_NAMEstringThe CloudFormation resource type name for this resource class.

attrArn

Type: string

The Amazon Resource Name (ARN) of the function.

attrSnapStartResponseApplyOn

Type: string

attrSnapStartResponseOptimizationStatus

Type: string

cfnOptions

Type: ICfnResourceOptions

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

cfnProperties

Type: { [string]: any }

cfnResourceType

Type: string

AWS resource type.

code

Type: IResolvable | CodeProperty

The code for the function.

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

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: TagManager

A list of tags to apply to the function.

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 | DeadLetterConfigProperty (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 | EnvironmentProperty (optional)

Environment variables that are accessible from function code during execution.

ephemeralStorage?

Type: IResolvable | EphemeralStorageProperty (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 | FileSystemConfigProperty[] (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 | ImageConfigProperty (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 your function's environment variables . When Lambda SnapStart is activated, Lambda also uses this key is to encrypt your function's snapshot. If you deploy your function using a container image, Lambda also uses this key to encrypt your function when it's deployed. Note that this is not the same key that's used to protect your container image in the Amazon Elastic Container Registry (Amazon ECR). If you don't provide a customer managed key, Lambda uses a default service 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.

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.

packageType?

Type: string (optional)

The type of deployment package.

Set to Image for container image and set Zip for .zip file archive.

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.

The following list includes deprecated runtimes. For more information, see Runtime deprecation policy .

runtimeManagementConfig?

Type: IResolvable | RuntimeManagementConfigProperty (optional)

Sets the runtime management configuration for a function's version.

For more information, see Runtime updates .

snapStart?

Type: IResolvable | SnapStartProperty (optional)

The function's AWS Lambda SnapStart setting.

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 | TracingConfigProperty (optional)

Set Mode to Active to sample and trace a subset of incoming requests with X-Ray .

vpcConfig?

Type: IResolvable | VpcConfigProperty (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 .

static CFN_RESOURCE_TYPE_NAME

Type: string

The CloudFormation resource type name for this resource class.

Methods

NameDescription
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

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

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

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 }
← PreviousNext →