@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)", date="2023-03-28T21:34:23.202Z") public class CfnAlias extends CfnResource implements IInspectable
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();
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.
|
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
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) |
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.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnAlias(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnAlias(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnAlias(Construct scope, java.lang.String id, CfnAliasProps props)
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.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public java.lang.String getFunctionName()
Name formats - Function name - MyFunction
.
arn:aws:lambda:us-west-2:123456789012:function:MyFunction
.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.
public void setFunctionName(java.lang.String value)
Name formats - Function name - MyFunction
.
arn:aws:lambda:us-west-2:123456789012:function:MyFunction
.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.
public java.lang.String getFunctionVersion()
public void setFunctionVersion(java.lang.String value)
public java.lang.String getName()
public void setName(java.lang.String value)
public java.lang.String getDescription()
public void setDescription(java.lang.String value)
public java.lang.Object getProvisionedConcurrencyConfig()
public void setProvisionedConcurrencyConfig(CfnAlias.ProvisionedConcurrencyConfigurationProperty value)
public void setProvisionedConcurrencyConfig(IResolvable value)
public java.lang.Object getRoutingConfig()
public void setRoutingConfig(IResolvable value)
public void setRoutingConfig(CfnAlias.AliasRoutingConfigurationProperty value)