software.amazon.awscdk.services.lambda

Class SingletonFunction

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.Construct

software.amazon.awscdk.services.lambda.FunctionRef

software.amazon.awscdk.services.lambda.SingletonFunction

All Implemented Interfaces:

software.amazon.awscdk.services.events.IEventRuleTarget, software.amazon.awscdk.services.logs.ILogSubscriptionDestination, software.amazon.awscdk.services.s3.notifications.IBucketNotificationDestination, software.amazon.jsii.JsiiSerializable

public class SingletonFunction
extends FunctionRef

A Lambda that will only ever be added to a stack once. The lambda is identified using the value of 'uuid'. Run 'uuidgen' for every SingletonLambda you create.

Nested Class Summary

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

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.events.IEventRuleTarget

software.amazon.awscdk.services.events.IEventRuleTarget.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.logs.ILogSubscriptionDestination

software.amazon.awscdk.services.logs.ILogSubscriptionDestination.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.s3.notifications.IBucketNotificationDestination

software.amazon.awscdk.services.s3.notifications.IBucketNotificationDestination.Jsii$Proxy

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	addPermission(String name, Permission permission) Adds a permission to the Lambda resource policy.
protected Boolean	getCanCreatePermissions() Whether the addPermission() call adds any permissions True for new Lambdas, false for imported Lambdas (they might live in different accounts).
FunctionArn	getFunctionArn() The ARN fo the function.
FunctionName	getFunctionName() The name of the function.
software.amazon.awscdk.services.iam.Role	getRole() The IAM role associated with this function.

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

addToRolePolicy, asBucketNotificationDestination, asEventRuleTarget, export, 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, addWarning, ancestors, ancestors, findChild, getChildren, getContext, getId, getMetadata, getParent, getPath, getUniqueId, lock, requireContext, required, 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

SingletonFunction

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

SingletonFunction

public SingletonFunction(software.amazon.awscdk.Construct parent,
                         String name,
                         SingletonFunctionProps props)

Method Detail

addPermission

public void addPermission(String name,
                          Permission permission)

Adds a permission to the Lambda resource policy.

Overrides:

addPermission in class FunctionRef

Parameters:

name - The id ƒor the permission construct

getFunctionName

public FunctionName getFunctionName()

The name of the function.

Overrides:

getFunctionName in class FunctionRef

getFunctionArn

public FunctionArn getFunctionArn()

The ARN fo the function.

Overrides:

getFunctionArn in class FunctionRef

getRole

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

The IAM role associated with this function.

Overrides:

getRole in class FunctionRef

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