software.amazon.awscdk.services.lambda

Class SingletonFunctionProps.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

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

All Implemented Interfaces:

FunctionProps, SingletonFunctionProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:

SingletonFunctionProps

public static final class SingletonFunctionProps.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements SingletonFunctionProps

A proxy class which represents a concrete javascript instance of this type.

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.lambda.SingletonFunctionProps

SingletonFunctionProps.Builder, SingletonFunctionProps.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Jsii$Proxy(software.amazon.jsii.JsiiObject.InitializationMode mode)

Method Summary

Modifier and Type	Method and Description
Boolean	getAllowAllOutbound() Whether to allow the Lambda to send all network traffic If set to false, you must individually add traffic rules to allow the Lambda to connect to network targets.
Code	getCode() The source code of your Lambda function.
software.amazon.awscdk.services.sqs.QueueRef	getDeadLetterQueue() The SQS queue to use if DLQ is enabled.
Boolean	getDeadLetterQueueEnabled() Enabled DLQ.
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.services.iam.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.
software.amazon.awscdk.services.ec2.SecurityGroupRef	getSecurityGroup() What security group to associate with the Lambda's network interfaces.
Number	getTimeout() The function execution time (in seconds) after which Lambda terminates the function.
Tracing	getTracing() Enable AWS X-Ray Tracing for Lambda Function.
String	getUuid() A unique identifier to identify this lambda The identifier should be unique across all custom resource providers.
software.amazon.awscdk.services.ec2.VpcNetworkRef	getVpc() VPC network to place Lambda network interfaces Specify this if the Lambda function needs to access resources in a VPC.
software.amazon.awscdk.services.ec2.VpcPlacementStrategy	getVpcPlacement() Where to place the network interfaces within the VPC.
void	setAllowAllOutbound(Boolean value) Whether to allow the Lambda to send all network traffic If set to false, you must individually add traffic rules to allow the Lambda to connect to network targets.
void	setCode(Code value) The source code of your Lambda function.
void	setDeadLetterQueue(software.amazon.awscdk.services.sqs.QueueRef value) The SQS queue to use if DLQ is enabled.
void	setDeadLetterQueueEnabled(Boolean value) Enabled DLQ.
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.services.iam.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	setSecurityGroup(software.amazon.awscdk.services.ec2.SecurityGroupRef value) What security group to associate with the Lambda's network interfaces.
void	setTimeout(Number value) The function execution time (in seconds) after which Lambda terminates the function.
void	setTracing(Tracing value) Enable AWS X-Ray Tracing for Lambda Function.
void	setUuid(String value) A unique identifier to identify this lambda The identifier should be unique across all custom resource providers.
void	setVpc(software.amazon.awscdk.services.ec2.VpcNetworkRef value) VPC network to place Lambda network interfaces Specify this if the Lambda function needs to access resources in a VPC.
void	setVpcPlacement(software.amazon.awscdk.services.ec2.VpcPlacementStrategy value) Where to place the network interfaces within the VPC.

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, toString, wait, wait, wait

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

builder

Constructor Detail

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObject.InitializationMode mode)

Method Detail

getUuid

public String getUuid()

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)

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

@Nullable
public String getLambdaPurpose()

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(@Nullable
                             String value)

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

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)

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

getHandler

public String getHandler()

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)

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

getRuntime

public Runtime getRuntime()

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)

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

getAllowAllOutbound

@Nullable
public Boolean getAllowAllOutbound()

Whether to allow the Lambda to send all network traffic If set to false, you must individually add traffic rules to allow the Lambda to connect to network targets.

Specified by:

getAllowAllOutbound in interface FunctionProps

setAllowAllOutbound

public void setAllowAllOutbound(@Nullable
                                Boolean value)

Whether to allow the Lambda to send all network traffic If set to false, you must individually add traffic rules to allow the Lambda to connect to network targets.

Specified by:

setAllowAllOutbound in interface FunctionProps

getDeadLetterQueue

@Nullable
public software.amazon.awscdk.services.sqs.QueueRef getDeadLetterQueue()

The SQS queue to use if DLQ is enabled.

Specified by:

getDeadLetterQueue in interface FunctionProps

setDeadLetterQueue

public void setDeadLetterQueue(@Nullable
                               software.amazon.awscdk.services.sqs.QueueRef value)

The SQS queue to use if DLQ is enabled.

Specified by:

setDeadLetterQueue in interface FunctionProps

getDeadLetterQueueEnabled

@Nullable
public Boolean getDeadLetterQueueEnabled()

Enabled DLQ. If `deadLetterQueue` is undefined, an SQS queue with default options will be defined for your Function.

Specified by:

getDeadLetterQueueEnabled in interface FunctionProps

setDeadLetterQueueEnabled

public void setDeadLetterQueueEnabled(@Nullable
                                      Boolean value)

Enabled DLQ. If `deadLetterQueue` is undefined, an SQS queue with default options will be defined for your Function.

Specified by:

setDeadLetterQueueEnabled in interface FunctionProps

getDescription

@Nullable
public String getDescription()

A description of the function.

Specified by:

getDescription in interface FunctionProps

setDescription

public void setDescription(@Nullable
                           String value)

A description of the function.

Specified by:

setDescription in interface FunctionProps

getEnvironment

@Nullable
public Map<String,Object> getEnvironment()

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(@Nullable
                           Map<String,Object> value)

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

getFunctionName

@Nullable
public String getFunctionName()

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(@Nullable
                            String value)

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

getInitialPolicy

@Nullable
public List<software.amazon.awscdk.services.iam.PolicyStatement> getInitialPolicy()

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(@Nullable
                             List<software.amazon.awscdk.services.iam.PolicyStatement> value)

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

getMemorySize

@Nullable
public Number getMemorySize()

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(@Nullable
                          Number value)

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

getRole

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

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(@Nullable
                    software.amazon.awscdk.services.iam.Role value)

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

getSecurityGroup

@Nullable
public software.amazon.awscdk.services.ec2.SecurityGroupRef getSecurityGroup()

What security group to associate with the Lambda's network interfaces. Only used if 'vpc' is supplied.

Specified by:

getSecurityGroup in interface FunctionProps

setSecurityGroup

public void setSecurityGroup(@Nullable
                             software.amazon.awscdk.services.ec2.SecurityGroupRef value)

What security group to associate with the Lambda's network interfaces. Only used if 'vpc' is supplied.

Specified by:

setSecurityGroup in interface FunctionProps

getTimeout

@Nullable
public Number getTimeout()

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(@Nullable
                       Number value)

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

getTracing

@Nullable
public Tracing getTracing()

Enable AWS X-Ray Tracing for Lambda Function.

Specified by:

getTracing in interface FunctionProps

setTracing

public void setTracing(@Nullable
                       Tracing value)

Enable AWS X-Ray Tracing for Lambda Function.

Specified by:

setTracing in interface FunctionProps

getVpc

@Nullable
public software.amazon.awscdk.services.ec2.VpcNetworkRef getVpc()

VPC network to place Lambda network interfaces Specify this if the Lambda function needs to access resources in a VPC.

Specified by:

getVpc in interface FunctionProps

setVpc

public void setVpc(@Nullable
                   software.amazon.awscdk.services.ec2.VpcNetworkRef value)

VPC network to place Lambda network interfaces Specify this if the Lambda function needs to access resources in a VPC.

Specified by:

setVpc in interface FunctionProps

getVpcPlacement

@Nullable
public software.amazon.awscdk.services.ec2.VpcPlacementStrategy getVpcPlacement()

Where to place the network interfaces within the VPC. Only used if 'vpc' is supplied. Note: internet access for Lambdas requires a NAT gateway, so picking Public subnets is not allowed.

Specified by:

getVpcPlacement in interface FunctionProps

setVpcPlacement

public void setVpcPlacement(@Nullable
                            software.amazon.awscdk.services.ec2.VpcPlacementStrategy value)

Where to place the network interfaces within the VPC. Only used if 'vpc' is supplied. Note: internet access for Lambdas requires a NAT gateway, so picking Public subnets is not allowed.

Specified by:

setVpcPlacement in interface FunctionProps