CfnAlias

java.lang.Object
- 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.CfnAlias

All Implemented Interfaces:: IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-28T21:34:23.202Z")
public class CfnAlias
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Lambda::Alias`.

The AWS::Lambda::Alias resource creates an alias for a Lambda function version. Use aliases to provide clients with a function identifier that you can update to invoke a different version.

You can also map an alias to split invocation requests between two versions. Use the RoutingConfig parameter to specify a second version and the percentage of invocation requests that it receives.

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.*;
 CfnAlias cfnAlias = CfnAlias.Builder.create(this, "MyCfnAlias")
         .functionName("functionName")
         .functionVersion("functionVersion")
         .name("name")
         // the properties below are optional
         .description("description")
         .provisionedConcurrencyConfig(ProvisionedConcurrencyConfigurationProperty.builder()
                 .provisionedConcurrentExecutions(123)
                 .build())
         .routingConfig(AliasRoutingConfigurationProperty.builder()
                 .additionalVersionWeights(List.of(VersionWeightProperty.builder()
                         .functionVersion("functionVersion")
                         .functionWeight(123)
                         .build()))
                 .build())
         .build();

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`CfnAlias.AliasRoutingConfigurationProperty` The [traffic-shifting](https://docs.aws.amazon.com/lambda/latest/dg/lambda-traffic-shifting-using-aliases.html) configuration of a Lambda function alias.
`static class`	`CfnAlias.Builder` A fluent builder for `CfnAlias`.
`static interface`	`CfnAlias.ProvisionedConcurrencyConfigurationProperty` A provisioned concurrency configuration for a function's alias.
`static interface`	`CfnAlias.VersionWeightProperty` The [traffic-shifting](https://docs.aws.amazon.com/lambda/latest/dg/lambda-traffic-shifting-using-aliases.html) configuration of a Lambda function alias.

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct
IConstruct.Jsii$Default

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.

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

Constructor Summary

Constructors
Modifier	Constructor and Description
	`CfnAlias(Construct scope, java.lang.String id, CfnAliasProps props)` Create a new `AWS::Lambda::Alias`.
`protected`	`CfnAlias(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)`
`protected`	`CfnAlias(software.amazon.jsii.JsiiObjectRef objRef)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected java.util.Map<java.lang.String,java.lang.Object>`	`getCfnProperties()`
`java.lang.String`	`getDescription()` A description of the alias.
`java.lang.String`	`getFunctionName()` The name of the Lambda function.
`java.lang.String`	`getFunctionVersion()` The function version that the alias invokes.
`java.lang.String`	`getName()` The name of the alias.
`java.lang.Object`	`getProvisionedConcurrencyConfig()` Specifies a [provisioned concurrency](https://docs.aws.amazon.com/lambda/latest/dg/configuration-concurrency.html) configuration for a function's alias.
`java.lang.Object`	`getRoutingConfig()` The [routing configuration](https://docs.aws.amazon.com/lambda/latest/dg/lambda-traffic-shifting-using-aliases.html) of the alias.
`void`	`inspect(TreeInspector inspector)` Examines the CloudFormation resource and discloses attributes.
`protected java.util.Map<java.lang.String,java.lang.Object>`	`renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)`
`void`	`setDescription(java.lang.String value)` A description of the alias.
`void`	`setFunctionName(java.lang.String value)` The name of the Lambda function.
`void`	`setFunctionVersion(java.lang.String value)` The function version that the alias invokes.
`void`	`setName(java.lang.String value)` The name of the alias.
`void`	`setProvisionedConcurrencyConfig(CfnAlias.ProvisionedConcurrencyConfigurationProperty value)` Specifies a [provisioned concurrency](https://docs.aws.amazon.com/lambda/latest/dg/configuration-concurrency.html) configuration for a function's alias.
`void`	`setProvisionedConcurrencyConfig(IResolvable value)` Specifies a [provisioned concurrency](https://docs.aws.amazon.com/lambda/latest/dg/configuration-concurrency.html) configuration for a function's alias.
`void`	`setRoutingConfig(CfnAlias.AliasRoutingConfigurationProperty value)` The [routing configuration](https://docs.aws.amazon.com/lambda/latest/dg/lambda-traffic-shifting-using-aliases.html) of the alias.
`void`	`setRoutingConfig(IResolvable value)` The [routing configuration](https://docs.aws.amazon.com/lambda/latest/dg/lambda-traffic-shifting-using-aliases.html) of the alias.

Methods inherited from class software.amazon.awscdk.core.CfnResource
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement
getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - CFN_RESOURCE_TYPE_NAME
```
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
```
    The CloudFormation resource type name for this resource class.
- Constructor Detail
  - CfnAlias
```
protected CfnAlias(software.amazon.jsii.JsiiObjectRef objRef)
```
  - CfnAlias
```
protected CfnAlias(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
```
  - CfnAlias
```
public CfnAlias(Construct scope,
                java.lang.String id,
                CfnAliasProps props)
```
    Create a new `AWS::Lambda::Alias`.
    
    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
```
public void inspect(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
```
protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
```
    Overrides:
    
    renderProperties in class CfnResource
    
    Parameters:
    
    props - This parameter is required.
  - getCfnProperties
```
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
```
    Overrides:
    
    getCfnProperties in class CfnResource
  - getFunctionName
```
public java.lang.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
```
public void setFunctionName(java.lang.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.
  - getFunctionVersion
```
public java.lang.String getFunctionVersion()
```
    The function version that the alias invokes.
  - setFunctionVersion
```
public void setFunctionVersion(java.lang.String value)
```
    The function version that the alias invokes.
  - getName
```
public java.lang.String getName()
```
    The name of the alias.
  - setName
```
public void setName(java.lang.String value)
```
    The name of the alias.
  - getDescription
```
public java.lang.String getDescription()
```
    A description of the alias.
  - setDescription
```
public void setDescription(java.lang.String value)
```
    A description of the alias.
  - getProvisionedConcurrencyConfig
```
public java.lang.Object getProvisionedConcurrencyConfig()
```
    Specifies a [provisioned concurrency](https://docs.aws.amazon.com/lambda/latest/dg/configuration-concurrency.html) configuration for a function's alias.
  - setProvisionedConcurrencyConfig
```
public void setProvisionedConcurrencyConfig(CfnAlias.ProvisionedConcurrencyConfigurationProperty value)
```
    Specifies a [provisioned concurrency](https://docs.aws.amazon.com/lambda/latest/dg/configuration-concurrency.html) configuration for a function's alias.
  - setProvisionedConcurrencyConfig
```
public void setProvisionedConcurrencyConfig(IResolvable value)
```
    Specifies a [provisioned concurrency](https://docs.aws.amazon.com/lambda/latest/dg/configuration-concurrency.html) configuration for a function's alias.
  - getRoutingConfig
```
public java.lang.Object getRoutingConfig()
```
    The [routing configuration](https://docs.aws.amazon.com/lambda/latest/dg/lambda-traffic-shifting-using-aliases.html) of the alias.
  - setRoutingConfig
```
public void setRoutingConfig(IResolvable value)
```
    The [routing configuration](https://docs.aws.amazon.com/lambda/latest/dg/lambda-traffic-shifting-using-aliases.html) of the alias.
  - setRoutingConfig
```
public void setRoutingConfig(CfnAlias.AliasRoutingConfigurationProperty value)
```
    The [routing configuration](https://docs.aws.amazon.com/lambda/latest/dg/lambda-traffic-shifting-using-aliases.html) of the alias.

Class CfnAlias

Nested Class Summary

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

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

Field Summary

Constructor Summary

Method Summary

Methods inherited from class software.amazon.awscdk.core.CfnResource

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

Methods inherited from class software.amazon.awscdk.core.CfnElement

Methods inherited from class software.amazon.awscdk.core.Construct

Methods inherited from class java.lang.Object

Field Detail

CFN_RESOURCE_TYPE_NAME

Constructor Detail

CfnAlias

CfnAlias

CfnAlias

Method Detail

inspect

renderProperties

getCfnProperties

getFunctionName

setFunctionName

getFunctionVersion

setFunctionVersion

getName

setName

getDescription

setDescription

getProvisionedConcurrencyConfig

setProvisionedConcurrencyConfig

setProvisionedConcurrencyConfig

getRoutingConfig

setRoutingConfig

setRoutingConfig