Class: Aws::EC2::Types::CreateVpcEndpointRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::EC2::Types::CreateVpcEndpointRequest
- Includes:
- Structure
- Defined in:
- lib/aws-sdk-ec2/types.rb
Overview
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
-
#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.
-
#private_dns_enabled ⇒ Boolean
(Interface endpoint) Indicate whether to associate a private hosted zone with the specified VPC.
-
#route_table_ids ⇒ 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.
-
#service_name ⇒ String
The service name.
-
#subnet_ids ⇒ Array<String>
(Interface endpoint) The ID of one or more subnets in which to create an endpoint network interface.
-
#vpc_endpoint_type ⇒ String
The type of endpoint.
-
#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
7171 7172 7173 7174 7175 7176 7177 7178 7179 7180 7181 7182 7183 |
# File 'lib/aws-sdk-ec2/types.rb', line 7171 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_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`.
7171 7172 7173 7174 7175 7176 7177 7178 7179 7180 7181 7182 7183 |
# File 'lib/aws-sdk-ec2/types.rb', line 7171 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_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.
7171 7172 7173 7174 7175 7176 7177 7178 7179 7180 7181 7182 7183 |
# File 'lib/aws-sdk-ec2/types.rb', line 7171 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_enabled ⇒ Boolean
(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: ‘false`
7171 7172 7173 7174 7175 7176 7177 7178 7179 7180 7181 7182 7183 |
# File 'lib/aws-sdk-ec2/types.rb', line 7171 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_ids ⇒ Array<String>
(Gateway endpoint) One or more route table IDs.
7171 7172 7173 7174 7175 7176 7177 7178 7179 7180 7181 7182 7183 |
# File 'lib/aws-sdk-ec2/types.rb', line 7171 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_ids ⇒ Array<String>
(Interface endpoint) The ID of one or more security groups to associate with the endpoint network interface.
7171 7172 7173 7174 7175 7176 7177 7178 7179 7180 7181 7182 7183 |
# File 'lib/aws-sdk-ec2/types.rb', line 7171 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_name ⇒ String
The service name. To get a list of available services, use the DescribeVpcEndpointServices request, or get the name from the service provider.
7171 7172 7173 7174 7175 7176 7177 7178 7179 7180 7181 7182 7183 |
# File 'lib/aws-sdk-ec2/types.rb', line 7171 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_ids ⇒ Array<String>
(Interface endpoint) The ID of one or more subnets in which to create an endpoint network interface.
7171 7172 7173 7174 7175 7176 7177 7178 7179 7180 7181 7182 7183 |
# File 'lib/aws-sdk-ec2/types.rb', line 7171 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_type ⇒ String
The type of endpoint.
Default: Gateway
7171 7172 7173 7174 7175 7176 7177 7178 7179 7180 7181 7182 7183 |
# File 'lib/aws-sdk-ec2/types.rb', line 7171 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_id ⇒ String
The ID of the VPC in which the endpoint will be used.
7171 7172 7173 7174 7175 7176 7177 7178 7179 7180 7181 7182 7183 |
# File 'lib/aws-sdk-ec2/types.rb', line 7171 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 |