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	awscc.stepfunctions.state_machine_aliases

Fields

get (all properties)

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.

list (identifiers only)

Name	Datatype	Description
arn	string	The ARN of the alias.
region	string	AWS region.

For more information, see AWS::StepFunctions::StateMachineAlias.

Methods

Name	Resource	Accessible by	Required Params
create_resource	state_machine_aliases	INSERT	region
delete_resource	state_machine_aliases	DELETE	Identifier, region
update_resource	state_machine_aliases	UPDATE	Identifier, PatchDocument, region
list_resources	state_machine_aliases_list_only	SELECT	region
get_resource	state_machine_aliases	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual state_machine_alias.

SELECT
  region,
  arn,
  name,
  description,
  routing_configuration,
  deployment_preference
FROM awscc.stepfunctions.state_machine_aliases
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ arn }}';

list (identifiers only)

Lists all state_machine_aliases in a region.

SELECT
  region,
  arn
FROM awscc.stepfunctions.state_machine_aliases_list_only
WHERE
  region = '{{ region }}';

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 awscc.stepfunctions.state_machine_aliases (
  Name,
  Description,
  RoutingConfiguration,
  DeploymentPreference,
  region
)
SELECT
  '{{ name }}',
  '{{ description }}',
  '{{ routing_configuration }}',
  '{{ deployment_preference }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.stepfunctions.state_machine_aliases (
  Name,
  Description,
  RoutingConfiguration,
  DeploymentPreference,
  region
)
SELECT
  '{{ name }}',
  '{{ description }}',
  '{{ routing_configuration }}',
  '{{ deployment_preference }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

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: routing_configuration
      value:
        - state_machine_version_arn: '{{ state_machine_version_arn }}'
          weight: '{{ weight }}'
    - name: deployment_preference
      value:
        state_machine_version_arn: '{{ state_machine_version_arn }}'
        type: '{{ type }}'
        percentage: '{{ percentage }}'
        interval: '{{ interval }}'
        alarms:
          - '{{ alarms[0] }}'

UPDATE example

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

/*+ update */
UPDATE awscc.stepfunctions.state_machine_aliases
SET PatchDocument = string('{{ {
    "Description": description,
    "RoutingConfiguration": routing_configuration,
    "DeploymentPreference": deployment_preference
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ arn }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.stepfunctions.state_machine_aliases
WHERE
  Identifier = '{{ arn }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

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