software.amazon.awscdk.services.lambda

Class CfnVersion

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.lambda.CfnVersion

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:40.426Z")
 @Stability(value=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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnVersion.Builder A fluent builder for CfnVersion.
static interface	CfnVersion.ProvisionedConcurrencyConfigurationProperty A [provisioned concurrency](https://docs.aws.amazon.com/lambda/latest/dg/configuration-concurrency.html) configuration for a function's version.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnVersion(software.constructs.Construct scope, String id, CfnVersionProps props) Create a new `AWS::Lambda::Version`.
protected	CfnVersion(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnVersion(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrVersion() The version number.
protected Map<String,Object>	getCfnProperties()
String	getCodeSha256() Only publish a version if the hash value matches the value that's specified.
String	getDescription() A description for the version to override the description in the function configuration.
String	getFunctionName() The name of the Lambda function.
Object	getProvisionedConcurrencyConfig() Specifies a provisioned concurrency configuration for a function's version.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setCodeSha256(String value) Only publish a version if the hash value matches the value that's specified.
void	setDescription(String value) A description for the version to override the description in the function configuration.
void	setFunctionName(String value) The name of the Lambda function.
void	setProvisionedConcurrencyConfig(CfnVersion.ProvisionedConcurrencyConfigurationProperty value) Specifies a provisioned concurrency configuration for a function's version.
void	setProvisionedConcurrencyConfig(IResolvable value) Specifies a provisioned concurrency configuration for a function's version.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

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, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnVersion

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

CfnVersion

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

CfnVersion

@Stability(value=Stable)
public CfnVersion(@NotNull
                                           software.constructs.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 Detail

inspect

@Stability(value=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(value=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(value=Stable)
 @NotNull
public String getAttrVersion()

The version number.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getFunctionName

@Stability(value=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(value=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(value=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(value=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(value=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(value=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(value=Stable)
 @Nullable
public Object getProvisionedConcurrencyConfig()

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

Updates are not supported for this property.

setProvisionedConcurrencyConfig

@Stability(value=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.

setProvisionedConcurrencyConfig

@Stability(value=Stable)
public void setProvisionedConcurrencyConfig(@Nullable
                                                                     IResolvable value)

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

Updates are not supported for this property.