OpsWorksCMClient Class

Member Function Documentation

OpsWorksCMClient::OpsWorksCMClient(const QtAws::Core::AwsRegion::Region region = QtAws::Core::AwsRegion::InvalidRegion, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0)

Constructs a OpsWorksCMClient object.

The new client object will region, credentials, and manager for network operations.

The new object will be owned by parent, if set.

OpsWorksCMClient::OpsWorksCMClient(const QUrl &endpoint, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0)

This function overloads OpsWorksCMClient().

This overload allows the caller to specify the specific endpoint to send requests to. Typically, it is easier to use the alternative constructor, which allows the caller to specify an AWS region instead, in which case this client will determine the correct endpoint for the given region automatically (via AwsEndpoint::getEndpoint).

See also QtAws::Core::AwsEndpoint::getEndpoint.

[slot] AssociateNodeResponse *OpsWorksCMClient::associateNode(const AssociateNodeRequest &request)

Sends request to the OpsWorksCMClient service, and returns a pointer to an AssociateNodeResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Associates a new node with the server. For more information about how to disassociate a node, see

<a>DisassociateNode</a>>

On a Chef server: This command is an alternative to <code>knife

bootstrap</code>>

Example (Chef): <code>aws opsworks-cm associate-node --server-name <i>MyServer</i> --node-name <i>MyManagedNode</i> --engine-attributes "Name=<i>CHEF_ORGANIZATION</i>,Value=default" "Name=<i>CHEF_NODE_PUBLIC_KEY</i>,Value=<i>public-key-pem</i>"</code>

</p

On a Puppet server, this command is an alternative to the <code>puppet cert sign</code> command that signs a Puppet node CSR.

</p

Example (Chef): <code>aws opsworks-cm associate-node --server-name <i>MyServer</i> --node-name <i>MyManagedNode</i> --engine-attributes "Name=<i>PUPPET_NODE_CSR</i>,Value=<i>csr-pem</i>"</code>

</p

A node can can only be associated with servers that are in a <code>HEALTHY</code> state. Otherwise, an <code>InvalidStateException</code> is thrown. A <code>ResourceNotFoundException</code> is thrown when the server does not exist. A <code>ValidationException</code> is raised when parameters of the request are not valid. The AssociateNode API call can be integrated into Auto Scaling configurations, AWS Cloudformation templates, or the user data of a server's instance.

[slot] CreateBackupResponse *OpsWorksCMClient::createBackup(const CreateBackupRequest &request)

Sends request to the OpsWorksCMClient service, and returns a pointer to an CreateBackupResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Creates an application-level backup of a server. While the server is in the <code>BACKING_UP</code> state, the server cannot be changed, and no additional backup can be created.

</p

Backups can be created for servers in <code>RUNNING</code>, <code>HEALTHY</code>, and <code>UNHEALTHY</code> states. By default, you can create a maximum of 50 manual backups.

</p

This operation is asynchronous.

</p

A <code>LimitExceededException</code> is thrown when the maximum number of manual backups is reached. An <code>InvalidStateException</code> is thrown when the server is not in any of the following states: RUNNING, HEALTHY, or UNHEALTHY. A <code>ResourceNotFoundException</code> is thrown when the server is not found. A <code>ValidationException</code> is thrown when parameters of the request are not valid.

[slot] CreateServerResponse *OpsWorksCMClient::createServer(const CreateServerRequest &request)

Sends request to the OpsWorksCMClient service, and returns a pointer to an CreateServerResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Creates and immedately starts a new server. The server is ready to use when it is in the <code>HEALTHY</code> state. By default, you can create a maximum of 10 servers.

</p

This operation is asynchronous.

</p

A <code>LimitExceededException</code> is thrown when you have created the maximum number of servers (10). A <code>ResourceAlreadyExistsException</code> is thrown when a server with the same name already exists in the account. A <code>ResourceNotFoundException</code> is thrown when you specify a backup ID that is not valid or is for a backup that does not exist. A <code>ValidationException</code> is thrown when parameters of the request are not valid.

</p

If you do not specify a security group by adding the <code>SecurityGroupIds</code> parameter, AWS OpsWorks creates a new security group.

</p

<i>Chef Automate:</i> The default security group opens the Chef server to the world on TCP port 443. If a KeyName is present, AWS OpsWorks enables SSH access. SSH is also open to the world on TCP port 22.

</p

<i>Puppet Enterprise:</i> The default security group opens TCP ports 22, 443, 4433, 8140, 8142, 8143, and 8170. If a KeyName is present, AWS OpsWorks enables SSH access. SSH is also open to the world on TCP port 22.

</p

By default, your server is accessible from any IP address. We recommend that you update your security group rules to allow access from known IP addresses and address ranges only. To edit security group rules, open Security Groups in the navigation pane of the EC2 management console.

[slot] DeleteBackupResponse *OpsWorksCMClient::deleteBackup(const DeleteBackupRequest &request)

Sends request to the OpsWorksCMClient service, and returns a pointer to an DeleteBackupResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Deletes a backup. You can delete both manual and automated backups. This operation is asynchronous.

</p

An <code>InvalidStateException</code> is thrown when a backup deletion is already in progress. A <code>ResourceNotFoundException</code> is thrown when the backup does not exist. A <code>ValidationException</code> is thrown when parameters of the request are not valid.

[slot] DeleteServerResponse *OpsWorksCMClient::deleteServer(const DeleteServerRequest &request)

Sends request to the OpsWorksCMClient service, and returns a pointer to an DeleteServerResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Deletes the server and the underlying AWS CloudFormation stacks (including the server's EC2 instance). When you run this command, the server state is updated to <code>DELETING</code>. After the server is deleted, it is no longer returned by <code>DescribeServer</code> requests. If the AWS CloudFormation stack cannot be deleted, the server cannot be deleted.

</p

This operation is asynchronous.

</p

An <code>InvalidStateException</code> is thrown when a server deletion is already in progress. A <code>ResourceNotFoundException</code> is thrown when the server does not exist. A <code>ValidationException</code> is raised when parameters of the request are not valid.

</p

[slot] DescribeAccountAttributesResponse *OpsWorksCMClient::describeAccountAttributes(const DescribeAccountAttributesRequest &request)

Sends request to the OpsWorksCMClient service, and returns a pointer to an DescribeAccountAttributesResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Describes your account attributes, and creates requests to increase limits before they are reached or exceeded.

</p

This operation is synchronous.

[slot] DescribeBackupsResponse *OpsWorksCMClient::describeBackups(const DescribeBackupsRequest &request)

Sends request to the OpsWorksCMClient service, and returns a pointer to an DescribeBackupsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Describes backups. The results are ordered by time, with newest backups first. If you do not specify a BackupId or ServerName, the command returns all backups.

</p

This operation is synchronous.

</p

A <code>ResourceNotFoundException</code> is thrown when the backup does not exist. A <code>ValidationException</code> is raised when parameters of the request are not valid.

[slot] DescribeEventsResponse *OpsWorksCMClient::describeEvents(const DescribeEventsRequest &request)

Sends request to the OpsWorksCMClient service, and returns a pointer to an DescribeEventsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Describes events for a specified server. Results are ordered by time, with newest events first.

</p

This operation is synchronous.

</p

A <code>ResourceNotFoundException</code> is thrown when the server does not exist. A <code>ValidationException</code> is raised when parameters of the request are not valid.

[slot] DescribeNodeAssociationStatusResponse *OpsWorksCMClient::describeNodeAssociationStatus(const DescribeNodeAssociationStatusRequest &request)

Sends request to the OpsWorksCMClient service, and returns a pointer to an DescribeNodeAssociationStatusResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Returns the current status of an existing association or disassociation request.

</p

A <code>ResourceNotFoundException</code> is thrown when no recent association or disassociation request with the specified token is found, or when the server does not exist. A <code>ValidationException</code> is raised when parameters of the request are not valid.

[slot] DescribeServersResponse *OpsWorksCMClient::describeServers(const DescribeServersRequest &request)

Sends request to the OpsWorksCMClient service, and returns a pointer to an DescribeServersResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Lists all configuration management servers that are identified with your account. Only the stored results from Amazon DynamoDB are returned. AWS OpsWorks CM does not query other services.

</p

This operation is synchronous.

</p

A <code>ResourceNotFoundException</code> is thrown when the server does not exist. A <code>ValidationException</code> is raised when parameters of the request are not valid.

[slot] DisassociateNodeResponse *OpsWorksCMClient::disassociateNode(const DisassociateNodeRequest &request)

Sends request to the OpsWorksCMClient service, and returns a pointer to an DisassociateNodeResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Disassociates a node from an AWS OpsWorks CM server, and removes the node from the server's managed nodes. After a node is disassociated, the node key pair is no longer valid for accessing the configuration manager's API. For more information about how to associate a node, see <a>AssociateNode</a>.

</p

A node can can only be disassociated from a server that is in a <code>HEALTHY</code> state. Otherwise, an <code>InvalidStateException</code> is thrown. A <code>ResourceNotFoundException</code> is thrown when the server does not exist. A <code>ValidationException</code> is raised when parameters of the request are not valid.

[slot] RestoreServerResponse *OpsWorksCMClient::restoreServer(const RestoreServerRequest &request)

Sends request to the OpsWorksCMClient service, and returns a pointer to an RestoreServerResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Restores a backup to a server that is in a <code>CONNECTION_LOST</code>, <code>HEALTHY</code>, <code>RUNNING</code>, <code>UNHEALTHY</code>, or <code>TERMINATED</code> state. When you run RestoreServer, the server's EC2 instance is deleted, and a new EC2 instance is configured. RestoreServer maintains the existing server endpoint, so configuration management of the server's client devices (nodes) should continue to work.

</p

This operation is asynchronous.

</p

An <code>InvalidStateException</code> is thrown when the server is not in a valid state. A <code>ResourceNotFoundException</code> is thrown when the server does not exist. A <code>ValidationException</code> is raised when parameters of the request are not valid.

[slot] StartMaintenanceResponse *OpsWorksCMClient::startMaintenance(const StartMaintenanceRequest &request)

Sends request to the OpsWorksCMClient service, and returns a pointer to an StartMaintenanceResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Manually starts server maintenance. This command can be useful if an earlier maintenance attempt failed, and the underlying cause of maintenance failure has been resolved. The server is in an <code>UNDER_MAINTENANCE</code> state while maintenance is in progress.

</p

Maintenance can only be started on servers in <code>HEALTHY</code> and <code>UNHEALTHY</code> states. Otherwise, an <code>InvalidStateException</code> is thrown. A <code>ResourceNotFoundException</code> is thrown when the server does not exist. A <code>ValidationException</code> is raised when parameters of the request are not valid.

[slot] UpdateServerResponse *OpsWorksCMClient::updateServer(const UpdateServerRequest &request)

Sends request to the OpsWorksCMClient service, and returns a pointer to an UpdateServerResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Updates settings for a server.

</p

This operation is synchronous.

[slot] UpdateServerEngineAttributesResponse *OpsWorksCMClient::updateServerEngineAttributes(const UpdateServerEngineAttributesRequest &request)

Sends request to the OpsWorksCMClient service, and returns a pointer to an UpdateServerEngineAttributesResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Updates engine-specific attributes on a specified server. The server enters the <code>MODIFYING</code> 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 private key (<code>CHEF_PIVOTAL_KEY</code>), a Chef server's admin password (<code>CHEF_DELIVERY_ADMIN_PASSWORD</code>), or a Puppet server's admin password (<code>PUPPET_ADMIN_PASSWORD</code>).

</p

This operation is asynchronous.

</p

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