PermissionArgs

data class PermissionArgs(val action: Output<String>? = null, val eventSourceToken: Output<String>? = null, val functionName: Output<String>? = null, val functionUrlAuthType: Output<PermissionFunctionUrlAuthType>? = null, val principal: Output<String>? = null, val principalOrgId: Output<String>? = null, val sourceAccount: Output<String>? = null, val sourceArn: Output<String>? = null) : ConvertibleToJava<PermissionArgs>

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.

Constructors

Link copied to clipboard
constructor(action: Output<String>? = null, eventSourceToken: Output<String>? = null, functionName: Output<String>? = null, functionUrlAuthType: Output<PermissionFunctionUrlAuthType>? = null, principal: Output<String>? = null, principalOrgId: Output<String>? = null, sourceAccount: Output<String>? = null, sourceArn: Output<String>? = null)

Properties

Link copied to clipboard
val action: Output<String>? = null

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

Link copied to clipboard
val eventSourceToken: Output<String>? = null

For Alexa Smart Home functions, a token that the invoker must supply.

Link copied to clipboard
val functionName: Output<String>? = null

The name or ARN of the Lambda function, version, or alias. Name formats

Link copied to clipboard

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.

Link copied to clipboard
val principal: Output<String>? = null

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.

Link copied to clipboard
val principalOrgId: Output<String>? = null

The identifier for your organization in AOlong. Use this to grant permissions to all the AWS-accounts under this organization.

Link copied to clipboard
val sourceAccount: Output<String>? = null

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.

Link copied to clipboard
val sourceArn: Output<String>? = null

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.

Functions

Link copied to clipboard
open override fun toJava(): PermissionArgs