1.204.0

interface CfnPermissionProps

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

Properties for defining a CfnPermission.

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

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

Properties

NameTypeDescription
actionstringThe action that the principal can use on the function.
functionNamestringThe name of the Lambda function, version, or alias.
principalstringThe AWS service or AWS account that invokes the function.
eventSourceToken?stringFor Alexa Smart Home functions, a token that the invoker must supply.
functionUrlAuthType?stringThe type of authentication that your function URL uses.
principalOrgId?stringThe identifier for your organization in AWS Organizations .
sourceAccount?stringFor AWS service , the ID of the AWS account that owns the resource.
sourceArn?stringFor 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 .

functionName

Type: string

The name 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.

principal

Type: string

The AWS service or AWS account that invokes the function.

If you specify a service, use SourceArn or SourceAccount to limit who can invoke the function through that service.

eventSourceToken?

Type: string (optional)

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

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 Security and auth model for Lambda function URLs .

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.

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.

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.

← PreviousNext →