| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.OpsWorksCM.ExportServerEngineAttribute
Description
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.
Synopsis
- data ExportServerEngineAttribute = ExportServerEngineAttribute' {}
- newExportServerEngineAttribute :: Text -> Text -> ExportServerEngineAttribute
- exportServerEngineAttribute_inputAttributes :: Lens' ExportServerEngineAttribute (Maybe [EngineAttribute])
- exportServerEngineAttribute_exportAttributeName :: Lens' ExportServerEngineAttribute Text
- exportServerEngineAttribute_serverName :: Lens' ExportServerEngineAttribute Text
- data ExportServerEngineAttributeResponse = ExportServerEngineAttributeResponse' {}
- newExportServerEngineAttributeResponse :: Int -> ExportServerEngineAttributeResponse
- exportServerEngineAttributeResponse_serverName :: Lens' ExportServerEngineAttributeResponse (Maybe Text)
- exportServerEngineAttributeResponse_engineAttribute :: Lens' ExportServerEngineAttributeResponse (Maybe EngineAttribute)
- exportServerEngineAttributeResponse_httpStatus :: Lens' ExportServerEngineAttributeResponse Int
Creating a Request
data ExportServerEngineAttribute Source #
See: newExportServerEngineAttribute smart constructor.
Constructors
| ExportServerEngineAttribute' | |
Fields
| |
Instances
newExportServerEngineAttribute Source #
Arguments
| :: Text | |
| -> Text | |
| -> ExportServerEngineAttribute |
Create a value of ExportServerEngineAttribute with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:inputAttributes:ExportServerEngineAttribute', exportServerEngineAttribute_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.
$sel:exportAttributeName:ExportServerEngineAttribute', exportServerEngineAttribute_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.
$sel:serverName:ExportServerEngineAttribute', exportServerEngineAttribute_serverName - The name of the server from which you are exporting the attribute.
Request Lenses
exportServerEngineAttribute_inputAttributes :: Lens' ExportServerEngineAttribute (Maybe [EngineAttribute]) Source #
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.
exportServerEngineAttribute_exportAttributeName :: Lens' ExportServerEngineAttribute Text Source #
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.
exportServerEngineAttribute_serverName :: Lens' ExportServerEngineAttribute Text Source #
The name of the server from which you are exporting the attribute.
Destructuring the Response
data ExportServerEngineAttributeResponse Source #
See: newExportServerEngineAttributeResponse smart constructor.
Constructors
| ExportServerEngineAttributeResponse' | |
Fields
| |
Instances
newExportServerEngineAttributeResponse Source #
Arguments
| :: Int | |
| -> ExportServerEngineAttributeResponse |
Create a value of ExportServerEngineAttributeResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:serverName:ExportServerEngineAttribute', exportServerEngineAttributeResponse_serverName - The server name used in the request.
$sel:engineAttribute:ExportServerEngineAttributeResponse', exportServerEngineAttributeResponse_engineAttribute - The requested engine attribute pair with attribute name and value.
$sel:httpStatus:ExportServerEngineAttributeResponse', exportServerEngineAttributeResponse_httpStatus - The response's http status code.
Response Lenses
exportServerEngineAttributeResponse_serverName :: Lens' ExportServerEngineAttributeResponse (Maybe Text) Source #
The server name used in the request.
exportServerEngineAttributeResponse_engineAttribute :: Lens' ExportServerEngineAttributeResponse (Maybe EngineAttribute) Source #
The requested engine attribute pair with attribute name and value.
exportServerEngineAttributeResponse_httpStatus :: Lens' ExportServerEngineAttributeResponse Int Source #
The response's http status code.