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) CreateVpcEndpoint API operation.

Syntax

New-EC2VpcEndpoint
-VpcId <String>
-DnsOptions_DnsRecordIpType <DnsRecordIpType>
-IpAddressType <IpAddressType>
-PolicyDocument <String>
-PrivateDnsEnabled <Boolean>
-DnsOptions_PrivateDnsOnlyForInboundResolverEndpoint <Boolean>
-DnsOptions_PrivateDnsPreference <String>
-DnsOptions_PrivateDnsSpecifiedDomain <String[]>
-ResourceConfigurationArn <String>
-RouteTableId <String[]>
-SecurityGroupId <String[]>
-ServiceName <String>
-ServiceNetworkArn <String>
-ServiceRegion <String>
-SubnetConfiguration <SubnetConfiguration[]>
-SubnetId <String[]>
-TagSpecification <TagSpecification[]>
-VpcEndpointType <VpcEndpointType>
-ClientToken <String>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>
-ClientConfig <AmazonEC2Config>

Description

Creates a VPC endpoint. A VPC endpoint provides a private connection between the specified VPC and the specified endpoint service. You can use an endpoint service provided by Amazon Web Services, an Amazon Web Services Marketplace Partner, or another Amazon Web Services account. For more information, see the Amazon Web Services PrivateLink User Guide.

Parameters

-ClientConfig <AmazonEC2Config>
Amazon.PowerShell.Cmdlets.EC2.AmazonEC2ClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientToken <String>
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DnsOptions_DnsRecordIpType <DnsRecordIpType>
The DNS records created for the endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DnsOptions_PrivateDnsOnlyForInboundResolverEndpoint <Boolean>
Indicates whether to enable private DNS only for inbound endpoints. This option is available only for services that support both gateway and interface endpoints. It routes traffic that originates from the VPC to the gateway endpoint and traffic that originates from on-premises to the interface endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DnsOptions_PrivateDnsPreference <String>
The preference for which private domains have a private hosted zone created for and associated with the specified VPC. Only supported when private DNS is enabled and when the VPC endpoint type is ServiceNetwork or Resource.
  • ALL_DOMAINS - VPC Lattice provisions private hosted zones for all custom domain names.
  • VERIFIED_DOMAINS_ONLY - VPC Lattice provisions a private hosted zone only if custom domain name has been verified by the provider.
  • VERIFIED_DOMAINS_AND_SPECIFIED_DOMAINS - VPC Lattice provisions private hosted zones for all verified custom domain names and other domain names that the resource consumer specifies. The resource consumer specifies the domain names in the PrivateDnsSpecifiedDomains parameter.
  • SPECIFIED_DOMAINS_ONLY - VPC Lattice provisions a private hosted zone for domain names specified by the resource consumer. The resource consumer specifies the domain names in the PrivateDnsSpecifiedDomains parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DnsOptions_PrivateDnsSpecifiedDomain <String[]>
Indicates which of the private domains to create private hosted zones for and associate with the specified VPC. Only supported when private DNS is enabled and the private DNS preference is verified-domains-and-specified-domains or specified-domains-only.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDnsOptions_PrivateDnsSpecifiedDomains
-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)
-IpAddressType <IpAddressType>
The IP address type for the endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the VpcId parameter. The -PassThru parameter is deprecated, use -Select '^VpcId' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PolicyDocument <String>
(Interface and gateway endpoints) A policy to attach to the endpoint that controls access to the service. The policy must be in valid JSON format. If this parameter is not specified, we attach a default policy that allows full access to the service.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PrivateDnsEnabled <Boolean>
(Interface endpoint) Indicates whether to associate a private hosted zone with the specified VPC. The private hosted zone contains a record set for the default public DNS name for the service for the Region (for example, kinesis.us-east-1.amazonaws.com), which resolves to the private IP addresses of the endpoint network interfaces in the VPC. This enables you to make requests to the default public DNS name for the service instead of the public DNS names that are automatically generated by the VPC endpoint service.To use a private hosted zone, you must set the following VPC attributes to true: enableDnsHostnames and enableDnsSupport. Use ModifyVpcAttribute to set the VPC attributes.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ResourceConfigurationArn <String>
The Amazon Resource Name (ARN) of a resource configuration that will be associated with the VPC endpoint of type resource.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RouteTableId <String[]>
(Gateway endpoint) The route table IDs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRouteTableIds
-SecurityGroupId <String[]>
(Interface endpoint) The IDs of the security groups to associate with the endpoint network interfaces. If this parameter is not specified, we use the default security group for the VPC.
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 '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.EC2.Model.CreateVpcEndpointResponse). Specifying the name of a property of type Amazon.EC2.Model.CreateVpcEndpointResponse 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)
-ServiceName <String>
The name of the endpoint service.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ServiceNetworkArn <String>
The Amazon Resource Name (ARN) of a service network that will be associated with the VPC endpoint of type service-network.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ServiceRegion <String>
The Region where the service is hosted. The default is the current Region.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SubnetConfiguration <SubnetConfiguration[]>
The subnet configurations for the endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSubnetConfigurations
-SubnetId <String[]>
(Interface and Gateway Load Balancer endpoints) The IDs of the subnets in which to create endpoint network interfaces. For a Gateway Load Balancer endpoint, you can specify only one subnet.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSubnetIds
-TagSpecification <TagSpecification[]>
The tags to associate with the endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTagSpecifications
-VpcEndpointType <VpcEndpointType>
The type of endpoint.Default: Gateway
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-VpcId <String>
The ID of the VPC.
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.CreateVpcEndpointResponse
This cmdlet returns an Amazon.EC2.Model.CreateVpcEndpointResponse object containing multiple properties.

Examples

Example 1

New-EC2VpcEndpoint -ServiceName com.amazonaws.eu-west-1.s3 -VpcId vpc-0fc1ff23f45b678eb

ClientToken VpcEndpoint
----------- -----------
            Amazon.EC2.Model.VpcEndpoint
This example create a new VPC Endpoint for the service com.amazonaws.eu-west-1.s3 in the VPC vpc-0fc1ff23f45b678eb
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