| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.AppMesh.CreateVirtualGateway
Description
Creates a virtual gateway.
A virtual gateway allows resources outside your mesh to communicate to resources that are inside your mesh. The virtual gateway represents an Envoy proxy running in an Amazon ECS task, in a Kubernetes service, or on an Amazon EC2 instance. Unlike a virtual node, which represents an Envoy running with an application, a virtual gateway represents Envoy deployed by itself.
For more information about virtual gateways, see Virtual gateways.
Synopsis
- data CreateVirtualGateway = CreateVirtualGateway' {
- clientToken :: Maybe Text
- meshOwner :: Maybe Text
- tags :: Maybe [TagRef]
- meshName :: Text
- spec :: VirtualGatewaySpec
- virtualGatewayName :: Text
- newCreateVirtualGateway :: Text -> VirtualGatewaySpec -> Text -> CreateVirtualGateway
- createVirtualGateway_clientToken :: Lens' CreateVirtualGateway (Maybe Text)
- createVirtualGateway_meshOwner :: Lens' CreateVirtualGateway (Maybe Text)
- createVirtualGateway_tags :: Lens' CreateVirtualGateway (Maybe [TagRef])
- createVirtualGateway_meshName :: Lens' CreateVirtualGateway Text
- createVirtualGateway_spec :: Lens' CreateVirtualGateway VirtualGatewaySpec
- createVirtualGateway_virtualGatewayName :: Lens' CreateVirtualGateway Text
- data CreateVirtualGatewayResponse = CreateVirtualGatewayResponse' {}
- newCreateVirtualGatewayResponse :: Int -> VirtualGatewayData -> CreateVirtualGatewayResponse
- createVirtualGatewayResponse_httpStatus :: Lens' CreateVirtualGatewayResponse Int
- createVirtualGatewayResponse_virtualGateway :: Lens' CreateVirtualGatewayResponse VirtualGatewayData
Creating a Request
data CreateVirtualGateway Source #
See: newCreateVirtualGateway smart constructor.
Constructors
| CreateVirtualGateway' | |
Fields
| |
Instances
newCreateVirtualGateway Source #
Arguments
| :: Text | |
| -> VirtualGatewaySpec | |
| -> Text | |
| -> CreateVirtualGateway |
Create a value of CreateVirtualGateway with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientToken:CreateVirtualGateway', createVirtualGateway_clientToken - Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request. Up to 36 letters, numbers, hyphens, and
underscores are allowed.
$sel:meshOwner:CreateVirtualGateway', createVirtualGateway_meshOwner - The AWS IAM account ID of the service mesh owner. If the account ID is
not your own, then the account that you specify must share the mesh with
your account before you can create the resource in the service mesh. For
more information about mesh sharing, see
Working with shared meshes.
$sel:tags:CreateVirtualGateway', createVirtualGateway_tags - Optional metadata that you can apply to the virtual gateway to assist
with categorization and organization. Each tag consists of a key and an
optional value, both of which you define. Tag keys can have a maximum
character length of 128 characters, and tag values can have a maximum
length of 256 characters.
$sel:meshName:CreateVirtualGateway', createVirtualGateway_meshName - The name of the service mesh to create the virtual gateway in.
$sel:spec:CreateVirtualGateway', createVirtualGateway_spec - The virtual gateway specification to apply.
$sel:virtualGatewayName:CreateVirtualGateway', createVirtualGateway_virtualGatewayName - The name to use for the virtual gateway.
Request Lenses
createVirtualGateway_clientToken :: Lens' CreateVirtualGateway (Maybe Text) Source #
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.
createVirtualGateway_meshOwner :: Lens' CreateVirtualGateway (Maybe Text) Source #
The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then the account that you specify must share the mesh with your account before you can create the resource in the service mesh. For more information about mesh sharing, see Working with shared meshes.
createVirtualGateway_tags :: Lens' CreateVirtualGateway (Maybe [TagRef]) Source #
Optional metadata that you can apply to the virtual gateway to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
createVirtualGateway_meshName :: Lens' CreateVirtualGateway Text Source #
The name of the service mesh to create the virtual gateway in.
createVirtualGateway_spec :: Lens' CreateVirtualGateway VirtualGatewaySpec Source #
The virtual gateway specification to apply.
createVirtualGateway_virtualGatewayName :: Lens' CreateVirtualGateway Text Source #
The name to use for the virtual gateway.
Destructuring the Response
data CreateVirtualGatewayResponse Source #
See: newCreateVirtualGatewayResponse smart constructor.
Constructors
| CreateVirtualGatewayResponse' | |
Fields
| |
Instances
newCreateVirtualGatewayResponse Source #
Arguments
| :: Int | |
| -> VirtualGatewayData | |
| -> CreateVirtualGatewayResponse |
Create a value of CreateVirtualGatewayResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:CreateVirtualGatewayResponse', createVirtualGatewayResponse_httpStatus - The response's http status code.
$sel:virtualGateway:CreateVirtualGatewayResponse', createVirtualGatewayResponse_virtualGateway - The full description of your virtual gateway following the create call.
Response Lenses
createVirtualGatewayResponse_httpStatus :: Lens' CreateVirtualGatewayResponse Int Source #
The response's http status code.
createVirtualGatewayResponse_virtualGateway :: Lens' CreateVirtualGatewayResponse VirtualGatewayData Source #
The full description of your virtual gateway following the create call.