aws-native.lambda.getPermission

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi

pulumi/pulumi-aws-native

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. This resource adds a statement to a resource-based permission policy for the function. For more information about function policies, see Lambda Function Policies.

Using getPermission

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getPermission(args: GetPermissionArgs, opts?: InvokeOptions): Promise<GetPermissionResult>
function getPermissionOutput(args: GetPermissionOutputArgs, opts?: InvokeOptions): Output<GetPermissionResult>

def get_permission(function_name: Optional[str] = None,
                   id: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetPermissionResult
def get_permission_output(function_name: Optional[pulumi.Input[str]] = None,
                   id: Optional[pulumi.Input[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetPermissionResult]

func LookupPermission(ctx *Context, args *LookupPermissionArgs, opts ...InvokeOption) (*LookupPermissionResult, error)
func LookupPermissionOutput(ctx *Context, args *LookupPermissionOutputArgs, opts ...InvokeOption) LookupPermissionResultOutput

> Note: This function is named LookupPermission in the Go SDK.

public static class GetPermission 
{
    public static Task<GetPermissionResult> InvokeAsync(GetPermissionArgs args, InvokeOptions? opts = null)
    public static Output<GetPermissionResult> Invoke(GetPermissionInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetPermissionResult> getPermission(GetPermissionArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: aws-native:lambda:getPermission
  arguments:
    # arguments dictionary

The following arguments are supported:

FunctionName string

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.