AWS PrivateLink API - PUT configuration
Updates the configuration of AWS PrivateLink.
The request consumes and produces an application/json payload.
This request is an Early Adopter release and may be changed in non-compatible way.
| PUT |
|
Authentication
To execute this request, you need the Write configuration (WriteConfig) permission assigned to your API token. To learn how to obtain and use it, see Tokens and authentication.
Parameters
| Parameter | Type | Description | In | Required |
|---|---|---|---|---|
| body | AwsPrivateLinkConfig |
The AWS PrivateLink configuration. |
body | optional |
Body format
The AwsPrivateLinkConfig object
| Element | Type | Description | Required |
|---|---|---|---|
| enabled | boolean |
Is AWS PrivateLink enabled |
required |
| vpcEndpointServiceName | string |
The VirtualPrivateCluster-service name |
optional |
This is a model of the request body, showing the possible elements. It has to be adjusted for usage in an actual request. See the Example expandable section for working sample request.
{
"enabled": true,
"vpcEndpointServiceName": "string"
}
Response
Response codes
| Code | Description |
|---|---|
| 201 | Success. The configuration settings have been updated. |
Response body
The AwsPrivateLinkConfig object
| Element | Type | Description |
|---|---|---|
| enabled | boolean | Is AWS PrivateLink enabled |
| vpcEndpointServiceName | string | The VirtualPrivateCluster-service name |
{
"enabled": true,
"vpcEndpointServiceName": "string"
}