Package software.amazon.awscdk.cfnpropertymixins.services.lambda

Class CfnFunctionMixinProps.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.cfnpropertymixins.services.lambda.CfnFunctionMixinProps.Jsii$Proxy

All Implemented Interfaces:

CfnFunctionMixinProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:

CfnFunctionMixinProps

@Stability(Stable)
@Internal
public static final class CfnFunctionMixinProps.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements CfnFunctionMixinProps

An implementation for CfnFunctionMixinProps

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.cfnpropertymixins.services.lambda.CfnFunctionMixinProps

CfnFunctionMixinProps.Builder, CfnFunctionMixinProps.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(CfnFunctionMixinProps.Builder builder)	Constructor that initializes the object based on literal property values passed by the CfnFunctionMixinProps.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)	Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method	Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
final boolean	equals(Object o)
final List<String>	getArchitectures()	The instruction set architecture that the function supports.
final Object	getCapacityProviderConfig()	Configuration for the capacity provider that manages compute resources for Lambda functions.
final Object	getCode()	The code for the function.
final Object	getCodeSigningConfigArn()	To enable code signing for this function, specify the ARN of a code-signing configuration.
final Object	getDeadLetterConfig()	A dead-letter queue configuration that specifies the queue or topic where Lambda sends asynchronous events when they fail processing.
final String	getDescription()	A description of the function.
final Object	getDurableConfig()	Configuration settings for durable functions , including execution timeout and retention period for execution history.
final Object	getEnvironment()	Environment variables that are accessible from function code during execution.
final Object	getEphemeralStorage()	The size of the function's /tmp directory in MB.
final Object	getFileSystemConfigs()	Connection settings for an Amazon EFS file system.
final String	getFunctionName()	The name of the Lambda function, up to 64 characters in length.
final Object	getFunctionScalingConfig()	Configuration that defines the scaling behavior for a Lambda Managed Instances function, including the minimum and maximum number of execution environments that can be provisioned.
final String	getHandler()	The name of the method within your code that Lambda calls to run your function.
final Object	getImageConfig()	Configuration values that override the container image Dockerfile settings.
final Object	getKmsKeyArn()	The ARN of the AWS Key Management Service ( AWS ) customer managed key that's used to encrypt the following resources:.
final List<Object>	getLayers()	A list of function layers to add to the function's execution environment.
final Object	getLoggingConfig()	The function's Amazon CloudWatch Logs configuration settings.
final Number	getMemorySize()	The amount of memory available to the function at runtime.
final String	getPackageType()	The type of deployment package.
final Object	getPublishToLatestPublished()	Returns union: either Boolean or IResolvable
final String	getRecursiveLoop()	The status of your function's recursive loop detection configuration.
final Number	getReservedConcurrentExecutions()	The number of simultaneous executions to reserve for the function.
final Object	getRole()	The Amazon Resource Name (ARN) of the function's execution role.
final String	getRuntime()	The identifier of the function's runtime .
final Object	getRuntimeManagementConfig()	Sets the runtime management configuration for a function's version.
final Object	getSnapStart()	The function's AWS Lambda SnapStart setting.
final List<CfnTag>	getTags()	A list of tags to apply to the function.
final Object	getTenancyConfig()	The function's tenant isolation configuration settings.
final Number	getTimeout()	The amount of time (in seconds) that Lambda allows a function to run before stopping it.
final Object	getTracingConfig()	Set Mode to Active to sample and trace a subset of incoming requests with X-Ray .
final Object	getVpcConfig()	For network connectivity to AWS resources in a VPC, specify a list of security groups and subnets in the VPC.
final int	hashCode()

Methods inherited from class software.amazon.jsii.JsiiObject

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

Methods inherited from class java.lang.Object

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

Constructor Details

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(CfnFunctionMixinProps.Builder builder)

Constructor that initializes the object based on literal property values passed by the CfnFunctionMixinProps.Builder.

Method Details

getArchitectures

public final List<String> getArchitectures()

Description copied from interface: CfnFunctionMixinProps

The instruction set architecture that the function supports.

Enter a string array with one of the valid values (arm64 or x86_64). The default value is x86_64 .

Specified by:

getArchitectures in interface CfnFunctionMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-architectures

getCapacityProviderConfig

public final Object getCapacityProviderConfig()

Description copied from interface: CfnFunctionMixinProps

Configuration for the capacity provider that manages compute resources for Lambda functions.

Returns union: either IResolvable or CfnFunctionPropsMixin.CapacityProviderConfigProperty

Specified by:

getCapacityProviderConfig in interface CfnFunctionMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-capacityproviderconfig

getCode

public final Object getCode()

Description copied from interface: CfnFunctionMixinProps

The code for the function. You can define your function code in multiple ways:.

• For .zip deployment packages, you can specify the Amazon S3 location of the .zip file in the S3Bucket , S3Key , and S3ObjectVersion properties.
• For .zip deployment packages, you can alternatively define the function code inline in the ZipFile property. This method works only for Node.js and Python functions.
• For container images, specify the URI of your container image in the Amazon ECR registry in the ImageUri property.

Returns union: either IResolvable or CfnFunctionPropsMixin.CodeProperty

Specified by:

getCode in interface CfnFunctionMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-code

getCodeSigningConfigArn

public final Object getCodeSigningConfigArn()

Description copied from interface: CfnFunctionMixinProps

To enable code signing for this function, specify the ARN of a code-signing configuration.

A code-signing configuration includes a set of signing profiles, which define the trusted publishers for this function.

Returns union: either String or ICodeSigningConfigRef

Specified by:

getCodeSigningConfigArn in interface CfnFunctionMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-codesigningconfigarn

getDeadLetterConfig

public final Object getDeadLetterConfig()

Description copied from interface: CfnFunctionMixinProps

A dead-letter queue configuration that specifies the queue or topic where Lambda sends asynchronous events when they fail processing.

For more information, see Dead-letter queues .

Returns union: either IResolvable or CfnFunctionPropsMixin.DeadLetterConfigProperty

Specified by:

getDeadLetterConfig in interface CfnFunctionMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-deadletterconfig

getDescription

public final String getDescription()

Description copied from interface: CfnFunctionMixinProps

A description of the function.

Specified by:

getDescription in interface CfnFunctionMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-description

getDurableConfig

public final Object getDurableConfig()

Description copied from interface: CfnFunctionMixinProps

Configuration settings for durable functions , including execution timeout and retention period for execution history.

Returns union: either IResolvable or CfnFunctionPropsMixin.DurableConfigProperty

Specified by:

getDurableConfig in interface CfnFunctionMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-durableconfig

getEnvironment

public final Object getEnvironment()

Description copied from interface: CfnFunctionMixinProps

Environment variables that are accessible from function code during execution.

Returns union: either IResolvable or CfnFunctionPropsMixin.EnvironmentProperty

Specified by:

getEnvironment in interface CfnFunctionMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-environment

getEphemeralStorage

public final Object getEphemeralStorage()

Description copied from interface: CfnFunctionMixinProps

The size of the function's /tmp directory in MB.

The default value is 512, but it can be any whole number between 512 and 10,240 MB.

Returns union: either IResolvable or CfnFunctionPropsMixin.EphemeralStorageProperty

Specified by:

getEphemeralStorage in interface CfnFunctionMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-ephemeralstorage

getFileSystemConfigs

public final Object getFileSystemConfigs()

Description copied from interface: CfnFunctionMixinProps

Connection settings for an Amazon EFS file system.

To connect a function to a file system, a mount target must be available in every Availability Zone that your function connects to. If your template contains an AWS::EFS::MountTarget resource, you must also specify a DependsOn attribute to ensure that the mount target is created or updated before the function.

For more information about using the DependsOn attribute, see DependsOn Attribute .

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnFunctionPropsMixin.FileSystemConfigProperty>

Specified by:

getFileSystemConfigs in interface CfnFunctionMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-filesystemconfigs

getFunctionName

public final String getFunctionName()

Description copied from interface: CfnFunctionMixinProps

The name of the Lambda function, up to 64 characters in length.

If you don't specify a name, CloudFormation generates one.

If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.

Specified by:

getFunctionName in interface CfnFunctionMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-functionname

getFunctionScalingConfig

public final Object getFunctionScalingConfig()

Description copied from interface: CfnFunctionMixinProps

Configuration that defines the scaling behavior for a Lambda Managed Instances function, including the minimum and maximum number of execution environments that can be provisioned.

Returns union: either IResolvable or CfnFunctionPropsMixin.FunctionScalingConfigProperty

Specified by:

getFunctionScalingConfig in interface CfnFunctionMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-functionscalingconfig

getHandler

public final String getHandler()

Description copied from interface: CfnFunctionMixinProps

The name of the method within your code that Lambda calls to run your function.

Handler is required if the deployment package is a .zip file archive. The format includes the file name. It can also include namespaces and other qualifiers, depending on the runtime. For more information, see Lambda programming model .

Specified by:

getHandler in interface CfnFunctionMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-handler

getImageConfig

public final Object getImageConfig()

Description copied from interface: CfnFunctionMixinProps

Configuration values that override the container image Dockerfile settings.

For more information, see Container image settings .

Returns union: either IResolvable or CfnFunctionPropsMixin.ImageConfigProperty

Specified by:

getImageConfig in interface CfnFunctionMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-imageconfig

getKmsKeyArn

public final Object getKmsKeyArn()

Description copied from interface: CfnFunctionMixinProps

The ARN of the AWS Key Management Service ( AWS ) customer managed key that's used to encrypt the following resources:.

• The function's environment variables .
• The function's Lambda SnapStart snapshots.
• When used with SourceKMSKeyArn , the unzipped version of the .zip deployment package that's used for function invocations. For more information, see Specifying a customer managed key for Lambda .
• The optimized version of the container image that's used for function invocations. Note that this is not the same key that's used to protect your container image in the Amazon Elastic Container Registry (Amazon ECR). For more information, see Function lifecycle .

If you don't provide a customer managed key, Lambda uses an AWS owned key or an AWS managed key .

Returns union: either String or IKeyRef

Specified by:

getKmsKeyArn in interface CfnFunctionMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-kmskeyarn

getLayers

public final List<Object> getLayers()

Description copied from interface: CfnFunctionMixinProps

A list of function layers to add to the function's execution environment. Specify each layer by its ARN, including the version.

Returns union: Listinvalid input: '<'either String or ILayerVersionRef>

Specified by:

getLayers in interface CfnFunctionMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-layers

getLoggingConfig

public final Object getLoggingConfig()

Description copied from interface: CfnFunctionMixinProps

The function's Amazon CloudWatch Logs configuration settings.

Returns union: either IResolvable or CfnFunctionPropsMixin.LoggingConfigProperty

Specified by:

getLoggingConfig in interface CfnFunctionMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-loggingconfig

getMemorySize

public final Number getMemorySize()

Description copied from interface: CfnFunctionMixinProps

The amount of memory available to the function at runtime. Increasing the function memory also increases its CPU allocation. The default value is 128 MB. The value can be any multiple of 1 MB. Note that new AWS accounts have reduced concurrency and memory quotas. AWS raises these quotas automatically based on your usage. You can also request a quota increase.

Specified by:

getMemorySize in interface CfnFunctionMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-memorysize

getPackageType

public final String getPackageType()

Description copied from interface: CfnFunctionMixinProps

The type of deployment package.

Set to Image for container image and set Zip for .zip file archive.

Specified by:

getPackageType in interface CfnFunctionMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-packagetype

getPublishToLatestPublished

public final Object getPublishToLatestPublished()

Description copied from interface: CfnFunctionMixinProps

Returns union: either Boolean or IResolvable

Specified by:

getPublishToLatestPublished in interface CfnFunctionMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-publishtolatestpublished

getRecursiveLoop

public final String getRecursiveLoop()

Description copied from interface: CfnFunctionMixinProps

The status of your function's recursive loop detection configuration.

When this value is set to Allow and Lambda detects your function being invoked as part of a recursive loop, it doesn't take any action.

When this value is set to Terminate and Lambda detects your function being invoked as part of a recursive loop, it stops your function being invoked and notifies you.

Specified by:

getRecursiveLoop in interface CfnFunctionMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-recursiveloop

getReservedConcurrentExecutions

public final Number getReservedConcurrentExecutions()

Description copied from interface: CfnFunctionMixinProps

The number of simultaneous executions to reserve for the function.

Specified by:

getReservedConcurrentExecutions in interface CfnFunctionMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-reservedconcurrentexecutions

getRole

public final Object getRole()

Description copied from interface: CfnFunctionMixinProps

The Amazon Resource Name (ARN) of the function's execution role.

Returns union: either String or IRoleRef

Specified by:

getRole in interface CfnFunctionMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-role

getRuntime

public final String getRuntime()

Description copied from interface: CfnFunctionMixinProps

The identifier of the function's runtime . Runtime is required if the deployment package is a .zip file archive. Specifying a runtime results in an error if you're deploying a function using a container image.

The following list includes deprecated runtimes. Lambda blocks creating new functions and updating existing functions shortly after each runtime is deprecated. For more information, see Runtime use after deprecation .

For a list of all currently supported runtimes, see Supported runtimes .

Specified by:

getRuntime in interface CfnFunctionMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-runtime

getRuntimeManagementConfig

public final Object getRuntimeManagementConfig()

Description copied from interface: CfnFunctionMixinProps

Sets the runtime management configuration for a function's version.

For more information, see Runtime updates .

Returns union: either IResolvable or CfnFunctionPropsMixin.RuntimeManagementConfigProperty

Specified by:

getRuntimeManagementConfig in interface CfnFunctionMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-runtimemanagementconfig

getSnapStart

public final Object getSnapStart()

Description copied from interface: CfnFunctionMixinProps

The function's AWS Lambda SnapStart setting.

Returns union: either IResolvable or CfnFunctionPropsMixin.SnapStartProperty

Specified by:

getSnapStart in interface CfnFunctionMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-snapstart

getTags

public final List<CfnTag> getTags()

Description copied from interface: CfnFunctionMixinProps

A list of tags to apply to the function.

You must have the lambda:TagResource , lambda:UntagResource , and lambda:ListTags permissions for your IAM principal to manage the CloudFormation stack. If you don't have these permissions, there might be unexpected behavior with stack-level tags propagating to the resource during resource creation and update.

Specified by:

getTags in interface CfnFunctionMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-tags

getTenancyConfig

public final Object getTenancyConfig()

Description copied from interface: CfnFunctionMixinProps

The function's tenant isolation configuration settings.

Determines whether the Lambda function runs on a shared or dedicated infrastructure per unique tenant.

Returns union: either IResolvable or CfnFunctionPropsMixin.TenancyConfigProperty

Specified by:

getTenancyConfig in interface CfnFunctionMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-tenancyconfig

getTimeout

public final Number getTimeout()

Description copied from interface: CfnFunctionMixinProps

The amount of time (in seconds) that Lambda allows a function to run before stopping it.

The default is 3 seconds. The maximum allowed value is 900 seconds. For more information, see Lambda execution environment .

Specified by:

getTimeout in interface CfnFunctionMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-timeout

getTracingConfig

public final Object getTracingConfig()

Description copied from interface: CfnFunctionMixinProps

Set Mode to Active to sample and trace a subset of incoming requests with X-Ray .

Returns union: either IResolvable or CfnFunctionPropsMixin.TracingConfigProperty

Specified by:

getTracingConfig in interface CfnFunctionMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-tracingconfig

getVpcConfig

public final Object getVpcConfig()

Description copied from interface: CfnFunctionMixinProps

For network connectivity to AWS resources in a VPC, specify a list of security groups and subnets in the VPC.

When you connect a function to a VPC, it can access resources and the internet only through that VPC. For more information, see Configuring a Lambda function to access resources in a VPC .

Returns union: either IResolvable or CfnFunctionPropsMixin.VpcConfigProperty

Specified by:

getVpcConfig in interface CfnFunctionMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-vpcconfig

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object