Skip to content

EC2  >  Operations  >  modify_vpc_endpoint

modify_vpc_endpoint

Operation

modify_vpc_endpoint async 

modify_vpc_endpoint(input: ModifyVpcEndpointInput, plugins: list[Plugin] | None = None) -> ModifyVpcEndpointOutput

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.

Parameters:

Name Type Description Default
input ModifyVpcEndpointInput

An instance of ModifyVpcEndpointInput.

 required
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

 None

Returns:

Type Description
ModifyVpcEndpointOutput

An instance of ModifyVpcEndpointOutput.

Input

ModifyVpcEndpointInput dataclass

Bases: _SerdeShape

Dataclass for ModifyVpcEndpointInput structure.

Attributes

add_route_table_ids class-attribute instance-attribute 
add_route_table_ids: list[str] | None = ...

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

add_security_group_ids class-attribute instance-attribute 
add_security_group_ids: list[str] | None = ...

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

add_subnet_ids class-attribute instance-attribute 
add_subnet_ids: list[str] | None = ...

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

dns_options class-attribute instance-attribute 
dns_options: DnsOptionsSpecification | None = ...

The DNS options for the endpoint.

dry_run class-attribute instance-attribute 
dry_run: bool | None = ...

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.

ip_address_type class-attribute instance-attribute 
ip_address_type: str | None = ...

The IP address type for the endpoint.

policy_document class-attribute instance-attribute 
policy_document: str | None = ...

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

private_dns_enabled class-attribute instance-attribute 
private_dns_enabled: bool | None = ...

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

remove_route_table_ids class-attribute instance-attribute 
remove_route_table_ids: list[str] | None = ...

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

remove_security_group_ids class-attribute instance-attribute 
remove_security_group_ids: list[str] | None = ...

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

remove_subnet_ids class-attribute instance-attribute 
remove_subnet_ids: list[str] | None = ...

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

reset_policy class-attribute instance-attribute 
reset_policy: bool | None = ...

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

subnet_configurations class-attribute instance-attribute 
subnet_configurations: list[SubnetConfiguration] | None = ...

The subnet configurations for the endpoint.

vpc_endpoint_id class-attribute instance-attribute 
vpc_endpoint_id: str | None = ...

The ID of the endpoint.

Output

ModifyVpcEndpointOutput dataclass

Bases: _SerdeShape

Dataclass for ModifyVpcEndpointOutput structure.

Attributes

response_metadata class-attribute instance-attribute 
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.

return_ class-attribute instance-attribute 
return_: bool | None = ...

Returns true if the request succeeds; otherwise, it returns an error.