Package software.amazon.awscdk.services.lambda

Class CfnVersion

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.lambda.CfnVersion
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:40.682Z") @Stability(Stable) public class CfnVersion extends CfnResource implements IInspectable
A CloudFormation AWS::Lambda::Version.

The AWS::Lambda::Version resource creates a version from the current code and configuration of a function. Use versions to create a snapshot of your function code and configuration that doesn't change.

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.*;
 CfnVersion cfnVersion = CfnVersion.Builder.create(this, "MyCfnVersion")
         .functionName("functionName")
         // the properties below are optional
         .codeSha256("codeSha256")
         .description("description")
         .provisionedConcurrencyConfig(ProvisionedConcurrencyConfigurationProperty.builder()
                 .provisionedConcurrentExecutions(123)
                 .build())
         .build();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnVersion

      protected CfnVersion(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnVersion

      protected CfnVersion(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnVersion

      @Stability(Stable) public CfnVersion(@NotNull Construct scope, @NotNull String id, @NotNull CfnVersionProps props)
      Create a new AWS::Lambda::Version.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.
      This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector -
      • tree inspector to collect and process attributes.
      This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrVersion

      @Stability(Stable) @NotNull public String getAttrVersion()
      The version number.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getFunctionName

      @Stability(Stable) @NotNull public String getFunctionName()
      The name 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.

    • setFunctionName

      @Stability(Stable) public void setFunctionName(@NotNull String value)
      The name 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.

    • getCodeSha256

      @Stability(Stable) @Nullable public 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.

    • setCodeSha256

      @Stability(Stable) public void setCodeSha256(@Nullable String value)
      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.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      A description for the version to override the description in the function configuration.

      Updates are not supported for this property.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      A description for the version to override the description in the function configuration.

      Updates are not supported for this property.

    • getProvisionedConcurrencyConfig

      @Stability(Stable) @Nullable public Object getProvisionedConcurrencyConfig()
      Specifies a provisioned concurrency configuration for a function's version.

      Updates are not supported for this property.

    • setProvisionedConcurrencyConfig

      @Stability(Stable) public void setProvisionedConcurrencyConfig(@Nullable IResolvable value)
      Specifies a provisioned concurrency configuration for a function's version.

      Updates are not supported for this property.

    • setProvisionedConcurrencyConfig

      @Stability(Stable) public void setProvisionedConcurrencyConfig(@Nullable CfnVersion.ProvisionedConcurrencyConfigurationProperty value)
      Specifies a provisioned concurrency configuration for a function's version.

      Updates are not supported for this property.