AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the Amazon Elastic Compute Cloud (EC2) CreateVerifiedAccessEndpoint API operation.

Syntax

New-EC2VerifiedAccessEndpoint
-VerifiedAccessGroupId <String>
-ApplicationDomain <String>
-AttachmentType <VerifiedAccessEndpointAttachmentType>
-CidrOptions_Cidr <String>
-SseSpecification_CustomerManagedKeyEnabled <Boolean>
-Description <String>
-DomainCertificateArn <String>
-DryRun <Boolean>
-EndpointDomainPrefix <String>
-EndpointType <VerifiedAccessEndpointType>
-SseSpecification_KmsKeyArn <String>
-LoadBalancerOptions_LoadBalancerArn <String>
-NetworkInterfaceOptions_NetworkInterfaceId <String>
-PolicyDocument <String>
-LoadBalancerOptions_Port <Int32>
-NetworkInterfaceOptions_Port <Int32>
-RdsOptions_Port <Int32>
-CidrOptions_PortRange <CreateVerifiedAccessEndpointPortRange[]>
-LoadBalancerOptions_PortRange <CreateVerifiedAccessEndpointPortRange[]>
-NetworkInterfaceOptions_PortRange <CreateVerifiedAccessEndpointPortRange[]>
-CidrOptions_Protocol <VerifiedAccessEndpointProtocol>
-LoadBalancerOptions_Protocol <VerifiedAccessEndpointProtocol>
-NetworkInterfaceOptions_Protocol <VerifiedAccessEndpointProtocol>
-RdsOptions_Protocol <VerifiedAccessEndpointProtocol>
-RdsOptions_RdsDbClusterArn <String>
-RdsOptions_RdsDbInstanceArn <String>
-RdsOptions_RdsDbProxyArn <String>
-RdsOptions_RdsEndpoint <String>
-SecurityGroupId <String[]>
-CidrOptions_SubnetId <String[]>
-LoadBalancerOptions_SubnetId <String[]>
-RdsOptions_SubnetId <String[]>
-TagSpecification <TagSpecification[]>
-ClientToken <String>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonEC2Config>

Description

An Amazon Web Services Verified Access endpoint is where you define your application along with an optional endpoint-level access policy.

Parameters

-ApplicationDomain <String>
The DNS name for users to reach your application.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AttachmentType <VerifiedAccessEndpointAttachmentType>
The type of attachment.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-CidrOptions_Cidr <String>
The CIDR.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CidrOptions_PortRange <CreateVerifiedAccessEndpointPortRange[]>
The port ranges. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCidrOptions_PortRanges
-CidrOptions_Protocol <VerifiedAccessEndpointProtocol>
The protocol.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CidrOptions_SubnetId <String[]>
The IDs of the subnets. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCidrOptions_SubnetIds
-ClientConfig <AmazonEC2Config>
Amazon.PowerShell.Cmdlets.EC2.AmazonEC2ClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientToken <String>
A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see Ensuring idempotency.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Description <String>
A description for the Verified Access endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DomainCertificateArn <String>
The ARN of the public TLS/SSL certificate in Amazon Web Services Certificate Manager to associate with the endpoint. The CN in the certificate must match the DNS name your end users will use to reach your application.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DryRun <Boolean>
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EndpointDomainPrefix <String>
A custom identifier that is prepended to the DNS name that is generated for the endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EndpointType <VerifiedAccessEndpointType>
The type of Verified Access endpoint to create.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-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?True (ByPropertyName)
-LoadBalancerOptions_LoadBalancerArn <String>
The ARN of the load balancer.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-LoadBalancerOptions_Port <Int32>
The IP port number.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-LoadBalancerOptions_PortRange <CreateVerifiedAccessEndpointPortRange[]>
The port ranges. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesLoadBalancerOptions_PortRanges
-LoadBalancerOptions_Protocol <VerifiedAccessEndpointProtocol>
The IP protocol.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-LoadBalancerOptions_SubnetId <String[]>
The IDs of the subnets. You can specify only one subnet per Availability Zone. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesLoadBalancerOptions_SubnetIds
-NetworkInterfaceOptions_NetworkInterfaceId <String>
The ID of the network interface.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkInterfaceOptions_Port <Int32>
The IP port number.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkInterfaceOptions_PortRange <CreateVerifiedAccessEndpointPortRange[]>
The port ranges. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesNetworkInterfaceOptions_PortRanges
-NetworkInterfaceOptions_Protocol <VerifiedAccessEndpointProtocol>
The IP protocol.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PolicyDocument <String>
The Verified Access policy document.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RdsOptions_Port <Int32>
The port.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RdsOptions_Protocol <VerifiedAccessEndpointProtocol>
The protocol.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RdsOptions_RdsDbClusterArn <String>
The ARN of the DB cluster.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RdsOptions_RdsDbInstanceArn <String>
The ARN of the RDS instance.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RdsOptions_RdsDbProxyArn <String>
The ARN of the RDS proxy.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RdsOptions_RdsEndpoint <String>
The RDS endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RdsOptions_SubnetId <String[]>
The IDs of the subnets. You can specify only one subnet per Availability Zone. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRdsOptions_SubnetIds
-SecurityGroupId <String[]>
The IDs of the security groups to associate with the Verified Access endpoint. Required if AttachmentType is set to vpc. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSecurityGroupIds
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'VerifiedAccessEndpoint'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.EC2.Model.CreateVerifiedAccessEndpointResponse). Specifying the name of a property of type Amazon.EC2.Model.CreateVerifiedAccessEndpointResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SseSpecification_CustomerManagedKeyEnabled <Boolean>
Enable or disable the use of customer managed KMS keys for server side encryption.Valid values: True | False
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SseSpecification_KmsKeyArn <String>
The ARN of the KMS key.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-TagSpecification <TagSpecification[]>
The tags to assign to the Verified Access endpoint. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTagSpecifications
-VerifiedAccessGroupId <String>
The ID of the Verified Access group to associate the endpoint with.
Required?True
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?True (ByPropertyName)
AliasesAK
-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?True (ByValue, ByPropertyName)
-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?True (ByPropertyName)
-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?True (ByValue, ByPropertyName)
-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.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?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-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?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-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?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

Amazon.EC2.Model.VerifiedAccessEndpoint or Amazon.EC2.Model.CreateVerifiedAccessEndpointResponse
This cmdlet returns an Amazon.EC2.Model.VerifiedAccessEndpoint object. The service call response (type Amazon.EC2.Model.CreateVerifiedAccessEndpointResponse) can be returned by specifying '-Select *'.
User Guide
Service API Reference
Microsoft Windows Guide
VPC User Guide
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z