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

Inherits:
Struct
  • Object
show all
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:

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

See Also:

Instance Attribute Summary collapse

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) 


7117
7118
7119
7120
7121
7122
7123
7124
7125
7126
7127
7128
7129
 
# File 'lib/aws-sdk-ec2/types.rb', line 7117

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

Returns:

  • (Boolean) 


7117
7118
7119
7120
7121
7122
7123
7124
7125
7126
7127
7128
7129
 
# File 'lib/aws-sdk-ec2/types.rb', line 7117

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

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


7117
7118
7119
7120
7121
7122
7123
7124
7125
7126
7127
7128
7129
 
# File 'lib/aws-sdk-ec2/types.rb', line 7117

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`

Returns:

  • (Boolean) 


7117
7118
7119
7120
7121
7122
7123
7124
7125
7126
7127
7128
7129
 
# File 'lib/aws-sdk-ec2/types.rb', line 7117

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.

Returns:

  • (Array<String>) 


7117
7118
7119
7120
7121
7122
7123
7124
7125
7126
7127
7128
7129
 
# File 'lib/aws-sdk-ec2/types.rb', line 7117

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.

Returns:

  • (Array<String>) 


7117
7118
7119
7120
7121
7122
7123
7124
7125
7126
7127
7128
7129
 
# File 'lib/aws-sdk-ec2/types.rb', line 7117

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.

Returns:

  • (String) 


7117
7118
7119
7120
7121
7122
7123
7124
7125
7126
7127
7128
7129
 
# File 'lib/aws-sdk-ec2/types.rb', line 7117

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.

Returns:

  • (Array<String>) 


7117
7118
7119
7120
7121
7122
7123
7124
7125
7126
7127
7128
7129
 
# File 'lib/aws-sdk-ec2/types.rb', line 7117

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

Returns:

  • (String) 


7117
7118
7119
7120
7121
7122
7123
7124
7125
7126
7127
7128
7129
 
# File 'lib/aws-sdk-ec2/types.rb', line 7117

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.

Returns:

  • (String) 


7117
7118
7119
7120
7121
7122
7123
7124
7125
7126
7127
7128
7129
 
# File 'lib/aws-sdk-ec2/types.rb', line 7117

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