Package software.amazon.awscdk.services.lambda

Interface CfnVersionProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnVersionProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-12-17T21:37:33.375Z")
@Stability(Stable)
public interface CfnVersionProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnVersion.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.lambda.*;
 Object policy;
 CfnVersionProps cfnVersionProps = CfnVersionProps.builder()
         .functionName("functionName")
         // the properties below are optional
         .codeSha256("codeSha256")
         .description("description")
         .policy(policy)
         .provisionedConcurrencyConfig(ProvisionedConcurrencyConfigurationProperty.builder()
                 .provisionedConcurrentExecutions(123)
                 .build())
         .runtimePolicy(RuntimePolicyProperty.builder()
                 .updateRuntimeOn("updateRuntimeOn")
                 // the properties below are optional
                 .runtimeVersionArn("runtimeVersionArn")
                 .build())
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-version.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnVersionProps.Builder	A builder for CfnVersionProps
static final class	CfnVersionProps.Jsii$Proxy	An implementation for CfnVersionProps

Method Summary

Modifier and Type	Method	Description
static CfnVersionProps.Builder	builder()
default String	getCodeSha256()	Only publish a version if the hash value matches the value that's specified.
default String	getDescription()	A description for the version to override the description in the function configuration.
String	getFunctionName()	The name or ARN of the Lambda function.
default Object	getPolicy()	The resource policy of your function.
default Object	getProvisionedConcurrencyConfig()	Specifies a provisioned concurrency configuration for a function's version.
default Object	getRuntimePolicy()	Runtime Management Config of a function.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getFunctionName

@Stability(Stable)
@NotNull
String getFunctionName()

The name or ARN of the Lambda function.

Name formats - Function name - MyFunction .

• Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction .
• Partial ARN - 123456789012:function:MyFunction .

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

See Also:

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

getCodeSha256

@Stability(Stable)
@Nullable
default String getCodeSha256()

Only publish a version if the hash value matches the value that's specified.

Use this option to avoid publishing a version if the function code has changed since you last updated it. Updates are not supported for this property.

See Also:

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

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

A description for the version to override the description in the function configuration.

Updates are not supported for this property.

See Also:

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

getPolicy

@Stability(Stable)
@Nullable
default Object getPolicy()

The resource policy of your function.

See Also:

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

getProvisionedConcurrencyConfig

@Stability(Stable)
@Nullable
default Object getProvisionedConcurrencyConfig()

Specifies a provisioned concurrency configuration for a function's version.

Updates are not supported for this property.

See Also:

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

getRuntimePolicy

@Stability(Stable)
@Nullable
default Object getRuntimePolicy()

Runtime Management Config of a function.

See Also:

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

builder

@Stability(Stable)
static CfnVersionProps.Builder builder()

Returns:

a CfnVersionProps.Builder of CfnVersionProps