software.amazon.awscdk.services.lambda

Class Function

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.Construct

software.amazon.awscdk.services.lambda.FunctionRef

software.amazon.awscdk.services.lambda.Function

All Implemented Interfaces:

software.amazon.awscdk.services.ec2.IConnectable, software.amazon.awscdk.services.events.IEventRuleTarget, software.amazon.awscdk.services.logs.ILogSubscriptionDestination, software.amazon.awscdk.services.s3.notifications.IBucketNotificationDestination, software.amazon.awscdk.services.stepfunctions.IStepFunctionsTaskResource, software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/0.7.8 (build 100f5ad)",
           date="2018-10-26T17:58:07.463Z")
public class Function
extends FunctionRef

Deploys a file from from inside the construct library as a function. The supplied file is subject to the 4096 bytes limit of being embedded in a CloudFormation template. The construct includes an associated role with the lambda. This construct does not yet reproduce all features from the underlying resource library.

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Constructor Summary

Constructors

Modifier	Constructor and Description
	Function(software.amazon.awscdk.Construct parent, String name, FunctionProps props)
protected	Function(software.amazon.jsii.JsiiObject.InitializationMode mode)

Method Summary

Modifier and Type	Method and Description
void	addEnvironment(String key) Adds an environment variable to this Lambda function.
void	addEnvironment(String key, Object value) Adds an environment variable to this Lambda function.
FunctionVersion	addVersion(String name) Add a new version for this Lambda If you want to deploy through CloudFormation and use aliases, you need to add a new version (with a new name) to your Lambda every time you want to deploy an update.
FunctionVersion	addVersion(String name, String codeSha256) Add a new version for this Lambda If you want to deploy through CloudFormation and use aliases, you need to add a new version (with a new name) to your Lambda every time you want to deploy an update.
FunctionVersion	addVersion(String name, String codeSha256, String description) Add a new version for this Lambda If you want to deploy through CloudFormation and use aliases, you need to add a new version (with a new name) to your Lambda every time you want to deploy an update.
protected Boolean	getCanCreatePermissions() Whether the addPermission() call adds any permissions True for new Lambdas, false for imported Lambdas (they might live in different accounts).
String	getFunctionArn() ARN of this function
String	getFunctionName() Name of this function
String	getHandler() The name of the handler configured for this lambda.
software.amazon.awscdk.services.iam.Role	getRole() Execution role associated with this function
Runtime	getRuntime() The runtime configured for this lambda.

Methods inherited from class software.amazon.awscdk.services.lambda.FunctionRef

addPermission, addToPipeline, addToPipeline, addToRolePolicy, asBucketNotificationDestination, asEventRuleTarget, asStepFunctionsTaskResource, export, getConnections, getIsBoundToVpc, grantInvoke, grantInvoke, import_, logSubscriptionDestination, metric, metric, metricAll, metricAll, metricAllConcurrentExecutions, metricAllConcurrentExecutions, metricAllDuration, metricAllDuration, metricAllErrors, metricAllErrors, metricAllInvocations, metricAllInvocations, metricAllThrottles, metricAllThrottles, metricAllUnreservedConcurrentExecutions, metricAllUnreservedConcurrentExecutions, metricDuration, metricDuration, metricErrors, metricErrors, metricInvocations, metricInvocations, metricThrottles, metricThrottles

Methods inherited from class software.amazon.awscdk.Construct

addChild, addError, addInfo, addMetadata, addMetadata, addMetadata, addWarning, ancestors, ancestors, findChild, getChildren, getContext, getId, getLocked, getMetadata, getParent, getPath, getUniqueId, lock, requireContext, required, setContext, setContext, toString, toTreeString, toTreeString, tryFindChild, unlock, validate, validateTree

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiCall, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticGet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Constructor Detail

Function

protected Function(software.amazon.jsii.JsiiObject.InitializationMode mode)

Function

public Function(software.amazon.awscdk.Construct parent,
                String name,
                FunctionProps props)

Method Detail

addEnvironment

public void addEnvironment(String key,
                           @Nullable
                           Object value)

Adds an environment variable to this Lambda function. If this is a ref to a Lambda function, this operation results in a no-op.

Parameters:

key - The environment variable key.

value - The environment variable's value.

addEnvironment

public void addEnvironment(String key)

Adds an environment variable to this Lambda function. If this is a ref to a Lambda function, this operation results in a no-op.

Parameters:

key - The environment variable key.

addVersion

public FunctionVersion addVersion(String name,
                                  @Nullable
                                  String codeSha256,
                                  @Nullable
                                  String description)

Add a new version for this Lambda If you want to deploy through CloudFormation and use aliases, you need to add a new version (with a new name) to your Lambda every time you want to deploy an update. An alias can then refer to the newly created Version. All versions should have distinct names, and you should not delete versions as long as your Alias needs to refer to them.

Parameters:

name - A unique name for this version

codeSha256 - The SHA-256 hash of the most recently deployed Lambda source code, or omit to skip validation.

description - A description for this version.

Returns:

A new Version object.

addVersion

public FunctionVersion addVersion(String name,
                                  @Nullable
                                  String codeSha256)

Add a new version for this Lambda If you want to deploy through CloudFormation and use aliases, you need to add a new version (with a new name) to your Lambda every time you want to deploy an update. An alias can then refer to the newly created Version. All versions should have distinct names, and you should not delete versions as long as your Alias needs to refer to them.

Parameters:

name - A unique name for this version

codeSha256 - The SHA-256 hash of the most recently deployed Lambda source code, or omit to skip validation.

Returns:

A new Version object.

addVersion

public FunctionVersion addVersion(String name)

Add a new version for this Lambda If you want to deploy through CloudFormation and use aliases, you need to add a new version (with a new name) to your Lambda every time you want to deploy an update. An alias can then refer to the newly created Version. All versions should have distinct names, and you should not delete versions as long as your Alias needs to refer to them.

Parameters:

name - A unique name for this version

Returns:

A new Version object.

getCanCreatePermissions

protected Boolean getCanCreatePermissions()

Whether the addPermission() call adds any permissions True for new Lambdas, false for imported Lambdas (they might live in different accounts).

Overrides:

getCanCreatePermissions in class FunctionRef

getFunctionArn

public String getFunctionArn()

ARN of this function

Overrides:

getFunctionArn in class FunctionRef

getFunctionName

public String getFunctionName()

Name of this function

Overrides:

getFunctionName in class FunctionRef

getHandler

public String getHandler()

The name of the handler configured for this lambda.

getRuntime

public Runtime getRuntime()

The runtime configured for this lambda.

getRole

@Nullable
public software.amazon.awscdk.services.iam.Role getRole()

Execution role associated with this function

Overrides:

getRole in class FunctionRef