ec2_modify_vpc_endpoint: Modify Vpc Endpoint

In aws.ecx: Communicating with AWS EC2 and ECS using AWS REST APIs

Description

Modifies attributes of a specified VPC endpoint. The attributes that you can modify depend on the type of VPC endpoint (interface, gateway, or Gateway Load Balancer). For more information, see VPC Endpoints in the Amazon Virtual Private Cloud User Guide.

Usage

ec2_modify_vpc_endpoint(
  VpcEndpointId,
  DryRun = NULL,
  ResetPolicy = NULL,
  PolicyDocument = NULL,
  AddRouteTableId = NULL,
  RemoveRouteTableId = NULL,
  AddSubnetId = NULL,
  RemoveSubnetId = NULL,
  AddSecurityGroupId = NULL,
  RemoveSecurityGroupId = NULL,
  PrivateDnsEnabled = NULL,
  simplify = TRUE,
  others = list(),
  print_on_error = aws_get_print_on_error(),
  retry_time = aws_get_retry_time(),
  network_timeout = aws_get_network_timeout(),
  region = aws_get_region()
)

Arguments

VpcEndpointId	Character. The ID of the endpoint.
DryRun	Logical. Checks whether you have the required permissions for the action, without actually making the request,...[optional]
ResetPolicy	Logical. (Gateway endpoint) Specify true to reset the policy document to the default policy.[optional]
PolicyDocument	Character. (Interface and gateway endpoints) A policy to attach to the endpoint that controls access to the...[optional]
AddRouteTableId	List. (Gateway endpoint) One or more route tables IDs to associate with the endpoint.[optional]
RemoveRouteTableId	List. (Gateway endpoint) One or more route table IDs to disassociate from the endpoint.[optional]
AddSubnetId	List. (Interface and Gateway Load Balancer endpoints) One or more subnet IDs in which to serve the endpoint....[optional]
RemoveSubnetId	List. (Interface endpoint) One or more subnets IDs in which to remove the endpoint.[optional]
AddSecurityGroupId	List. (Interface endpoint) One or more security group IDs to associate with the network interface.[optional]
RemoveSecurityGroupId	List. (Interface endpoint) One or more security group IDs to disassociate from the network interface.[optional]
PrivateDnsEnabled	Logical. (Interface endpoint) Indicates whether a private hosted zone is associated with the VPC.[optional]
simplify	Logical. Whether to simplify the result and handle nextToken in the response[optional]
others	Named list. The parameters that are not included in the function parameters and need to be added into the request[optional]
print_on_error	Logical. Whether to show an error message when a network error occurs.
retry_time	Integer. Number of retries for a REST request when encounter the network issue. If the request has been sent retry_time times but still not be able to get the response, an error will be thrown.
network_timeout	Numeric. Number of seconds to wait for a REST response until giving up. Can not be less than 1 ms.
region	Character. The region of the AWS service.

Value

A list object or a character vector

VpcEndpointId

The ID of the endpoint.

DryRun

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.

ResetPolicy

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

PolicyDocument

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

AddRouteTableId

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

RemoveRouteTableId

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

AddSubnetId

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

RemoveSubnetId

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

AddSecurityGroupId

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

RemoveSecurityGroupId

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

PrivateDnsEnabled

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

aws.ecx documentation built on Jan. 27, 2022, 1:10 a.m.