L1 ConstructAWS::Lambda::Permission

CfnPermission

The `AWS::Lambda::Permission` resource grants an AWS service or another account permission to use a function. You can apply the policy at the function level, or specify a qualifier to restrict access to a single version or alias. If you use a qualifier, the invoker must use the full Amazon Resource Name (ARN) of that version or alias to invoke the function. To grant permission to another account, specify the account ID as the `Principal` . To grant permission to an organization defined in AWS Organizations , specify the organization ID as the `PrincipalOrgID` . For AWS services, the principal is a domain-style identifier defined by the service, like `s3.amazonaws.com` or `sns.amazonaws.com` . For AWS services, you can also specify the ARN of the associated resource as the `SourceArn` . If you grant permission to a service principal without specifying the source, other accounts could potentially configure resources in their account to invoke your Lambda function. If your function has a function URL, you can specify the `FunctionUrlAuthType` parameter. This adds a condition to your permission that only applies when your function URL's `AuthType` matches the specified `FunctionUrlAuthType` . For more information about the `AuthType` parameter, see [Control access to Lambda function URLs](https://docs.aws.amazon.com/lambda/latest/dg/urls-auth.html) . This resource adds a statement to a resource-based permission policy for the function. For more information about function policies, see [Lambda Function Policies](https://docs.aws.amazon.com/lambda/latest/dg/access-control-resource-based.html) .

Import

import { CfnPermission } from 'aws-cdk-lib/aws-lambda';

Or use the module namespace:

import * as lambda from 'aws-cdk-lib/aws-lambda';
// lambda.CfnPermission

Properties

Configuration passed to the constructor as CfnPermissionProps.

actionRequired

string

The action that the principal can use on the function. For example, `lambda:InvokeFunction` or `lambda:GetFunction` .

functionNameRequired

string | IFunctionRef | IVersionRef

The name or ARN of the Lambda function, version, or alias. **Name formats** - *Function name* – `my-function` (name-only), `my-function:v1` (with alias). - *Function ARN* – `arn:aws:lambda:us-west-2:123456789012:function:my-function` . - *Partial ARN* – `123456789012:function:my-function` . You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

principalRequired

string | IRoleRef | IUserRef

The AWS service , AWS account , IAM user, or IAM role that invokes the function. If you specify a service, use `SourceArn` or `SourceAccount` to limit who can invoke the function through that service.

eventSourceTokenOptional

string

For Alexa Smart Home functions, a token that the invoker must supply.

functionUrlAuthTypeOptional

string

The type of authentication that your function URL uses. Set to `AWS_IAM` if you want to restrict access to authenticated users only. Set to `NONE` if you want to bypass IAM authentication to create a public endpoint. For more information, see [Control access to Lambda function URLs](https://docs.aws.amazon.com/lambda/latest/dg/urls-auth.html) .

invokedViaFunctionUrlOptional

boolean | IResolvable

Indicates whether the permission applies when the function is invoked through a function URL.

principalOrgIdOptional

string

The identifier for your organization in AWS Organizations . Use this to grant permissions to all the AWS accounts under this organization.

sourceAccountOptional

string

For AWS service , the ID of the AWS account that owns the resource. Use this together with `SourceArn` to ensure that the specified account owns the resource. It is possible for an Amazon S3 bucket to be deleted by its owner and recreated by another account.

sourceArnOptional

string | IUserPoolRef | IRuleRef | IRoleRef | ITopicRuleRef | IDeliveryStreamRef | IFunctionRef | ILogGroupRef | IBucketRef | ITopicRef | IQueueRef

For AWS services , the ARN of the AWS resource that invokes the function. For example, an Amazon S3 bucket or Amazon SNS topic. Note that Lambda configures the comparison using the `StringLike` operator.

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

AWS::Lambda::PermissionView in CloudFormation Explorer

Get the AWS Lambda Cheat Sheet

Everything you need to know about AWS Lambda on one page. HD quality, print-friendly.

Download Free Infographic

Quick Facts

LevelL1 (CloudFormation)

Moduleaws-lambda

CFN TypeAWS::Lambda::Permission

Properties9

Related Constructs

Explore This Service

External Links

CDK API Documentation