software.amazon.awscdk.services.lambda

Class FunctionAttributes.Builder

java.lang.Object

software.amazon.awscdk.services.lambda.FunctionAttributes.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<FunctionAttributes>

Enclosing interface:

FunctionAttributes

@Stability(value=Stable)
public static final class FunctionAttributes.Builder
extends Object
implements software.amazon.jsii.Builder<FunctionAttributes>

A builder for FunctionAttributes

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
FunctionAttributes.Builder	architecture(Architecture architecture) Sets the value of FunctionAttributes.getArchitecture()
FunctionAttributes	build() Builds the configured instance.
FunctionAttributes.Builder	functionArn(String functionArn) Sets the value of FunctionAttributes.getFunctionArn()
FunctionAttributes.Builder	role(IRole role) Sets the value of FunctionAttributes.getRole()
FunctionAttributes.Builder	sameEnvironment(Boolean sameEnvironment) Sets the value of FunctionAttributes.getSameEnvironment()
FunctionAttributes.Builder	securityGroup(ISecurityGroup securityGroup) Sets the value of FunctionAttributes.getSecurityGroup()
FunctionAttributes.Builder	securityGroupId(String securityGroupId) Deprecated. use `securityGroup` instead
FunctionAttributes.Builder	skipPermissions(Boolean skipPermissions) Sets the value of FunctionAttributes.getSkipPermissions()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

functionArn

@Stability(value=Stable)
public FunctionAttributes.Builder functionArn(String functionArn)

Sets the value of FunctionAttributes.getFunctionArn()

Parameters:

functionArn - The ARN of the Lambda function. This parameter is required. Format: arn::lambda:::function:

Returns:

this

architecture

@Stability(value=Stable)
public FunctionAttributes.Builder architecture(Architecture architecture)

Sets the value of FunctionAttributes.getArchitecture()

Parameters:

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

Returns:

this

role

@Stability(value=Stable)
public FunctionAttributes.Builder role(IRole role)

Sets the value of FunctionAttributes.getRole()

Parameters:

role - The IAM execution role associated with this function. If the role is not specified, any role-related operations will no-op.

Returns:

this

sameEnvironment

@Stability(value=Stable)
public FunctionAttributes.Builder sameEnvironment(Boolean sameEnvironment)

Sets the value of FunctionAttributes.getSameEnvironment()

Parameters:

sameEnvironment - 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.

Returns:

this

securityGroup

@Stability(value=Stable)
public FunctionAttributes.Builder securityGroup(ISecurityGroup securityGroup)

Sets the value of FunctionAttributes.getSecurityGroup()

Parameters:

securityGroup - The security group of this Lambda, if in a VPC. This needs to be given in order to support allowing connections to this Lambda.

Returns:

this

securityGroupId

@Stability(value=Deprecated)
 @Deprecated
public FunctionAttributes.Builder securityGroupId(String securityGroupId)

Deprecated. use `securityGroup` instead

Sets the value of FunctionAttributes.getSecurityGroupId()

Parameters:

securityGroupId - 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.

Returns:

this

skipPermissions

@Stability(value=Stable)
public FunctionAttributes.Builder skipPermissions(Boolean skipPermissions)

Sets the value of FunctionAttributes.getSkipPermissions()

Parameters:

skipPermissions - 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.

Returns:

this

build

@Stability(value=Stable)
public FunctionAttributes build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<FunctionAttributes>

Returns:

a new instance of FunctionAttributes

Throws:

NullPointerException - if any required attribute was not provided