UpdateServer
Updates settings for a server.
This operation is synchronous.
Request Syntax
{
"BackupRetentionCount": number
,
"DisableAutomatedBackup": boolean
,
"PreferredBackupWindow": "string
",
"PreferredMaintenanceWindow": "string
",
"ServerName": "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.
- BackupRetentionCount
-
Sets the number of automated backups that you want to keep.
Type: Integer
Required: No
- DisableAutomatedBackup
-
Setting DisableAutomatedBackup to
true
disables automated or scheduled backups. Automated backups are enabled by default.Type: Boolean
Required: No
- PreferredBackupWindow
-
DDD:HH:MM
(weekly start time) orHH:MM
(daily start time).Time windows always use coordinated universal time (UTC). Valid strings for day of week (
DDD
) are:Mon
,Tue
,Wed
,Thr
,Fri
,Sat
, orSun
.Type: String
Length Constraints: Maximum length of 10000.
Pattern:
^((Mon|Tue|Wed|Thu|Fri|Sat|Sun):)?([0-1][0-9]|2[0-3]):[0-5][0-9]$
Required: No
- PreferredMaintenanceWindow
-
DDD:HH:MM
(weekly start time) orHH:MM
(daily start time).Time windows always use coordinated universal time (UTC). Valid strings for day of week (
DDD
) are:Mon
,Tue
,Wed
,Thr
,Fri
,Sat
, orSun
.Type: String
Length Constraints: Maximum length of 10000.
Pattern:
^((Mon|Tue|Wed|Thu|Fri|Sat|Sun):)?([0-1][0-9]|2[0-3]):[0-5][0-9]$
Required: No
- ServerName
-
The name of the server to update.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 40.
Pattern:
[a-zA-Z][a-zA-Z0-9\-]*
Required: Yes
Response Syntax
{
"Server": {
"AssociatePublicIpAddress": boolean,
"BackupRetentionCount": number,
"CloudFormationStackArn": "string",
"CreatedAt": number,
"CustomDomain": "string",
"DisableAutomatedBackup": boolean,
"Endpoint": "string",
"Engine": "string",
"EngineAttributes": [
{
"Name": "string",
"Value": "string"
}
],
"EngineModel": "string",
"EngineVersion": "string",
"InstanceProfileArn": "string",
"InstanceType": "string",
"KeyPair": "string",
"MaintenanceStatus": "string",
"PreferredBackupWindow": "string",
"PreferredMaintenanceWindow": "string",
"SecurityGroupIds": [ "string" ],
"ServerArn": "string",
"ServerName": "string",
"ServiceRoleArn": "string",
"Status": "string",
"StatusReason": "string",
"SubnetIds": [ "string" ]
}
}
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.
Errors
For information about the errors that are common to all actions, see Common Errors.
- InvalidStateException
-
The resource is in a state that does not allow you to perform a specified action.
- Message
-
Error or informational message that provides more detail if a resource is in a state that is not valid for performing a specified action.
HTTP Status Code: 400
- ResourceNotFoundException
-
The requested resource does not exist, or access was denied.
- Message
-
Error or informational message that can contain more detail about problems locating or accessing a resource.
HTTP Status Code: 400
- ValidationException
-
One or more of the provided request parameters are not valid.
- Message
-
Error or informational message that can contain more detail about a validation failure.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: