AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Interface for accessing OpsWorksCM AWS OpsWorks for Chef Automate

AWS OpsWorks for Chef Automate is a service that runs and manages configuration management servers.

Glossary of terms

Endpoints

AWS OpsWorks for Chef Automate supports the following endpoints, all HTTPS. You must connect to one of the following endpoints. Chef servers can only be accessed or managed within the endpoint in which they are created.

Throttling limits

All API operations allow for five requests per second with a burst of 10 requests per second.

Inheritance Hierarchy

Amazon.OpsWorksCM.IAmazonOpsWorksCM

Namespace: Amazon.OpsWorksCM
Assembly: AWSSDK.OpsWorksCM.dll
Version: 3.x.y.z

Syntax

C#
public interface IAmazonOpsWorksCM
         IAmazonService, IDisposable

The IAmazonOpsWorksCM type exposes the following members

Methods

Note:

Asynchronous operations (methods ending with Async) in the table below are for .NET 4.5 or higher. For .NET 3.5 the SDK follows the standard naming convention of BeginMethodName and EndMethodName to indicate asynchronous operations - these method pairs are not shown in the table below.

NameDescription
Public Method AssociateNode(AssociateNodeRequest)

Associates a new node with the Chef server. This command is an alternative to

knife
            bootstrap
. For more information about how to disassociate a node, see DisassociateNode.

A node can can only be associated with servers that are in a HEALTHY state. Otherwise, an InvalidStateException is thrown. A ResourceNotFoundException is thrown when the server does not exist. A ValidationException 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.

Example:

aws opsworks-cm associate-node --server-name MyServer --node-name
            MyManagedNode --engine-attributes "Name=MyOrganization,Value=default"
            "Name=Chef_node_public_key,Value=Public_key_contents"

Public Method AssociateNodeAsync(AssociateNodeRequest, CancellationToken)

Initiates the asynchronous execution of the AssociateNode operation.

Public Method CreateBackup(CreateBackupRequest)

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

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

This operation is asynchronous.

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

Public Method CreateBackupAsync(CreateBackupRequest, CancellationToken)

Initiates the asynchronous execution of the CreateBackup operation.

Public Method CreateServer(CreateServerRequest)

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

This operation is asynchronous.

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

If you do not specify a security group by adding the SecurityGroupIds parameter, AWS OpsWorks creates a new security group. 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.

By default, the Chef 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.

Public Method CreateServerAsync(CreateServerRequest, CancellationToken)

Initiates the asynchronous execution of the CreateServer operation.

Public Method DeleteBackup(DeleteBackupRequest)

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

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

Public Method DeleteBackupAsync(DeleteBackupRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteBackup operation.

Public Method DeleteServer(DeleteServerRequest)

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

This operation is asynchronous.

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

Public Method DeleteServerAsync(DeleteServerRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteServer operation.

Public Method DescribeAccountAttributes(DescribeAccountAttributesRequest)

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

This operation is synchronous.

Public Method DescribeAccountAttributesAsync(DescribeAccountAttributesRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeAccountAttributes operation.

Public Method DescribeBackups(DescribeBackupsRequest)

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.

This operation is synchronous.

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

Public Method DescribeBackupsAsync(DescribeBackupsRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeBackups operation.

Public Method DescribeEvents(DescribeEventsRequest)

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

This operation is synchronous.

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

Public Method DescribeEventsAsync(DescribeEventsRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeEvents operation.

Public Method DescribeNodeAssociationStatus(DescribeNodeAssociationStatusRequest)

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

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

Public Method DescribeNodeAssociationStatusAsync(DescribeNodeAssociationStatusRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeNodeAssociationStatus operation.

Public Method DescribeServers(DescribeServersRequest)

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

This operation is synchronous.

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

Public Method DescribeServersAsync(DescribeServersRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeServers operation.

Public Method DisassociateNode(DisassociateNodeRequest)

Disassociates a node from a Chef server, and removes the node from the Chef server's managed nodes. After a node is disassociated, the node key pair is no longer valid for accessing the Chef API. For more information about how to associate a node, see AssociateNode.

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

Public Method DisassociateNodeAsync(DisassociateNodeRequest, CancellationToken)

Initiates the asynchronous execution of the DisassociateNode operation.

Public Method RestoreServer(RestoreServerRequest)

Restores a backup to a server that is in a CONNECTION_LOST, HEALTHY, RUNNING, UNHEALTHY, or TERMINATED 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.

This operation is asynchronous.

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

Public Method RestoreServerAsync(RestoreServerRequest, CancellationToken)

Initiates the asynchronous execution of the RestoreServer operation.

Public Method StartMaintenance(StartMaintenanceRequest)

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 UNDER_MAINTENANCE state while maintenance is in progress.

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

Public Method StartMaintenanceAsync(StartMaintenanceRequest, CancellationToken)

Initiates the asynchronous execution of the StartMaintenance operation.

Public Method UpdateServer(UpdateServerRequest)

Updates settings for a server.

This operation is synchronous.

Public Method UpdateServerAsync(UpdateServerRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateServer operation.

Public Method UpdateServerEngineAttributes(UpdateServerEngineAttributesRequest)

Updates engine-specific attributes on a specified server. The server enters the MODIFYING state when this operation is in progress. Only one update can occur at a time. You can use this command to reset the Chef server's private key (CHEF_PIVOTAL_KEY).

This operation is asynchronous.

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

Public Method UpdateServerEngineAttributesAsync(UpdateServerEngineAttributesRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateServerEngineAttributes operation.

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms