Skip to contents

Grants a principal permission to use a function

Source: R/lambda_operations.R
lambda_add_permission.Rd

Grants a principal 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. Note: Lambda does not support adding policies to version $LATEST.

See https://www.paws-r-sdk.com/docs/lambda_add_permission/ for full documentation.

Usage

lambda_add_permission(
  FunctionName,
  StatementId,
  Action,
  Principal,
  SourceArn = NULL,
  SourceAccount = NULL,
  EventSourceToken = NULL,
  Qualifier = NULL,
  RevisionId = NULL,
  PrincipalOrgID = NULL,
  FunctionUrlAuthType = NULL,
  InvokedViaFunctionUrl = NULL
)

Arguments

FunctionName

[required] 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.

StatementId

[required] A statement identifier that differentiates the statement from others in the same policy.

Action

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

Principal

[required] The Amazon Web Services service, Amazon Web Services 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.

SourceArn

For Amazon Web Services services, the ARN of the Amazon Web Services 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.

SourceAccount

For Amazon Web Services service, the ID of the Amazon Web Services 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.

EventSourceToken

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

Qualifier

Specify a version or alias to add permissions to a published version of the function.

RevisionId

Update the policy only if the revision ID matches the ID that's specified. Use this option to avoid modifying a policy that has changed since you last read it.

PrincipalOrgID

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

FunctionUrlAuthType

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.

InvokedViaFunctionUrl

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