Create Vpc Endpoint

ec2_create_vpc_endpoint

R Documentation

Creates a VPC endpoint

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.

Usage

ec2_create_vpc_endpoint(DryRun, VpcEndpointType, VpcId, ServiceName,
  PolicyDocument, RouteTableIds, SubnetIds, SecurityGroupIds,
  IpAddressType, DnsOptions, ClientToken, PrivateDnsEnabled,
  TagSpecifications, SubnetConfigurations)

Arguments

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

VpcId

[required] The ID of the VPC.

ServiceName

[required] The name of the endpoint service.

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.

RouteTableIds

(Gateway endpoint) The route table IDs.

SubnetIds

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

SecurityGroupIds

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

IpAddressType

The IP address type for the endpoint.

DnsOptions

The DNS options for the endpoint.

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 modify_vpc_attribute to set the VPC attributes.

Default: true

TagSpecifications

The tags to associate with the endpoint.

SubnetConfigurations

The subnet configurations for the endpoint.

Value

A list with the following syntax:

list(
  VpcEndpoint = list(
    VpcEndpointId = "string",
    VpcEndpointType = "Interface"|"Gateway"|"GatewayLoadBalancer",
    VpcId = "string",
    ServiceName = "string",
    State = "PendingAcceptance"|"Pending"|"Available"|"Deleting"|"Deleted"|"Rejected"|"Failed"|"Expired",
    PolicyDocument = "string",
    RouteTableIds = list(
      "string"
    ),
    SubnetIds = list(
      "string"
    ),
    Groups = list(
      list(
        GroupId = "string",
        GroupName = "string"
      )
    ),
    IpAddressType = "ipv4"|"dualstack"|"ipv6",
    DnsOptions = list(
      DnsRecordIpType = "ipv4"|"dualstack"|"ipv6"|"service-defined",
      PrivateDnsOnlyForInboundResolverEndpoint = TRUE|FALSE
    ),
    PrivateDnsEnabled = TRUE|FALSE,
    RequesterManaged = TRUE|FALSE,
    NetworkInterfaceIds = list(
      "string"
    ),
    DnsEntries = list(
      list(
        DnsName = "string",
        HostedZoneId = "string"
      )
    ),
    CreationTimestamp = as.POSIXct(
      "2015-01-01"
    ),
    Tags = list(
      list(
        Key = "string",
        Value = "string"
      )
    ),
    OwnerId = "string",
    LastError = list(
      Message = "string",
      Code = "string"
    )
  ),
  ClientToken = "string"
)

Request syntax

svc$create_vpc_endpoint(
  DryRun = TRUE|FALSE,
  VpcEndpointType = "Interface"|"Gateway"|"GatewayLoadBalancer",
  VpcId = "string",
  ServiceName = "string",
  PolicyDocument = "string",
  RouteTableIds = list(
    "string"
  ),
  SubnetIds = list(
    "string"
  ),
  SecurityGroupIds = list(
    "string"
  ),
  IpAddressType = "ipv4"|"dualstack"|"ipv6",
  DnsOptions = list(
    DnsRecordIpType = "ipv4"|"dualstack"|"ipv6"|"service-defined",
    PrivateDnsOnlyForInboundResolverEndpoint = TRUE|FALSE
  ),
  ClientToken = "string",
  PrivateDnsEnabled = TRUE|FALSE,
  TagSpecifications = list(
    list(
      ResourceType = "capacity-reservation"|"client-vpn-endpoint"|"customer-gateway"|"carrier-gateway"|"coip-pool"|"dedicated-host"|"dhcp-options"|"egress-only-internet-gateway"|"elastic-ip"|"elastic-gpu"|"export-image-task"|"export-instance-task"|"fleet"|"fpga-image"|"host-reservation"|"image"|"import-image-task"|"import-snapshot-task"|"instance"|"instance-event-window"|"internet-gateway"|"ipam"|"ipam-pool"|"ipam-scope"|"ipv4pool-ec2"|"ipv6pool-ec2"|"key-pair"|"launch-template"|"local-gateway"|"local-gateway-route-table"|"local-gateway-virtual-interface"|"local-gateway-virtual-interface-group"|"local-gateway-route-table-vpc-association"|"local-gateway-route-table-virtual-interface-group-association"|"natgateway"|"network-acl"|"network-interface"|"network-insights-analysis"|"network-insights-path"|"network-insights-access-scope"|"network-insights-access-scope-analysis"|"placement-group"|"prefix-list"|"replace-root-volume-task"|"reserved-instances"|"route-table"|"security-group"|"security-group-rule"|"snapshot"|"spot-fleet-request"|"spot-instances-request"|"subnet"|"subnet-cidr-reservation"|"traffic-mirror-filter"|"traffic-mirror-session"|"traffic-mirror-target"|"transit-gateway"|"transit-gateway-attachment"|"transit-gateway-connect-peer"|"transit-gateway-multicast-domain"|"transit-gateway-policy-table"|"transit-gateway-route-table"|"transit-gateway-route-table-announcement"|"volume"|"vpc"|"vpc-endpoint"|"vpc-endpoint-connection"|"vpc-endpoint-service"|"vpc-endpoint-service-permission"|"vpc-peering-connection"|"vpn-connection"|"vpn-gateway"|"vpc-flow-log"|"capacity-reservation-fleet"|"traffic-mirror-filter-rule"|"vpc-endpoint-connection-device-type"|"verified-access-instance"|"verified-access-group"|"verified-access-endpoint"|"verified-access-policy"|"verified-access-trust-provider"|"vpn-connection-device-type"|"vpc-block-public-access-exclusion"|"ipam-resource-discovery"|"ipam-resource-discovery-association"|"instance-connect-endpoint"|"ipam-external-resource-verification-token",
      Tags = list(
        list(
          Key = "string",
          Value = "string"
        )
      )
    )
  ),
  SubnetConfigurations = list(
    list(
      SubnetId = "string",
      Ipv4 = "string",
      Ipv6 = "string"
    )
  )
)