aws appmesh create-virtual-gateway

Creates a virtual gateway. AWS CLI reference

1 example 6 options Its page in the AWS CLI reference

Examples

from aws-cli, each command read by CmdID

To create a new virtual gateway

The following create-virtual-gateway example uses a JSON input file to create a virtual gateway with a listener for HTTP using port 9080.

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

Identify

--mesh-nameThe name of the service mesh to create the virtual gateway in.

--virtual-gateway-nameThe name to use for the virtual gateway.

Contents of create-virtual-gateway.json:

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

Its output

{
    "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-EXAMPLE11111",
            "version": 1
        },
        "spec": {
            "listeners": [
                {
                    "portMapping": {
                        "port": 9080,
                        "protocol": "http"
                    }
                }
            ]
        },
        "status": {
            "status": "ACTIVE"
        },
        "virtualGatewayName": "virtualGatewayName"
    }
}

For more information, see Virtual Gateways in the AWS App Mesh User Guide.

Options

6 in the AWS CLI reference

--client-tokenUnique, case-sensitive identifier that you provide to ensure the idempotency of the request.

--mesh-nameThe name of the service mesh to create the virtual gateway in.

--mesh-ownerThe Amazon Web Services IAM account ID of the service mesh owner.

--specThe virtual gateway specification to apply.

--tagsOptional metadata that you can apply to the virtual gateway to assist with categorization and organization.

--virtual-gateway-nameThe name to use for the virtual gateway.