AddPermissionRequest Class | AWS SDK for .NET V3

Container for the parameters to the AddPermission operation. Grants an Amazon Web Service, Amazon Web Services account, or Amazon Web Services organization 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.

To grant permission to another account, specify the account ID as the Principal. To grant permission to an organization defined in Organizations, specify the organization ID as the PrincipalOrgID. For Amazon Web Services, the principal is a domain-style identifier that the service defines, such as s3.amazonaws.com or sns.amazonaws.com. For Amazon Web 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.

This operation adds a statement to a resource-based permissions policy for the function. For more information about function policies, see Using resource-based policies for Lambda.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.Lambda.AmazonLambdaRequest
      Amazon.Lambda.Model.AddPermissionRequest

Namespace: Amazon.Lambda.Model
Assembly: AWSSDK.Lambda.dll
Version: 3.x.y.z

Syntax

public class AddPermissionRequest : AmazonLambdaRequest
         IAmazonWebServiceRequest

The AddPermissionRequest type exposes the following members

Constructors

	Name	Description
	AddPermissionRequest()

Properties

Name	Type	Description
Action	System.String	Gets and sets the property Action. The action that the principal can use on the function. For example, `lambda:InvokeFunction` or `lambda:GetFunction`.
EventSourceToken	System.String	Gets and sets the property EventSourceToken. For Alexa Smart Home functions, a token that the invoker must supply.
FunctionName	System.String	Gets and sets the property FunctionName. 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.
FunctionUrlAuthType	Amazon.Lambda.FunctionUrlAuthType	Gets and sets the property 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 Security and auth model for Lambda function URLs.
Principal	System.String	Gets and sets the property Principal. The Amazon Web Service or Amazon Web Services account that invokes the function. If you specify a service, use `SourceArn` or `SourceAccount` to limit who can invoke the function through that service.
PrincipalOrgID	System.String	Gets and sets the property PrincipalOrgID. The identifier for your organization in Organizations. Use this to grant permissions to all the Amazon Web Services accounts under this organization.
Qualifier	System.String	Gets and sets the property Qualifier. Specify a version or alias to add permissions to a published version of the function.
RevisionId	System.String	Gets and sets the property 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.
SourceAccount	System.String	Gets and sets the property SourceAccount. For Amazon Web 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.
SourceArn	System.String	Gets and sets the property SourceArn. For Amazon Web 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.
StatementId	System.String	Gets and sets the property StatementId. A statement identifier that differentiates the statement from others in the same policy.

Examples

The following example adds permission for Amazon S3 to invoke a Lambda function named my-function for notifications from a bucket named my-bucket-1xpuxmplzrlbh in account 123456789012.

To grant Amazon S3 permission to invoke a function


var response = client.AddPermission(new AddPermissionRequest 
{
    Action = "lambda:InvokeFunction",
    FunctionName = "my-function",
    Principal = "s3.amazonaws.com",
    SourceAccount = "123456789012",
    SourceArn = "arn:aws:s3:::my-bucket-1xpuxmplzrlbh/*",
    StatementId = "s3"
});

string statement = response.Statement;

The following example adds permission for account 223456789012 invoke a Lambda function named my-function.

To grant another account permission to invoke a function


var response = client.AddPermission(new AddPermissionRequest 
{
    Action = "lambda:InvokeFunction",
    FunctionName = "my-function",
    Principal = "223456789012",
    StatementId = "xaccount"
});

string statement = response.Statement;

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5