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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb

Overview

Note:

When making an API call, you may pass CreateVpcEndpointRequest data as a hash:

{
  client_token: "String",
  dry_run: false,
  policy_document: "String",
  route_table_ids: ["String"],
  service_name: "String", # required
  vpc_id: "String", # required
}

Contains the parameters for CreateVpcEndpoint.

Instance Attribute Summary collapse

Instance Attribute Details

#client_tokenString

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

Returns:

  • (String)


4112
4113
4114
4115
4116
4117
4118
4119
4120
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 4112

class CreateVpcEndpointRequest < Struct.new(
  :client_token,
  :dry_run,
  :policy_document,
  :route_table_ids,
  :service_name,
  :vpc_id)
  include Aws::Structure
end

#dry_runBoolean

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)


4112
4113
4114
4115
4116
4117
4118
4119
4120
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 4112

class CreateVpcEndpointRequest < Struct.new(
  :client_token,
  :dry_run,
  :policy_document,
  :route_table_ids,
  :service_name,
  :vpc_id)
  include Aws::Structure
end

#policy_documentString

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)


4112
4113
4114
4115
4116
4117
4118
4119
4120
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 4112

class CreateVpcEndpointRequest < Struct.new(
  :client_token,
  :dry_run,
  :policy_document,
  :route_table_ids,
  :service_name,
  :vpc_id)
  include Aws::Structure
end

#route_table_idsArray<String>

One or more route table IDs.

Returns:

  • (Array<String>)


4112
4113
4114
4115
4116
4117
4118
4119
4120
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 4112

class CreateVpcEndpointRequest < Struct.new(
  :client_token,
  :dry_run,
  :policy_document,
  :route_table_ids,
  :service_name,
  :vpc_id)
  include Aws::Structure
end

#service_nameString

The AWS service name, in the form com.amazonaws.region.service. To get a list of available services, use the DescribeVpcEndpointServices request.

Returns:

  • (String)


4112
4113
4114
4115
4116
4117
4118
4119
4120
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 4112

class CreateVpcEndpointRequest < Struct.new(
  :client_token,
  :dry_run,
  :policy_document,
  :route_table_ids,
  :service_name,
  :vpc_id)
  include Aws::Structure
end

#vpc_idString

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

Returns:

  • (String)


4112
4113
4114
4115
4116
4117
4118
4119
4120
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 4112

class CreateVpcEndpointRequest < Struct.new(
  :client_token,
  :dry_run,
  :policy_document,
  :route_table_ids,
  :service_name,
  :vpc_id)
  include Aws::Structure
end