Aliases de máquina de estado

Um alias é um ponteiro para até duas versões da mesma máquina de estado. Você pode criar vários aliases para as máquinas de estado. Cada alias tem um nome do recurso da Amazon (ARN) exclusivo. O ARN do alias é uma combinação do ARN da máquina de estado e do nome do alias, separados por dois pontos (:). O exemplo a seguir mostra o formato de um ARN do alias de uma máquina de estado.

arn:partition:states:region:account-id:stateMachine:myStateMachine:aliasName

Você pode usar um alias para rotear o tráfego entre uma das duas versões da máquina de estado. Você também pode criar um alias que direcione para uma única versão. Os aliases só podem direcionar para versões de máquinas de estado. Você não pode usar um alias para direcionar para outro alias. O alias pode ser atualizado para direcionar para uma versão diferente da máquina de estado.

Como criar um alias de máquina de estado (Console)

Você pode criar até 100 aliases para cada máquina de estado usando o console Step Functions ou invocando a ação da CreateStateMachineAliasAPI. Para solicitar um aumento desse limite flexível, use a página Support Center no AWS Management Console. Exclua aliases não utilizados do console ou invocando a ação da DeleteStateMachineAliasAPI.

Para criar um alias de máquina de estado:

1. Abra o console do Step Functions e escolha uma máquina de estado.

2. Na página Detalhes da máquina de estado, escolha a guia Aliases.

3. Escolha Criar novo alias.

4. Na página Create alias (Criar alias), faça o seguinte:

   1. Insira um Nome do alias.

   2. (Opcional) Insira uma Description (Descrição) do alias.

5. Para configurar o roteamento no alias, consulte Configuração de roteamento de alias.

6. Escolha Criar alias.

Como gerenciar aliases com operações da API do Step Functions

O Step Functions fornece as seguintes operações de API que você pode usar para criar e gerenciar aliases de máquinas de estado ou obter informações sobre os aliases:

• CreateStateMachineAlias— Cria um alias para uma máquina de estado.

• DescribeStateMachineAlias— Retorna detalhes sobre um alias de máquina de estado.

• ListStateMachineAliases— Lista aliases para o ARN da máquina de estado especificada.

• UpdateStateMachineAlias— Atualiza a configuração de um alias de máquina de estado existente modificando seu description ou. routingConfiguration

• DeleteStateMachineAlias— Exclui uma versão da máquina de estado.

Para criar um alias chamado PROD que aponte para a versão 1 de uma máquina de estado chamada myStateMachine usando o AWS Command Line Interface, use o create-state-machine-alias comando.

aws stepfunctions create-state-machine-alias --name PROD  --routing-configuration "[{\"stateMachineVersionArn\":\"arn:aws:states:us-east-1:123456789012:stateMachine:myStateMachine:1\",\"weight\":100}]"

Configuração de roteamento de alias

Você pode usar um alias para rotear o tráfego entre duas versões de uma máquina de estado. Por exemplo, digamos que você queira lançar uma nova versão da sua máquina de estado. Você pode reduzir os riscos envolvidos na implantação da nova versão configurando o roteamento em um alias. Ao configurar o roteamento, você pode enviar a maior parte do tráfego para uma versão anterior e testada da sua máquina de estado. A nova versão pode então receber uma porcentagem menor, até que você possa confirmar que é seguro avançar com a nova versão.

Para definir a configuração de roteamento, verifique se publicou as duas versões da máquina de estado para as quais seu alias direciona. Ao iniciar uma execução a partir de um alias, o Step Functions escolhe aleatoriamente a versão da máquina de estado a ser executada a partir das versões especificadas na configuração de roteamento. Ele baseia essa escolha na porcentagem de tráfego que você atribui a cada versão na configuração de roteamento de alias.

Para definir a configuração de roteamento em um alias:

• Na página Criar alias, em Configuração de roteamento, faça o seguinte:

  1. Em Versão, escolha a primeira versão da máquina de estado para a qual o alias direciona.

  2. Marque a caixa de seleção Dividir tráfego entre duas versões.

     dica

     Para direcionar para uma única versão, desmarque a caixa de seleção Dividir tráfego entre duas versões.

  3. Em Versão, escolha a segunda versão para a qual o alias deve direcionar.

  4. Nos campos Porcentagem de tráfego, especifique a porcentagem de tráfego a ser roteada para cada versão. Por exemplo, digite 60 e 40 para rotear 60% do tráfego de execução para a primeira versão e 40% do tráfego para a segunda versão.

     As porcentagens de tráfego combinadas devem ser iguais a 100%.

Como executar uma máquina de estado usando um alias (Console)

Você pode iniciar as execuções da máquina de estado com um alias do console ou invocando a ação da StartExecutionAPI com o ARN do alias. O Step Functions então executa a versão especificada pelo alias. Por padrão, se você não especificar uma versão ou alias ao iniciar a execução de uma máquina de estado, o Step Functions usará a revisão mais recente.

Para iniciar a execução de uma máquina de estado usando um alias:

1. Abra o console Step Functions e, em seguida, escolha uma máquina de estado existente para a qual você criou um alias. Para obter informações sobre como criar um alias, consulte Como criar um alias de máquina de estado (Console).

2. Na página Detalhes da máquina de estado, escolha a guia Aliases.

3. Na seção Aliases, faça o seguinte:

   1. Selecione o alias com o qual você deseja iniciar a execução.

   2. Selecione Iniciar execução.

4. (Opcional) Na caixa de diálogo Iniciar execução, digite um nome para a execução.

5. Se necessário, digite a entrada de execução e escolha Iniciar execução.