software.amazon.awscdk.services.lambda

Class SingletonFunctionProps.Jsii$Pojo

java.lang.Object

software.amazon.awscdk.services.lambda.SingletonFunctionProps.Jsii$Pojo

All Implemented Interfaces:

FunctionProps, SingletonFunctionProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:

SingletonFunctionProps

public static final class SingletonFunctionProps.Jsii$Pojo
extends Object
implements SingletonFunctionProps

A PoJo (plain-old-java-object) class that implements SingletonFunctionProps.

Nested Class Summary

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.lambda.SingletonFunctionProps

SingletonFunctionProps.Builder, SingletonFunctionProps.Jsii$Pojo, SingletonFunctionProps.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field and Description
protected Code	_code
protected String	_description
protected Map<String,Object>	_environment
protected String	_functionName
protected String	_handler
protected List<software.amazon.awscdk.PolicyStatement>	_initialPolicy
protected String	_lambdaPurpose
protected Number	_memorySize
protected software.amazon.awscdk.services.iam.Role	_role
protected Runtime	_runtime
protected Number	_timeout
protected String	_uuid

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Jsii$Pojo() Constructor used by builders.

Method Summary

Modifier and Type	Method and Description
Code	getCode() The source code of your Lambda function.
String	getDescription() A description of the function.
Map<String,Object>	getEnvironment() Key-value pairs that Lambda caches and makes available for your Lambda functions.
String	getFunctionName() A name for the function.
String	getHandler() The name of the function (within your source code) that Lambda calls to start running your code.
List<software.amazon.awscdk.PolicyStatement>	getInitialPolicy() Initial policy statements to add to the created Lambda Role.
String	getLambdaPurpose() A descriptive name for the purpose of this Lambda.
Number	getMemorySize() The amount of memory, in MB, that is allocated to your Lambda function.
software.amazon.awscdk.services.iam.Role	getRole() Lambda execution role.
Runtime	getRuntime() The runtime environment for the Lambda function that you are uploading.
Number	getTimeout() The function execution time (in seconds) after which Lambda terminates the function.
String	getUuid() A unique identifier to identify this lambda The identifier should be unique across all custom resource providers.
void	setCode(Code value) The source code of your Lambda function.
void	setDescription(String value) A description of the function.
void	setEnvironment(Map<String,Object> value) Key-value pairs that Lambda caches and makes available for your Lambda functions.
void	setFunctionName(String value) A name for the function.
void	setHandler(String value) The name of the function (within your source code) that Lambda calls to start running your code.
void	setInitialPolicy(List<software.amazon.awscdk.PolicyStatement> value) Initial policy statements to add to the created Lambda Role.
void	setLambdaPurpose(String value) A descriptive name for the purpose of this Lambda.
void	setMemorySize(Number value) The amount of memory, in MB, that is allocated to your Lambda function.
void	setRole(software.amazon.awscdk.services.iam.Role value) Lambda execution role.
void	setRuntime(Runtime value) The runtime environment for the Lambda function that you are uploading.
void	setTimeout(Number value) The function execution time (in seconds) after which Lambda terminates the function.
void	setUuid(String value) A unique identifier to identify this lambda The identifier should be unique across all custom resource providers.

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awscdk.services.lambda.SingletonFunctionProps

builder

Field Detail

_uuid

protected String _uuid

_lambdaPurpose

protected String _lambdaPurpose

_code

protected Code _code

_description

protected String _description

_handler

protected String _handler

_timeout

protected Number _timeout

_environment

protected Map<String,Object> _environment

_runtime

protected Runtime _runtime

_functionName

protected String _functionName

_memorySize

protected Number _memorySize

_initialPolicy

protected List<software.amazon.awscdk.PolicyStatement> _initialPolicy

_role

protected software.amazon.awscdk.services.iam.Role _role

Constructor Detail

Jsii$Pojo

protected Jsii$Pojo()

Constructor used by builders.

Method Detail

getUuid

public String getUuid()

Description copied from interface: SingletonFunctionProps

A unique identifier to identify this lambda The identifier should be unique across all custom resource providers. We recommend generating a UUID per provider.

Specified by:

getUuid in interface SingletonFunctionProps

setUuid

public void setUuid(String value)

Description copied from interface: SingletonFunctionProps

A unique identifier to identify this lambda The identifier should be unique across all custom resource providers. We recommend generating a UUID per provider.

Specified by:

setUuid in interface SingletonFunctionProps

getLambdaPurpose

public String getLambdaPurpose()

Description copied from interface: SingletonFunctionProps

A descriptive name for the purpose of this Lambda. If the Lambda does not have a physical name, this string will be reflected its generated name. The combination of lambdaPurpose and uuid must be unique.

Specified by:

getLambdaPurpose in interface SingletonFunctionProps

setLambdaPurpose

public void setLambdaPurpose(String value)

Description copied from interface: SingletonFunctionProps

A descriptive name for the purpose of this Lambda. If the Lambda does not have a physical name, this string will be reflected its generated name. The combination of lambdaPurpose and uuid must be unique.

Specified by:

setLambdaPurpose in interface SingletonFunctionProps

getCode

public Code getCode()

Description copied from interface: FunctionProps

The source code of your Lambda function. You can point to a file in an Amazon Simple Storage Service (Amazon S3) bucket or specify your source code as inline text.

Specified by:

getCode in interface FunctionProps

setCode

public void setCode(Code value)

Description copied from interface: FunctionProps

The source code of your Lambda function. You can point to a file in an Amazon Simple Storage Service (Amazon S3) bucket or specify your source code as inline text.

Specified by:

setCode in interface FunctionProps

getDescription

public String getDescription()

Description copied from interface: FunctionProps

A description of the function.

Specified by:

getDescription in interface FunctionProps

setDescription

public void setDescription(String value)

Description copied from interface: FunctionProps

A description of the function.

Specified by:

setDescription in interface FunctionProps

getHandler

public String getHandler()

Description copied from interface: FunctionProps

The name of the function (within your source code) that Lambda calls to start running your code. For more information, see the Handler property in the AWS Lambda Developer Guide. NOTE: If you specify your source code as inline text by specifying the ZipFile property within the Code property, specify index.function_name as the handler.

Specified by:

getHandler in interface FunctionProps

setHandler

public void setHandler(String value)

Description copied from interface: FunctionProps

The name of the function (within your source code) that Lambda calls to start running your code. For more information, see the Handler property in the AWS Lambda Developer Guide. NOTE: If you specify your source code as inline text by specifying the ZipFile property within the Code property, specify index.function_name as the handler.

Specified by:

setHandler in interface FunctionProps

getTimeout

public Number getTimeout()

Description copied from interface: FunctionProps

The function execution time (in seconds) after which Lambda terminates the function. Because the execution time affects cost, set this value based on the function's expected execution time.

Specified by:

getTimeout in interface FunctionProps

setTimeout

public void setTimeout(Number value)

Description copied from interface: FunctionProps

The function execution time (in seconds) after which Lambda terminates the function. Because the execution time affects cost, set this value based on the function's expected execution time.

Specified by:

setTimeout in interface FunctionProps

getEnvironment

public Map<String,Object> getEnvironment()

Description copied from interface: FunctionProps

Key-value pairs that Lambda caches and makes available for your Lambda functions. Use environment variables to apply configuration changes, such as test and production environment configurations, without changing your Lambda function source code.

Specified by:

getEnvironment in interface FunctionProps

setEnvironment

public void setEnvironment(Map<String,Object> value)

Description copied from interface: FunctionProps

Key-value pairs that Lambda caches and makes available for your Lambda functions. Use environment variables to apply configuration changes, such as test and production environment configurations, without changing your Lambda function source code.

Specified by:

setEnvironment in interface FunctionProps

getRuntime

public Runtime getRuntime()

Description copied from interface: FunctionProps

The runtime environment for the Lambda function that you are uploading. For valid values, see the Runtime property in the AWS Lambda Developer Guide.

Specified by:

getRuntime in interface FunctionProps

setRuntime

public void setRuntime(Runtime value)

Description copied from interface: FunctionProps

The runtime environment for the Lambda function that you are uploading. For valid values, see the Runtime property in the AWS Lambda Developer Guide.

Specified by:

setRuntime in interface FunctionProps

getFunctionName

public String getFunctionName()

Description copied from interface: FunctionProps

A name for the function. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the function's name. For more information, see Name Type.

Specified by:

getFunctionName in interface FunctionProps

setFunctionName

public void setFunctionName(String value)

Description copied from interface: FunctionProps

A name for the function. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the function's name. For more information, see Name Type.

Specified by:

setFunctionName in interface FunctionProps

getMemorySize

public Number getMemorySize()

Description copied from interface: FunctionProps

The amount of memory, in MB, that is allocated to your Lambda function. Lambda uses this value to proportionally allocate the amount of CPU power. For more information, see Resource Model in the AWS Lambda Developer Guide.

Specified by:

getMemorySize in interface FunctionProps

setMemorySize

public void setMemorySize(Number value)

Description copied from interface: FunctionProps

The amount of memory, in MB, that is allocated to your Lambda function. Lambda uses this value to proportionally allocate the amount of CPU power. For more information, see Resource Model in the AWS Lambda Developer Guide.

Specified by:

setMemorySize in interface FunctionProps

getInitialPolicy

public List<software.amazon.awscdk.PolicyStatement> getInitialPolicy()

Description copied from interface: FunctionProps

Initial policy statements to add to the created Lambda Role. You can call `addToRolePolicy` to the created lambda to add statements post creation.

Specified by:

getInitialPolicy in interface FunctionProps

setInitialPolicy

public void setInitialPolicy(List<software.amazon.awscdk.PolicyStatement> value)

Description copied from interface: FunctionProps

Initial policy statements to add to the created Lambda Role. You can call `addToRolePolicy` to the created lambda to add statements post creation.

Specified by:

setInitialPolicy in interface FunctionProps

getRole

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

Description copied from interface: FunctionProps

Lambda execution role. This is the role that will be assumed by the function upon execution. It controls the permissions that the function will have. The Role must be assumable by the 'lambda.amazonaws.com' service principal.

Specified by:

getRole in interface FunctionProps

setRole

public void setRole(software.amazon.awscdk.services.iam.Role value)

Description copied from interface: FunctionProps

Lambda execution role. This is the role that will be assumed by the function upon execution. It controls the permissions that the function will have. The Role must be assumable by the 'lambda.amazonaws.com' service principal.

Specified by:

setRole in interface FunctionProps