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

Inherits:

Struct

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

show all

Defined in:: gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb

Overview

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#client_token ⇒ String
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
#dns_options ⇒ Types::DnsOptionsSpecification
The DNS options for the endpoint.
#dry_run ⇒ Boolean
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.
#ip_address_type ⇒ String
The IP address type for the endpoint.
#policy_document ⇒ String
(Interface and gateway endpoints) A policy to attach to the endpoint that controls access to the service.
#private_dns_enabled ⇒ Boolean
(Interface endpoint) Indicates whether to associate a private hosted zone with the specified VPC.
#resource_configuration_arn ⇒ String
(Resource and Tunnel endpoints only) The Amazon Resource Name (ARN) of a resource configuration associated with the VPC endpoint.
#route_table_ids ⇒ Array<String>
(Gateway endpoint) The route table IDs.
#security_group_ids ⇒ Array<String>
(Interface, Resource, ServiceNetwork, and Tunnel endpoints only) The IDs of the security groups to associate with the endpoint network interfaces.
#service_name ⇒ String
The name of the endpoint service.
#service_network_arn ⇒ String
The Amazon Resource Name (ARN) of a service network that will be associated with the VPC endpoint of type service-network.
#service_region ⇒ String
The Region where the service is hosted.
#subnet_configurations ⇒ Array<Types::SubnetConfiguration>
The subnet configurations for the endpoint.
#subnet_ids ⇒ Array<String>
(Interface, Gateway Load Balancer endpoints, Resource, ServiceNetwork, and Tunnel endpoints only) The IDs of the subnets in which to create endpoint network interfaces.
#tag_specifications ⇒ Array<Types::TagSpecification>
The tags to associate with the endpoint.
#vpc_endpoint_type ⇒ String
The type of endpoint.
#vpc_id ⇒ String
The ID of the VPC.

Instance Attribute Details

#client_token ⇒ `String`

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

Returns:

(String)

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

class CreateVpcEndpointRequest < Struct.new(
  :dry_run,
  :vpc_endpoint_type,
  :vpc_id,
  :service_name,
  :policy_document,
  :route_table_ids,
  :subnet_ids,
  :security_group_ids,
  :ip_address_type,
  :dns_options,
  :client_token,
  :private_dns_enabled,
  :tag_specifications,
  :subnet_configurations,
  :service_network_arn,
  :resource_configuration_arn,
  :service_region)
  SENSITIVE = []
  include Aws::Structure
end

#dns_options ⇒ `Types::DnsOptionsSpecification`

The DNS options for the endpoint.

Returns:

(Types::DnsOptionsSpecification)

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

class CreateVpcEndpointRequest < Struct.new(
  :dry_run,
  :vpc_endpoint_type,
  :vpc_id,
  :service_name,
  :policy_document,
  :route_table_ids,
  :subnet_ids,
  :security_group_ids,
  :ip_address_type,
  :dns_options,
  :client_token,
  :private_dns_enabled,
  :tag_specifications,
  :subnet_configurations,
  :service_network_arn,
  :resource_configuration_arn,
  :service_region)
  SENSITIVE = []
  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 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 18625

class CreateVpcEndpointRequest < Struct.new(
  :dry_run,
  :vpc_endpoint_type,
  :vpc_id,
  :service_name,
  :policy_document,
  :route_table_ids,
  :subnet_ids,
  :security_group_ids,
  :ip_address_type,
  :dns_options,
  :client_token,
  :private_dns_enabled,
  :tag_specifications,
  :subnet_configurations,
  :service_network_arn,
  :resource_configuration_arn,
  :service_region)
  SENSITIVE = []
  include Aws::Structure
end

#ip_address_type ⇒ `String`

The IP address type for the endpoint.

Returns:

(String)

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

class CreateVpcEndpointRequest < Struct.new(
  :dry_run,
  :vpc_endpoint_type,
  :vpc_id,
  :service_name,
  :policy_document,
  :route_table_ids,
  :subnet_ids,
  :security_group_ids,
  :ip_address_type,
  :dns_options,
  :client_token,
  :private_dns_enabled,
  :tag_specifications,
  :subnet_configurations,
  :service_network_arn,
  :resource_configuration_arn,
  :service_region)
  SENSITIVE = []
  include Aws::Structure
end

#policy_document ⇒ `String`

(Interface and gateway endpoints) 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 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 18625

class CreateVpcEndpointRequest < Struct.new(
  :dry_run,
  :vpc_endpoint_type,
  :vpc_id,
  :service_name,
  :policy_document,
  :route_table_ids,
  :subnet_ids,
  :security_group_ids,
  :ip_address_type,
  :dns_options,
  :client_token,
  :private_dns_enabled,
  :tag_specifications,
  :subnet_configurations,
  :service_network_arn,
  :resource_configuration_arn,
  :service_region)
  SENSITIVE = []
  include Aws::Structure
end

#private_dns_enabled ⇒ `Boolean`

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

Returns:

(Boolean)

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

class CreateVpcEndpointRequest < Struct.new(
  :dry_run,
  :vpc_endpoint_type,
  :vpc_id,
  :service_name,
  :policy_document,
  :route_table_ids,
  :subnet_ids,
  :security_group_ids,
  :ip_address_type,
  :dns_options,
  :client_token,
  :private_dns_enabled,
  :tag_specifications,
  :subnet_configurations,
  :service_network_arn,
  :resource_configuration_arn,
  :service_region)
  SENSITIVE = []
  include Aws::Structure
end

#resource_configuration_arn ⇒ `String`

(Resource and Tunnel endpoints only) The Amazon Resource Name (ARN) of a resource configuration associated with the VPC endpoint. The type of resource configuration depends on the endpoint type:

For a Resource endpoint, you can specify a resource configuration that is of type SINGLE, GROUP, or ARN. To reach a resource that belongs to a group, specify the parent GROUP resource configuration.
For a Tunnel endpoint, you can specify a resource configuration that is of type CIDR.

For more information about the types of resource configurations, see Types of resource configurations in the Amazon Web Services PrivateLink User Guide.

This request fails if a VPC endpoint owned by a different Amazon Web Services account already exists on a resource gateway that is enabled for ResourceGatewayCharges payer responsibility.

Returns:

(String)

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

class CreateVpcEndpointRequest < Struct.new(
  :dry_run,
  :vpc_endpoint_type,
  :vpc_id,
  :service_name,
  :policy_document,
  :route_table_ids,
  :subnet_ids,
  :security_group_ids,
  :ip_address_type,
  :dns_options,
  :client_token,
  :private_dns_enabled,
  :tag_specifications,
  :subnet_configurations,
  :service_network_arn,
  :resource_configuration_arn,
  :service_region)
  SENSITIVE = []
  include Aws::Structure
end

#route_table_ids ⇒ `Array<String>`

(Gateway endpoint) The route table IDs.

Returns:

(Array<String>)

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

class CreateVpcEndpointRequest < Struct.new(
  :dry_run,
  :vpc_endpoint_type,
  :vpc_id,
  :service_name,
  :policy_document,
  :route_table_ids,
  :subnet_ids,
  :security_group_ids,
  :ip_address_type,
  :dns_options,
  :client_token,
  :private_dns_enabled,
  :tag_specifications,
  :subnet_configurations,
  :service_network_arn,
  :resource_configuration_arn,
  :service_region)
  SENSITIVE = []
  include Aws::Structure
end

#security_group_ids ⇒ `Array<String>`

(Interface, Resource, ServiceNetwork, and Tunnel endpoints only) The IDs of the security groups to associate with the endpoint network interfaces. If this parameter is not specified, we use the default security group for the VPC.

Returns:

(Array<String>)

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

class CreateVpcEndpointRequest < Struct.new(
  :dry_run,
  :vpc_endpoint_type,
  :vpc_id,
  :service_name,
  :policy_document,
  :route_table_ids,
  :subnet_ids,
  :security_group_ids,
  :ip_address_type,
  :dns_options,
  :client_token,
  :private_dns_enabled,
  :tag_specifications,
  :subnet_configurations,
  :service_network_arn,
  :resource_configuration_arn,
  :service_region)
  SENSITIVE = []
  include Aws::Structure
end

#service_name ⇒ `String`

The name of the endpoint service.

Returns:

(String)

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

class CreateVpcEndpointRequest < Struct.new(
  :dry_run,
  :vpc_endpoint_type,
  :vpc_id,
  :service_name,
  :policy_document,
  :route_table_ids,
  :subnet_ids,
  :security_group_ids,
  :ip_address_type,
  :dns_options,
  :client_token,
  :private_dns_enabled,
  :tag_specifications,
  :subnet_configurations,
  :service_network_arn,
  :resource_configuration_arn,
  :service_region)
  SENSITIVE = []
  include Aws::Structure
end

#service_network_arn ⇒ `String`

The Amazon Resource Name (ARN) of a service network that will be associated with the VPC endpoint of type service-network.

Returns:

(String)

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

class CreateVpcEndpointRequest < Struct.new(
  :dry_run,
  :vpc_endpoint_type,
  :vpc_id,
  :service_name,
  :policy_document,
  :route_table_ids,
  :subnet_ids,
  :security_group_ids,
  :ip_address_type,
  :dns_options,
  :client_token,
  :private_dns_enabled,
  :tag_specifications,
  :subnet_configurations,
  :service_network_arn,
  :resource_configuration_arn,
  :service_region)
  SENSITIVE = []
  include Aws::Structure
end

#service_region ⇒ `String`

The Region where the service is hosted. The default is the current Region.

Returns:

(String)

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

class CreateVpcEndpointRequest < Struct.new(
  :dry_run,
  :vpc_endpoint_type,
  :vpc_id,
  :service_name,
  :policy_document,
  :route_table_ids,
  :subnet_ids,
  :security_group_ids,
  :ip_address_type,
  :dns_options,
  :client_token,
  :private_dns_enabled,
  :tag_specifications,
  :subnet_configurations,
  :service_network_arn,
  :resource_configuration_arn,
  :service_region)
  SENSITIVE = []
  include Aws::Structure
end

#subnet_configurations ⇒ `Array<Types::SubnetConfiguration>`

The subnet configurations for the endpoint.

Returns:

(Array<Types::SubnetConfiguration>)

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

class CreateVpcEndpointRequest < Struct.new(
  :dry_run,
  :vpc_endpoint_type,
  :vpc_id,
  :service_name,
  :policy_document,
  :route_table_ids,
  :subnet_ids,
  :security_group_ids,
  :ip_address_type,
  :dns_options,
  :client_token,
  :private_dns_enabled,
  :tag_specifications,
  :subnet_configurations,
  :service_network_arn,
  :resource_configuration_arn,
  :service_region)
  SENSITIVE = []
  include Aws::Structure
end

#subnet_ids ⇒ `Array<String>`

(Interface, Gateway Load Balancer endpoints, Resource, ServiceNetwork, and Tunnel endpoints only) The IDs of the subnets in which to create endpoint network interfaces. For a Gateway Load Balancer endpoint, you can specify only one subnet. For a Tunnel endpoint, the subnets must be in the Availability Zones of the resource gateway associated with the shared resource configuration. An endpoint network interface is created only in an Availability Zone that the resource gateway is also in.

Returns:

(Array<String>)

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

class CreateVpcEndpointRequest < Struct.new(
  :dry_run,
  :vpc_endpoint_type,
  :vpc_id,
  :service_name,
  :policy_document,
  :route_table_ids,
  :subnet_ids,
  :security_group_ids,
  :ip_address_type,
  :dns_options,
  :client_token,
  :private_dns_enabled,
  :tag_specifications,
  :subnet_configurations,
  :service_network_arn,
  :resource_configuration_arn,
  :service_region)
  SENSITIVE = []
  include Aws::Structure
end

#tag_specifications ⇒ `Array<Types::TagSpecification>`

The tags to associate with the endpoint.

Returns:

(Array<Types::TagSpecification>)

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

class CreateVpcEndpointRequest < Struct.new(
  :dry_run,
  :vpc_endpoint_type,
  :vpc_id,
  :service_name,
  :policy_document,
  :route_table_ids,
  :subnet_ids,
  :security_group_ids,
  :ip_address_type,
  :dns_options,
  :client_token,
  :private_dns_enabled,
  :tag_specifications,
  :subnet_configurations,
  :service_network_arn,
  :resource_configuration_arn,
  :service_region)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_endpoint_type ⇒ `String`

The type of endpoint.

For more information about the types of VPC endpoints, see VPC endpoints in the Amazon Web Services PrivateLink User Guide.

Default: Gateway

Returns:

(String)

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

class CreateVpcEndpointRequest < Struct.new(
  :dry_run,
  :vpc_endpoint_type,
  :vpc_id,
  :service_name,
  :policy_document,
  :route_table_ids,
  :subnet_ids,
  :security_group_ids,
  :ip_address_type,
  :dns_options,
  :client_token,
  :private_dns_enabled,
  :tag_specifications,
  :subnet_configurations,
  :service_network_arn,
  :resource_configuration_arn,
  :service_region)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_id ⇒ `String`

The ID of the VPC.

Returns:

(String)

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

class CreateVpcEndpointRequest < Struct.new(
  :dry_run,
  :vpc_endpoint_type,
  :vpc_id,
  :service_name,
  :policy_document,
  :route_table_ids,
  :subnet_ids,
  :security_group_ids,
  :ip_address_type,
  :dns_options,
  :client_token,
  :private_dns_enabled,
  :tag_specifications,
  :subnet_configurations,
  :service_network_arn,
  :resource_configuration_arn,
  :service_region)
  SENSITIVE = []
  include Aws::Structure
end

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

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#client_token ⇒ String

#dns_options ⇒ Types::DnsOptionsSpecification

#dry_run ⇒ Boolean

#ip_address_type ⇒ String

#policy_document ⇒ String

#private_dns_enabled ⇒ Boolean

#resource_configuration_arn ⇒ String

#route_table_ids ⇒ Array<String>

#security_group_ids ⇒ Array<String>

#service_name ⇒ String

#service_network_arn ⇒ String

#service_region ⇒ String

#subnet_configurations ⇒ Array<Types::SubnetConfiguration>

#subnet_ids ⇒ Array<String>

#tag_specifications ⇒ Array<Types::TagSpecification>

#vpc_endpoint_type ⇒ String

#vpc_id ⇒ String

#client_token ⇒ `String`

#dns_options ⇒ `Types::DnsOptionsSpecification`

#dry_run ⇒ `Boolean`

#ip_address_type ⇒ `String`

#policy_document ⇒ `String`

#private_dns_enabled ⇒ `Boolean`

#resource_configuration_arn ⇒ `String`

#route_table_ids ⇒ `Array<String>`

#security_group_ids ⇒ `Array<String>`

#service_name ⇒ `String`

#service_network_arn ⇒ `String`

#service_region ⇒ `String`

#subnet_configurations ⇒ `Array<Types::SubnetConfiguration>`

#subnet_ids ⇒ `Array<String>`

#tag_specifications ⇒ `Array<Types::TagSpecification>`

#vpc_endpoint_type ⇒ `String`

#vpc_id ⇒ `String`