AppMesh / Client / create_virtual_router

create_virtual_router#

AppMesh.Client.create_virtual_router(**kwargs)#

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.

Request Syntax

response = client.create_virtual_router(
    clientToken='string',
    meshName='string',
    meshOwner='string',
    spec={
        'listeners': [
            {
                'portMapping': {
                    'port': 123,
                    'protocol': 'http'|'tcp'|'http2'|'grpc'
                }
            },
        ]
    },
    tags=[
        {
            'key': 'string',
            'value': 'string'
        },
    ],
    virtualRouterName='string'
)

Parameters:

clientToken (string) –
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.

This field is autopopulated if not provided.
meshName (string) –
[REQUIRED]

The name of the service mesh to create the virtual router in.
meshOwner (string) – 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.
spec (dict) –
[REQUIRED]

The virtual router specification to apply.
- listeners (list) –
  
  The listeners that the virtual router is expected to receive inbound traffic from. You can specify one listener.
  - (dict) –
    
    An object that represents a virtual router listener.
    - portMapping (dict) – [REQUIRED]
      
      An object that represents a port mapping.
      - port (integer) – [REQUIRED]
        
        The port used for the port mapping.
      - protocol (string) – [REQUIRED]
        
        The protocol used for the port mapping. Specify one protocol.
tags (list) –
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.
- (dict) –
  
  Optional metadata that you apply to a resource 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.
  - key (string) – [REQUIRED]
    
    One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.
  - value (string) – [REQUIRED]
    
    The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).
virtualRouterName (string) –
[REQUIRED]

The name to use for the virtual router.

Return type:

dict

Returns:

Response Syntax

{
    'virtualRouter': {
        'meshName': 'string',
        'metadata': {
            'arn': 'string',
            'createdAt': datetime(2015, 1, 1),
            'lastUpdatedAt': datetime(2015, 1, 1),
            'meshOwner': 'string',
            'resourceOwner': 'string',
            'uid': 'string',
            'version': 123
        },
        'spec': {
            'listeners': [
                {
                    'portMapping': {
                        'port': 123,
                        'protocol': 'http'|'tcp'|'http2'|'grpc'
                    }
                },
            ]
        },
        'status': {
            'status': 'ACTIVE'|'INACTIVE'|'DELETED'
        },
        'virtualRouterName': 'string'
    }
}

Response Structure

(dict) –
- virtualRouter (dict) –
  
  The full description of your virtual router following the create call.
  - meshName (string) –
    
    The name of the service mesh that the virtual router resides in.
  - metadata (dict) –
    
    The associated metadata for the virtual router.
    - arn (string) –
      
      The full Amazon Resource Name (ARN) for the resource.
    - createdAt (datetime) –
      
      The Unix epoch timestamp in seconds for when the resource was created.
    - lastUpdatedAt (datetime) –
      
      The Unix epoch timestamp in seconds for when the resource was last updated.
    - meshOwner (string) –
      
      The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it’s the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
    - resourceOwner (string) –
      
      The Amazon Web Services IAM account ID of the resource owner. If the account ID is not your own, then it’s the ID of the mesh owner or of another account that the mesh is shared with. For more information about mesh sharing, see Working with shared meshes.
    - uid (string) –
      
      The unique identifier for the resource.
    - version (integer) –
      
      The version of the resource. Resources are created at version 1, and this version is incremented each time that they’re updated.
  - spec (dict) –
    
    The specifications of the virtual router.
    - listeners (list) –
      
      The listeners that the virtual router is expected to receive inbound traffic from. You can specify one listener.
      - (dict) –
        
        An object that represents a virtual router listener.
        
        portMapping (dict) –
        
        An object that represents a port mapping.
        
        port (integer) –
        
        The port used for the port mapping.
        
        protocol (string) –
        
        The protocol used for the port mapping. Specify one protocol.
  - status (dict) –
    
    The current status of the virtual router.
    - status (string) –
      
      The current status of the virtual router.
  - virtualRouterName (string) –
    
    The name of the virtual router.

Exceptions

AppMesh.Client.exceptions.NotFoundException
AppMesh.Client.exceptions.BadRequestException
AppMesh.Client.exceptions.ConflictException
AppMesh.Client.exceptions.TooManyRequestsException
AppMesh.Client.exceptions.ForbiddenException
AppMesh.Client.exceptions.ServiceUnavailableException
AppMesh.Client.exceptions.InternalServerErrorException
AppMesh.Client.exceptions.LimitExceededException