aws-cdk-lib.aws_lambda.S3Code

class S3Code

LanguageType name
.NETAmazon.CDK.AWS.Lambda.S3Code
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awslambda#S3Code
Javasoftware.amazon.awscdk.services.lambda.S3Code
Pythonaws_cdk.aws_lambda.S3Code
TypeScript (source)aws-cdk-lib » aws_lambda » S3Code

Extends Code

Lambda code from an S3 archive.

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';
import { aws_s3 as s3 } from 'aws-cdk-lib';

declare const bucket: s3.Bucket;
const s3Code = new lambda.S3Code(bucket, 'key', /* all optional props */ 'objectVersion');

Initializer

new S3Code(bucket: IBucket, key: string, objectVersion?: string)

Parameters

  • bucket IBucket
  • key string
  • objectVersion string

Properties

NameTypeDescription
isInlinebooleanDetermines whether this Code is inline code or not.

isInline

Type: boolean

Determines whether this Code is inline code or not.

Methods

NameDescription
bind(_scope)Called when the lambda or layer is initialized to allow this object to bind to the stack, add resources and have fun.
bindToResource(_resource, _options?)Called after the CFN function resource has been created to allow the code class to bind to it.

bind(_scope)

public bind(_scope: Construct): CodeConfig

Parameters

  • _scope Construct

Returns

  • CodeConfig

Called when the lambda or layer is initialized to allow this object to bind to the stack, add resources and have fun.


bindToResource(_resource, _options?)

public bindToResource(_resource: CfnResource, _options?: ResourceBindOptions): void

Parameters

  • _resource CfnResource
  • _options ResourceBindOptions

Called after the CFN function resource has been created to allow the code class to bind to it.

Specifically it's required to allow assets to add metadata for tooling like SAM CLI to be able to find their origins.