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.CreateGatewayRoute

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a gateway route.

A gateway route is attached to a virtual gateway and routes traffic to an existing virtual service. If a route matches a request, it can distribute traffic to a target virtual service.

For more information about gateway routes, see Gateway routes.

Synopsis

data CreateGatewayRoute = CreateGatewayRoute' {
- clientToken :: Maybe Text
- meshOwner :: Maybe Text
- tags :: Maybe [TagRef]
- gatewayRouteName :: Text
- meshName :: Text
- spec :: GatewayRouteSpec
- virtualGatewayName :: Text
}
newCreateGatewayRoute :: Text -> Text -> GatewayRouteSpec -> Text -> CreateGatewayRoute
createGatewayRoute_clientToken :: Lens' CreateGatewayRoute (Maybe Text)
createGatewayRoute_meshOwner :: Lens' CreateGatewayRoute (Maybe Text)
createGatewayRoute_tags :: Lens' CreateGatewayRoute (Maybe [TagRef])
createGatewayRoute_gatewayRouteName :: Lens' CreateGatewayRoute Text
createGatewayRoute_meshName :: Lens' CreateGatewayRoute Text
createGatewayRoute_spec :: Lens' CreateGatewayRoute GatewayRouteSpec
createGatewayRoute_virtualGatewayName :: Lens' CreateGatewayRoute Text
data CreateGatewayRouteResponse = CreateGatewayRouteResponse' {
- httpStatus :: Int
- gatewayRoute :: GatewayRouteData
}
newCreateGatewayRouteResponse :: Int -> GatewayRouteData -> CreateGatewayRouteResponse
createGatewayRouteResponse_httpStatus :: Lens' CreateGatewayRouteResponse Int
createGatewayRouteResponse_gatewayRoute :: Lens' CreateGatewayRouteResponse GatewayRouteData

Creating a Request

data CreateGatewayRoute Source #

See: newCreateGatewayRoute smart constructor.

Constructors

CreateGatewayRoute'

Fields

clientToken :: Maybe Text
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.
meshOwner :: Maybe Text
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.
tags :: Maybe [TagRef]
Optional metadata that you can apply to the gateway route 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.
gatewayRouteName :: Text
The name to use for the gateway route.
meshName :: Text
The name of the service mesh to create the gateway route in.
spec :: GatewayRouteSpec
The gateway route specification to apply.
virtualGatewayName :: Text
The name of the virtual gateway to associate the gateway route with. If the virtual gateway is in a shared mesh, then you must be the owner of the virtual gateway resource.

Instances

Instances details

Eq CreateGatewayRoute Source #
Instance details Defined in Amazonka.AppMesh.CreateGatewayRoute Methods (==) :: CreateGatewayRoute -> CreateGatewayRoute -> Bool # (/=) :: CreateGatewayRoute -> CreateGatewayRoute -> Bool #
Read CreateGatewayRoute Source #
Instance details Defined in Amazonka.AppMesh.CreateGatewayRoute Methods readsPrec :: Int -> ReadS CreateGatewayRoute # readList :: ReadS [CreateGatewayRoute] # readPrec :: ReadPrec CreateGatewayRoute # readListPrec :: ReadPrec [CreateGatewayRoute] #
Show CreateGatewayRoute Source #
Instance details Defined in Amazonka.AppMesh.CreateGatewayRoute Methods showsPrec :: Int -> CreateGatewayRoute -> ShowS # show :: CreateGatewayRoute -> String # showList :: [CreateGatewayRoute] -> ShowS #
Generic CreateGatewayRoute Source #
Instance details Defined in Amazonka.AppMesh.CreateGatewayRoute Associated Types type Rep CreateGatewayRoute :: Type -> Type # Methods from :: CreateGatewayRoute -> Rep CreateGatewayRoute x # to :: Rep CreateGatewayRoute x -> CreateGatewayRoute #
NFData CreateGatewayRoute Source #
Instance details Defined in Amazonka.AppMesh.CreateGatewayRoute Methods rnf :: CreateGatewayRoute -> () #
Hashable CreateGatewayRoute Source #
Instance details Defined in Amazonka.AppMesh.CreateGatewayRoute Methods hashWithSalt :: Int -> CreateGatewayRoute -> Int # hash :: CreateGatewayRoute -> Int #
ToJSON CreateGatewayRoute Source #
Instance details Defined in Amazonka.AppMesh.CreateGatewayRoute Methods toJSON :: CreateGatewayRoute -> Value # toEncoding :: CreateGatewayRoute -> Encoding # toJSONList :: [CreateGatewayRoute] -> Value # toEncodingList :: [CreateGatewayRoute] -> Encoding #
AWSRequest CreateGatewayRoute Source #
Instance details Defined in Amazonka.AppMesh.CreateGatewayRoute Associated Types type AWSResponse CreateGatewayRoute # Methods request :: CreateGatewayRoute -> Request CreateGatewayRoute # response :: MonadResource m => Logger -> Service -> Proxy CreateGatewayRoute -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateGatewayRoute))) #
ToHeaders CreateGatewayRoute Source #
Instance details Defined in Amazonka.AppMesh.CreateGatewayRoute Methods toHeaders :: CreateGatewayRoute -> [Header] #
ToPath CreateGatewayRoute Source #
Instance details Defined in Amazonka.AppMesh.CreateGatewayRoute Methods toPath :: CreateGatewayRoute -> ByteString #
ToQuery CreateGatewayRoute Source #
Instance details Defined in Amazonka.AppMesh.CreateGatewayRoute Methods toQuery :: CreateGatewayRoute -> QueryString #
type Rep CreateGatewayRoute Source #
Instance details Defined in Amazonka.AppMesh.CreateGatewayRoute type Rep CreateGatewayRoute = D1 ('MetaData "CreateGatewayRoute" "Amazonka.AppMesh.CreateGatewayRoute" "libZSservicesZSamazonka-appmeshZSamazonka-appmesh" 'False) (C1 ('MetaCons "CreateGatewayRoute'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "clientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "meshOwner") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [TagRef])))) :: ((S1 ('MetaSel ('Just "gatewayRouteName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "meshName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "spec") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 GatewayRouteSpec) :: S1 ('MetaSel ('Just "virtualGatewayName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))
type AWSResponse CreateGatewayRoute Source #
Instance details Defined in Amazonka.AppMesh.CreateGatewayRoute type AWSResponse CreateGatewayRoute = CreateGatewayRouteResponse

newCreateGatewayRoute Source #

Arguments

:: Text	`$sel:gatewayRouteName:CreateGatewayRoute'`
-> Text	`$sel:meshName:CreateGatewayRoute'`
-> GatewayRouteSpec	`$sel:spec:CreateGatewayRoute'`
-> Text	`$sel:virtualGatewayName:CreateGatewayRoute'`
-> CreateGatewayRoute

Create a value of CreateGatewayRoute 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:CreateGatewayRoute', createGatewayRoute_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:CreateGatewayRoute', createGatewayRoute_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:CreateGatewayRoute', createGatewayRoute_tags - Optional metadata that you can apply to the gateway route 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:gatewayRouteName:CreateGatewayRoute', createGatewayRoute_gatewayRouteName - The name to use for the gateway route.

$sel:meshName:CreateGatewayRoute', createGatewayRoute_meshName - The name of the service mesh to create the gateway route in.

$sel:spec:CreateGatewayRoute', createGatewayRoute_spec - The gateway route specification to apply.

$sel:virtualGatewayName:CreateGatewayRoute', createGatewayRoute_virtualGatewayName - The name of the virtual gateway to associate the gateway route with. If the virtual gateway is in a shared mesh, then you must be the owner of the virtual gateway resource.

Request Lenses

createGatewayRoute_clientToken :: Lens' CreateGatewayRoute (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.

createGatewayRoute_meshOwner :: Lens' CreateGatewayRoute (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.

createGatewayRoute_tags :: Lens' CreateGatewayRoute (Maybe [TagRef]) Source #

Optional metadata that you can apply to the gateway route 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.

createGatewayRoute_gatewayRouteName :: Lens' CreateGatewayRoute Text Source #

The name to use for the gateway route.

createGatewayRoute_meshName :: Lens' CreateGatewayRoute Text Source #

The name of the service mesh to create the gateway route in.

createGatewayRoute_spec :: Lens' CreateGatewayRoute GatewayRouteSpec Source #

The gateway route specification to apply.

createGatewayRoute_virtualGatewayName :: Lens' CreateGatewayRoute Text Source #

The name of the virtual gateway to associate the gateway route with. If the virtual gateway is in a shared mesh, then you must be the owner of the virtual gateway resource.

Destructuring the Response

data CreateGatewayRouteResponse Source #

See: newCreateGatewayRouteResponse smart constructor.

Constructors

CreateGatewayRouteResponse'
Fields httpStatus :: Int The response's http status code. gatewayRoute :: GatewayRouteData The full description of your gateway route following the create call.

Instances

Instances details

Eq CreateGatewayRouteResponse Source #
Instance details Defined in Amazonka.AppMesh.CreateGatewayRoute Methods (==) :: CreateGatewayRouteResponse -> CreateGatewayRouteResponse -> Bool # (/=) :: CreateGatewayRouteResponse -> CreateGatewayRouteResponse -> Bool #
Read CreateGatewayRouteResponse Source #
Instance details Defined in Amazonka.AppMesh.CreateGatewayRoute Methods readsPrec :: Int -> ReadS CreateGatewayRouteResponse # readList :: ReadS [CreateGatewayRouteResponse] # readPrec :: ReadPrec CreateGatewayRouteResponse # readListPrec :: ReadPrec [CreateGatewayRouteResponse] #
Show CreateGatewayRouteResponse Source #
Instance details Defined in Amazonka.AppMesh.CreateGatewayRoute Methods showsPrec :: Int -> CreateGatewayRouteResponse -> ShowS # show :: CreateGatewayRouteResponse -> String # showList :: [CreateGatewayRouteResponse] -> ShowS #
Generic CreateGatewayRouteResponse Source #
Instance details Defined in Amazonka.AppMesh.CreateGatewayRoute Associated Types type Rep CreateGatewayRouteResponse :: Type -> Type # Methods from :: CreateGatewayRouteResponse -> Rep CreateGatewayRouteResponse x # to :: Rep CreateGatewayRouteResponse x -> CreateGatewayRouteResponse #
NFData CreateGatewayRouteResponse Source #
Instance details Defined in Amazonka.AppMesh.CreateGatewayRoute Methods rnf :: CreateGatewayRouteResponse -> () #
type Rep CreateGatewayRouteResponse Source #
Instance details Defined in Amazonka.AppMesh.CreateGatewayRoute type Rep CreateGatewayRouteResponse = D1 ('MetaData "CreateGatewayRouteResponse" "Amazonka.AppMesh.CreateGatewayRoute" "libZSservicesZSamazonka-appmeshZSamazonka-appmesh" 'False) (C1 ('MetaCons "CreateGatewayRouteResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "gatewayRoute") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 GatewayRouteData)))

newCreateGatewayRouteResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateGatewayRouteResponse'`
-> GatewayRouteData	`$sel:gatewayRoute:CreateGatewayRouteResponse'`
-> CreateGatewayRouteResponse

Create a value of CreateGatewayRouteResponse 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:CreateGatewayRouteResponse', createGatewayRouteResponse_httpStatus - The response's http status code.

$sel:gatewayRoute:CreateGatewayRouteResponse', createGatewayRouteResponse_gatewayRoute - The full description of your gateway route following the create call.

Response Lenses

createGatewayRouteResponse_httpStatus :: Lens' CreateGatewayRouteResponse Int Source #

The response's http status code.

createGatewayRouteResponse_gatewayRoute :: Lens' CreateGatewayRouteResponse GatewayRouteData Source #

The full description of your gateway route following the create call.