libZSservicesZSamazonka-appmeshZSamazonka-appmesh
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.AppMesh.CreateVirtualService

Description

Creates a virtual service within a service mesh.

A virtual service is an abstraction of a real service that is provided by a virtual node directly or indirectly by means of a virtual router. Dependent services call your virtual service by its virtualServiceName, and those requests are routed to the virtual node or virtual router that is specified as the provider for the virtual service.

For more information about virtual services, see Virtual services.

Synopsis

Creating a Request

data CreateVirtualService Source #

See: newCreateVirtualService smart constructor.

Constructors

CreateVirtualService' 

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 virtual service 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 service in.

  • spec :: VirtualServiceSpec

    The virtual service specification to apply.

  • virtualServiceName :: Text

    The name to use for the virtual service.

Instances

Instances details
Eq CreateVirtualService Source # 
Instance details

Defined in Amazonka.AppMesh.CreateVirtualService

Read CreateVirtualService Source # 
Instance details

Defined in Amazonka.AppMesh.CreateVirtualService

Show CreateVirtualService Source # 
Instance details

Defined in Amazonka.AppMesh.CreateVirtualService

Generic CreateVirtualService Source # 
Instance details

Defined in Amazonka.AppMesh.CreateVirtualService

Associated Types

type Rep CreateVirtualService :: Type -> Type #

NFData CreateVirtualService Source # 
Instance details

Defined in Amazonka.AppMesh.CreateVirtualService

Methods

rnf :: CreateVirtualService -> () #

Hashable CreateVirtualService Source # 
Instance details

Defined in Amazonka.AppMesh.CreateVirtualService

ToJSON CreateVirtualService Source # 
Instance details

Defined in Amazonka.AppMesh.CreateVirtualService

AWSRequest CreateVirtualService Source # 
Instance details

Defined in Amazonka.AppMesh.CreateVirtualService

Associated Types

type AWSResponse CreateVirtualService #

ToHeaders CreateVirtualService Source # 
Instance details

Defined in Amazonka.AppMesh.CreateVirtualService

ToPath CreateVirtualService Source # 
Instance details

Defined in Amazonka.AppMesh.CreateVirtualService

ToQuery CreateVirtualService Source # 
Instance details

Defined in Amazonka.AppMesh.CreateVirtualService

type Rep CreateVirtualService Source # 
Instance details

Defined in Amazonka.AppMesh.CreateVirtualService

type Rep CreateVirtualService = D1 ('MetaData "CreateVirtualService" "Amazonka.AppMesh.CreateVirtualService" "libZSservicesZSamazonka-appmeshZSamazonka-appmesh" 'False) (C1 ('MetaCons "CreateVirtualService'" '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 VirtualServiceSpec) :*: S1 ('MetaSel ('Just "virtualServiceName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))
type AWSResponse CreateVirtualService Source # 
Instance details

Defined in Amazonka.AppMesh.CreateVirtualService

newCreateVirtualService Source #

Create a value of CreateVirtualService 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:CreateVirtualService', createVirtualService_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:CreateVirtualService', createVirtualService_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:CreateVirtualService', createVirtualService_tags - Optional metadata that you can apply to the virtual service 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:CreateVirtualService', createVirtualService_meshName - The name of the service mesh to create the virtual service in.

$sel:spec:CreateVirtualService', createVirtualService_spec - The virtual service specification to apply.

$sel:virtualServiceName:CreateVirtualService', createVirtualService_virtualServiceName - The name to use for the virtual service.

Request Lenses

createVirtualService_clientToken :: Lens' CreateVirtualService (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.

createVirtualService_meshOwner :: Lens' CreateVirtualService (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.

createVirtualService_tags :: Lens' CreateVirtualService (Maybe [TagRef]) Source #

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

createVirtualService_meshName :: Lens' CreateVirtualService Text Source #

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

createVirtualService_spec :: Lens' CreateVirtualService VirtualServiceSpec Source #

The virtual service specification to apply.

Destructuring the Response

data CreateVirtualServiceResponse Source #

See: newCreateVirtualServiceResponse smart constructor.

Constructors

CreateVirtualServiceResponse' 

Fields

Instances

Instances details
Eq CreateVirtualServiceResponse Source # 
Instance details

Defined in Amazonka.AppMesh.CreateVirtualService

Read CreateVirtualServiceResponse Source # 
Instance details

Defined in Amazonka.AppMesh.CreateVirtualService

Show CreateVirtualServiceResponse Source # 
Instance details

Defined in Amazonka.AppMesh.CreateVirtualService

Generic CreateVirtualServiceResponse Source # 
Instance details

Defined in Amazonka.AppMesh.CreateVirtualService

Associated Types

type Rep CreateVirtualServiceResponse :: Type -> Type #

NFData CreateVirtualServiceResponse Source # 
Instance details

Defined in Amazonka.AppMesh.CreateVirtualService

type Rep CreateVirtualServiceResponse Source # 
Instance details

Defined in Amazonka.AppMesh.CreateVirtualService

type Rep CreateVirtualServiceResponse = D1 ('MetaData "CreateVirtualServiceResponse" "Amazonka.AppMesh.CreateVirtualService" "libZSservicesZSamazonka-appmeshZSamazonka-appmesh" 'False) (C1 ('MetaCons "CreateVirtualServiceResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "virtualService") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 VirtualServiceData)))

newCreateVirtualServiceResponse Source #

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

$sel:virtualService:CreateVirtualServiceResponse', createVirtualServiceResponse_virtualService - The full description of your virtual service following the create call.

Response Lenses

createVirtualServiceResponse_virtualService :: Lens' CreateVirtualServiceResponse VirtualServiceData Source #

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