state_machine_aliases

Creates, updates, deletes or gets a state_machine_alias resource or lists state_machine_aliases in a region

Overview

Name	state_machine_aliases
Type	Resource
Description	Resource schema for StateMachineAlias
Id	aws.stepfunctions.state_machine_aliases

Fields

Name	Datatype	Description
arn	string	The ARN of the alias.
name	string	The alias name.
description	string	An optional description of the alias.
routing_configuration	array	The routing configuration of the alias. One or two versions can be mapped to an alias to split StartExecution requests of the same state machine.
deployment_preference	object	The settings to enable gradual state machine deployments.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all state_machine_aliases in a region.

SELECT
region,
arn,
name,
description,
routing_configuration,
deployment_preference
FROM aws.stepfunctions.state_machine_aliases
WHERE region = 'us-east-1';

Gets all properties from an individual state_machine_alias.

SELECT
region,
arn,
name,
description,
routing_configuration,
deployment_preference
FROM aws.stepfunctions.state_machine_aliases
WHERE region = 'us-east-1' AND data__Identifier = '<Arn>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.stepfunctions.state_machine_aliases (
 Name,
 Description,
 RoutingConfiguration,
 DeploymentPreference,
 region
)
SELECT 
'{{ Name }}',
 '{{ Description }}',
 '{{ RoutingConfiguration }}',
 '{{ DeploymentPreference }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.stepfunctions.state_machine_aliases (
 Name,
 Description,
 RoutingConfiguration,
 DeploymentPreference,
 region
)
SELECT 
 '{{ Name }}',
 '{{ Description }}',
 '{{ RoutingConfiguration }}',
 '{{ DeploymentPreference }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: state_machine_alias
    props:
      - name: Name
        value: '{{ Name }}'
      - name: Description
        value: '{{ Description }}'
      - name: RoutingConfiguration
        value:
          - StateMachineVersionArn: '{{ StateMachineVersionArn }}'
            Weight: '{{ Weight }}'
      - name: DeploymentPreference
        value:
          StateMachineVersionArn: '{{ StateMachineVersionArn }}'
          Type: '{{ Type }}'
          Percentage: '{{ Percentage }}'
          Interval: '{{ Interval }}'
          Alarms:
            - '{{ Alarms[0] }}'

DELETE example

/*+ delete */
DELETE FROM aws.stepfunctions.state_machine_aliases
WHERE data__Identifier = '<Arn>'
AND region = 'us-east-1';

Permissions

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

Create

states:CreateStateMachineAlias,
states:DescribeStateMachineAlias

Read

states:DescribeStateMachineAlias

Update

cloudwatch:DescribeAlarms,
states:UpdateStateMachineAlias,
states:DescribeStateMachineAlias

Delete

states:DescribeStateMachineAlias,
states:DeleteStateMachineAlias

List

states:ListStateMachineAliases