ec2_create_vpc_endpoint {aws.ecx}

Create Vpc Endpoint

Description

Create Vpc Endpoint

Usage

ec2_create_vpc_endpoint(
  VpcId,
  ServiceName,
  DryRun = NULL,
  VpcEndpointType = NULL,
  PolicyDocument = NULL,
  RouteTableId = NULL,
  SubnetId = NULL,
  SecurityGroupId = NULL,
  ClientToken = NULL,
  PrivateDnsEnabled = NULL,
  TagSpecification = NULL,
  simplify = TRUE,
  others = list(),
  print_on_error = aws_get_print_on_error(),
  retry_time = aws_get_retry_time(),
  network_timeout = aws_get_network_timeout(),
  region = aws_get_region()
)

Arguments

VpcId

Character. The ID of the VPC in which the endpoint will be used.

ServiceName

Character. The service name.

DryRun

Logical. Checks whether you have the required permissions for the action, without actually making the request,...[optional]

VpcEndpointType

Character. The type of endpoint. Default: Gateway [optional]

PolicyDocument

Character. (Interface and gateway endpoints) A policy to attach to the endpoint that controls access to the...[optional]

RouteTableId

List. (Gateway endpoint) One or more route table IDs.[optional]

SubnetId

List. (Interface and Gateway Load Balancer endpoints) The ID of one or more subnets in which to create...[optional]

SecurityGroupId

List. (Interface endpoint) The ID of one or more security groups to associate with the endpoint network...[optional]

ClientToken

Character. Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.[optional]

PrivateDnsEnabled

Logical. (Interface endpoint) Indicates whether to associate a private hosted zone with the specified VPC.[optional]

TagSpecification

List. The tags to associate with the endpoint.[optional]

simplify

Logical. Whether to simplify the result and handle nextToken in the response[optional]

others

Named list. The parameters that are not included in the function parameters and need to be added into the request[optional]

print_on_error

Logical. Whether to show an error message when a network error occurs.

retry_time

Integer. Number of retries for a REST request when encounter the network issue. If the request has been sent retry_time times but still not be able to get the response, an error will be thrown.

network_timeout

Numeric. Number of seconds to wait for a REST response until giving up. Can not be less than 1 ms.

region

Character. The region of the AWS service.

Value

A list object or a character vector

VpcId

The ID of the VPC in which the endpoint will be used.

ServiceName

The service name. To get a list of available services, use the DescribeVpcEndpointServices request, or get the name from the service provider.

DryRun

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.

VpcEndpointType

The type of endpoint.

Default: Gateway

PolicyDocument

(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.

RouteTableId

(Gateway endpoint) One or more route table IDs.

SubnetId

(Interface and Gateway Load Balancer endpoints) The ID of one or more subnets in which to create an endpoint network interface. For a Gateway Load Balancer endpoint, you can specify one subnet only.

SecurityGroupId

(Interface endpoint) The ID of one or more security groups to associate with the endpoint network interface.

ClientToken

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

PrivateDnsEnabled

(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.

Default: true

TagSpecification

The tags to associate with the endpoint.