create_virtual_router
async
¶
create_virtual_router(
virtual_router_name: ResourceName,
mesh_name: ResourceName,
spec: VirtualRouterSpec,
*,
config_overrides: Optional[AsyncAppMeshClientConfig] = None,
tags: Optional[TagList] = None,
client_token: Optional[str] = None,
mesh_owner: Optional[AccountId] = None,
) -> CreateVirtualRouterOutput
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.
Parameters:
-
virtual_router_name(ResourceName) –The name to use for the virtual router.
-
mesh_name(ResourceName) –The name of the service mesh to create the virtual router in.
-
spec(VirtualRouterSpec) –The virtual router specification to apply.
-
tags(Optional[TagList], default:None) –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.
-
client_token(Optional[str], default:None) –Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.
-
mesh_owner(Optional[AccountId], default:None) –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.
Raises:
-
BadRequestException–The request syntax was malformed. Check your request syntax and try again.
-
ConflictException–The request contains a client token that was used for a previous update resource call with different specifications. Try the request again with a new client token.
-
ForbiddenException–You don't have permissions to perform this action.
-
InternalServerErrorException–The request processing has failed because of an unknown error, exception, or failure.
-
LimitExceededException–You have exceeded a service limit for your account. For more information, see Service Limits in the App Mesh User Guide.
-
NotFoundException–The specified resource doesn't exist. Check your request syntax and try again.
-
ServiceUnavailableException–The request has failed due to a temporary failure of the service.
-
TooManyRequestsException–The maximum request rate permitted by the App Mesh APIs has been exceeded for your account. For best results, use an increasing or variable sleep interval between requests.
-
UnknownServiceError–The service returned an error code this client does not model.
Source code in docs_src/capo_app_mesh/_services/async_app_mesh.py
1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 | |