Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.AppMesh.CreateVirtualRouter

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a virtual router within a service mesh.

Specify a listener for any inbound traffic that your virtual router receives. Create a virtual router for each protocol and port that you need to route. Virtual routers handle traffic for one or more virtual services within your mesh. After you create your virtual router, create and associate routes for your virtual router that direct incoming requests to different virtual nodes.

For more information about virtual routers, see Virtual routers.

Synopsis

data CreateVirtualRouter = CreateVirtualRouter' {
- clientToken :: Maybe Text
- meshOwner :: Maybe Text
- tags :: Maybe [TagRef]
- meshName :: Text
- spec :: VirtualRouterSpec
- virtualRouterName :: Text
}
newCreateVirtualRouter :: Text -> VirtualRouterSpec -> Text -> CreateVirtualRouter
createVirtualRouter_clientToken :: Lens' CreateVirtualRouter (Maybe Text)
createVirtualRouter_meshOwner :: Lens' CreateVirtualRouter (Maybe Text)
createVirtualRouter_tags :: Lens' CreateVirtualRouter (Maybe [TagRef])
createVirtualRouter_meshName :: Lens' CreateVirtualRouter Text
createVirtualRouter_spec :: Lens' CreateVirtualRouter VirtualRouterSpec
createVirtualRouter_virtualRouterName :: Lens' CreateVirtualRouter Text
data CreateVirtualRouterResponse = CreateVirtualRouterResponse' {
- httpStatus :: Int
- virtualRouter :: VirtualRouterData
}
newCreateVirtualRouterResponse :: Int -> VirtualRouterData -> CreateVirtualRouterResponse
createVirtualRouterResponse_httpStatus :: Lens' CreateVirtualRouterResponse Int
createVirtualRouterResponse_virtualRouter :: Lens' CreateVirtualRouterResponse VirtualRouterData

Creating a Request

data CreateVirtualRouter Source #

See: newCreateVirtualRouter smart constructor.

Constructors

CreateVirtualRouter'

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 Amazon Web Services 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 virtual router 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 virtual router in.
spec :: VirtualRouterSpec
The virtual router specification to apply.
virtualRouterName :: Text
The name to use for the virtual router.

Instances

Instances details

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

newCreateVirtualRouter Source #

Arguments

:: Text	`CreateVirtualRouter`
-> VirtualRouterSpec	`CreateVirtualRouter`
-> Text	`CreateVirtualRouter`
-> CreateVirtualRouter

Create a value of CreateVirtualRouter 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:CreateVirtualRouter', createVirtualRouter_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.

CreateVirtualRouter, createVirtualRouter_meshOwner - The Amazon Web Services 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:CreateVirtualRouter', createVirtualRouter_tags - Optional metadata that you can apply to the virtual router 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.

CreateVirtualRouter, createVirtualRouter_meshName - The name of the service mesh to create the virtual router in.

CreateVirtualRouter, createVirtualRouter_spec - The virtual router specification to apply.

CreateVirtualRouter, createVirtualRouter_virtualRouterName - The name to use for the virtual router.

Request Lenses

createVirtualRouter_clientToken :: Lens' CreateVirtualRouter (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.

createVirtualRouter_meshOwner :: Lens' CreateVirtualRouter (Maybe Text) Source #

The Amazon Web Services 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.

createVirtualRouter_tags :: Lens' CreateVirtualRouter (Maybe [TagRef]) Source #

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

createVirtualRouter_meshName :: Lens' CreateVirtualRouter Text Source #

The name of the service mesh to create the virtual router in.

createVirtualRouter_spec :: Lens' CreateVirtualRouter VirtualRouterSpec Source #

The virtual router specification to apply.

createVirtualRouter_virtualRouterName :: Lens' CreateVirtualRouter Text Source #

The name to use for the virtual router.

Destructuring the Response

data CreateVirtualRouterResponse Source #

See: newCreateVirtualRouterResponse smart constructor.

Constructors

CreateVirtualRouterResponse'
Fields httpStatus :: Int The response's http status code. virtualRouter :: VirtualRouterData The full description of your virtual router following the create call.

Instances

Instances details

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

newCreateVirtualRouterResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateVirtualRouterResponse'`
-> VirtualRouterData	`CreateVirtualRouterResponse`
-> CreateVirtualRouterResponse

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

CreateVirtualRouterResponse, createVirtualRouterResponse_virtualRouter - The full description of your virtual router following the create call.

Response Lenses

createVirtualRouterResponse_httpStatus :: Lens' CreateVirtualRouterResponse Int Source #

The response's http status code.

createVirtualRouterResponse_virtualRouter :: Lens' CreateVirtualRouterResponse VirtualRouterData Source #

The full description of your virtual router following the create call.