interface CfnPermissionProps

Language	Type name
.NET	Amazon.CDK.AWS.Lambda.CfnPermissionProps
Go	github.com/aws/aws-cdk-go/awscdk/v2/awslambda#CfnPermissionProps
Java	software.amazon.awscdk.services.lambda.CfnPermissionProps
Python	aws_cdk.aws_lambda.CfnPermissionProps
TypeScript	aws-cdk-lib » aws_lambda » CfnPermissionProps

Properties for defining a CfnPermission.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-permission.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 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

Name	Type	Description
action	string	The action that the principal can use on the function.
functionName	string	The name or ARN of the Lambda function, version, or alias.
principal	string	The AWS service , AWS account , IAM user, or IAM role that invokes the function.
eventSourceToken?	string	For Alexa Smart Home functions, a token that the invoker must supply.
functionUrlAuthType?	string	The type of authentication that your function URL uses.
invokedViaFunctionUrl?	boolean | IResolvable	Restricts the lambda:InvokeFunction action to function URL calls.
principalOrgId?	string	The identifier for your organization in AWS Organizations .
sourceAccount?	string	For AWS service , the ID of the AWS account that owns the resource.
sourceArn?	string	For AWS services , the ARN of the AWS resource that invokes the function.

---

action

Type: string

The action that the principal can use on the function.

For example, lambda:InvokeFunction or lambda:GetFunction .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-permission.html#cfn-lambda-permission-action

---

functionName

Type: string

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-permission.html#cfn-lambda-permission-functionname

---

principal

Type: string

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-permission.html#cfn-lambda-permission-principal

---

eventSourceToken?

Type: string (optional)

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-permission.html#cfn-lambda-permission-eventsourcetoken

---

functionUrlAuthType?

Type: string (optional)

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 .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-permission.html#cfn-lambda-permission-functionurlauthtype

---

invokedViaFunctionUrl?

Type: boolean | IResolvable (optional)

Restricts the lambda:InvokeFunction action to function URL calls.

When set to true , this prevents the principal from invoking the function by any means other than the function URL. For more information, see Control access to Lambda function URLs .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-permission.html#cfn-lambda-permission-invokedviafunctionurl

---

principalOrgId?

Type: string (optional)

The identifier for your organization in AWS Organizations .

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-permission.html#cfn-lambda-permission-principalorgid

---

sourceAccount?

Type: string (optional)

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-permission.html#cfn-lambda-permission-sourceaccount

---

sourceArn?

Type: string (optional)

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-permission.html#cfn-lambda-permission-sourcearn