Package software.amazon.awscdk.services.lambda

Interface Permission

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
Permission.Jsii$Proxy
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:40.809Z") @Stability(Stable) public interface Permission extends software.amazon.jsii.JsiiSerializable
Represents a permission statement that can be added to a Lambda function's resource policy via the addPermission() method.

Example: 

 Function fn;
 ServicePrincipal principal = new ServicePrincipal("my-service");
 fn.grantInvoke(principal);
 // Equivalent to:
 fn.addPermission("my-service Invocation", Permission.builder()
         .principal(principal)
         .build());

  • Method Details

    • getPrincipal

      @Stability(Stable) @NotNull IPrincipal getPrincipal()
      The entity for which you are granting permission to invoke the Lambda function.

      This entity can be any valid AWS service principal, such as s3.amazonaws.com or sns.amazonaws.com, or, if you are granting cross-account permission, an AWS account ID. For example, you might want to allow a custom application in another AWS account to push events to Lambda by invoking your function.

      The principal can be either an AccountPrincipal or a ServicePrincipal.

    • getAction

      @Stability(Stable) @Nullable default String getAction()
      The Lambda actions that you want to allow in this statement.

      For example, you can specify lambda:CreateFunction to specify a certain action, or use a wildcard (lambda:*) to grant permission to all Lambda actions. For a list of actions, see Actions and Condition Context Keys for AWS Lambda in the IAM User Guide.

      Default: 'lambda:InvokeFunction'

    • getEventSourceToken

      @Stability(Stable) @Nullable default String getEventSourceToken()
      A unique token that must be supplied by the principal invoking the function.

      Default: The caller would not need to present a token.

    • getFunctionUrlAuthType

      @Stability(Stable) @Nullable default FunctionUrlAuthType getFunctionUrlAuthType()
      The authType for the function URL that you are granting permissions for.

      Default: - No functionUrlAuthType

    • getScope

      @Stability(Stable) @Nullable default Construct getScope()
      The scope to which the permission constructs be attached.

      The default is the Lambda function construct itself, but this would need to be different in cases such as cross-stack references where the Permissions would need to sit closer to the consumer of this permission (i.e., the caller).

      Default: - The instance of lambda.IFunction

    • getSourceAccount

      @Stability(Stable) @Nullable default String getSourceAccount()
      The AWS account ID (without hyphens) of the source owner.

      For example, if you specify an S3 bucket in the SourceArn property, this value is the bucket owner's account ID. You can use this property to ensure that all source principals are owned by a specific account.

    • getSourceArn

      @Stability(Stable) @Nullable default String getSourceArn()
      The ARN of a resource that is invoking your function.

      When granting Amazon Simple Storage Service (Amazon S3) permission to invoke your function, specify this property with the bucket ARN as its value. This ensures that events generated only from the specified bucket, not just any bucket from any AWS account that creates a mapping to your function, can invoke the function.

    • builder

      @Stability(Stable) static Permission.Builder builder()
      Returns:
      a Permission.Builder of Permission