Package-level declarations

Types

Link copied to clipboard
data class AliasProvisionedConcurrencyConfiguration(val provisionedConcurrentExecutions: Int)

A provisioned concurrency configuration for a function's alias.

Link copied to clipboard
data class AliasRoutingConfiguration(val additionalVersionWeights: List<AliasVersionWeight>? = null)

The traffic-shifting configuration of a Lambda function alias.

Link copied to clipboard
data class AliasVersionWeight(val functionVersion: String, val functionWeight: Double)

The traffic-shifting configuration of a Lambda function alias.

Link copied to clipboard
data class CodeSigningConfigAllowedPublishers(val signingProfileVersionArns: List<String>)

When the CodeSigningConfig is later on attached to a function, the function code will be expected to be signed by profiles from this list

Link copied to clipboard

Policies to control how to act if a signature is invalid

Link copied to clipboard
data class EventInvokeConfigDestinationConfig(val onFailure: EventInvokeConfigOnFailure? = null, val onSuccess: EventInvokeConfigOnSuccess? = null)

A destination for events after they have been sent to a function for processing.

Link copied to clipboard
data class EventInvokeConfigOnFailure(val destination: String)

The destination configuration for failed invocations.

Link copied to clipboard
data class EventInvokeConfigOnSuccess(val destination: String)

The destination configuration for successful invocations.

data class EventSourceMappingAmazonManagedKafkaEventSourceConfig(val consumerGroupId: String? = null)

Specific configuration settings for an Amazon Managed Streaming for Apache Kafka (Amazon MSK) event source.

Link copied to clipboard

A configuration object that specifies the destination of an event after Lambda processes it.

data class EventSourceMappingDocumentDbEventSourceConfig(val collectionName: String? = null, val databaseName: String? = null, val fullDocument: EventSourceMappingDocumentDbEventSourceConfigFullDocument? = null)

Specific configuration settings for a DocumentDB event source.

Link copied to clipboard
data class EventSourceMappingEndpoints(val kafkaBootstrapServers: List<String>? = null)

The list of bootstrap servers for your Kafka brokers in the following format: `"KafkaBootstrapServers": ["abc&#46;xyz&#46;com:xxxx","abc2&#46;xyz&#46;com:xxxx"]`.

Link copied to clipboard
data class EventSourceMappingFilter(val pattern: String? = null)

A structure within a `FilterCriteria` object that defines an event filtering pattern.

Link copied to clipboard

An object that contains the filters for an event source.

Link copied to clipboard

The metrics configuration for your event source. Use this configuration object to define which metrics you want your event source mapping to produce.

Link copied to clipboard
data class EventSourceMappingOnFailure(val destination: String? = null)

A destination for events that failed processing.

data class EventSourceMappingProvisionedPollerConfig(val maximumPollers: Int? = null, val minimumPollers: Int? = null)

The provisioned mode configuration for the event source. Use provisioned mode to customize the minimum and maximum number of event pollers for your event source.

Link copied to clipboard
data class EventSourceMappingScalingConfig(val maximumConcurrency: Int? = null)

(Amazon SQS only) The scaling configuration for the event source. To remove the configuration, pass an empty value.

Link copied to clipboard

The self-managed Apache Kafka cluster for your event source.

data class EventSourceMappingSelfManagedKafkaEventSourceConfig(val consumerGroupId: String? = null)

Specific configuration settings for a self-managed Apache Kafka event source.

An array of the authentication protocol, VPC components, or virtual host to secure and define your event source.

Link copied to clipboard
data class FunctionCode(val imageUri: String? = null, val s3Bucket: String? = null, val s3Key: String? = null, val s3ObjectVersion: String? = null, val sourceKmsKeyArn: String? = null, val zipFile: String? = null)

The deployment package for a Lambda function. To deploy a function defined as a container image, you specify the location of a container image in the Amazon ECR registry. For a .zip file deployment package, you can specify the location of an object in Amazon S3. For Node.js and Python functions, you can specify the function code inline in the template. When you specify source code inline for a Node.js function, the `index` file that CFN creates uses the extension `.js`. This means that LAM treats the file as a CommonJS module. ES modules aren't supported for inline functions. Changes to a deployment package in Amazon S3 or a container image in ECR are not detected automatically during stack updates. To update the function code, change the object key or version in the template.

Link copied to clipboard
data class FunctionDeadLetterConfig(val targetArn: String? = null)

The dead-letter queue for failed asynchronous invocations.

Link copied to clipboard
data class FunctionEnvironment(val variables: Map<String, String>? = null)

A function's environment variable settings. You can use environment variables to adjust your function's behavior without updating code. An environment variable is a pair of strings that are stored in a function's version-specific configuration.

Link copied to clipboard
data class FunctionEphemeralStorage(val size: Int)

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.

Link copied to clipboard
data class FunctionFileSystemConfig(val arn: String, val localMountPath: String)

Details about the connection between a Lambda function and an Amazon EFS file system.

Link copied to clipboard
data class FunctionImageConfig(val command: List<String>? = null, val entryPoint: List<String>? = null, val workingDirectory: String? = null)

Configuration values that override the container image Dockerfile settings. For more information, see Container image settings.

Link copied to clipboard
data class FunctionLoggingConfig(val applicationLogLevel: FunctionLoggingConfigApplicationLogLevel? = null, val logFormat: FunctionLoggingConfigLogFormat? = null, val logGroup: String? = null, val systemLogLevel: FunctionLoggingConfigSystemLogLevel? = null)

The function's Amazon CloudWatch Logs configuration settings.

Link copied to clipboard
data class FunctionRuntimeManagementConfig(val runtimeVersionArn: String? = null, val updateRuntimeOn: FunctionRuntimeManagementConfigUpdateRuntimeOn)

Sets the runtime management configuration for a function's version. For more information, see Runtime updates.

Link copied to clipboard

The function's SnapStart setting.

Link copied to clipboard
data class FunctionSnapStartResponse(val applyOn: FunctionSnapStartResponseApplyOn? = null, val optimizationStatus: FunctionSnapStartResponseOptimizationStatus? = null)

The function's SnapStart setting.

Link copied to clipboard
data class FunctionTracingConfig(val mode: FunctionTracingConfigMode? = null)

The function's tracing configuration. To sample and record incoming requests, set `Mode` to `Active`.

Link copied to clipboard
data class FunctionVpcConfig(val ipv6AllowedForDualStack: Boolean? = null, val securityGroupIds: List<String>? = null, val subnetIds: List<String>? = null)

The VPC security groups and subnets that are attached to a Lambda function. When you connect a function to a VPC, Lambda creates an elastic network interface for each combination of security group and subnet in the function's VPC configuration. The function can only access resources and the internet through that VPC. For more information, see VPC Settings. When you delete a function, CFN monitors the state of its network interfaces and waits for Lambda to delete them before proceeding. If the VPC is defined in the same stack, the network interfaces need to be deleted by Lambda before CFN can delete the VPC's resources. To monitor network interfaces, CFN needs the `ec2:DescribeNetworkInterfaces` permission. It obtains this from the user or role that modifies the stack. If you don't provide this permission, CFN does not wait for network interfaces to be deleted.

Link copied to clipboard
data class GetAliasResult(val aliasArn: String? = null, val description: String? = null, val functionVersion: String? = null, val provisionedConcurrencyConfig: AliasProvisionedConcurrencyConfiguration? = null, val routingConfig: AliasRoutingConfiguration? = null)
Link copied to clipboard
data class GetCodeSigningConfigResult(val allowedPublishers: CodeSigningConfigAllowedPublishers? = null, val codeSigningConfigArn: String? = null, val codeSigningConfigId: String? = null, val codeSigningPolicies: CodeSigningConfigCodeSigningPolicies? = null, val description: String? = null, val tags: List<Tag>? = null)
Link copied to clipboard
data class GetEventInvokeConfigResult(val destinationConfig: EventInvokeConfigDestinationConfig? = null, val maximumEventAgeInSeconds: Int? = null, val maximumRetryAttempts: Int? = null)
Link copied to clipboard
data class GetEventSourceMappingResult(val batchSize: Int? = null, val bisectBatchOnFunctionError: Boolean? = null, val destinationConfig: EventSourceMappingDestinationConfig? = null, val documentDbEventSourceConfig: EventSourceMappingDocumentDbEventSourceConfig? = null, val enabled: Boolean? = null, val eventSourceMappingArn: String? = null, val filterCriteria: EventSourceMappingFilterCriteria? = null, val functionName: String? = null, val functionResponseTypes: List<EventSourceMappingFunctionResponseTypesItem>? = null, val id: String? = null, val kmsKeyArn: String? = null, val maximumBatchingWindowInSeconds: Int? = null, val maximumRecordAgeInSeconds: Int? = null, val maximumRetryAttempts: Int? = null, val metricsConfig: EventSourceMappingMetricsConfig? = null, val parallelizationFactor: Int? = null, val provisionedPollerConfig: EventSourceMappingProvisionedPollerConfig? = null, val queues: List<String>? = null, val scalingConfig: EventSourceMappingScalingConfig? = null, val sourceAccessConfigurations: List<EventSourceMappingSourceAccessConfiguration>? = null, val tags: List<Tag>? = null, val topics: List<String>? = null, val tumblingWindowInSeconds: Int? = null)
Link copied to clipboard
data class GetFunctionResult(val architectures: List<FunctionArchitecturesItem>? = null, val arn: String? = null, val code: FunctionCode? = null, val codeSigningConfigArn: String? = null, val deadLetterConfig: FunctionDeadLetterConfig? = null, val description: String? = null, val environment: FunctionEnvironment? = null, val ephemeralStorage: FunctionEphemeralStorage? = null, val fileSystemConfigs: List<FunctionFileSystemConfig>? = null, val handler: String? = null, val imageConfig: FunctionImageConfig? = null, val kmsKeyArn: String? = null, val layers: List<String>? = null, val loggingConfig: FunctionLoggingConfig? = null, val memorySize: Int? = null, val recursiveLoop: FunctionRecursiveLoop? = null, val reservedConcurrentExecutions: Int? = null, val role: String? = null, val runtime: String? = null, val runtimeManagementConfig: FunctionRuntimeManagementConfig? = null, val snapStartResponse: FunctionSnapStartResponse? = null, val tags: List<Tag>? = null, val timeout: Int? = null, val tracingConfig: FunctionTracingConfig? = null, val vpcConfig: FunctionVpcConfig? = null)
Link copied to clipboard
data class GetLayerVersionPermissionResult(val id: String? = null)
Link copied to clipboard
data class GetLayerVersionResult(val layerVersionArn: String? = null)
Link copied to clipboard
data class GetPermissionResult(val id: String? = null)
Link copied to clipboard
data class GetUrlResult(val authType: UrlAuthType? = null, val cors: UrlCors? = null, val functionArn: String? = null, val functionUrl: String? = null, val invokeMode: UrlInvokeMode? = null)
Link copied to clipboard
data class GetVersionResult(val functionArn: String? = null, val version: String? = null)
Link copied to clipboard
data class LayerVersionContent(val s3Bucket: String, val s3Key: String, val s3ObjectVersion: String? = null)
Link copied to clipboard
data class UrlCors(val allowCredentials: Boolean? = null, val allowHeaders: List<String>? = null, val allowMethods: List<UrlAllowMethodsItem>? = null, val allowOrigins: List<String>? = null, val exposeHeaders: List<String>? = null, val maxAge: Int? = null)
data class VersionProvisionedConcurrencyConfiguration(val provisionedConcurrentExecutions: Int)

A provisioned concurrency configuration for a function's version.

Link copied to clipboard
data class VersionRuntimePolicy(val runtimeVersionArn: String? = null, val updateRuntimeOn: String)

Runtime Management Config of a function.