@pulumi/aws-native
Version:
The Pulumi AWS Cloud Control Provider enables you to build, deploy, and manage [any AWS resource that's supported by the AWS Cloud Control API](https://github.com/pulumi/pulumi-aws-native/blob/master/provider/cmd/pulumi-gen-aws-native/supported-types.txt)
117 lines (116 loc) • 8.14 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as enums from "../types/enums";
/**
* 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).
*/
export declare class Permission extends pulumi.CustomResource {
/**
* Get an existing Permission resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): Permission;
/**
* Returns true if the given object is an instance of Permission. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is Permission;
/**
* The action that the principal can use on the function. For example, ``lambda:InvokeFunction`` or ``lambda:GetFunction``.
*/
readonly action: pulumi.Output<string>;
readonly awsId: pulumi.Output<string>;
/**
* For Alexa Smart Home functions, a token that the invoker must supply.
*/
readonly eventSourceToken: pulumi.Output<string | undefined>;
/**
* 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.
*/
readonly functionName: pulumi.Output<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).
*/
readonly functionUrlAuthType: pulumi.Output<enums.lambda.PermissionFunctionUrlAuthType | undefined>;
/**
* 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.
*/
readonly principal: pulumi.Output<string>;
/**
* The identifier for your organization in AOlong. Use this to grant permissions to all the AWS-accounts under this organization.
*/
readonly principalOrgId: pulumi.Output<string | undefined>;
/**
* 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.
*/
readonly sourceAccount: pulumi.Output<string | undefined>;
/**
* For AWS-services, the ARN of the AWS 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.
*/
readonly sourceArn: pulumi.Output<string | undefined>;
/**
* Create a Permission resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: PermissionArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a Permission resource.
*/
export interface PermissionArgs {
/**
* The action that the principal can use on the function. For example, ``lambda:InvokeFunction`` or ``lambda:GetFunction``.
*/
action: pulumi.Input<string>;
/**
* For Alexa Smart Home functions, a token that the invoker must supply.
*/
eventSourceToken?: pulumi.Input<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``.
*
* 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.
*/
functionName: pulumi.Input<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).
*/
functionUrlAuthType?: pulumi.Input<enums.lambda.PermissionFunctionUrlAuthType>;
/**
* 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.
*/
principal: pulumi.Input<string>;
/**
* The identifier for your organization in AOlong. Use this to grant permissions to all the AWS-accounts under this organization.
*/
principalOrgId?: pulumi.Input<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.
*/
sourceAccount?: pulumi.Input<string>;
/**
* For AWS-services, the ARN of the AWS 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.
*/
sourceArn?: pulumi.Input<string>;
}