Skip to content

Modify Vpc Endpoint

ec2_modify_vpc_endpoint R Documentation

Modifies attributes of a specified VPC endpoint

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 the Amazon Web Services PrivateLink Guide.

Usage

ec2_modify_vpc_endpoint(DryRun, VpcEndpointId, ResetPolicy,
  PolicyDocument, AddRouteTableIds, RemoveRouteTableIds, AddSubnetIds,
  RemoveSubnetIds, AddSecurityGroupIds, RemoveSecurityGroupIds,
  IpAddressType, DnsOptions, PrivateDnsEnabled, SubnetConfigurations)

Arguments

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.

VpcEndpointId

[required] The ID of the endpoint.

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.

AddRouteTableIds

(Gateway endpoint) The IDs of the route tables to associate with the endpoint.

RemoveRouteTableIds

(Gateway endpoint) The IDs of the route tables to disassociate from the endpoint.

AddSubnetIds

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

RemoveSubnetIds

(Interface endpoint) The IDs of the subnets from which to remove the endpoint.

AddSecurityGroupIds

(Interface endpoint) The IDs of the security groups to associate with the endpoint network interfaces.

RemoveSecurityGroupIds

(Interface endpoint) The IDs of the security groups to disassociate from the endpoint network interfaces.

IpAddressType

The IP address type for the endpoint.

DnsOptions

The DNS options for the endpoint.

PrivateDnsEnabled

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

SubnetConfigurations

The subnet configurations for the endpoint.

Value

A list with the following syntax: 

list(
  Return = TRUE|FALSE
)

Request syntax

svc$modify_vpc_endpoint(
  DryRun = TRUE|FALSE,
  VpcEndpointId = "string",
  ResetPolicy = TRUE|FALSE,
  PolicyDocument = "string",
  AddRouteTableIds = list(
    "string"
  ),
  RemoveRouteTableIds = list(
    "string"
  ),
  AddSubnetIds = list(
    "string"
  ),
  RemoveSubnetIds = list(
    "string"
  ),
  AddSecurityGroupIds = list(
    "string"
  ),
  RemoveSecurityGroupIds = list(
    "string"
  ),
  IpAddressType = "ipv4"|"dualstack"|"ipv6",
  DnsOptions = list(
    DnsRecordIpType = "ipv4"|"dualstack"|"ipv6"|"service-defined",
    PrivateDnsOnlyForInboundResolverEndpoint = TRUE|FALSE
  ),
  PrivateDnsEnabled = TRUE|FALSE,
  SubnetConfigurations = list(
    list(
      SubnetId = "string",
      Ipv4 = "string",
      Ipv6 = "string"
    )
  )
)