SetIpAddressType
Sets the IP address type for an Amazon Lightsail resource.
Use this action to enable dual-stack for a resource, which enables IPv4 and IPv6 for the specified resource. Alternately, you can use this action to disable dual-stack, and enable IPv4 only.
Request Syntax
{
"acceptBundleUpdate": boolean,
"ipAddressType": "string",
"resourceName": "string",
"resourceType": "string"
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- acceptBundleUpdate
-
Required parameter to accept the instance bundle update when changing to, and from, IPv6-only.
Note
An instance bundle will change when switching from
dual-stackoripv4, toipv6. It also changes when switching fromipv6, todual-stackoripv4.You must include this parameter in the command to update the bundle. For example, if you switch from
dual-stacktoipv6, the bundle will be updated, and billing for the IPv6-only instance bundle begins immediately.Type: Boolean
Required: No
- ipAddressType
-
The IP address type to set for the specified resource.
The possible values are
ipv4for IPv4 only,ipv6for IPv6 only, anddualstackfor IPv4 and IPv6.Type: String
Valid Values:
dualstack | ipv4 | ipv6Required: Yes
- resourceName
-
The name of the resource for which to set the IP address type.
Type: String
Pattern:
\w[\w\-]*\wRequired: Yes
- resourceType
-
The resource type.
The resource values are
Distribution,Instance, andLoadBalancer.Note
Distribution-related APIs are available only in the N. Virginia (
us-east-1) AWS Region. Set your AWS Region configuration tous-east-1to create, view, or edit distributions.Type: String
Valid Values:
ContainerService | Instance | StaticIp | KeyPair | InstanceSnapshot | Domain | PeeredVpc | LoadBalancer | LoadBalancerTlsCertificate | Disk | DiskSnapshot | RelationalDatabase | RelationalDatabaseSnapshot | ExportSnapshotRecord | CloudFormationStackRecord | Alarm | ContactMethod | Distribution | Certificate | BucketRequired: Yes
Response Syntax
{
"operations": [
{
"createdAt": number,
"errorCode": "string",
"errorDetails": "string",
"id": "string",
"isTerminal": boolean,
"location": {
"availabilityZone": "string",
"regionName": "string"
},
"operationDetails": "string",
"operationType": "string",
"resourceName": "string",
"resourceType": "string",
"status": "string",
"statusChangedAt": number
}
]
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- operations
-
An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
Type: Array of Operation objects
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
HTTP Status Code: 400
- AccountSetupInProgressException
-
Lightsail throws this exception when an account is still in the setup in progress state.
HTTP Status Code: 400
- InvalidInputException
-
Lightsail throws this exception when user input does not conform to the validation rules of an input field.
Note
Domain and distribution APIs are only available in the N. Virginia (
us-east-1) AWS Region. Please set your AWS Region configuration tous-east-1to create, view, or edit these resources.HTTP Status Code: 400
- NotFoundException
-
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
- OperationFailureException
-
Lightsail throws this exception when an operation fails to execute.
HTTP Status Code: 400
- ServiceException
-
A general service exception.
HTTP Status Code: 500
- UnauthenticatedException
-
Lightsail throws this exception when the user has not been authenticated.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
