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:

{
  dry_run: false,
  vpc_endpoint_type: "Interface", # accepts Interface, Gateway
  vpc_id: "String", # required
  service_name: "String", # required
  policy_document: "String",
  route_table_ids: ["String"],
  subnet_ids: ["String"],
  security_group_ids: ["String"],
  client_token: "String",
  private_dns_enabled: false,
}

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)


4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 4752

class CreateVpcEndpointRequest < Struct.new(
  :dry_run,
  :vpc_endpoint_type,
  :vpc_id,
  :service_name,
  :policy_document,
  :route_table_ids,
  :subnet_ids,
  :security_group_ids,
  :client_token,
  :private_dns_enabled)
  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)


4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 4752

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

#policy_documentString

(Gateway endpoint) 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)


4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 4752

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

#private_dns_enabledBoolean

(Interface endpoint) Indicate 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)


4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 4752

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

#route_table_idsArray<String>

(Gateway endpoint) One or more route table IDs.

Returns:

  • (Array<String>)


4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 4752

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

#security_group_idsArray<String>

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

Returns:

  • (Array<String>)


4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 4752

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

#service_nameString

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

Returns:

  • (String)


4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 4752

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

#subnet_idsArray<String>

(Interface endpoint) The ID of one or more subnets in which to create an endpoint network interface.

Returns:

  • (Array<String>)


4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 4752

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

#vpc_endpoint_typeString

The type of endpoint.

Default: Gateway

Returns:

  • (String)


4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 4752

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

#vpc_idString

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

Returns:

  • (String)


4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 4752

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