AWS OpsWorks CM
API Reference (API Version 2016-11-01)

ExportServerEngineAttribute

Exports a specified server engine attribute as a base64-encoded string. For example, you can export user data that you can use in EC2 to associate nodes with a server.

This operation is synchronous.

A ValidationException is raised when parameters of the request are not valid. A ResourceNotFoundException is thrown when the server does not exist. An InvalidStateException is thrown when the server is in any of the following states: CREATING, TERMINATED, FAILED or DELETING.

Request Syntax

{ "ExportAttributeName": "string", "InputAttributes": [ { "Name": "string", "Value": "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.

ExportAttributeName

The name of the export attribute. Currently, the supported export attribute is Userdata. This exports a user data script that includes parameters and values provided in the InputAttributes list.

Type: String

Length Constraints: Maximum length of 10000.

Pattern: (?s).*

Required: Yes

InputAttributes

The list of engine attributes. The list type is EngineAttribute. An EngineAttribute list item is a pair that includes an attribute name and its value. For the Userdata ExportAttributeName, the following are supported engine attribute names.

  • RunList In Chef, a list of roles or recipes that are run in the specified order. In Puppet, this parameter is ignored.

  • OrganizationName In Chef, an organization name. AWS OpsWorks for Chef Automate always creates the organization default. In Puppet, this parameter is ignored.

  • NodeEnvironment In Chef, a node environment (for example, development, staging, or one-box). In Puppet, this parameter is ignored.

  • NodeClientVersion In Chef, the version of the Chef engine (three numbers separated by dots, such as 13.8.5). If this attribute is empty, OpsWorks for Chef Automate uses the most current version. In Puppet, this parameter is ignored.

Type: Array of EngineAttribute objects

Required: No

ServerName

The name of the server from which you are exporting the attribute.

Type: String

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

Pattern: [a-zA-Z][a-zA-Z0-9\-]*

Required: Yes

Response Syntax

{ "EngineAttribute": { "Name": "string", "Value": "string" }, "ServerName": "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.

EngineAttribute

The requested engine attribute pair with attribute name and value.

Type: EngineAttribute object

ServerName

The server name used in the request.

Type: String

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

Pattern: [a-zA-Z][a-zA-Z0-9\-]*

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

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: