Class: Aws::EC2::Types::ModifyVpcEndpointRequest

Inherits:

Struct

• Object
• Struct
• Aws::EC2::Types::ModifyVpcEndpointRequest

Includes:

Structure

Defined in:

lib/aws-sdk-ec2/types.rb

Overview

Note:

When making an API call, you may pass ModifyVpcEndpointRequest data as a hash:

{
  dry_run: false,
  vpc_endpoint_id: "String", # required
  reset_policy: false,
  policy_document: "String",
  add_route_table_ids: ["String"],
  remove_route_table_ids: ["String"],
  add_subnet_ids: ["String"],
  remove_subnet_ids: ["String"],
  add_security_group_ids: ["String"],
  remove_security_group_ids: ["String"],
  private_dns_enabled: false,
}

Contains the parameters for ModifyVpcEndpoint.

See Also:

• AWS API Documentation

Instance Attribute Summary

• #add_route_table_ids ⇒ Array<String>

  (Gateway endpoint) One or more route tables IDs to associate with the endpoint.

• #add_security_group_ids ⇒ Array<String>

  (Interface endpoint) One or more security group IDs to associate with the network interface.

• #add_subnet_ids ⇒ Array<String>

  (Interface endpoint) One or more subnet IDs in which to serve 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.

• #policy_document ⇒ String

  (Gateway endpoint) A policy document to attach to the endpoint.

• #private_dns_enabled ⇒ Boolean

  (Interface endpoint) Indicate whether a private hosted zone is associated with the VPC.

• #remove_route_table_ids ⇒ Array<String>

  (Gateway endpoint) One or more route table IDs to disassociate from the endpoint.

• #remove_security_group_ids ⇒ Array<String>

  (Interface endpoint) One or more security group IDs to disassociate from the network interface.

• #remove_subnet_ids ⇒ Array<String>

  (Interface endpoint) One or more subnets IDs in which to remove the endpoint.

• #reset_policy ⇒ Boolean

  (Gateway endpoint) Specify ‘true` to reset the policy document to the default policy.

• #vpc_endpoint_id ⇒ String

  The ID of the endpoint.

Instance Attribute Details

#add_route_table_ids ⇒ Array<String>

(Gateway endpoint) One or more route tables IDs to associate with the endpoint.

Returns:

• (Array<String>)

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

class ModifyVpcEndpointRequest < Struct.new(
  :dry_run,
  :vpc_endpoint_id,
  :reset_policy,
  :policy_document,
  :add_route_table_ids,
  :remove_route_table_ids,
  :add_subnet_ids,
  :remove_subnet_ids,
  :add_security_group_ids,
  :remove_security_group_ids,
  :private_dns_enabled)
  include Aws::Structure
end

#add_security_group_ids ⇒ Array<String>

(Interface endpoint) One or more security group IDs to associate with the network interface.

Returns:

• (Array<String>)

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

class ModifyVpcEndpointRequest < Struct.new(
  :dry_run,
  :vpc_endpoint_id,
  :reset_policy,
  :policy_document,
  :add_route_table_ids,
  :remove_route_table_ids,
  :add_subnet_ids,
  :remove_subnet_ids,
  :add_security_group_ids,
  :remove_security_group_ids,
  :private_dns_enabled)
  include Aws::Structure
end

#add_subnet_ids ⇒ Array<String>

(Interface endpoint) One or more subnet IDs in which to serve the endpoint.

Returns:

• (Array<String>)

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

class ModifyVpcEndpointRequest < Struct.new(
  :dry_run,
  :vpc_endpoint_id,
  :reset_policy,
  :policy_document,
  :add_route_table_ids,
  :remove_route_table_ids,
  :add_subnet_ids,
  :remove_subnet_ids,
  :add_security_group_ids,
  :remove_security_group_ids,
  :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)

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

class ModifyVpcEndpointRequest < Struct.new(
  :dry_run,
  :vpc_endpoint_id,
  :reset_policy,
  :policy_document,
  :add_route_table_ids,
  :remove_route_table_ids,
  :add_subnet_ids,
  :remove_subnet_ids,
  :add_security_group_ids,
  :remove_security_group_ids,
  :private_dns_enabled)
  include Aws::Structure
end

#policy_document ⇒ String

(Gateway endpoint) A policy document to attach to the endpoint. The policy must be in valid JSON format.

Returns:

• (String)

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

class ModifyVpcEndpointRequest < Struct.new(
  :dry_run,
  :vpc_endpoint_id,
  :reset_policy,
  :policy_document,
  :add_route_table_ids,
  :remove_route_table_ids,
  :add_subnet_ids,
  :remove_subnet_ids,
  :add_security_group_ids,
  :remove_security_group_ids,
  :private_dns_enabled)
  include Aws::Structure
end

#private_dns_enabled ⇒ Boolean

(Interface endpoint) Indicate whether a private hosted zone is associated with the VPC.

Returns:

• (Boolean)

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

class ModifyVpcEndpointRequest < Struct.new(
  :dry_run,
  :vpc_endpoint_id,
  :reset_policy,
  :policy_document,
  :add_route_table_ids,
  :remove_route_table_ids,
  :add_subnet_ids,
  :remove_subnet_ids,
  :add_security_group_ids,
  :remove_security_group_ids,
  :private_dns_enabled)
  include Aws::Structure
end

#remove_route_table_ids ⇒ Array<String>

(Gateway endpoint) One or more route table IDs to disassociate from the endpoint.

Returns:

• (Array<String>)

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

class ModifyVpcEndpointRequest < Struct.new(
  :dry_run,
  :vpc_endpoint_id,
  :reset_policy,
  :policy_document,
  :add_route_table_ids,
  :remove_route_table_ids,
  :add_subnet_ids,
  :remove_subnet_ids,
  :add_security_group_ids,
  :remove_security_group_ids,
  :private_dns_enabled)
  include Aws::Structure
end

#remove_security_group_ids ⇒ Array<String>

(Interface endpoint) One or more security group IDs to disassociate from the network interface.

Returns:

• (Array<String>)

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

class ModifyVpcEndpointRequest < Struct.new(
  :dry_run,
  :vpc_endpoint_id,
  :reset_policy,
  :policy_document,
  :add_route_table_ids,
  :remove_route_table_ids,
  :add_subnet_ids,
  :remove_subnet_ids,
  :add_security_group_ids,
  :remove_security_group_ids,
  :private_dns_enabled)
  include Aws::Structure
end

#remove_subnet_ids ⇒ Array<String>

(Interface endpoint) One or more subnets IDs in which to remove the endpoint.

Returns:

• (Array<String>)

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

class ModifyVpcEndpointRequest < Struct.new(
  :dry_run,
  :vpc_endpoint_id,
  :reset_policy,
  :policy_document,
  :add_route_table_ids,
  :remove_route_table_ids,
  :add_subnet_ids,
  :remove_subnet_ids,
  :add_security_group_ids,
  :remove_security_group_ids,
  :private_dns_enabled)
  include Aws::Structure
end

#reset_policy ⇒ Boolean

(Gateway endpoint) Specify ‘true` to reset the policy document to the default policy. The default policy allows full access to the service.

Returns:

• (Boolean)

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

class ModifyVpcEndpointRequest < Struct.new(
  :dry_run,
  :vpc_endpoint_id,
  :reset_policy,
  :policy_document,
  :add_route_table_ids,
  :remove_route_table_ids,
  :add_subnet_ids,
  :remove_subnet_ids,
  :add_security_group_ids,
  :remove_security_group_ids,
  :private_dns_enabled)
  include Aws::Structure
end

#vpc_endpoint_id ⇒ String

The ID of the endpoint.

Returns:

• (String)

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

class ModifyVpcEndpointRequest < Struct.new(
  :dry_run,
  :vpc_endpoint_id,
  :reset_policy,
  :policy_document,
  :add_route_table_ids,
  :remove_route_table_ids,
  :add_subnet_ids,
  :remove_subnet_ids,
  :add_security_group_ids,
  :remove_security_group_ids,
  :private_dns_enabled)
  include Aws::Structure
end