You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::EC2::Types::CreateVpcEndpointRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing CreateVpcEndpointRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  dry_run: false,
  vpc_endpoint_type: "Interface", # accepts Interface, Gateway, GatewayLoadBalancer
  vpc_id: "VpcId", # required
  service_name: "String", # required
  policy_document: "String",
  route_table_ids: ["RouteTableId"],
  subnet_ids: ["SubnetId"],
  security_group_ids: ["SecurityGroupId"],
  client_token: "String",
  private_dns_enabled: false,
  tag_specifications: [
    {
      resource_type: "client-vpn-endpoint", # accepts client-vpn-endpoint, customer-gateway, 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, internet-gateway, key-pair, launch-template, local-gateway-route-table-vpc-association, natgateway, network-acl, network-interface, placement-group, reserved-instances, route-table, security-group, snapshot, spot-fleet-request, spot-instances-request, subnet, traffic-mirror-filter, traffic-mirror-session, traffic-mirror-target, transit-gateway, transit-gateway-attachment, transit-gateway-multicast-domain, transit-gateway-route-table, volume, vpc, vpc-peering-connection, vpn-connection, vpn-gateway, vpc-flow-log
      tags: [
        {
          key: "String",
          value: "String",
        },
      ],
    },
  ],
}

Contains the parameters for CreateVpcEndpoint.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#client_token ⇒ String

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

Returns:

  • (String) —

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

#dry_run ⇒ 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.

Returns:

  • (Boolean) —

    Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.

#policy_document ⇒ 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.

Returns:

  • (String) —

    (Interface and gateway endpoints) A policy to attach to the endpoint that controls access to the service.

#private_dns_enabled ⇒ 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.

Default: true

Returns:

  • (Boolean) —

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

#route_table_ids ⇒ Array<String>

(Gateway endpoint) One or more route table IDs.

Returns:

  • (Array<String>) —

    (Gateway endpoint) One or more route table IDs.

#security_group_ids ⇒ Array<String>

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

Returns:

  • (Array<String>) —

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

#service_name ⇒ String

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

Returns:

  • (String) —

    The service name.

#subnet_ids ⇒ Array<String>

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

Returns:

  • (Array<String>) —

    (Interface and Gateway Load Balancer endpoints) The ID of one or more subnets in which to create an endpoint network interface.

#tag_specifications ⇒ Array<Types::TagSpecification>

The tags to associate with the endpoint.

Returns:

#vpc_endpoint_type ⇒ String

The type of endpoint.

Default: Gateway

Possible values:

  • Interface
  • Gateway
  • GatewayLoadBalancer

Returns:

  • (String) —

    The type of endpoint.

#vpc_id ⇒ String

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

Returns:

  • (String) —

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