ModifyVpcEndpointServiceConfiguration - Amazon Elastic Compute Cloud

ModifyVpcEndpointServiceConfiguration

Modifies the attributes of your VPC endpoint service configuration. You can change the Network Load Balancers for your service, and you can specify whether acceptance is required for requests to connect to your endpoint service through an interface VPC endpoint.

If you set or modify the private DNS name, you must prove that you own the private DNS domain name. For more information, see VPC Endpoint Service Private DNS Name Verification in the Amazon Virtual Private Cloud User Guide.

Request Parameters

The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see Common Query Parameters.

AcceptanceRequired

Indicates whether requests to create an endpoint to your service must be accepted.

Type: Boolean

Required: No

AddNetworkLoadBalancerArn.N

The Amazon Resource Names (ARNs) of Network Load Balancers to add to your service configuration.

Type: Array of strings

Required: No

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.

Type: Boolean

Required: No

PrivateDnsName

The private DNS name to assign to the endpoint service.

Type: String

Required: No

RemoveNetworkLoadBalancerArn.N

The Amazon Resource Names (ARNs) of Network Load Balancers to remove from your service configuration.

Type: Array of strings

Required: No

RemovePrivateDnsName

Removes the private DNS name of the endpoint service.

Type: Boolean

Required: No

ServiceId

The ID of the service.

Type: String

Required: Yes

Response Elements

The following elements are returned by the service.

requestId

The ID of the request.

Type: String

return

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

Type: Boolean

Errors

For information about the errors that are common to all actions, see Common Client Errors.

Example

Example

This example modifies service configuration vpce-svc-03d5ebb7d9579a2b3 to specify that acceptance is required for interface VPC endpoint connection requests to the service, and to assign a private DNS name to the endpoint service.

Sample Request

https://ec2.amazonaws.com/?Action=ModifyVpcEndpointServiceConfiguration &ServiceId=vpce-svc-03d5ebb7d9579a2b3 &AcceptanceRequired=true &PrivateDnsName=myexampleservice.com &AUTHPARAMS

Sample Response

<ModifyVpcEndpointServiceConfigurationResponse xmlns="http://ec2.amazonaws.com/doc/2016-11-15/"> <requestId>08d80840-f750-42db-a6f8-2cd32example</requestId> <return>true</return> </ModifyVpcEndpointServiceConfigurationResponse>

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: