Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

UpdateServerEngineAttributes

Updates engine-specific attributes on a specified server. The server enters the MODIFYING state when this operation is in progress. Only one update can occur at a time. You can use this command to reset a Chef server's public key (CHEF_PIVOTAL_KEY) or a Puppet server's admin password (PUPPET_ADMIN_PASSWORD).

This operation is asynchronous.

This operation can only be called for servers in HEALTHY or UNHEALTHY states. Otherwise, an InvalidStateException is raised. A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are not valid.

Request Syntax


{
   "AttributeName": "string",
   "AttributeValue": "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.

AttributeName

The name of the engine attribute to update.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [A-Z][A-Z0-9_]*

Required: Yes

AttributeValue

The value to set for the attribute.

Type: String

Length Constraints: Maximum length of 10000.

Pattern: (?s).*

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.

Server

Contains the response to an UpdateServerEngineAttributes request.

Type: Server object

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.

HTTP Status Code: 400

ResourceNotFoundException

The requested resource does not exist, or access was denied.

HTTP Status Code: 400

ValidationException

One or more of the provided request parameters are not valid.

HTTP Status Code: 400