ModifyVpcEndpointServiceConfiguration
Modifies the attributes of the specified VPC endpoint service configuration.
If you set or modify the private DNS name, you must prove that you own the private DNS domain name.
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 the service must be accepted.
Type: Boolean
Required: No
- AddGatewayLoadBalancerArn.N
-
The Amazon Resource Names (ARNs) of Gateway Load Balancers to add to the service configuration.
Type: Array of strings
Required: No
- AddNetworkLoadBalancerArn.N
-
The Amazon Resource Names (ARNs) of Network Load Balancers to add to the service configuration.
Type: Array of strings
Required: No
- AddSupportedIpAddressType.N
-
The IP address types to add to the service configuration.
Type: Array of strings
Required: No
- AddSupportedRegion.N
-
The supported Regions to add to the 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 isUnauthorizedOperation
.Type: Boolean
Required: No
- PrivateDnsName
-
(Interface endpoint configuration) The private DNS name to assign to the endpoint service.
Type: String
Required: No
- RemoveGatewayLoadBalancerArn.N
-
The Amazon Resource Names (ARNs) of Gateway Load Balancers to remove from the service configuration.
Type: Array of strings
Required: No
- RemoveNetworkLoadBalancerArn.N
-
The Amazon Resource Names (ARNs) of Network Load Balancers to remove from the service configuration.
Type: Array of strings
Required: No
- RemovePrivateDnsName
-
(Interface endpoint configuration) Removes the private DNS name of the endpoint service.
Type: Boolean
Required: No
- RemoveSupportedIpAddressType.N
-
The IP address types to remove from the service configuration.
Type: Array of strings
Required: No
- RemoveSupportedRegion.N
-
The supported Regions to remove from the service configuration.
Type: Array of strings
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 error codes.
Examples
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 Amazon SDKs, see the following: