aliases

Creates, updates, deletes or gets an alias resource or lists aliases in a region

Overview

Name	aliases
Type	Resource
Description	Resource Type definition for AWS::Lambda::Alias
Id	awscc.lambda.aliases

Fields

get (all properties)

Name	Datatype	Description
function_name	string	The name of the Lambda function.
alias_arn	string	Lambda Alias ARN generated by the service.
▶provisioned_concurrency_config	object	Specifies a provisioned concurrency configuration for a function's alias.
description	string	A description of the alias.
function_version	string	The function version that the alias invokes.
▶routing_config	object	The routing configuration of the alias.
name	string	The name of the alias.
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
alias_arn	string	Lambda Alias ARN generated by the service.
region	string	AWS region.

For more information, see AWS::Lambda::Alias.

Methods

Name	Resource	Accessible by	Required Params
create_resource	aliases	INSERT	FunctionName, FunctionVersion, Name, region
delete_resource	aliases	DELETE	Identifier, region
update_resource	aliases	UPDATE	Identifier, PatchDocument, region
list_resources	aliases_list_only	SELECT	region
get_resource	aliases	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual alias.

SELECT
  region,
  function_name,
  alias_arn,
  provisioned_concurrency_config,
  description,
  function_version,
  routing_config,
  name
FROM awscc.lambda.aliases
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ alias_arn }}';

list (identifiers only)

Lists all aliases in a region.

SELECT
  region,
  alias_arn
FROM awscc.lambda.aliases_list_only
WHERE
  region = 'us-east-1';

INSERT example

Use the following StackQL query and manifest file to create a new alias resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO awscc.lambda.aliases (
  FunctionName,
  FunctionVersion,
  Name,
  region
)
SELECT
  '{{ function_name }}',
  '{{ function_version }}',
  '{{ name }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.lambda.aliases (
  FunctionName,
  ProvisionedConcurrencyConfig,
  Description,
  FunctionVersion,
  RoutingConfig,
  Name,
  region
)
SELECT
  '{{ function_name }}',
  '{{ provisioned_concurrency_config }}',
  '{{ description }}',
  '{{ function_version }}',
  '{{ routing_config }}',
  '{{ name }}',
  '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: alias
    props:
      - name: function_name
        value: '{{ function_name }}'
      - name: provisioned_concurrency_config
        value:
          provisioned_concurrent_executions: '{{ provisioned_concurrent_executions }}'
      - name: description
        value: '{{ description }}'
      - name: function_version
        value: '{{ function_version }}'
      - name: routing_config
        value:
          additional_version_weights:
            - function_weight: null
              function_version: '{{ function_version }}'
      - name: name
        value: '{{ name }}'

UPDATE example

Use the following StackQL query and manifest file to update a alias resource, using stack-deploy.

/*+ update */
UPDATE awscc.lambda.aliases
SET PatchDocument = string('{{ {
    "ProvisionedConcurrencyConfig": provisioned_concurrency_config,
    "Description": description,
    "FunctionVersion": function_version,
    "RoutingConfig": routing_config
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ alias_arn }}';

DELETE example

/*+ delete */
DELETE FROM awscc.lambda.aliases
WHERE
  Identifier = '{{ alias_arn }}' AND
  region = 'us-east-1';

Permissions

To operate on the aliases resource, the following permissions are required:

Create

lambda:CreateAlias,
lambda:PutProvisionedConcurrencyConfig,
lambda:GetProvisionedConcurrencyConfig

Read

lambda:GetAlias,
lambda:GetProvisionedConcurrencyConfig

Delete

lambda:DeleteAlias,
lambda:GetAlias

List

lambda:ListAliases

Update

lambda:UpdateAlias,
lambda:GetAlias,
lambda:PutProvisionedConcurrencyConfig,
lambda:DeleteProvisionedConcurrencyConfig,
lambda:GetProvisionedConcurrencyConfig,
codedeploy:CreateDeployment,
codedeploy:GetDeployment,
codedeploy:GetDeploymentGroup,
codedeploy:GetDeploymentConfig,
codedeploy:StopDeployment