AWS.Tools.AppMesh.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.AppMesh</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.AMSH.AddAMSHResourceTagCmdlet"> <summary> Associates the specified tags to a resource with the specified <code>resourceArn</code>. If existing tags on a resource aren't specified in the request parameters, they aren't changed. When a resource is deleted, the tags associated with that resource are also deleted. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMSH.AddAMSHResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the resource to add tags to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMSH.AddAMSHResourceTagCmdlet.Tag"> <summary> <para> <para>The tags to add to the resource. A tag is an array of key-value pairs. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMSH.AddAMSHResourceTagCmdlet.PassThru"> <summary> Returns the value passed to the ResourceArn parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMSH.AddAMSHResourceTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AMSH.GetAMSHMeshCmdlet"> <summary> Describes an existing service mesh. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMSH.GetAMSHMeshCmdlet.MeshName"> <summary> <para> <para>The name of the service mesh to describe.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AMSH.GetAMSHMeshListCmdlet"> <summary> Returns a list of existing service meshes.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMSH.GetAMSHMeshListCmdlet.Limit"> <summary> <para> <para>The maximum number of results returned by <code>ListMeshes</code> in paginated output. When you use this parameter, <code>ListMeshes</code> returns only <code>limit</code> results in a single page along with a <code>nextToken</code> response element. You can see the remaining results of the initial request by sending another <code>ListMeshes</code> request with the returned <code>nextToken</code> value. This value can be between 1 and 100. If you don't use this parameter, <code>ListMeshes</code> returns up to 100 results and a <code>nextToken</code> value if applicable.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMSH.GetAMSHMeshListCmdlet.NextToken"> <summary> <para> <para>The <code>nextToken</code> value returned from a previous paginated <code>ListMeshes</code> request where <code>limit</code> was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the <code>nextToken</code> value.</para><note><para>This token should be treated as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic purposes.</para></note> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AMSH.GetAMSHResourceTagCmdlet"> <summary> List the tags for an App Mesh resource.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMSH.GetAMSHResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) that identifies the resource to list the tags for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMSH.GetAMSHResourceTagCmdlet.Limit"> <summary> <para> <para>The maximum number of tag results returned by <code>ListTagsForResource</code> in paginated output. When this parameter is used, <code>ListTagsForResource</code> returns only <code>limit</code> results in a single page along with a <code>nextToken</code> response element. You can see the remaining results of the initial request by sending another <code>ListTagsForResource</code> request with the returned <code>nextToken</code> value. This value can be between 1 and 100. If you don't use this parameter, <code>ListTagsForResource</code> returns up to 100 results and a <code>nextToken</code> value if applicable.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMSH.GetAMSHResourceTagCmdlet.NextToken"> <summary> <para> <para>The <code>nextToken</code> value returned from a previous paginated <code>ListTagsForResource</code> request where <code>limit</code> was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the <code>nextToken</code> value.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AMSH.GetAMSHRouteCmdlet"> <summary> Describes an existing route. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMSH.GetAMSHRouteCmdlet.MeshName"> <summary> <para> <para>The name of the service mesh that the route resides in.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMSH.GetAMSHRouteCmdlet.RouteName"> <summary> <para> <para>The name of the route to describe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMSH.GetAMSHRouteCmdlet.VirtualRouterName"> <summary> <para> <para>The name of the virtual router that the route is associated with.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AMSH.GetAMSHRouteListCmdlet"> <summary> Returns a list of existing routes in a service mesh.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMSH.GetAMSHRouteListCmdlet.MeshName"> <summary> <para> <para>The name of the service mesh to list routes in.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMSH.GetAMSHRouteListCmdlet.VirtualRouterName"> <summary> <para> <para>The name of the virtual router to list routes in.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMSH.GetAMSHRouteListCmdlet.Limit"> <summary> <para> <para>The maximum number of results returned by <code>ListRoutes</code> in paginated output. When you use this parameter, <code>ListRoutes</code> returns only <code>limit</code> results in a single page along with a <code>nextToken</code> response element. You can see the remaining results of the initial request by sending another <code>ListRoutes</code> request with the returned <code>nextToken</code> value. This value can be between 1 and 100. If you don't use this parameter, <code>ListRoutes</code> returns up to 100 results and a <code>nextToken</code> value if applicable.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMSH.GetAMSHRouteListCmdlet.NextToken"> <summary> <para> <para>The <code>nextToken</code> value returned from a previous paginated <code>ListRoutes</code> request where <code>limit</code> was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the <code>nextToken</code> value.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AMSH.GetAMSHVirtualNodeCmdlet"> <summary> Describes an existing virtual node. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMSH.GetAMSHVirtualNodeCmdlet.MeshName"> <summary> <para> <para>The name of the service mesh that the virtual node resides in.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMSH.GetAMSHVirtualNodeCmdlet.VirtualNodeName"> <summary> <para> <para>The name of the virtual node to describe.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AMSH.GetAMSHVirtualNodeListCmdlet"> <summary> Returns a list of existing virtual nodes.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMSH.GetAMSHVirtualNodeListCmdlet.MeshName"> <summary> <para> <para>The name of the service mesh to list virtual nodes in.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMSH.GetAMSHVirtualNodeListCmdlet.Limit"> <summary> <para> <para>The maximum number of results returned by <code>ListVirtualNodes</code> in paginated output. When you use this parameter, <code>ListVirtualNodes</code> returns only <code>limit</code> results in a single page along with a <code>nextToken</code> response element. You can see the remaining results of the initial request by sending another <code>ListVirtualNodes</code> request with the returned <code>nextToken</code> value. This value can be between 1 and 100. If you don't use this parameter, <code>ListVirtualNodes</code> returns up to 100 results and a <code>nextToken</code> value if applicable.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMSH.GetAMSHVirtualNodeListCmdlet.NextToken"> <summary> <para> <para>The <code>nextToken</code> value returned from a previous paginated <code>ListVirtualNodes</code> request where <code>limit</code> was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the <code>nextToken</code> value.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AMSH.GetAMSHVirtualRouterCmdlet"> <summary> Describes an existing virtual router. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMSH.GetAMSHVirtualRouterCmdlet.MeshName"> <summary> <para> <para>The name of the service mesh that the virtual router resides in.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMSH.GetAMSHVirtualRouterCmdlet.VirtualRouterName"> <summary> <para> <para>The name of the virtual router to describe.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AMSH.GetAMSHVirtualRouterListCmdlet"> <summary> Returns a list of existing virtual routers in a service mesh.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMSH.GetAMSHVirtualRouterListCmdlet.MeshName"> <summary> <para> <para>The name of the service mesh to list virtual routers in.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMSH.GetAMSHVirtualRouterListCmdlet.Limit"> <summary> <para> <para>The maximum number of results returned by <code>ListVirtualRouters</code> in paginated output. When you use this parameter, <code>ListVirtualRouters</code> returns only <code>limit</code> results in a single page along with a <code>nextToken</code> response element. You can see the remaining results of the initial request by sending another <code>ListVirtualRouters</code> request with the returned <code>nextToken</code> value. This value can be between 1 and 100. If you don't use this parameter, <code>ListVirtualRouters</code> returns up to 100 results and a <code>nextToken</code> value if applicable.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMSH.GetAMSHVirtualRouterListCmdlet.NextToken"> <summary> <para> <para>The <code>nextToken</code> value returned from a previous paginated <code>ListVirtualRouters</code> request where <code>limit</code> was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the <code>nextToken</code> value.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AMSH.GetAMSHVirtualServiceCmdlet"> <summary> Describes an existing virtual service. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMSH.GetAMSHVirtualServiceCmdlet.MeshName"> <summary> <para> <para>The name of the service mesh that the virtual service resides in.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMSH.GetAMSHVirtualServiceCmdlet.VirtualServiceName"> <summary> <para> <para>The name of the virtual service to describe.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AMSH.GetAMSHVirtualServiceListCmdlet"> <summary> Returns a list of existing virtual services in a service mesh.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMSH.GetAMSHVirtualServiceListCmdlet.MeshName"> <summary> <para> <para>The name of the service mesh to list virtual services in.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMSH.GetAMSHVirtualServiceListCmdlet.Limit"> <summary> <para> <para>The maximum number of results returned by <code>ListVirtualServices</code> in paginated output. When you use this parameter, <code>ListVirtualServices</code> returns only <code>limit</code> results in a single page along with a <code>nextToken</code> response element. You can see the remaining results of the initial request by sending another <code>ListVirtualServices</code> request with the returned <code>nextToken</code> value. This value can be between 1 and 100. If you don't use this parameter, <code>ListVirtualServices</code> returns up to 100 results and a <code>nextToken</code> value if applicable.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMSH.GetAMSHVirtualServiceListCmdlet.NextToken"> <summary> <para> <para>The <code>nextToken</code> value returned from a previous paginated <code>ListVirtualServices</code> request where <code>limit</code> was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the <code>nextToken</code> value.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AMSH.NewAMSHMeshCmdlet"> <summary> Creates a service mesh. A service mesh is a logical boundary for network traffic between the services that reside within it. <para> After you create your service mesh, you can create virtual services, virtual nodes, virtual routers, and routes to distribute traffic between the applications in your mesh. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMSH.NewAMSHMeshCmdlet.ClientToken"> <summary> <para> <para>Unique, case-sensitive identifier that you provide to ensure the idempotency of therequest. Up to 36 letters, numbers, hyphens, and underscores are allowed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMSH.NewAMSHMeshCmdlet.MeshName"> <summary> <para> <para>The name to use for the service mesh.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMSH.NewAMSHMeshCmdlet.Tag"> <summary> <para> <para>Optional metadata that you can apply to the service mesh 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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMSH.NewAMSHMeshCmdlet.EgressFilter_Type"> <summary> <para> <para>The egress filter type. By default, the type is <code>DROP_ALL</code>, which allows egress only from virtual nodes to other defined resources in the service mesh (and any traffic to <code>*.amazonaws.com</code> for AWS API calls). You can set the egress filter type to <code>ALLOW_ALL</code> to allow egress to any endpoint inside or outside of the service mesh.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMSH.NewAMSHMeshCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AMSH.NewAMSHRouteCmdlet"> <summary> Creates a route that is associated with a virtual router. <para> You can use the <code>prefix</code> parameter in your route specification for path-based routing of requests. For example, if your virtual service name is <code>my-service.local</code> and you want the route to match requests to <code>my-service.local/metrics</code>, your prefix should be <code>/metrics</code>. </para><para> If your route matches a request, you can distribute traffic to one or more target virtual nodes with relative weighting. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMSH.NewAMSHRouteCmdlet.ClientToken"> <summary> <para> <para>Unique, case-sensitive identifier that you provide to ensure the idempotency of therequest. Up to 36 letters, numbers, hyphens, and underscores are allowed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMSH.NewAMSHRouteCmdlet.MeshName"> <summary> <para> <para>The name of the service mesh to create the route in.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMSH.NewAMSHRouteCmdlet.Match_Prefix"> <summary> <para> <para>Specifies the path to match requests with. This parameter must always start with <code>/</code>, which by itself matches all requests to the virtual service name. You can also match for path-based routing of requests. For example, if your virtual service name is <code>my-service.local</code> and you want the route to match requests to <code>my-service.local/metrics</code>, your prefix should be <code>/metrics</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMSH.NewAMSHRouteCmdlet.RouteName"> <summary> <para> <para>The name to use for the route.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMSH.NewAMSHRouteCmdlet.Tag"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMSH.NewAMSHRouteCmdlet.VirtualRouterName"> <summary> <para> <para>The name of the virtual router in which to create the route.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMSH.NewAMSHRouteCmdlet.Spec_HttpRoute_Action_WeightedTarget"> <summary> <para> <para>The targets that traffic is routed to when a request matches the route. You can specify one or more targets and their relative weights to distribute traffic with.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMSH.NewAMSHRouteCmdlet.Spec_TcpRoute_Action_WeightedTarget"> <summary> <para> <para>The targets that traffic is routed to when a request matches the route. You can specify one or more targets and their relative weights to distribute traffic with.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMSH.NewAMSHRouteCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AMSH.NewAMSHVirtualNodeCmdlet"> <summary> Creates a virtual node within a service mesh. <para> A virtual node acts as a logical pointer to a particular task group, such as an Amazon ECS service or a Kubernetes deployment. When you create a virtual node, you can specify the service discovery information for your task group. </para><para> Any inbound traffic that your virtual node expects should be specified as a <code>listener</code>. Any outbound traffic that your virtual node expects to reach should be specified as a <code>backend</code>. </para><para> The response metadata for your new virtual node contains the <code>arn</code> that is associated with the virtual node. Set this value (either the full ARN or the truncated resource name: for example, <code>mesh/default/virtualNode/simpleapp</code>) as the <code>APPMESH_VIRTUAL_NODE_NAME</code> environment variable for your task group's Envoy proxy container in your task definition or pod spec. This is then mapped to the <code>node.id</code> and <code>node.cluster</code> Envoy parameters. </para><note><para> If you require your Envoy stats or tracing to use a different name, you can override the <code>node.cluster</code> value that is set by <code>APPMESH_VIRTUAL_NODE_NAME</code> with the <code>APPMESH_VIRTUAL_NODE_CLUSTER</code> environment variable. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMSH.NewAMSHVirtualNodeCmdlet.AwsCloudMap_Attribute"> <summary> <para> <para>A string map that contains attributes with values that you can use to filter instances by any custom attribute that you specified when you registered the instance. Only instances that match all of the specified key/value pairs will be returned.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMSH.NewAMSHVirtualNodeCmdlet.Spec_Backend"> <summary> <para> <para>The backends that the virtual node is expected to send outbound traffic to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMSH.NewAMSHVirtualNodeCmdlet.ClientToken"> <summary> <para> <para>Unique, case-sensitive identifier that you provide to ensure the idempotency of therequest. Up to 36 letters, numbers, hyphens, and underscores are allowed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMSH.NewAMSHVirtualNodeCmdlet.Dns_Hostname"> <summary> <para> <para>Specifies the DNS service discovery hostname for the virtual node. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMSH.NewAMSHVirtualNodeCmdlet.Spec_Listener"> <summary> <para> <para>The listeners that the virtual node is expected to receive inbound traffic from. Currently only one listener is supported per virtual node.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMSH.NewAMSHVirtualNodeCmdlet.MeshName"> <summary> <para> <para>The name of the service mesh to create the virtual node in.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMSH.NewAMSHVirtualNodeCmdlet.AwsCloudMap_NamespaceName"> <summary> <para> <para>The name of the AWS Cloud Map namespace to use.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMSH.NewAMSHVirtualNodeCmdlet.File_Path"> <summary> <para> <para>The file path to write access logs to. You can use <code>/dev/stdout</code> to send access logs to standard out and configure your Envoy container to use a log driver, such as <code>awslogs</code>, to export the access logs to a log storage service such as Amazon CloudWatch Logs. You can also specify a path in the Envoy container's file system to write the files to disk.</para><note><para>The Envoy process must have write permissions to the path that you specify here. Otherwise, Envoy fails to bootstrap properly.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMSH.NewAMSHVirtualNodeCmdlet.AwsCloudMap_ServiceName"> <summary> <para> <para>The name of the AWS Cloud Map service to use.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMSH.NewAMSHVirtualNodeCmdlet.Tag"> <summary> <para> <para>Optional metadata that you can apply to the virtual node 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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMSH.NewAMSHVirtualNodeCmdlet.VirtualNodeName"> <summary> <para> <para>The name to use for the virtual node.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMSH.NewAMSHVirtualNodeCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AMSH.NewAMSHVirtualRouterCmdlet"> <summary> Creates a virtual router within a service mesh. <para> Any inbound traffic that your virtual router expects should be specified as a <code>listener</code>. </para><para> 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. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMSH.NewAMSHVirtualRouterCmdlet.ClientToken"> <summary> <para> <para>Unique, case-sensitive identifier that you provide to ensure the idempotency of therequest. Up to 36 letters, numbers, hyphens, and underscores are allowed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMSH.NewAMSHVirtualRouterCmdlet.Spec_Listener"> <summary> <para> <para>The listeners that the virtual router is expected to receive inbound traffic from. Currently only one listener is supported per virtual router.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMSH.NewAMSHVirtualRouterCmdlet.MeshName"> <summary> <para> <para>The name of the service mesh to create the virtual router in.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMSH.NewAMSHVirtualRouterCmdlet.Tag"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMSH.NewAMSHVirtualRouterCmdlet.VirtualRouterName"> <summary> <para> <para>The name to use for the virtual router.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMSH.NewAMSHVirtualRouterCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AMSH.NewAMSHVirtualServiceCmdlet"> <summary> Creates a virtual service within a service mesh. <para> 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 <code>virtualServiceName</code>, and those requests are routed to the virtual node or virtual router that is specified as the provider for the virtual service. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMSH.NewAMSHVirtualServiceCmdlet.ClientToken"> <summary> <para> <para>Unique, case-sensitive identifier that you provide to ensure the idempotency of therequest. Up to 36 letters, numbers, hyphens, and underscores are allowed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMSH.NewAMSHVirtualServiceCmdlet.MeshName"> <summary> <para> <para>The name of the service mesh to create the virtual service in.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMSH.NewAMSHVirtualServiceCmdlet.Tag"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMSH.NewAMSHVirtualServiceCmdlet.VirtualNode_VirtualNodeName"> <summary> <para> <para>The name of the virtual node that is acting as a service provider.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMSH.NewAMSHVirtualServiceCmdlet.VirtualRouter_VirtualRouterName"> <summary> <para> <para>The name of the virtual router that is acting as a service provider.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMSH.NewAMSHVirtualServiceCmdlet.VirtualServiceName"> <summary> <para> <para>The name to use for the virtual service.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMSH.NewAMSHVirtualServiceCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AMSH.RemoveAMSHMeshCmdlet"> <summary> Deletes an existing service mesh. <para> You must delete all resources (virtual services, routes, virtual routers, and virtual nodes) in the service mesh before you can delete the mesh itself. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMSH.RemoveAMSHMeshCmdlet.MeshName"> <summary> <para> <para>The name of the service mesh to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMSH.RemoveAMSHMeshCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AMSH.RemoveAMSHResourceTagCmdlet"> <summary> Deletes specified tags from a resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMSH.RemoveAMSHResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the resource to delete tags from.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMSH.RemoveAMSHResourceTagCmdlet.TagKey"> <summary> <para> <para>The keys of the tags to be removed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMSH.RemoveAMSHResourceTagCmdlet.PassThru"> <summary> Returns the value passed to the ResourceArn parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMSH.RemoveAMSHResourceTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AMSH.RemoveAMSHRouteCmdlet"> <summary> Deletes an existing route. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMSH.RemoveAMSHRouteCmdlet.MeshName"> <summary> <para> <para>The name of the service mesh to delete the route in.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMSH.RemoveAMSHRouteCmdlet.RouteName"> <summary> <para> <para>The name of the route to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMSH.RemoveAMSHRouteCmdlet.VirtualRouterName"> <summary> <para> <para>The name of the virtual router to delete the route in.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMSH.RemoveAMSHRouteCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AMSH.RemoveAMSHVirtualNodeCmdlet"> <summary> Deletes an existing virtual node. <para> You must delete any virtual services that list a virtual node as a service provider before you can delete the virtual node itself. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMSH.RemoveAMSHVirtualNodeCmdlet.MeshName"> <summary> <para> <para>The name of the service mesh to delete the virtual node in.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMSH.RemoveAMSHVirtualNodeCmdlet.VirtualNodeName"> <summary> <para> <para>The name of the virtual node to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMSH.RemoveAMSHVirtualNodeCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AMSH.RemoveAMSHVirtualRouterCmdlet"> <summary> Deletes an existing virtual router. <para> You must delete any routes associated with the virtual router before you can delete the router itself. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMSH.RemoveAMSHVirtualRouterCmdlet.MeshName"> <summary> <para> <para>The name of the service mesh to delete the virtual router in.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMSH.RemoveAMSHVirtualRouterCmdlet.VirtualRouterName"> <summary> <para> <para>The name of the virtual router to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMSH.RemoveAMSHVirtualRouterCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AMSH.RemoveAMSHVirtualServiceCmdlet"> <summary> Deletes an existing virtual service. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMSH.RemoveAMSHVirtualServiceCmdlet.MeshName"> <summary> <para> <para>The name of the service mesh to delete the virtual service in.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMSH.RemoveAMSHVirtualServiceCmdlet.VirtualServiceName"> <summary> <para> <para>The name of the virtual service to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMSH.RemoveAMSHVirtualServiceCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AMSH.UpdateAMSHMeshCmdlet"> <summary> Updates an existing service mesh. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMSH.UpdateAMSHMeshCmdlet.ClientToken"> <summary> <para> <para>Unique, case-sensitive identifier that you provide to ensure the idempotency of therequest. Up to 36 letters, numbers, hyphens, and underscores are allowed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMSH.UpdateAMSHMeshCmdlet.MeshName"> <summary> <para> <para>The name of the service mesh to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMSH.UpdateAMSHMeshCmdlet.EgressFilter_Type"> <summary> <para> <para>The egress filter type. By default, the type is <code>DROP_ALL</code>, which allows egress only from virtual nodes to other defined resources in the service mesh (and any traffic to <code>*.amazonaws.com</code> for AWS API calls). You can set the egress filter type to <code>ALLOW_ALL</code> to allow egress to any endpoint inside or outside of the service mesh.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMSH.UpdateAMSHMeshCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AMSH.UpdateAMSHRouteCmdlet"> <summary> Updates an existing route for a specified service mesh and virtual router. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMSH.UpdateAMSHRouteCmdlet.ClientToken"> <summary> <para> <para>Unique, case-sensitive identifier that you provide to ensure the idempotency of therequest. Up to 36 letters, numbers, hyphens, and underscores are allowed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMSH.UpdateAMSHRouteCmdlet.MeshName"> <summary> <para> <para>The name of the service mesh that the route resides in.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMSH.UpdateAMSHRouteCmdlet.Match_Prefix"> <summary> <para> <para>Specifies the path to match requests with. This parameter must always start with <code>/</code>, which by itself matches all requests to the virtual service name. You can also match for path-based routing of requests. For example, if your virtual service name is <code>my-service.local</code> and you want the route to match requests to <code>my-service.local/metrics</code>, your prefix should be <code>/metrics</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMSH.UpdateAMSHRouteCmdlet.RouteName"> <summary> <para> <para>The name of the route to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMSH.UpdateAMSHRouteCmdlet.VirtualRouterName"> <summary> <para> <para>The name of the virtual router that the route is associated with.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMSH.UpdateAMSHRouteCmdlet.Spec_HttpRoute_Action_WeightedTarget"> <summary> <para> <para>The targets that traffic is routed to when a request matches the route. You can specify one or more targets and their relative weights to distribute traffic with.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMSH.UpdateAMSHRouteCmdlet.Spec_TcpRoute_Action_WeightedTarget"> <summary> <para> <para>The targets that traffic is routed to when a request matches the route. You can specify one or more targets and their relative weights to distribute traffic with.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMSH.UpdateAMSHRouteCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AMSH.UpdateAMSHVirtualNodeCmdlet"> <summary> Updates an existing virtual node in a specified service mesh. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMSH.UpdateAMSHVirtualNodeCmdlet.AwsCloudMap_Attribute"> <summary> <para> <para>A string map that contains attributes with values that you can use to filter instances by any custom attribute that you specified when you registered the instance. Only instances that match all of the specified key/value pairs will be returned.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMSH.UpdateAMSHVirtualNodeCmdlet.Spec_Backend"> <summary> <para> <para>The backends that the virtual node is expected to send outbound traffic to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMSH.UpdateAMSHVirtualNodeCmdlet.ClientToken"> <summary> <para> <para>Unique, case-sensitive identifier that you provide to ensure the idempotency of therequest. Up to 36 letters, numbers, hyphens, and underscores are allowed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMSH.UpdateAMSHVirtualNodeCmdlet.Dns_Hostname"> <summary> <para> <para>Specifies the DNS service discovery hostname for the virtual node. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMSH.UpdateAMSHVirtualNodeCmdlet.Spec_Listener"> <summary> <para> <para>The listeners that the virtual node is expected to receive inbound traffic from. Currently only one listener is supported per virtual node.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMSH.UpdateAMSHVirtualNodeCmdlet.MeshName"> <summary> <para> <para>The name of the service mesh that the virtual node resides in.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMSH.UpdateAMSHVirtualNodeCmdlet.AwsCloudMap_NamespaceName"> <summary> <para> <para>The name of the AWS Cloud Map namespace to use.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMSH.UpdateAMSHVirtualNodeCmdlet.File_Path"> <summary> <para> <para>The file path to write access logs to. You can use <code>/dev/stdout</code> to send access logs to standard out and configure your Envoy container to use a log driver, such as <code>awslogs</code>, to export the access logs to a log storage service such as Amazon CloudWatch Logs. You can also specify a path in the Envoy container's file system to write the files to disk.</para><note><para>The Envoy process must have write permissions to the path that you specify here. Otherwise, Envoy fails to bootstrap properly.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMSH.UpdateAMSHVirtualNodeCmdlet.AwsCloudMap_ServiceName"> <summary> <para> <para>The name of the AWS Cloud Map service to use.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMSH.UpdateAMSHVirtualNodeCmdlet.VirtualNodeName"> <summary> <para> <para>The name of the virtual node to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMSH.UpdateAMSHVirtualNodeCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AMSH.UpdateAMSHVirtualRouterCmdlet"> <summary> Updates an existing virtual router in a specified service mesh. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMSH.UpdateAMSHVirtualRouterCmdlet.ClientToken"> <summary> <para> <para>Unique, case-sensitive identifier that you provide to ensure the idempotency of therequest. Up to 36 letters, numbers, hyphens, and underscores are allowed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMSH.UpdateAMSHVirtualRouterCmdlet.Spec_Listener"> <summary> <para> <para>The listeners that the virtual router is expected to receive inbound traffic from. Currently only one listener is supported per virtual router.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMSH.UpdateAMSHVirtualRouterCmdlet.MeshName"> <summary> <para> <para>The name of the service mesh that the virtual router resides in.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMSH.UpdateAMSHVirtualRouterCmdlet.VirtualRouterName"> <summary> <para> <para>The name of the virtual router to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMSH.UpdateAMSHVirtualRouterCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AMSH.UpdateAMSHVirtualServiceCmdlet"> <summary> Updates an existing virtual service in a specified service mesh. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMSH.UpdateAMSHVirtualServiceCmdlet.ClientToken"> <summary> <para> <para>Unique, case-sensitive identifier that you provide to ensure the idempotency of therequest. Up to 36 letters, numbers, hyphens, and underscores are allowed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMSH.UpdateAMSHVirtualServiceCmdlet.MeshName"> <summary> <para> <para>The name of the service mesh that the virtual service resides in.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMSH.UpdateAMSHVirtualServiceCmdlet.VirtualNode_VirtualNodeName"> <summary> <para> <para>The name of the virtual node that is acting as a service provider.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMSH.UpdateAMSHVirtualServiceCmdlet.VirtualRouter_VirtualRouterName"> <summary> <para> <para>The name of the virtual router that is acting as a service provider.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMSH.UpdateAMSHVirtualServiceCmdlet.VirtualServiceName"> <summary> <para> <para>The name of the virtual service to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMSH.UpdateAMSHVirtualServiceCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> </members> </doc> |