OpsWorksCM / Client / export_server_engine_attribute

export_server_engine_attribute#

OpsWorksCM.Client.export_server_engine_attribute(**kwargs)#

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

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

  • ExportAttributeName (string) –

    [REQUIRED]

    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.

  • ServerName (string) –

    [REQUIRED]

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

  • InputAttributes (list) –

    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.

    • (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.

Return type:

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 server name used in the request.

Exceptions

  • OpsWorksCM.Client.exceptions.ValidationException

  • OpsWorksCM.Client.exceptions.ResourceNotFoundException

  • OpsWorksCM.Client.exceptions.InvalidStateException