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

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 ModifyVpcEndpointRequest data as a hash:

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

Contains the parameters for ModifyVpcEndpoint.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#add_route_table_idsArray<String>

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

Returns:

  • (Array<String>)


42511
42512
42513
42514
42515
42516
42517
42518
42519
42520
42521
42522
42523
42524
42525
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 42511

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)
  SENSITIVE = []
  include Aws::Structure
end

#add_security_group_idsArray<String>

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

Returns:

  • (Array<String>)


42511
42512
42513
42514
42515
42516
42517
42518
42519
42520
42521
42522
42523
42524
42525
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 42511

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)
  SENSITIVE = []
  include Aws::Structure
end

#add_subnet_idsArray<String>

(Interface and Gateway Load Balancer endpoints) One or more subnet IDs in which to serve the endpoint. For a Gateway Load Balancer endpoint, you can specify only one subnet.

Returns:

  • (Array<String>)


42511
42512
42513
42514
42515
42516
42517
42518
42519
42520
42521
42522
42523
42524
42525
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 42511

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)
  SENSITIVE = []
  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)


42511
42512
42513
42514
42515
42516
42517
42518
42519
42520
42521
42522
42523
42524
42525
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 42511

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)
  SENSITIVE = []
  include Aws::Structure
end

#policy_documentString

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

Returns:

  • (String)


42511
42512
42513
42514
42515
42516
42517
42518
42519
42520
42521
42522
42523
42524
42525
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 42511

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)
  SENSITIVE = []
  include Aws::Structure
end

#private_dns_enabledBoolean

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

Returns:

  • (Boolean)


42511
42512
42513
42514
42515
42516
42517
42518
42519
42520
42521
42522
42523
42524
42525
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 42511

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)
  SENSITIVE = []
  include Aws::Structure
end

#remove_route_table_idsArray<String>

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

Returns:

  • (Array<String>)


42511
42512
42513
42514
42515
42516
42517
42518
42519
42520
42521
42522
42523
42524
42525
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 42511

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)
  SENSITIVE = []
  include Aws::Structure
end

#remove_security_group_idsArray<String>

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

Returns:

  • (Array<String>)


42511
42512
42513
42514
42515
42516
42517
42518
42519
42520
42521
42522
42523
42524
42525
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 42511

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)
  SENSITIVE = []
  include Aws::Structure
end

#remove_subnet_idsArray<String>

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

Returns:

  • (Array<String>)


42511
42512
42513
42514
42515
42516
42517
42518
42519
42520
42521
42522
42523
42524
42525
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 42511

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)
  SENSITIVE = []
  include Aws::Structure
end

#reset_policyBoolean

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

Returns:

  • (Boolean)


42511
42512
42513
42514
42515
42516
42517
42518
42519
42520
42521
42522
42523
42524
42525
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 42511

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)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_endpoint_idString

The ID of the endpoint.

Returns:

  • (String)


42511
42512
42513
42514
42515
42516
42517
42518
42519
42520
42521
42522
42523
42524
42525
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 42511

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)
  SENSITIVE = []
  include Aws::Structure
end