Interface FunctionAttributes

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
FunctionAttributes.Jsii$Proxy

@Generated(value="jsii-pacmak/1.94.0 (build b380f01)", date="2024-03-01T20:58:26.543Z") @Stability(Stable) public interface FunctionAttributes extends software.amazon.jsii.JsiiSerializable
Represents a Lambda function defined outside of this stack.

Example:

 IFunction fn = Function.fromFunctionAttributes(this, "Function", FunctionAttributes.builder()
         .functionArn("arn:aws:lambda:us-east-1:123456789012:function:MyFn")
         // The following are optional properties for specific use cases and should be used with caution:
         // Use Case: imported function is in the same account as the stack. This tells the CDK that it
         // can modify the function's permissions.
         .sameEnvironment(true)
         // Use Case: imported function is in a different account and user commits to ensuring that the
         // imported function has the correct permissions outside the CDK.
         .skipPermissions(true)
         .build());
 
  • Method Details

    • getFunctionArn

      @Stability(Stable) @NotNull String getFunctionArn()
      The ARN of the Lambda function.

      Format: arn::lambda::invalid input: '<'account-id>:function:invalid input: '<'function-name>

    • getArchitecture

      @Stability(Stable) @Nullable default Architecture getArchitecture()
      The architecture of this Lambda Function (this is an optional attribute and defaults to X86_64).

      Default: - Architecture.X86_64

    • getRole

      @Stability(Stable) @Nullable default IRole getRole()
      The IAM execution role associated with this function.

      If the role is not specified, any role-related operations will no-op.

    • getSameEnvironment

      @Stability(Stable) @Nullable default Boolean getSameEnvironment()
      Setting this property informs the CDK that the imported function is in the same environment as the stack.

      This affects certain behaviours such as, whether this function's permission can be modified. When not configured, the CDK attempts to auto-determine this. For environment agnostic stacks, i.e., stacks where the account is not specified with the env property, this is determined to be false.

      Set this to property ONLY IF the imported function is in the same account as the stack it's imported in.

      Default: - depends: true, if the Stack is configured with an explicit `env` (account and region) and the account is the same as this function. For environment-agnostic stacks this will default to `false`.

    • getSecurityGroup

      @Stability(Stable) @Nullable default ISecurityGroup getSecurityGroup()
      The security group of this Lambda, if in a VPC.

      This needs to be given in order to support allowing connections to this Lambda.

    • getSkipPermissions

      @Stability(Stable) @Nullable default Boolean getSkipPermissions()
      Setting this property informs the CDK that the imported function ALREADY HAS the necessary permissions for what you are trying to do.

      When not configured, the CDK attempts to auto-determine whether or not additional permissions are necessary on the function when grant APIs are used. If the CDK tried to add permissions on an imported lambda, it will fail.

      Set this property ONLY IF you are committing to manage the imported function's permissions outside of CDK. You are acknowledging that your CDK code alone will have insufficient permissions to access the imported function.

      Default: false

    • builder

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