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

Inherits:

Struct

• Object
• Struct
• Aws::EC2::Types::CreateVpcEndpointRequest

Includes:

Structure

Defined in:

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.

See Also:

• AWS API Documentation

Instance Attribute Summary

• #client_token ⇒ String

  Unique, case-sensitive identifier 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.

• #policy_document ⇒ String

  A policy to attach to the endpoint that controls access to the service.

• #route_table_ids ⇒ Array<String>

  One or more route table IDs.

• #service_name ⇒ String

  The AWS service name, in the form ‘com.amazonaws.region.service `.

• #vpc_id ⇒ String

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

Instance Attribute Details

#client_token ⇒ String

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

[1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html

Returns:

• (String)

# File 'lib/aws-sdk-ec2/types.rb', line 4037

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

#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)

# File 'lib/aws-sdk-ec2/types.rb', line 4037

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

#policy_document ⇒ String

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)

# File 'lib/aws-sdk-ec2/types.rb', line 4037

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

#route_table_ids ⇒ Array<String>

One or more route table IDs.

Returns:

• (Array<String>)

# File 'lib/aws-sdk-ec2/types.rb', line 4037

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

#service_name ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-ec2/types.rb', line 4037

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

#vpc_id ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-ec2/types.rb', line 4037

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