software.amazon.awscdk.services.lambda

Interface FunctionAttributes

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

FunctionAttributes.Jsii$Proxy

@Generated(value="jsii-pacmak/1.50.0 (build d1830a4)",
           date="2022-01-04T15:39:11.381Z")
 @Stability(value=Experimental)
public interface FunctionAttributes
extends software.amazon.jsii.JsiiSerializable

(experimental) Represents a Lambda function defined outside of this stack.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.ec2.*;
 import software.amazon.awscdk.services.iam.*;
 import software.amazon.awscdk.services.lambda.*;
 Architecture architecture;
 Role role;
 SecurityGroup securityGroup;
 FunctionAttributes functionAttributes = FunctionAttributes.builder()
         .functionArn("functionArn")
         // the properties below are optional
         .architecture(architecture)
         .role(role)
         .sameEnvironment(false)
         .securityGroup(securityGroup)
         .securityGroupId("securityGroupId")
         .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() (experimental) The architecture of this Lambda Function (this is an optional attribute and defaults to X86_64).
String	getFunctionArn() (experimental) The ARN of the Lambda function.
default IRole	getRole() (experimental) The IAM execution role associated with this function.
default Boolean	getSameEnvironment() (experimental) Setting this property informs the CDK that the imported function is in the same environment as the stack.
default ISecurityGroup	getSecurityGroup() (experimental) The security group of this Lambda, if in a VPC.
default String	getSecurityGroupId() Deprecated. use `securityGroup` instead

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getFunctionArn

@Stability(value=Experimental)
 @NotNull
String getFunctionArn()

(experimental) The ARN of the Lambda function.

Format: arn::lambda:::function:

getArchitecture

@Stability(value=Experimental)
 @Nullable
default Architecture getArchitecture()

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

Default: - Architecture.X86_64

getRole

@Stability(value=Experimental)
 @Nullable
default IRole getRole()

(experimental) The IAM execution role associated with this function.

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

getSameEnvironment

@Stability(value=Experimental)
 @Nullable
default Boolean getSameEnvironment()

(experimental) 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(value=Experimental)
 @Nullable
default ISecurityGroup getSecurityGroup()

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

@Stability(value=Deprecated)
 @Deprecated
 @Nullable
default 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.

builder

@Stability(value=Experimental)
static FunctionAttributes.Builder builder()

Returns:

a FunctionAttributes.Builder of FunctionAttributes