You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::Lambda::Types::AddPermissionRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing AddPermissionRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  function_name: "FunctionName", # required
  statement_id: "StatementId", # required
  action: "Action", # required
  principal: "Principal", # required
  source_arn: "Arn",
  source_account: "SourceOwner",
  event_source_token: "EventSourceToken",
  qualifier: "Qualifier",
  revision_id: "String",
}

Instance Attribute Summary collapse

Instance Attribute Details

#actionString

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

Returns:

  • (String)

    The action that the principal can use on the function.

#event_source_tokenString

For Alexa Smart Home functions, a token that must be supplied by the invoker.

Returns:

  • (String)

    For Alexa Smart Home functions, a token that must be supplied by the invoker.

#function_nameString

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

Name formats .title

  • 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.

Returns:

  • (String)

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

#principalString

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

Returns:

  • (String)

    The AWS service or account that invokes the function.

#qualifierString

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

Returns:

  • (String)

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

#revision_idString

Only update the policy 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.

Returns:

  • (String)

    Only update the policy if the revision ID matches the ID that\'s specified.

#source_accountString

For AWS services, the ID of the account that owns the resource. Use this instead of SourceArn to grant permission to resources that are owned by another account (for example, all of an account\'s Amazon S3 buckets). Or use it together with SourceArn to ensure that the resource is owned by the specified account. For example, an Amazon S3 bucket could be deleted by its owner and recreated by another account.

Returns:

  • (String)

    For AWS services, the ID of the account that owns the resource.

#source_arnString

For AWS services, the ARN of the AWS resource that invokes the function. For example, an Amazon S3 bucket or Amazon SNS topic.

Returns:

  • (String)

    For AWS services, the ARN of the AWS resource that invokes the function.

#statement_idString

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

Returns:

  • (String)

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