Step Functions ワークフローのステートマシンエイリアス

エイリアスは、同じステートマシンの最大 2 つのバージョンを示すポインタです。ステートマシンには複数のエイリアスを作成できます。各エイリアスには固有の Amazon リソースネーム (ARN) があります。エイリアス ARN は、ステートマシンの ARN とエイリアス名をコロン (:) で区切ったものです。次の例は、ステートマシンのエイリアス ARN の形式を示しています。

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

エイリアスを使用すると、2 つのステートマシンバージョンのいずれかの間でトラフィックをルーティングできます。1 つのバージョンを指すエイリアスを作成することもできます。エイリアスはステートマシンのバージョンのみを指すことができます。エイリアスを使って別のエイリアスを指すことはできません。ステートマシンの別のバージョンを指すよう、エイリアスを更新することもできます。

ステートマシンエイリアスの作成 (コンソール)

Step Functions コンソールを使用するか、CreateStateMachineAlias API アクションを呼び出すと、ステートマシンごとに最大 100 個のエイリアスを作成できます。このソフトリミットの引き上げをリクエストするには、AWS Management Console の [サポートセンター] ページを使用してください。未使用のエイリアスをコンソールから削除するか、DeleteStateMachineAlias API アクションを呼び出してください。

ステートマシンエイリアスを作成するには

1. Step Functions コンソールを開き、既存のステートマシンを選択します。

2. [ステートマシンの詳細]」ページで [エイリアス] タブを選択します。

3. [新しいエイリアスの作成] を選択します。

4. [Create alias (エイリアスの作成)] ページで、以下の操作を行います。

   1. [エイリアス名] を入力します。

   2. (オプション) [Description (説明)] で、エイリアスの説明を入力します。

5. エイリアスのルーティングを設定するには、「エイリアスのルーティング設定」を参照してください。

6. [エイリアスを作成] を選択します。

Step Functions API 操作によるエイリアスの管理

Step Functions では、ステートマシンエイリアスの作成と管理やエイリアスに関する情報の取得に使用できる、以下の API 操作を使用できます。

• CreateStateMachineAlias - ステートマシンのエイリアスを作成します。

• DescribeStateMachineAlias - ステートマシンエイリアスに関する詳細を返します。

• ListStateMachineAliases - 指定されたステートマシン ARN のエイリアスを一覧表示します。

• UpdateStateMachineAlias - description または routingConfiguration を変更することにより、既存のステートマシンエイリアスの設定を更新します。

• DeleteStateMachineAlias - ステートマシンのバージョンを削除します。

myStateMachine を使用して、 という名前のステートマシンのバージョン 1 PRODを指す という名前のエイリアスを作成するには AWS Command Line Interface、 create-state-machine-alias コマンドを使用します。

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

エイリアスのルーティング設定

エイリアスを使用すると、ステートマシンの 2 つのバージョンの間で実行トラフィックをルーティングできます。例えば、ステートマシンの新しいバージョンを起動するとします。エイリアスにルーティングを設定すると、新しいバージョンのデプロイに伴うリスクを軽減できます。ルーティングを設定すると、ほとんどのトラフィックを以前のテスト済みバージョンのステートマシンに送信できます。これで、新しいバージョンが安全にロールフォワードされることが確認できるまで、新しいバージョンが受け取るトラフィックの割合が少なくなります。

ルーティング設定を定義するには、エイリアスが指すステートマシンの両方のバージョン必ず公開してください。エイリアスから実行を開始すると、Step Functions は、ルーティング設定で指定されたバージョンから実行するステートマシンのバージョンをランダムに選択します。この選択は、エイリアスルーティング設定の各バージョンに割り当てられたトラフィックの割合に基づいて行われます。

エイリアスのルーティング設定を構成するには

• [エイリアスの作成] ページの [ルーティングの設定]」で、次の操作を行います。

  1. [バージョン] では、エイリアスが指す最初のステートマシンのバージョンを選択します。

  2. [2 つのバージョン間でトラフィックを分割します] チェックボックスを選択します。

     ヒント

     1 つのバージョンを指定するには、[2 つのバージョン間でトラフィックを分割します] チェックボックスをオフにします。

  3. [バージョン] では、エイリアスが指す必要のある 2 番目のバージョンを選択します。

  4. [トラフィックの割合] フィールドに、各バージョンにルーティングするトラフィックの割合を指定します。例えば、実行トラフィックの 60 パーセントを最初のバージョンにルーティングして、40 パーセントのトラフィックを 2 番目のバージョンにルーティングするには、60 と 40 を入力します。

     トラフィックの割合の合計は 100% になる必要があります。

エイリアスを使用したステートマシンの実行 (コンソール)

ステートマシンの実行は、コンソールからエイリアスを使用して開始することも、エイリアスの ARN を指定して StartExecution API アクションを呼び出すことによって開始することもできます。次に、Step Functions はエイリアスで指定されたバージョンを実行します。ステートマシンの実行を開始するときにバージョンまたはエイリアスを指定していない場合、Step Functions はデフォルトで最新のリビジョンを使用します。

エイリアスを使用してステートマシンの実行を開始するには

1. Step Functions コンソールを開き、エイリアスを作成した既存のステートマシンを選択します。エイリアスの作成の詳細については、「ステートマシンエイリアスの作成 (コンソール)」を参照してください。

2. [ステートマシンの詳細]」ページで [エイリアス] タブを選択します。

3. [エイリアス] セクションで、次の操作を行います。

   1. 実行の開始に使用するエイリアスを選択します。

   2. [実行のスタート] を選択します。

4. (オプション) [実行を開始] ダイアログボックスで、実行の名前を入力します。

5. 必要に応じて実行の入力を指定し、[実行を開始] を選択します。