permissions

Creates, updates, deletes or gets a permission resource or lists permissions in a region

Overview

Name	`permissions`
Type	Resource
Description	The ``AWS::Lambda::Permission`` resource grants an AWS service or another account 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. To grant permission to another account, specify the account ID as the ``Principal``. To grant permission to an organization defined in AOlong, specify the organization ID as the ``PrincipalOrgID``. For AWS services, the principal is a domain-style identifier defined by the service, like ``s3.amazonaws.com`` or ``sns.amazonaws.com``. For AWS 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. If your function has a function URL, you can specify the ``FunctionUrlAuthType`` parameter. This adds a condition to your permission that only applies when your function URL's ``AuthType`` matches the specified ``FunctionUrlAuthType``. For more information about the ``AuthType`` parameter, see [Security and auth model for function URLs](https://docs.aws.amazon.com/lambda/latest/dg/urls-auth.html). This resource adds a statement to a resource-based permission policy for the function. For more information about function policies, see [Lambda Function Policies](https://docs.aws.amazon.com/lambda/latest/dg/access-control-resource-based.html).
Id	`awscc.lambda.permissions`

Fields

Name	Datatype	Description
`function_name`	`string`	The name or ARN of the Lambda function, version, or alias.<br />Name formats<br />+ Function name – ``my-function`` (name-only), ``my-function:v1`` (with alias).<br />+ Function ARN – ``arn:aws:lambda:us-west-2:123456789012:function:my-function``.<br />+ Partial ARN – ``123456789012:function:my-function``.<br /><br />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.
`action`	`string`	The action that the principal can use on the function. For example, ``lambda:InvokeFunction`` or ``lambda:GetFunction``.
`event_source_token`	`string`	For Alexa Smart Home functions, a token that the invoker must supply.
`function_url_auth_type`	`string`	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](https://docs.aws.amazon.com/lambda/latest/dg/urls-auth.html).
`source_arn`	`string`	For AWS-services, the ARN of the AWS resource that invokes the function. For example, an Amazon S3 bucket or Amazon SNS topic.<br />Note that Lambda configures the comparison using the ``StringLike`` operator.
`source_account`	`string`	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.
`principal_org_id`	`string`	The identifier for your organization in AOlong. Use this to grant permissions to all the AWS-accounts under this organization.
`id`	`string`
`principal`	`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.
`region`	`string`	AWS region.

For more information, see AWS::Lambda::Permission.

Methods

Name	Accessible by	Required Params
`create_resource`	`INSERT`	`FunctionName, Action, Principal, region`
`delete_resource`	`DELETE`	`data__Identifier, region`
`list_resources`	`SELECT`	`region`
`get_resource`	`SELECT`	`data__Identifier, region`

`SELECT` examples

Gets all properties from an individual permission.

SELECT
region,
function_name,
action,
event_source_token,
function_url_auth_type,
source_arn,
source_account,
principal_org_id,
id,
principal
FROM awscc.lambda.permissions
WHERE region = 'us-east-1' AND data__Identifier = '<FunctionName>|<Id>';

`INSERT` example

Use the following StackQL query and manifest file to create a new permission resource, using stack-deploy.

Required Properties
All Properties
Manifest

/*+ create */
INSERT INTO awscc.lambda.permissions (
 FunctionName,
 Action,
 Principal,
 region
)
SELECT 
'{{ FunctionName }}',
 '{{ Action }}',
 '{{ Principal }}',
'{{ region }}';

/*+ create */
INSERT INTO awscc.lambda.permissions (
 FunctionName,
 Action,
 EventSourceToken,
 FunctionUrlAuthType,
 SourceArn,
 SourceAccount,
 PrincipalOrgID,
 Principal,
 region
)
SELECT 
 '{{ FunctionName }}',
 '{{ Action }}',
 '{{ EventSourceToken }}',
 '{{ FunctionUrlAuthType }}',
 '{{ SourceArn }}',
 '{{ SourceAccount }}',
 '{{ PrincipalOrgID }}',
 '{{ Principal }}',
 '{{ region }}';

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: permission
    props:
      - name: FunctionName
        value: '{{ FunctionName }}'
      - name: Action
        value: '{{ Action }}'
      - name: EventSourceToken
        value: '{{ EventSourceToken }}'
      - name: FunctionUrlAuthType
        value: '{{ FunctionUrlAuthType }}'
      - name: SourceArn
        value: '{{ SourceArn }}'
      - name: SourceAccount
        value: '{{ SourceAccount }}'
      - name: PrincipalOrgID
        value: '{{ PrincipalOrgID }}'
      - name: Principal
        value: '{{ Principal }}'

`DELETE` example

/*+ delete */
DELETE FROM awscc.lambda.permissions
WHERE data__Identifier = '<FunctionName|Id>'
AND region = 'us-east-1';

Permissions

To operate on the permissions resource, the following permissions are required:

Read

lambda:GetPolicy

Create

lambda:AddPermission

List

lambda:GetPolicy

Delete

lambda:RemovePermission

Overview​

Fields​

Methods​

SELECT examples​

INSERT example​

DELETE example​

Permissions​

Read​

Create​

List​

Delete​