Package com.pulumi.aws.lambda
Class Alias
- java.lang.Object
-
- com.pulumi.resources.Resource
-
- com.pulumi.resources.CustomResource
-
- com.pulumi.aws.lambda.Alias
-
public class Alias extends com.pulumi.resources.CustomResourceManages an AWS Lambda Alias. Use this resource to create an alias that points to a specific Lambda function version for traffic management and deployment strategies. For information about Lambda and how to use it, see [What is AWS Lambda?](http://docs.aws.amazon.com/lambda/latest/dg/welcome.html). For information about function aliases, see [CreateAlias](http://docs.aws.amazon.com/lambda/latest/dg/API_CreateAlias.html) and [AliasRoutingConfiguration](https://docs.aws.amazon.com/lambda/latest/dg/API_AliasRoutingConfiguration.html) in the API docs. ## Example Usage ### Basic Alias
### Alias with Traffic Splittingpackage generated_program; import com.pulumi.Context; import com.pulumi.Pulumi; import com.pulumi.core.Output; import com.pulumi.aws.lambda.Alias; import com.pulumi.aws.lambda.AliasArgs; import java.util.ArrayList; import java.util.Arrays; import java.util.Map; import java.io.File; import java.nio.file.Files; import java.nio.file.Paths; public class App { public static void main(String[] args) { Pulumi.run(App::stack); } public static void stack(Context ctx) { var example = new Alias("example", AliasArgs.builder() .name("production") .description("Production environment alias") .functionName(exampleAwsLambdaFunction.arn()) .functionVersion("1") .build()); } }
### Blue-Green Deployment Aliaspackage generated_program; import com.pulumi.Context; import com.pulumi.Pulumi; import com.pulumi.core.Output; import com.pulumi.aws.lambda.Alias; import com.pulumi.aws.lambda.AliasArgs; import com.pulumi.aws.lambda.inputs.AliasRoutingConfigArgs; import java.util.ArrayList; import java.util.Arrays; import java.util.Map; import java.io.File; import java.nio.file.Files; import java.nio.file.Paths; public class App { public static void main(String[] args) { Pulumi.run(App::stack); } public static void stack(Context ctx) { var example = new Alias("example", AliasArgs.builder() .routingConfig(AliasRoutingConfigArgs.builder() .additionalVersionWeights(Map.of("1", 0.1)) .build()) .name("staging") .description("Staging environment with traffic splitting") .functionName(exampleAwsLambdaFunction.functionName()) .functionVersion("2") .build()); } }
### Development Aliaspackage generated_program; import com.pulumi.Context; import com.pulumi.Pulumi; import com.pulumi.core.Output; import com.pulumi.aws.lambda.Alias; import com.pulumi.aws.lambda.AliasArgs; import com.pulumi.aws.lambda.inputs.AliasRoutingConfigArgs; import java.util.ArrayList; import java.util.Arrays; import java.util.Map; import java.io.File; import java.nio.file.Files; import java.nio.file.Paths; public class App { public static void main(String[] args) { Pulumi.run(App::stack); } public static void stack(Context ctx) { // Alias for gradual rollout var example = new Alias("example", AliasArgs.builder() .routingConfig(AliasRoutingConfigArgs.builder() .additionalVersionWeights(Map.of("6", 0.05)) .build()) .name("live") .description("Live traffic with gradual rollout to new version") .functionName(exampleAwsLambdaFunction.functionName()) .functionVersion("5") .build()); } }
## Import ### Identity Schema #### Required * `functionName` (String) Name or ARN of the Lambda function. * `name` (String) Name of the alias. #### Optional * `accountId` (String) AWS Account where this resource is managed. * `region` (String) Region where this resource is managed. Using `pulumi import`, import Lambda Function Aliases using `function_name/alias`. For example: ```sh $ pulumi import aws:lambda/alias:Alias example example-function/production ```package generated_program; import com.pulumi.Context; import com.pulumi.Pulumi; import com.pulumi.core.Output; import com.pulumi.aws.lambda.Alias; import com.pulumi.aws.lambda.AliasArgs; import java.util.ArrayList; import java.util.Arrays; import java.util.Map; import java.io.File; import java.nio.file.Files; import java.nio.file.Paths; public class App { public static void main(String[] args) { Pulumi.run(App::stack); } public static void stack(Context ctx) { var example = new Alias("example", AliasArgs.builder() .name("dev") .description("Development environment - always points to latest") .functionName(exampleAwsLambdaFunction.functionName()) .functionVersion("$LATEST") .build()); } }
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description com.pulumi.core.Output<java.lang.String>arn()com.pulumi.core.Output<java.util.Optional<java.lang.String>>description()com.pulumi.core.Output<java.lang.String>functionName()com.pulumi.core.Output<java.lang.String>functionVersion()static Aliasget(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, AliasState state, com.pulumi.resources.CustomResourceOptions options)Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.com.pulumi.core.Output<java.lang.String>invokeArn()com.pulumi.core.Output<java.lang.String>name()com.pulumi.core.Output<java.lang.String>region()com.pulumi.core.Output<java.util.Optional<AliasRoutingConfig>>routingConfig()
-
-
-
Constructor Detail
-
Alias
public Alias(java.lang.String name)
- Parameters:
name- The _unique_ name of the resulting resource.
-
Alias
public Alias(java.lang.String name, AliasArgs args)- Parameters:
name- The _unique_ name of the resulting resource.args- The arguments to use to populate this resource's properties.
-
Alias
public Alias(java.lang.String name, AliasArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options)- Parameters:
name- The _unique_ name of the resulting resource.args- The arguments to use to populate this resource's properties.options- A bag of options that control this resource's behavior.
-
-
Method Detail
-
arn
public com.pulumi.core.Output<java.lang.String> arn()
- Returns:
- ARN identifying your Lambda function alias.
-
description
public com.pulumi.core.Output<java.util.Optional<java.lang.String>> description()
- Returns:
- Description of the alias.
-
functionName
public com.pulumi.core.Output<java.lang.String> functionName()
- Returns:
- Name or ARN of the Lambda function.
-
functionVersion
public com.pulumi.core.Output<java.lang.String> functionVersion()
- Returns:
- Lambda function version for which you are creating the alias. Pattern: `(\$LATEST|[0-9]+)`.
-
invokeArn
public com.pulumi.core.Output<java.lang.String> invokeArn()
- Returns:
- ARN to be used for invoking Lambda Function from API Gateway - to be used in `aws.apigateway.Integration`'s `uri`.
-
name
public com.pulumi.core.Output<java.lang.String> name()
- Returns:
- Name for the alias. Pattern: `(?!^[0-9]+$)([a-zA-Z0-9-_]+)`. The following arguments are optional:
-
region
public com.pulumi.core.Output<java.lang.String> region()
- Returns:
- Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
-
routingConfig
public com.pulumi.core.Output<java.util.Optional<AliasRoutingConfig>> routingConfig()
- Returns:
- Lambda alias' route configuration settings. See below.
-
get
public static Alias get(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, @Nullable AliasState state, @Nullable com.pulumi.resources.CustomResourceOptions options)
Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.- Parameters:
name- The _unique_ name of the resulting resource.id- The _unique_ provider ID of the resource to lookup.state-options- Optional settings to control the behavior of the CustomResource.
-
-