aws-cdk-lib.aws_lambda.CfnPermissionProps

CfnPermissionProps Struct

Properties for defining a CfnPermission.

CfnPermissionProps

used as props by

• CfnPermission

Source

Generated code

Type last changed

v2.227.0 · 21 Nov 2025

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 cfnPermissionProps: lambda.CfnPermissionProps = {
  action: 'action',
  functionName: 'functionName',
  principal: 'principal',

  // the properties below are optional
  eventSourceToken: 'eventSourceToken',
  functionUrlAuthType: 'functionUrlAuthType',
  invokedViaFunctionUrl: false,
  principalOrgId: 'principalOrgId',
  sourceAccount: 'sourceAccount',
  sourceArn: 'sourceArn',
};

Properties

actionstringactionstractionStringActionstringAction*stringrequired#

The action that the principal can use on the function.

For example, lambda:InvokeFunction or lambda:GetFunction .

eventSourceTokenstringevent_source_tokenstreventSourceTokenStringEventSourceTokenstringEventSourceToken*string#

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

functionNamestring | IFunctionRef | IVersionReffunction_nametyping.Union[str, IFunctionRef, IVersionRef]functionNameStringFunctionNamestringFunctionNameinterface{}required#

The name or ARN of the Lambda function, version, or alias.

notes

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.

functionUrlAuthTypestringfunction_url_auth_typestrfunctionUrlAuthTypeStringFunctionUrlAuthTypestringFunctionUrlAuthType*string#

The type of authentication that your function URL uses.

notes

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 .

invokedViaFunctionUrlboolean | IResolvableinvoked_via_function_urltyping.Union[bool, IResolvable]invokedViaFunctionUrlBooleanInvokedViaFunctionUrlboolInvokedViaFunctionUrlinterface{}#

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

principalstring | IRoleRef | IUserRefprincipaltyping.Union[str, IRoleRef, IUserRef]principalStringPrincipalstringPrincipalinterface{}required#

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.

principalOrgIdstringprincipal_org_idstrprincipalOrgIdStringPrincipalOrgIdstringPrincipalOrgId*string#

The identifier for your organization in AWS Organizations .

Use this to grant permissions to all the AWS accounts under this organization.

sourceAccountstringsource_accountstrsourceAccountStringSourceAccountstringSourceAccount*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.

sourceArnstring | IUserPoolRef | IRuleRef | IRoleRef | ITopicRuleRef | IDeliveryStreamRef | IFunctionRef | ILogGroupRef | IBucketRef | ITopicRef | IQueueRefsource_arntyping.Union[str, IUserPoolRef, IRuleRef, IRoleRef, ITopicRuleRef, IDeliveryStreamRef, IFunctionRef, ILogGroupRef, IBucketRef, ITopicRef, IQueueRef]sourceArnStringSourceArnstringSourceArninterface{}#

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.