software.amazon.awscdk.services.lambda

Interface FunctionAttributes

All Known Implementing Classes:

FunctionAttributes.Jsii$Proxy

@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-11-18T02:14:10.734Z")
public interface FunctionAttributes

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());
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	FunctionAttributes.Builder A builder for FunctionAttributes
static class	FunctionAttributes.Jsii$Proxy An implementation for FunctionAttributes

Method Summary

Modifier and Type	Method and Description
static FunctionAttributes.Builder	builder()
default Architecture	getArchitecture() The architecture of this Lambda Function (this is an optional attribute and defaults to X86_64).
java.lang.String	getFunctionArn() The ARN of the Lambda function.
default IRole	getRole() The IAM execution role associated with this function.
default java.lang.Boolean	getSameEnvironment() Setting this property informs the CDK that the imported function is in the same environment as the stack.
default ISecurityGroup	getSecurityGroup() The security group of this Lambda, if in a VPC.
default java.lang.String	getSecurityGroupId() Deprecated. use `securityGroup` instead
default java.lang.Boolean	getSkipPermissions() Setting this property informs the CDK that the imported function ALREADY HAS the necessary permissions for what you are trying to do.

Method Detail

getFunctionArn

java.lang.String getFunctionArn()

The ARN of the Lambda function.

Format: arn::lambda:::function:

getArchitecture

default Architecture getArchitecture()

The architecture of this Lambda Function (this is an optional attribute and defaults to X86_64).

Default: - Architecture.X86_64

getRole

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

default java.lang.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

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.

getSecurityGroupId

@Deprecated
default java.lang.String getSecurityGroupId()

Deprecated. use `securityGroup` instead

(deprecated) Id of 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

default java.lang.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

static FunctionAttributes.Builder builder()

Returns:

a FunctionAttributes.Builder of FunctionAttributes