Synopsis
Calls the AWS App Mesh CreateVirtualNode API operation.
Syntax
New-AMSHVirtualNode-VirtualNodeName <String>-AwsCloudMap_Attribute <AwsCloudMapInstanceAttribute[]>-Spec_Backend <Backend[]>-ClientToken <String>-Dns_Hostname <String>-Spec_Listener <Listener[]>-MeshName <String>-AwsCloudMap_NamespaceName <String>-File_Path <String>-AwsCloudMap_ServiceName <String>-Tag <TagRef[]>-Force <SwitchParameter>
Description
Creates a virtual node within a service mesh.
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.
Any inbound traffic that your virtual node expects should be specified as a
listener. Any outbound traffic that your virtual node expects to reach should be specified as a backend.
The response metadata for your new virtual node contains the arn that is associated with the virtual node. Set this value (either the full ARN or the truncated resource name: for example, mesh/default/virtualNode/simpleapp) as the APPMESH_VIRTUAL_NODE_NAME environment variable for your task group's Envoy proxy container in your task definition or pod spec. This is then mapped to the node.id and node.cluster Envoy parameters.
If you require your Envoy stats or tracing to use a different name, you can override the node.cluster value that is set by APPMESH_VIRTUAL_NODE_NAME with the APPMESH_VIRTUAL_NODE_CLUSTER environment variable. Parameters
-AwsCloudMap_Attribute <AwsCloudMapInstanceAttribute[]>
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.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | Spec_ServiceDiscovery_AwsCloudMap_Attributes |
-AwsCloudMap_NamespaceName <String>
The name of the AWS Cloud Map namespace to use.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | Spec_ServiceDiscovery_AwsCloudMap_NamespaceName |
-AwsCloudMap_ServiceName <String>
The name of the AWS Cloud Map service to use.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | Spec_ServiceDiscovery_AwsCloudMap_ServiceName |
-ClientToken <String>
Unique, case-sensitive identifier that you provide to ensure the idempotency of therequest. Up to 36 letters, numbers, hyphens, and underscores are allowed.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-Dns_Hostname <String>
Specifies the DNS service discovery hostname for the virtual node.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | Spec_ServiceDiscovery_Dns_Hostname |
-File_Path <String>
The file path to write access logs to. You can use
/dev/stdout to send access logs to standard out and configure your Envoy container to use a log driver, such as awslogs, 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.The Envoy process must have write permissions to the path that you specify here. Otherwise, Envoy fails to bootstrap properly. | Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | Spec_Logging_AccessLog_File_Path |
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-MeshName <String>
The name of the service mesh to create the virtual node in.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | True (ByPropertyName) |
-Spec_Backend <Backend[]>
The backends that the virtual node is expected to send outbound traffic to.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | Spec_Backends |
-Spec_Listener <Listener[]>
The listeners that the virtual node is expected to receive inbound traffic from. Currently only one listener is supported per virtual node.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | Spec_Listeners |
-Tag <TagRef[]>
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.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | Tags |
-VirtualNodeName <String>
The name to use for the virtual node.
| Required? | False |
| Position? | 1 |
| Accept pipeline input? | True (ByValue, ByPropertyName) |
Common Credential and Region Parameters
-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key
if the corresponding session token is supplied to the -SessionToken parameter.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information,
and optionally a token for session-based credentials.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)
If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials. Note that the encrypted credential file is not supported on all platforms. It will be skipped when searching for profiles on Windows Nano Server, Mac, and Linux platforms.
If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.
As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing
credential information. The profile is expected to be found in the secure credential
file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also
specify the name of a profile stored in the .ini-format credential file used with
the AWS CLI and other AWS SDKs.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile.
Contains the network credentials to be supplied during authentication with the
configured identity provider's endpoint. This parameter is not required if the
user's default network identity can or should be used during authentication.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key
if the corresponding session token is supplied to the -SessionToken parameter.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-SessionToken <String>
The session token if the access and secret keys are temporary session-based
credentials.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-Region <String>
The system name of the AWS region in which the operation should be invoked. For example, us-east-1, eu-west-1 etc.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-EndpointUrl <String>
The endpoint to make the call against.
Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
Inputs
You can pipe a String object to this cmdlet for the VirtualNodeName parameter.
Outputs
This cmdlet returns a Amazon.AppMesh.Model.VirtualNodeData object.
The service call response (type Amazon.AppMesh.Model.CreateVirtualNodeResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.
Related Links
Supported Version
AWS Tools for PowerShell: 2.x.y.z
