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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a route that is associated with a virtual router.

You can route several different protocols and define a retry policy for a route. Traffic can be routed to one or more virtual nodes.

For more information about routes, see Routes.

Synopsis

data CreateRoute = CreateRoute' {
- clientToken :: Maybe Text
- meshOwner :: Maybe Text
- tags :: Maybe [TagRef]
- meshName :: Text
- routeName :: Text
- spec :: RouteSpec
- virtualRouterName :: Text
}
newCreateRoute :: Text -> Text -> RouteSpec -> Text -> CreateRoute
createRoute_clientToken :: Lens' CreateRoute (Maybe Text)
createRoute_meshOwner :: Lens' CreateRoute (Maybe Text)
createRoute_tags :: Lens' CreateRoute (Maybe [TagRef])
createRoute_meshName :: Lens' CreateRoute Text
createRoute_routeName :: Lens' CreateRoute Text
createRoute_spec :: Lens' CreateRoute RouteSpec
createRoute_virtualRouterName :: Lens' CreateRoute Text
data CreateRouteResponse = CreateRouteResponse' {
- httpStatus :: Int
- route :: RouteData
}
newCreateRouteResponse :: Int -> RouteData -> CreateRouteResponse
createRouteResponse_httpStatus :: Lens' CreateRouteResponse Int
createRouteResponse_route :: Lens' CreateRouteResponse RouteData

Creating a Request

data CreateRoute Source #

See: newCreateRoute smart constructor.

Constructors

CreateRoute'

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 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.
meshName :: Text
The name of the service mesh to create the route in.
routeName :: Text
The name to use for the route.
spec :: RouteSpec
The route specification to apply.
virtualRouterName :: Text
The name of the virtual router in which to create the route. If the virtual router is in a shared mesh, then you must be the owner of the virtual router resource.

Instances

Instances details

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

newCreateRoute Source #

Arguments

:: Text	`$sel:meshName:CreateRoute'`
-> Text	`$sel:routeName:CreateRoute'`
-> RouteSpec	`$sel:spec:CreateRoute'`
-> Text	`$sel:virtualRouterName:CreateRoute'`
-> CreateRoute

Create a value of CreateRoute 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:CreateRoute', createRoute_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:CreateRoute', createRoute_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:CreateRoute', createRoute_tags - Optional metadata that you can apply to the 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:meshName:CreateRoute', createRoute_meshName - The name of the service mesh to create the route in.

$sel:routeName:CreateRoute', createRoute_routeName - The name to use for the route.

$sel:spec:CreateRoute', createRoute_spec - The route specification to apply.

$sel:virtualRouterName:CreateRoute', createRoute_virtualRouterName - The name of the virtual router in which to create the route. If the virtual router is in a shared mesh, then you must be the owner of the virtual router resource.

Request Lenses

createRoute_clientToken :: Lens' CreateRoute (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.

createRoute_meshOwner :: Lens' CreateRoute (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.

createRoute_tags :: Lens' CreateRoute (Maybe [TagRef]) Source #

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

createRoute_meshName :: Lens' CreateRoute Text Source #

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

createRoute_routeName :: Lens' CreateRoute Text Source #

The name to use for the route.

createRoute_spec :: Lens' CreateRoute RouteSpec Source #

The route specification to apply.

createRoute_virtualRouterName :: Lens' CreateRoute Text Source #

The name of the virtual router in which to create the route. If the virtual router is in a shared mesh, then you must be the owner of the virtual router resource.

Destructuring the Response

data CreateRouteResponse Source #

See: newCreateRouteResponse smart constructor.

Constructors

CreateRouteResponse'
Fields httpStatus :: Int The response's http status code. route :: RouteData The full description of your mesh following the create call.

Instances

Instances details

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

newCreateRouteResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateRouteResponse'`
-> RouteData	`$sel:route:CreateRouteResponse'`
-> CreateRouteResponse

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

$sel:route:CreateRouteResponse', createRouteResponse_route - The full description of your mesh following the create call.

Response Lenses

createRouteResponse_httpStatus :: Lens' CreateRouteResponse Int Source #

The response's http status code.

createRouteResponse_route :: Lens' CreateRouteResponse RouteData Source #

The full description of your mesh following the create call.