AWS OpsWorks for Chef Automate

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.

See also: AWS API Documentation

Request Syntax

client.export_server_engine_attribute(
    ExportAttributeName='string',
    ServerName='string',
    InputAttributes=[
        {
            'Name': 'string',
            'Value': 'string'
        },
    ]
)

type ExportAttributeName:

string

param ExportAttributeName:

[REQUIRED]

The name of the export attribute. Currently supported export attribute is "Userdata" which exports a userdata script filled out with parameters provided in the InputAttributes list.

type ServerName:

string

param ServerName:

[REQUIRED]

The name of the Server to which the attribute is being exported from

type InputAttributes:

list

param InputAttributes:

The list of engine attributes. The list type is EngineAttribute. EngineAttribute is a pair of attribute name and value. For ExportAttributeName "Userdata", currently supported input attribute names are: - "RunList": For Chef, an ordered list of roles and/or recipes that are run in the exact order. For Puppet, this parameter is ignored. - "OrganizationName": For Chef, an organization name. AWS OpsWorks for Chef Server always creates the organization "default". For Puppet, this parameter is ignored. - "NodeEnvironment": For Chef, a node environment (eg. development, staging, onebox). For Puppet, this parameter is ignored. - "NodeClientVersion": For Chef, version of Chef Engine (3 numbers separated by dots, eg. "13.8.5"). If empty, it uses the latest one. For Puppet, this parameter is ignored.

• (dict) --

  A name and value pair that is specific to the engine of the server.

  • Name (string) --

    The name of the engine attribute.

  • Value (string) --

    The value of the engine attribute.

rtype:

dict

returns:

Response Syntax

{
    'EngineAttribute': {
        'Name': 'string',
        'Value': 'string'
    },
    'ServerName': 'string'
}

Response Structure

• (dict) --

  • EngineAttribute (dict) --

    The requested engine attribute pair with attribute name and value.

    • Name (string) --

      The name of the engine attribute.

    • Value (string) --

      The value of the engine attribute.

  • ServerName (string) --

    The requested ServerName.