を使用した App Mesh の例 AWS CLI

次のコード例は、App Mesh AWS Command Line Interface で を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。

アクションはより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。

各例には、完全なソースコードへのリンクが含まれています。ここでは、コンテキストでコードを設定および実行する方法の手順を確認できます。

アクション

create-mesh

次のコード例は、create-mesh を使用する方法を示しています。

AWS CLI

例 1: 新しいサービスメッシュを作成するには

次のcreate-mesh例では、サービスメッシュを作成します。

aws appmesh create-mesh \
    --mesh-name app1

出力:

{
    "mesh":{
        "meshName":"app1",
        "metadata":{
            "arn":"arn:aws:appmesh:us-east-1:123456789012:mesh/app1",
            "createdAt":1563809909.282,
            "lastUpdatedAt":1563809909.282,
            "uid":"a1b2c3d4-5678-90ab-cdef-11111EXAMPLE",
            "version":1
        },
        "spec":{},
        "status":{
            "status":"ACTIVE"
        }
    }
}

例 2: 複数のタグで新しいサービスメッシュを作成するには

次のcreate-mesh例では、複数のタグを持つサービスメッシュを作成します。

aws appmesh create-mesh \
    --mesh-name app2 \
    --tags key=key1,value=value1 key=key2,value=value2 key=key3,value=value3

出力:

{
    "mesh":{
        "meshName":"app2",
        "metadata":{
            "arn":"arn:aws:appmesh:us-east-1:123456789012:mesh/app2",
            "createdAt":1563822121.877,
            "lastUpdatedAt":1563822121.877,
            "uid":"a1b2c3d4-5678-90ab-cdef-11111EXAMPLE",
            "version":1
        },
        "spec":{},
        "status":{
            "status":"ACTIVE"
        }
    }
}

詳細については、App Mesh ユーザーガイドの「Service MeshesAWS 」を参照してください。

• API 詳細については、AWS CLI 「 コマンドリファレンスCreateMesh」の「」を参照してください。

create-route

次のコード例は、create-route を使用する方法を示しています。

AWS CLI

新しい gRPC ルートを作成するには

次のcreate-route例では、JSON入力ファイルを使用して gRPC ルートを作成します。GRPC 123 で始まるメタデータを持つトラフィックは、 という名前の仮想ノードにルーティングされますserviceBgrpc。ルートのターゲットと通信しようとするときに特定の g RPC、HTTP、または のTCP障害が発生した場合、ルートは 3 回再試行されます。再試行のたびに 15 秒の遅延が発生します。

aws appmesh create-route \
    --cli-input-json file://create-route-grpc.json

create-route-grpc.json の内容:

{
    "meshName" : "apps",
    "routeName" : "grpcRoute",
    "spec" : {
       "grpcRoute" : {
          "action" : {
             "weightedTargets" : [
                {
                   "virtualNode" : "serviceBgrpc",
                   "weight" : 100
                }
             ]
          },
          "match" : {
             "metadata" : [
                {
                   "invert" : false,
                   "match" : {
                      "prefix" : "123"
                   },
                   "name" : "myMetadata"
                }
             ],
             "methodName" : "GetColor",
             "serviceName" : "com.amazonaws.services.ColorService"
          },
          "retryPolicy" : {
             "grpcRetryEvents" : [ "deadline-exceeded" ],
             "httpRetryEvents" : [ "server-error", "gateway-error" ],
             "maxRetries" : 3,
             "perRetryTimeout" : {
                "unit" : "s",
                "value" : 15
             },
             "tcpRetryEvents" : [ "connection-error" ]
          }
       },
       "priority" : 100
    },
    "virtualRouterName" : "serviceBgrpc"
}

出力:

{
    "route": {
        "meshName": "apps",
        "metadata": {
            "arn": "arn:aws:appmesh:us-west-2:123456789012:mesh/apps/virtualRouter/serviceBgrpc/route/grpcRoute",
            "createdAt": 1572010806.008,
            "lastUpdatedAt": 1572010806.008,
            "uid": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE",
            "version": 1
        },
        "routeName": "grpcRoute",
        "spec": {
            "grpcRoute": {
                "action": {
                    "weightedTargets": [
                        {
                            "virtualNode": "serviceBgrpc",
                            "weight": 100
                        }
                    ]
                },
                "match": {
                    "metadata": [
                        {
                            "invert": false,
                            "match": {
                                "prefix": "123"
                            },
                            "name": "mymetadata"
                        }
                    ],
                    "methodName": "GetColor",
                    "serviceName": "com.amazonaws.services.ColorService"
                },
                "retryPolicy": {
                    "grpcRetryEvents": [
                        "deadline-exceeded"
                    ],
                    "httpRetryEvents": [
                        "server-error",
                        "gateway-error"
                    ],
                    "maxRetries": 3,
                    "perRetryTimeout": {
                        "unit": "s",
                        "value": 15
                    },
                    "tcpRetryEvents": [
                        "connection-error"
                    ]
                }
            },
            "priority": 100
        },
        "status": {
            "status": "ACTIVE"
        },
        "virtualRouterName": "serviceBgrpc"
    }
}

新しいルートHTTPまたは HTTP/2 ルートを作成するには

次のcreate-route例では、JSON入力ファイルを使用して HTTP/2 ルートを作成します。HTTP ルートを作成するには、http2Route を httpRoute under spec に置き換えます。123 で始まるヘッダー値を持つURLプレフィックス宛てのすべての HTTP/2 トラフィックは、serviceBhttp2 という名前の仮想ノードにルーティングされます。ルートのターゲットと通信しようとするときに特定の HTTPまたは にTCP障害が発生した場合、ルートは 3 回再試行されます。再試行のたびに 15 秒の遅延が発生します。

aws appmesh create-route \
    --cli-input-json file://create-route-http2.json

create-route-http2.json の内容:

{
    "meshName": "apps",
    "routeName": "http2Route",
    "spec": {
        "http2Route": {
            "action": {
                "weightedTargets": [
                    {
                        "virtualNode": "serviceBhttp2",
                        "weight": 100
                    }
                ]
            },
            "match": {
                "headers": [
                    {
                        "invert": false,
                        "match": {
                            "prefix": "123"
                        },
                        "name": "clientRequestId"
                    }
                ],
                "method": "POST",
                "prefix": "/",
                "scheme": "http"
            },
            "retryPolicy": {
                "httpRetryEvents": [
                    "server-error",
                    "gateway-error"
                ],
                "maxRetries": 3,
                "perRetryTimeout": {
                    "unit": "s",
                    "value": 15
                },
                "tcpRetryEvents": [
                    "connection-error"
                ]
            }
        },
        "priority": 200
    },
    "virtualRouterName": "serviceBhttp2"
}

出力:

{
    "route": {
        "meshName": "apps",
        "metadata": {
            "arn": "arn:aws:appmesh:us-west-2:123456789012:mesh/apps/virtualRouter/serviceBhttp2/route/http2Route",
            "createdAt": 1572011008.352,
            "lastUpdatedAt": 1572011008.352,
            "uid": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE",
            "version": 1
        },
        "routeName": "http2Route",
        "spec": {
            "http2Route": {
                "action": {
                    "weightedTargets": [
                        {
                            "virtualNode": "serviceBhttp2",
                            "weight": 100
                        }
                    ]
                },
                "match": {
                    "headers": [
                        {
                            "invert": false,
                            "match": {
                                "prefix": "123"
                            },
                            "name": "clientRequestId"
                        }
                    ],
                    "method": "POST",
                    "prefix": "/",
                    "scheme": "http"
                },
                "retryPolicy": {
                    "httpRetryEvents": [
                        "server-error",
                        "gateway-error"
                    ],
                    "maxRetries": 3,
                    "perRetryTimeout": {
                        "unit": "s",
                        "value": 15
                    },
                    "tcpRetryEvents": [
                        "connection-error"
                    ]
                }
            },
            "priority": 200
        },
        "status": {
            "status": "ACTIVE"
        },
        "virtualRouterName": "serviceBhttp2"
    }
}

新しいTCPルートを作成するには

次のcreate-route例では、JSON入力ファイルを使用してTCPルートを作成します。トラフィックの 75% は という名前の仮想ノードにルーティングされserviceBtcp、トラフィックの 25% は serviceBv2tcp という名前の仮想ノードにルーティングされます。ターゲットごとに異なる重みを指定すると、アプリケーションの新しいバージョンのデプロイを効果的に行うことができます。重みを調整して、最終的にすべてのトラフィックの 100% がアプリケーションの新しいバージョンを持つターゲットにルーティングされるようにできます。

aws appmesh create-route \
    --cli-input-json file://create-route-tcp.json

create-route-tcp.json の内容：

{
    "meshName": "apps",
    "routeName": "tcpRoute",
    "spec": {
        "priority": 300,
        "tcpRoute": {
            "action": {
                "weightedTargets": [
                    {
                        "virtualNode": "serviceBtcp",
                        "weight": 75
                    },
                    {
                        "virtualNode": "serviceBv2tcp",
                        "weight": 25
                    }
                ]
            }
        }
    },
    "virtualRouterName": "serviceBtcp"
}

出力:

{
    "route": {
        "meshName": "apps",
        "metadata": {
            "arn": "arn:aws:appmesh:us-west-2:123456789012:mesh/apps/virtualRouter/serviceBtcp/route/tcpRoute",
            "createdAt": 1572011436.26,
            "lastUpdatedAt": 1572011436.26,
            "uid": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE",
            "version": 1
        },
        "routeName": "tcpRoute",
        "spec": {
            "priority": 300,
            "tcpRoute": {
                "action": {
                    "weightedTargets": [
                        {
                            "virtualNode": "serviceBtcp",
                            "weight": 75
                        },
                        {
                            "virtualNode": "serviceBv2tcp",
                            "weight": 25
                        }
                    ]
                }
            }
        },
        "status": {
            "status": "ACTIVE"
        },
        "virtualRouterName": "serviceBtcp"
    }
}

詳細については、AWS 「App Mesh ユーザーガイド」の「ルート」を参照してください。

• API 詳細については、AWS CLI 「 コマンドリファレンスCreateRoute」の「」を参照してください。

create-virtual-gateway

次のコード例は、create-virtual-gateway を使用する方法を示しています。

AWS CLI

新しい仮想ゲートウェイを作成するには

次のcreate-virtual-gateway例では、JSON入力ファイルを使用して、ポート 9080 HTTPを使用するリスナーを持つ仮想ゲートウェイを作成します。

aws appmesh create-virtual-gateway \
    --mesh-name meshName \
    --virtual-gateway-name virtualGatewayName \
    --cli-input-json file://create-virtual-gateway.json

create-virtual-gateway.json の内容:

{
    "spec": {
      "listeners": [
        {
          "portMapping": {
            "port": 9080,
            "protocol": "http"
          }
        }
      ]
    }
}

出力:

{
    "virtualGateway": {
        "meshName": "meshName",
        "metadata": {
            "arn": "arn:aws:appmesh:us-west-2:123456789012:mesh/meshName/virtualGateway/virtualGatewayName",
            "createdAt": "2022-04-06T10:42:42.015000-05:00",
            "lastUpdatedAt": "2022-04-06T10:42:42.015000-05:00",
            "meshOwner": "123456789012",
            "resourceOwner": "123456789012",
            "uid": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE",
            "version": 1
        },
        "spec": {
            "listeners": [
                {
                    "portMapping": {
                        "port": 9080,
                        "protocol": "http"
                    }
                }
            ]
        },
        "status": {
            "status": "ACTIVE"
        },
        "virtualGatewayName": "virtualGatewayName"
    }
}

詳細については、AWS App Mesh ユーザーガイドの「仮想ゲートウェイ」を参照してください。

• API 詳細については、AWS CLI 「 コマンドリファレンスCreateVirtualGateway」の「」を参照してください。

create-virtual-node

次の例は、create-virtual-node を使用する方法を説明しています。

AWS CLI

例 1: 検出DNSに を使用する新しい仮想ノードを作成するには

次のcreate-virtual-node例では、JSON入力ファイルを使用して、 がサービス検出DNSに使用する仮想ノードを作成します。

aws appmesh create-virtual-node \
    --cli-input-json file://create-virtual-node-dns.json

create-virtual-node-dns.json の内容:

{
    "meshName": "app1",
    "spec": {
        "listeners": [
            {
                "portMapping": {
                    "port": 80,
                    "protocol": "http"
                }
            }
        ],
        "serviceDiscovery": {
            "dns": {
                "hostname": "serviceBv1.svc.cluster.local"
            }
        }
    },
    "virtualNodeName": "vnServiceBv1"
}

出力:

{
    "virtualNode": {
        "meshName": "app1",
        "metadata": {
            "arn": "arn:aws:appmesh:us-east-1:123456789012:mesh/app1/virtualNode/vnServiceBv1",
            "createdAt": 1563810019.874,
            "lastUpdatedAt": 1563810019.874,
            "uid": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE",
            "version": 1
        },
        "spec": {
            "listeners": [
                {
                    "portMapping": {
                        "port": 80,
                        "protocol": "http"
                    }
                }
            ],
            "serviceDiscovery": {
                "dns": {
                    "hostname": "serviceBv1.svc.cluster.local"
                }
            }
        },
        "status": {
            "status": "ACTIVE"
        },
        "virtualNodeName": "vnServiceBv1"
    }
}

例 2: 検出に AWS Cloud Map を使用する新しい仮想ノードを作成するには

次のcreate-virtual-node例では、JSON入力ファイルを使用して、サービス検出に AWS Cloud Map を使用する仮想ノードを作成します。

aws appmesh create-virtual-node \
    --cli-input-json file://create-virtual-node-cloud-map.json

create-virtual-node-cloud-map.json の内容:

{
    "meshName": "app1",
    "spec": {
        "backends": [
            {
                "virtualService": {
                    "virtualServiceName": "serviceA.svc.cluster.local"
                }
            }
        ],
        "listeners": [
            {
                "portMapping": {
                    "port": 80,
                    "protocol": "http"
                }
            }
        ],
        "serviceDiscovery": {
            "awsCloudMap": {
                "attributes": [
                    {
                        "key": "Environment",
                        "value": "Testing"
                    }
                ],
                "namespaceName": "namespace1",
                "serviceName": "serviceA"
            }
        }
    },
    "virtualNodeName": "vnServiceA"
}

出力:

{
    "virtualNode": {
        "meshName": "app1",
        "metadata": {
            "arn": "arn:aws:appmesh:us-east-1:123456789012:mesh/app1/virtualNode/vnServiceA",
            "createdAt": 1563810859.465,
            "lastUpdatedAt": 1563810859.465,
            "uid": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE",
            "version": 1
        },
        "spec": {
            "backends": [
                {
                    "virtualService": {
                        "virtualServiceName": "serviceA.svc.cluster.local"
                    }
                }
            ],
            "listeners": [
                {
                    "portMapping": {
                        "port": 80,
                        "protocol": "http"
                    }
                }
            ],
            "serviceDiscovery": {
                "awsCloudMap": {
                    "attributes": [
                        {
                            "key": "Environment",
                            "value": "Testing"
                        }
                    ],
                    "namespaceName": "namespace1",
                    "serviceName": "serviceA"
                }
            }
        },
        "status": {
            "status": "ACTIVE"
        },
        "virtualNodeName": "vnServiceA"
    }
}

詳細については、AWS App Mesh ユーザーガイドの「仮想ノード」を参照してください。

• API 詳細については、AWS CLI 「 コマンドリファレンスCreateVirtualNode」の「」を参照してください。

create-virtual-router

次のコード例は、create-virtual-router を使用する方法を示しています。

AWS CLI

新しい仮想ルーターを作成するには

次のcreate-virtual-router例では、JSON入力ファイルを使用して、ポート 80 HTTPを使用するリスナーを持つ仮想ルーターを作成します。

aws appmesh create-virtual-router \
    --cli-input-json file://create-virtual-router.json

create-virtual-router.json の内容:

{
    "meshName": "app1",
    "spec": {
        "listeners": [
            {
                "portMapping": {
                    "port": 80,
                    "protocol": "http"
                }
            }
        ]
    },
    "virtualRouterName": "vrServiceB"
}

出力:

{
    "virtualRouter": {
        "meshName": "app1",
        "metadata": {
            "arn": "arn:aws:appmesh:us-east-1:123456789012:mesh/app1/virtualRouter/vrServiceB",
            "createdAt": 1563810546.59,
            "lastUpdatedAt": 1563810546.59,
            "uid": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE",
            "version": 1
        },
        "spec": {
            "listeners": [
                {
                    "portMapping": {
                        "port": 80,
                        "protocol": "http"
                    }
                }
            ]
        },
        "status": {
            "status": "ACTIVE"
        },
        "virtualRouterName": "vrServiceB"
    }
}

詳細については、AWS App Mesh ユーザーガイドの「仮想ルーター」を参照してください。

• API 詳細については、AWS CLI 「 コマンドリファレンスCreateVirtualRouter」の「」を参照してください。

create-virtual-service

次のコード例は、create-virtual-service を使用する方法を示しています。

AWS CLI

例 1: 仮想ノードプロバイダーを使用して新しい仮想サービスを作成するには

次のcreate-virtual-service例では、JSON入力ファイルを使用して、仮想ノードプロバイダーを使用して仮想サービスを作成します。

aws appmesh create-virtual-service \
    --cli-input-json file://create-virtual-service-virtual-node.json

create-virtual-service-virtual-node.json の内容:

{
    "meshName": "app1",
    "spec": {
        "provider": {
            "virtualNode": {
                "virtualNodeName": "vnServiceA"
            }
        }
    },
    "virtualServiceName": "serviceA.svc.cluster.local"
}

出力:

{
    "virtualService": {
        "meshName": "app1",
        "metadata": {
            "arn": "arn:aws:appmesh:us-east-1:123456789012:mesh/app1/virtualService/serviceA.svc.cluster.local",
            "createdAt": 1563810859.474,
            "lastUpdatedAt": 1563810967.179,
            "uid": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE",
            "version": 2
        },
        "spec": {
            "provider": {
                "virtualNode": {
                    "virtualNodeName": "vnServiceA"
                }
            }
        },
        "status": {
            "status": "ACTIVE"
        },
        "virtualServiceName": "serviceA.svc.cluster.local"
    }
}

詳細については、AWS App Mesh ユーザーガイドの「仮想ノード」を参照してください。

例 2: 仮想ルータープロバイダーを使用して新しい仮想サービスを作成するには

次のcreate-virtual-service例では、JSON入力ファイルを使用して、仮想ルータープロバイダーを使用して仮想サービスを作成します。

aws appmesh create-virtual-service \
    --cli-input-json file://create-virtual-service-virtual-router.json

create-virtual-service-virtual-router.json の内容:

{
    "meshName": "app1",
    "spec": {
        "provider": {
            "virtualRouter": {
                "virtualRouterName": "vrServiceB"
            }
        }
    },
    "virtualServiceName": "serviceB.svc.cluster.local"
}

出力:

{
    "virtualService": {
        "meshName": "app1",
        "metadata": {
            "arn": "arn:aws:appmesh:us-east-1:123456789012:mesh/app1/virtualService/serviceB.svc.cluster.local",
            "createdAt": 1563908363.999,
            "lastUpdatedAt": 1563908363.999,
            "uid": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE",
            "version": 1
        },
        "spec": {
            "provider": {
                "virtualRouter": {
                    "virtualRouterName": "vrServiceB"
                }
            }
        },
        "status": {
            "status": "ACTIVE"
        },
        "virtualServiceName": "serviceB.svc.cluster.local"
    }
}

詳細については、AWS App Mesh ユーザーガイドの「Virtual Services<https://docs.aws.amazon.com/app-mesh/latest/userguide/virtual_services.html>」を参照してください。

• API 詳細については、AWS CLI 「 コマンドリファレンスCreateVirtualService」の「」を参照してください。

delete-mesh

次のコード例は、delete-mesh を使用する方法を示しています。

AWS CLI

サービスメッシュを削除するには

次のdelete-mesh例では、指定されたサービスメッシュを削除します。

aws appmesh delete-mesh \
    --mesh-name app1

出力:

{
    "mesh": {
        "meshName": "app1",
        "metadata": {
            "arn": "arn:aws:appmesh:us-east-1:123456789012:mesh/app1",
            "createdAt": 1563809909.282,
            "lastUpdatedAt": 1563824981.248,
            "uid": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE",
            "version": 2
        },
        "spec": {
            "egressFilter": {
                "type": "ALLOW_ALL"
            }
        },
        "status": {
            "status": "DELETED"
        }
    }
}

詳細については、App Mesh ユーザーガイドの「Service AWS Meshes」を参照してください。

• API 詳細については、AWS CLI 「 コマンドリファレンスDeleteMesh」の「」を参照してください。

delete-route

次の例は、delete-route を使用する方法を説明しています。

AWS CLI

ルートを削除するには

次のdelete-route例では、指定されたルートを削除します。

aws appmesh delete-route \
    --mesh-name app1 \
    --virtual-router-name vrServiceB \
    --route-name toVnServiceB-weighted

出力:

{
    "route": {
        "meshName": "app1",
        "metadata": {
            "arn": "arn:aws:appmesh:us-east-1:123456789012:mesh/app1/virtualRouter/vrServiceB/route/toVnServiceB-weighted",
            "createdAt": 1563811384.015,
            "lastUpdatedAt": 1563823915.936,
            "uid": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE",
            "version": 3
        },
        "routeName": "toVnServiceB-weighted",
        "spec": {
            "httpRoute": {
                "action": {
                    "weightedTargets": [
                        {
                            "virtualNode": "vnServiceBv1",
                            "weight": 80
                        },
                        {
                            "virtualNode": "vnServiceBv2",
                            "weight": 20
                        }
                    ]
                },
                "match": {
                    "prefix": "/"
                }
            }
        },
        "status": {
            "status": "DELETED"
        },
        "virtualRouterName": "vrServiceB"
    }
}

詳細については、AWS 「App Mesh ユーザーガイド」の「ルート」を参照してください。

• API 詳細については、AWS CLI 「 コマンドリファレンスDeleteRoute」の「」を参照してください。

delete-virtual-node

次のコード例は、delete-virtual-node を使用する方法を示しています。

AWS CLI

仮想ノードを削除するには

次のdelete-virtual-node例では、指定された仮想ノードを削除します。

aws appmesh delete-virtual-node \
    --mesh-name app1 \
    --virtual-node-name vnServiceBv2

出力:

{
    "virtualNode": {
        "meshName": "app1",
        "metadata": {
            "arn": "arn:aws:appmesh:us-east-1:123456789012:mesh/app1/virtualNode/vnServiceBv2",
            "createdAt": 1563810117.297,
            "lastUpdatedAt": 1563824700.678,
            "uid": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE",
            "version": 2
        },
        "spec": {
            "backends": [],
            "listeners": [
                {
                    "portMapping": {
                        "port": 80,
                        "protocol": "http"
                    }
                }
            ],
            "serviceDiscovery": {
                "dns": {
                    "hostname": "serviceBv2.svc.cluster.local"
                }
            }
        },
        "status": {
            "status": "DELETED"
        },
        "virtualNodeName": "vnServiceBv2"
    }
}

詳細については、AWS App Mesh ユーザーガイドの「仮想ノード」を参照してください。

• API 詳細については、AWS CLI 「 コマンドリファレンスDeleteVirtualNode」の「」を参照してください。

delete-virtual-router

次のコード例は、delete-virtual-router を使用する方法を示しています。

AWS CLI

仮想ルーターを削除するには

次のdelete-virtual-router例では、指定された仮想ルーターを削除します。

aws appmesh delete-virtual-router \
    --mesh-name app1 \
    --virtual-router-name vrServiceB

出力:

{
    "virtualRouter": {
        "meshName": "app1",
        "metadata": {
            "arn": "arn:aws:appmesh:us-east-1:123456789012:mesh/app1/virtualRouter/vrServiceB",
            "createdAt": 1563810546.59,
            "lastUpdatedAt": 1563824253.467,
            "uid": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE",
            "version": 3
        },
        "spec": {
            "listeners": [
                {
                    "portMapping": {
                        "port": 80,
                        "protocol": "http"
                    }
                }
            ]
        },
        "status": {
            "status": "DELETED"
        },
        "virtualRouterName": "vrServiceB"
    }
}

詳細については、AWS App Mesh ユーザーガイドの「仮想ルーター」を参照してください。

• API 詳細については、AWS CLI 「 コマンドリファレンスDeleteVirtualRouter」の「」を参照してください。

delete-virtual-service

次の例は、delete-virtual-service を使用する方法を説明しています。

AWS CLI

仮想サービスを削除するには

次のdelete-virtual-service例では、指定された仮想サービスを削除します。

aws appmesh delete-virtual-service \
    --mesh-name app1 \
    --virtual-service-name serviceB.svc.cluster.local

出力:

{
    "virtualService": {
        "meshName": "app1",
        "metadata": {
            "arn": "arn:aws:appmesh:us-east-1:123456789012:mesh/app1/virtualService/serviceB.svc.cluster.local",
            "createdAt": 1563908363.999,
            "lastUpdatedAt": 1563913940.866,
            "uid": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE",
            "version": 3
        },
        "spec": {},
        "status": {
            "status": "DELETED"
        },
        "virtualServiceName": "serviceB.svc.cluster.local"
    }
}

詳細については、AWS App Mesh ユーザーガイドの「仮想サービス」を参照してください。

• API 詳細については、AWS CLI 「 コマンドリファレンスDeleteVirtualService」の「」を参照してください。

describe-mesh

次の例は、describe-mesh を使用する方法を説明しています。

AWS CLI

サービスメッシュを記述するには

次のdescribe-mesh例では、指定されたサービスメッシュの詳細を返します。

aws appmesh describe-mesh \
    --mesh-name app1

出力:

{
    "mesh": {
        "meshName": "app1",
        "metadata": {
            "arn": "arn:aws:appmesh:us-east-1:123456789012:mesh/app1",
            "createdAt": 1563809909.282,
            "lastUpdatedAt": 1563809909.282,
            "uid": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE",
            "version": 1
        },
        "spec": {},
        "status": {
            "status": "ACTIVE"
        }
    }
}

詳細については、App Mesh ユーザーガイドの「Service AWS Meshes」を参照してください。

• API 詳細については、AWS CLI 「 コマンドリファレンスDescribeMesh」の「」を参照してください。

describe-route

次のコード例は、describe-route を使用する方法を示しています。

AWS CLI

ルートを記述するには

次のdescribe-route例では、指定されたルートに関する詳細を返します。

aws appmesh describe-route \
    --mesh-name app1 \
    --virtual-router-name vrServiceB \
    --route-name toVnServiceB-weighted

出力:

{
    "route": {
        "meshName": "app1",
        "metadata": {
            "arn": "arn:aws:appmesh:us-east-1:123456789012:mesh/app1/virtualRouter/vrServiceB/route/toVnServiceB-weighted",
            "createdAt": 1563811384.015,
            "lastUpdatedAt": 1563811384.015,
            "uid": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE",
            "version": 1
        },
        "routeName": "toVnServiceB-weighted",
        "spec": {
            "httpRoute": {
                "action": {
                    "weightedTargets": [
                        {
                            "virtualNode": "vnServiceBv1",
                            "weight": 90
                        },
                        {
                            "virtualNode": "vnServiceBv2",
                            "weight": 10
                        }
                    ]
                },
                "match": {
                    "prefix": "/"
                }
            }
        },
        "status": {
            "status": "ACTIVE"
        },
        "virtualRouterName": "vrServiceB"
    }
}

詳細については、AWS 「App Mesh ユーザーガイド」の「ルート」を参照してください。

• API 詳細については、AWS CLI 「 コマンドリファレンスDescribeRoute」の「」を参照してください。

describe-virtual-node

次のコード例は、describe-virtual-node を使用する方法を示しています。

AWS CLI

仮想ノードを記述するには

次のdescribe-virtual-node例では、指定された仮想ノードに関する詳細を返します。

aws appmesh describe-virtual-node \
    --mesh-name app1 \
    --virtual-node-name vnServiceBv1

出力:

{
    "virtualNode": {
        "meshName": "app1",
        "metadata": {
            "arn": "arn:aws:appmesh:us-east-1:123456789012:mesh/app1/virtualNode/vnServiceBv1",
            "createdAt": 1563810019.874,
            "lastUpdatedAt": 1563810019.874,
            "uid": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE",
            "version": 1
        },
        "spec": {
            "backends": [],
            "listeners": [
                {
                    "portMapping": {
                        "port": 80,
                        "protocol": "http"
                    }
                }
            ],
            "serviceDiscovery": {
                "dns": {
                    "hostname": "serviceBv1.svc.cluster.local"
                }
            }
        },
        "status": {
            "status": "ACTIVE"
        },
        "virtualNodeName": "vnServiceBv1"
    }
}

詳細については、AWS App Mesh ユーザーガイドの「仮想ノード」を参照してください。

• API 詳細については、AWS CLI 「 コマンドリファレンスDescribeVirtualNode」の「」を参照してください。

describe-virtual-router

次のコード例は、describe-virtual-router を使用する方法を示しています。

AWS CLI

仮想ルーターを記述するには

次のdescribe-virtual-router例では、指定された仮想ルーターの詳細を返します。

aws appmesh describe-virtual-router \
    --mesh-name app1 \
    --virtual-router-name vrServiceB

出力:

{
    "virtualRouter": {
        "meshName": "app1",
        "metadata": {
            "arn": "arn:aws:appmesh:us-east-1:123456789012:mesh/app1/virtualRouter/vrServiceB",
            "createdAt": 1563810546.59,
            "lastUpdatedAt": 1563810546.59,
            "uid": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE",
            "version": 1
        },
        "spec": {
            "listeners": [
                {
                    "portMapping": {
                        "port": 80,
                        "protocol": "http"
                    }
                }
            ]
        },
        "status": {
            "status": "ACTIVE"
        },
        "virtualRouterName": "vrServiceB"
    }
}

詳細については、AWS App Mesh ユーザーガイドの「仮想ルーター」を参照してください。

• API 詳細については、AWS CLI 「 コマンドリファレンスDescribeVirtualRouter」の「」を参照してください。

describe-virtual-service

次の例は、describe-virtual-service を使用する方法を説明しています。

AWS CLI

仮想サービスを記述するには

次のdescribe-virtual-service例では、指定された仮想サービスの詳細を返します。

aws appmesh describe-virtual-service \
    --mesh-name app1 \
    --virtual-service-name serviceB.svc.cluster.local

出力:

{
    "virtualService": {
        "meshName": "app1",
        "metadata": {
            "arn": "arn:aws:appmesh:us-east-1:123456789012:mesh/app1/virtualService/serviceB.svc.cluster.local",
            "createdAt": 1563908363.999,
            "lastUpdatedAt": 1563908363.999,
            "uid": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE",
            "version": 1
        },
        "spec": {
            "provider": {
                "virtualRouter": {
                    "virtualRouterName": "vrServiceB"
                }
            }
        },
        "status": {
            "status": "ACTIVE"
        },
        "virtualServiceName": "serviceB.svc.cluster.local"
    }
}

詳細については、AWS App Mesh ユーザーガイドの「仮想サービス」を参照してください。

• API 詳細については、AWS CLI 「 コマンドリファレンスDescribeVirtualService」の「」を参照してください。

list-meshes

次のコード例は、list-meshes を使用する方法を示しています。

AWS CLI

サービスメッシュを一覧表示するには

次のlist-meshes例では、現在の AWS リージョンのすべてのサービスメッシュを一覧表示します。

aws appmesh list-meshes

出力:

{
    "meshes": [
        {
            "arn": "arn:aws:appmesh:us-east-1:123456789012:mesh/app1",
            "meshName": "app1"
        }
    ]
}

詳細については、App Mesh ユーザーガイドの「Service AWS Meshes」を参照してください。

• API 詳細については、AWS CLI 「 コマンドリファレンスListMeshes」の「」を参照してください。

list-routes

次のコード例は、list-routes を使用する方法を示しています。

AWS CLI

ルートを一覧表示するには

次のlist-routes例では、指定された仮想ルーターのすべてのルートを一覧表示します。

aws appmesh list-routes \
    --mesh-name app1 \
    --virtual-router-name vrServiceB

出力:

{
    "routes": [
        {
            "arn": "arn:aws:appmesh:us-east-1:123456789012:mesh/app1/virtualRouter/vrServiceB/route/toVnServiceB",
            "meshName": "app1",
            "routeName": "toVnServiceB-weighted",
            "virtualRouterName": "vrServiceB"
        }
    ]
}

詳細については、AWS 「App Mesh ユーザーガイド」の「ルート」を参照してください。

• API 詳細については、AWS CLI 「 コマンドリファレンスListRoutes」の「」を参照してください。

list-tags-for-resource

次の例は、list-tags-for-resource を使用する方法を説明しています。

AWS CLI

リソースのタグを一覧表示するには

次のlist-tags-for-resource例では、指定されたリソースに割り当てられたすべてのタグを一覧表示します。

aws appmesh list-tags-for-resource \
    --resource-arn arn:aws:appmesh:us-east-1:123456789012:mesh/app1

出力:

{
    "tags": [
        {
            "key": "key1",
            "value": "value1"
        },
        {
            "key": "key2",
            "value": "value2"
        },
        {
            "key": "key3",
            "value": "value3"
        }
    ]
}

• API 詳細については、AWS CLI 「 コマンドリファレンスListTagsForResource」の「」を参照してください。

list-virtual-nodes

次の例は、list-virtual-nodes を使用する方法を説明しています。

AWS CLI

仮想ノードを一覧表示するには

次のlist-virtual-nodes例では、指定されたサービスメッシュ内のすべての仮想ノードを一覧表示します。

aws appmesh list-virtual-nodes \
    --mesh-name app1

出力:

{
    "virtualNodes": [
        {
            "arn": "arn:aws:appmesh:us-east-1:123456789012:mesh/app1/virtualNode/vnServiceBv1",
            "meshName": "app1",
            "virtualNodeName": "vnServiceBv1"
        },
        {
            "arn": "arn:aws:appmesh:us-east-1:123456789012:mesh/app1/virtualNode/vnServiceBv2",
            "meshName": "app1",
            "virtualNodeName": "vnServiceBv2"
        }
    ]
}

詳細については、AWS App Mesh ユーザーガイドの「仮想ノード」を参照してください。

• API 詳細については、AWS CLI 「 コマンドリファレンスListVirtualNodes」の「」を参照してください。

list-virtual-routers

次のコード例は、list-virtual-routers を使用する方法を示しています。

AWS CLI

仮想ルーターを一覧表示するには

次のlist-virtual-routers例では、指定されたサービスメッシュ内のすべての仮想ルーターを一覧表示します。

aws appmesh list-virtual-routers \
    --mesh-name app1

出力:

{
    "virtualRouters": [
        {
            "arn": "arn:aws:appmesh:us-east-1:123456789012:mesh/app1/virtualRouter/vrServiceB",
            "meshName": "app1",
            "virtualRouterName": "vrServiceB"
        }
    ]
}

詳細については、AWS App Mesh ユーザーガイドの「仮想ルーター」を参照してください。

• API 詳細については、AWS CLI 「 コマンドリファレンスListVirtualRouters」の「」を参照してください。

list-virtual-services

次の例は、list-virtual-services を使用する方法を説明しています。

AWS CLI

仮想サービスを一覧表示するには

次のlist-virtual-services例では、指定されたサービスメッシュ内のすべての仮想サービスを一覧表示します。

aws appmesh list-virtual-services \
    --mesh-name app1

出力:

{
    "virtualServices": [
        {
            "arn": "arn:aws:appmesh:us-east-1:123456789012:mesh/app1/virtualService/serviceA.svc.cluster.local",
            "meshName": "app1",
            "virtualServiceName": "serviceA.svc.cluster.local"
        },
        {
            "arn": "arn:aws:appmesh:us-east-1:123456789012:mesh/app1/virtualService/serviceB.svc.cluster.local",
            "meshName": "app1",
            "virtualServiceName": "serviceB.svc.cluster.local"
        }
    ]
}

詳細については、AWS App Mesh ユーザーガイドの「仮想サービス」を参照してください。

• API 詳細については、AWS CLI 「 コマンドリファレンスListVirtualServices」の「」を参照してください。

tag-resource

次のコード例は、tag-resource を使用する方法を示しています。

AWS CLI

リソースにタグを付けるには

次のtag-resource例では、 値key1を持つ タグvalue1を指定されたリソースに追加します。

aws appmesh tag-resource \
    --resource-arn arn:aws:appmesh:us-east-1:123456789012:mesh/app1 \
    --tags key=key1,value=value1

このコマンドでは何も出力されません。

• API 詳細については、AWS CLI 「 コマンドリファレンスTagResource」の「」を参照してください。

untag-resource

次の例は、untag-resource を使用する方法を説明しています。

AWS CLI

リソースのタグを解除するには

次のuntag-resource例では、指定されたリソースkey1から キーを持つタグを削除します。

aws appmesh untag-resource \
    --resource-arn arn:aws:appmesh:us-east-1:123456789012:mesh/app1 \
    --tag-keys key1

このコマンドでは何も出力されません。

• API 詳細については、AWS CLI 「 コマンドリファレンスUntagResource」の「」を参照してください。

update-mesh

次のコード例は、update-mesh を使用する方法を示しています。

AWS CLI

サービスメッシュを更新するには

次のupdate-mesh例では、JSON入力ファイルを使用してサービスメッシュを更新し、Envoy プロキシを介してすべての外部出力トラフィックをそのまま転送できるようにします。

aws appmesh update-mesh \
    --cli-input-json file://update-mesh.json

update-mesh.json の内容:

{
    "meshName": "app1",
    "spec": {
        "egressFilter": {
            "type": "ALLOW_ALL"
        }
    }
}

出力:

{
    "mesh": {
        "meshName": "app1",
        "metadata": {
            "arn": "arn:aws:appmesh:us-east-1:123456789012:mesh/app1",
            "createdAt": 1563809909.282,
            "lastUpdatedAt": 1563812829.687,
            "uid": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE",
            "version": 2
        },
        "spec": {
            "egressFilter": {
                "type": "ALLOW_ALL"
            }
        },
        "status": {
            "status": "ACTIVE"
        }
    }
}

詳細については、App Mesh ユーザーガイドの「Service AWS Meshes」を参照してください。

• API 詳細については、AWS CLI 「 コマンドリファレンスUpdateMesh」の「」を参照してください。

update-route

次の例は、update-route を使用する方法を説明しています。

AWS CLI

ルートを更新するには

次のupdate-route例では、JSON入力ファイルを使用してルートの重みを更新します。

aws appmesh update-route \
    --cli-input-json file://update-route-weighted.json

update-route-weighted.json の内容:

{
    "meshName": "app1",
    "routeName": "toVnServiceB-weighted",
    "spec": {
        "httpRoute": {
            "action": {
                "weightedTargets": [
                    {
                        "virtualNode": "vnServiceBv1",
                        "weight": 80
                    },
                    {
                        "virtualNode": "vnServiceBv2",
                        "weight": 20
                    }
                ]
            },
            "match": {
                "prefix": "/"
            }
        }
    },
    "virtualRouterName": "vrServiceB"
}

出力:

{
    "route": {
        "meshName": "app1",
        "metadata": {
            "arn": "arn:aws:appmesh:us-east-1:123456789012:mesh/app1/virtualRouter/vrServiceB/route/toVnServiceB-weighted",
            "createdAt": 1563811384.015,
            "lastUpdatedAt": 1563819600.022,
            "uid": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE",
            "version": 2
        },
        "routeName": "toVnServiceB-weighted",
        "spec": {
            "httpRoute": {
                "action": {
                    "weightedTargets": [
                        {
                            "virtualNode": "vnServiceBv1",
                            "weight": 80
                        },
                        {
                            "virtualNode": "vnServiceBv2",
                            "weight": 20
                        }
                    ]
                },
                "match": {
                    "prefix": "/"
                }
            }
        },
        "status": {
            "status": "ACTIVE"
        },
        "virtualRouterName": "vrServiceB"
    }
}

詳細については、AWS 「App Mesh ユーザーガイド」の「ルート」を参照してください。

• API 詳細については、AWS CLI 「 コマンドリファレンスUpdateRoute」の「」を参照してください。

update-virtual-node

次の例は、update-virtual-node を使用する方法を説明しています。

AWS CLI

仮想ノードを更新するには

次のupdate-virtual-node例では、JSON入力ファイルを使用して、仮想ノードにヘルスチェックを追加します。

aws appmesh update-virtual-node \
    --cli-input-json file://update-virtual-node.json

update-virtual-node.json の内容:

{
    "clientToken": "500",
    "meshName": "app1",
    "spec": {
        "listeners": [
            {
                "healthCheck": {
                    "healthyThreshold": 5,
                    "intervalMillis": 10000,
                    "path": "/",
                    "port": 80,
                    "protocol": "http",
                    "timeoutMillis": 3000,
                    "unhealthyThreshold": 3
                },
                "portMapping": {
                    "port": 80,
                    "protocol": "http"
                }
            }
        ],
        "serviceDiscovery": {
            "dns": {
                "hostname": "serviceBv1.svc.cluster.local"
            }
        }
    },
    "virtualNodeName": "vnServiceBv1"
}

出力:

{
    "virtualNode": {
        "meshName": "app1",
        "metadata": {
            "arn": "arn:aws:appmesh:us-east-1:123456789012:mesh/app1/virtualNode/vnServiceBv1",
            "createdAt": 1563810019.874,
            "lastUpdatedAt": 1563819234.825,
            "uid": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE",
            "version": 2
        },
        "spec": {
            "listeners": [
                {
                    "healthCheck": {
                        "healthyThreshold": 5,
                        "intervalMillis": 10000,
                        "path": "/",
                        "port": 80,
                        "protocol": "http",
                        "timeoutMillis": 3000,
                        "unhealthyThreshold": 3
                    },
                    "portMapping": {
                        "port": 80,
                        "protocol": "http"
                    }
                }
            ],
            "serviceDiscovery": {
                "dns": {
                    "hostname": "serviceBv1.svc.cluster.local"
                }
            }
        },
        "status": {
            "status": "ACTIVE"
        },
        "virtualNodeName": "vnServiceBv1"
    }
}

詳細については、AWS App Mesh ユーザーガイドの「仮想ノード」を参照してください。

• API 詳細については、AWS CLI 「 コマンドリファレンスUpdateVirtualNode」の「」を参照してください。

update-virtual-router

次のコード例は、update-virtual-router を使用する方法を示しています。

AWS CLI

仮想ルーターを更新するには

次のupdate-virtual-router例では、JSON入力ファイルを使用して仮想ルーターリスナーポートを更新します。

aws appmesh update-virtual-router \
    --cli-input-json file://update-virtual-router.json

update-virtual-router.json の内容:

{
    "meshName": "app1",
    "spec": {
        "listeners": [
            {
                "portMapping": {
                    "port": 8080,
                    "protocol": "http"
                }
            }
        ]
    },
    "virtualRouterName": "vrServiceB"
}

出力:

{
    "virtualRouter": {
        "meshName": "app1",
        "metadata": {
            "arn": "arn:aws:appmesh:us-east-1:123456789012:mesh/app1/virtualRouter/vrServiceB",
            "createdAt": 1563810546.59,
            "lastUpdatedAt": 1563819431.352,
            "uid": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE",
            "version": 2
        },
        "spec": {
            "listeners": [
                {
                    "portMapping": {
                        "port": 8080,
                        "protocol": "http"
                    }
                }
            ]
        },
        "status": {
            "status": "ACTIVE"
        },
        "virtualRouterName": "vrServiceB"
    }
}

詳細については、AWS App Mesh ユーザーガイドの「仮想ルーター」を参照してください。

• API 詳細については、AWS CLI 「 コマンドリファレンスUpdateVirtualRouter」の「」を参照してください。

update-virtual-service

次のコード例は、update-virtual-service を使用する方法を示しています。

AWS CLI

仮想サービスを更新するには

次のupdate-virtual-service例では、JSON入力ファイルを使用して仮想ルータープロバイダーを使用するように仮想サービスを更新します。

aws appmesh update-virtual-service \
    --cli-input-json file://update-virtual-service.json

update-virtual-service.json の内容:

{
    "meshName": "app1",
    "spec": {
        "provider": {
            "virtualRouter": {
                "virtualRouterName": "vrServiceA"
            }
        }
    },
    "virtualServiceName": "serviceA.svc.cluster.local"
}

出力:

{
    "virtualService": {
        "meshName": "app1",
        "metadata": {
            "arn": "arn:aws:appmesh:us-east-1:123456789012:mesh/app1/virtualService/serviceA.svc.cluster.local",
            "createdAt": 1563810859.474,
            "lastUpdatedAt": 1563820257.411,
            "uid": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE",
            "version": 3
        },
        "spec": {
            "provider": {
                "virtualRouter": {
                    "virtualRouterName": "vrServiceA"
                }
            }
        },
        "status": {
            "status": "ACTIVE"
        },
        "virtualServiceName": "serviceA.svc.cluster.local"
    }
}

詳細については、AWS App Mesh ユーザーガイドの「仮想サービス」を参照してください。

• API 詳細については、AWS CLI 「 コマンドリファレンスUpdateVirtualService」の「」を参照してください。