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 CMAWS OpsWorks for configuration management (CM) is a service that runs and manages configuration management servers. You can use AWS OpsWorks CM to create and manage AWS OpsWorks for Chef Automate and AWS OpsWorks for Puppet Enterprise servers, and add or remove nodes for the servers to manage.
Glossary of terms
Server: A configuration management server that can be highly-available. The configuration management server runs on an Amazon Elastic Compute Cloud (EC2) instance, and may use various other AWS services, such as Amazon Relational Database Service (RDS) and Elastic Load Balancing. A server is a generic abstraction over the configuration manager that you want to use, much like Amazon RDS. In AWS OpsWorks CM, you do not start or stop servers. After you create servers, they continue to run until they are deleted.
Engine: The engine is the specific configuration manager that you want to
use. Valid values in this release include ChefAutomate
and Puppet
.
Backup: This is an application-level backup of the data that the configuration manager stores. AWS OpsWorks CM creates an S3 bucket for backups when you launch the first server. A backup maintains a snapshot of a server's configuration-related attributes at the time the backup starts.
Events: Events are always related to a server. Events are written during server creation, when health checks run, when backups are created, when system maintenance is performed, etc. When you delete a server, the server's events are also deleted.
Account attributes: Every account has attributes that are assigned in the AWS OpsWorks CM database. These attributes store information about configuration limits (servers, backups, etc.) and your customer account.
Endpoints
AWS OpsWorks CM supports the following endpoints, all HTTPS. You must connect to one of the following endpoints. Your servers can only be accessed or managed within the endpoint in which they are created.
opsworks-cm.us-east-1.amazonaws.com
opsworks-cm.us-east-2.amazonaws.com
opsworks-cm.us-west-1.amazonaws.com
opsworks-cm.us-west-2.amazonaws.com
opsworks-cm.ap-northeast-1.amazonaws.com
opsworks-cm.ap-southeast-1.amazonaws.com
opsworks-cm.ap-southeast-2.amazonaws.com
opsworks-cm.eu-central-1.amazonaws.com
opsworks-cm.eu-west-1.amazonaws.com
For more information, see AWS OpsWorks endpoints and quotas in the AWS General Reference.
Throttling limits
All API operations allow for five requests per second with a burst of 10 requests per second.
Namespace: Amazon.OpsWorksCM
Assembly: AWSSDK.OpsWorksCM.dll
Version: 3.x.y.z
public interface IAmazonOpsWorksCM IAmazonService, IDisposable
The IAmazonOpsWorksCM type exposes the following members
Name | Type | Description | |
---|---|---|---|
Paginators | Amazon.OpsWorksCM.Model.IOpsWorksCMPaginatorFactory |
Paginators for the service |
Name | Description | |
---|---|---|
AssociateNode(AssociateNodeRequest) |
Associates a new node with the server. For more information about how to disassociate a node, see DisassociateNode.
On a Chef server: This command is an alternative to
Example (Chef):
On a Puppet server, this command is an alternative to the
Example (Puppet):
A node can can only be associated with servers that are in a |
|
AssociateNodeAsync(AssociateNodeRequest, CancellationToken) |
Associates a new node with the server. For more information about how to disassociate a node, see DisassociateNode.
On a Chef server: This command is an alternative to
Example (Chef):
On a Puppet server, this command is an alternative to the
Example (Puppet):
A node can can only be associated with servers that are in a |
|
CreateBackup(CreateBackupRequest) |
Creates an application-level backup of a server. While the server is in the
Backups can be created for servers in This operation is asynchronous.
A |
|
CreateBackupAsync(CreateBackupRequest, CancellationToken) |
Creates an application-level backup of a server. While the server is in the
Backups can be created for servers in This operation is asynchronous.
A |
|
CreateServer(CreateServerRequest) |
Creates and immedately starts a new server. The server is ready to use when it is
in the This operation is asynchronous.
A
If you do not specify a security group by adding the Chef Automate: 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. Puppet Enterprise: 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. 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.
To specify your own domain for a server, and provide your own self-signed or CA-signed
certificate and private key, specify values for |
|
CreateServerAsync(CreateServerRequest, CancellationToken) |
Creates and immedately starts a new server. The server is ready to use when it is
in the This operation is asynchronous.
A
If you do not specify a security group by adding the Chef Automate: 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. Puppet Enterprise: 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. 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.
To specify your own domain for a server, and provide your own self-signed or CA-signed
certificate and private key, specify values for |
|
DeleteBackup(DeleteBackupRequest) |
Deletes a backup. You can delete both manual and automated backups. This operation is asynchronous.
An |
|
DeleteBackupAsync(DeleteBackupRequest, CancellationToken) |
Deletes a backup. You can delete both manual and automated backups. This operation is asynchronous.
An |
|
DeleteServer(DeleteServerRequest) |
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 This operation is asynchronous.
An
|
|
DeleteServerAsync(DeleteServerRequest, CancellationToken) |
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 This operation is asynchronous.
An
|
|
DescribeAccountAttributes(DescribeAccountAttributesRequest) |
Describes your OpsWorks-CM account attributes. This operation is synchronous. |
|
DescribeAccountAttributesAsync(DescribeAccountAttributesRequest, CancellationToken) |
Describes your OpsWorks-CM account attributes. This operation is synchronous. |
|
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 |
|
DescribeBackupsAsync(DescribeBackupsRequest, CancellationToken) |
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 |
|
DescribeEvents(DescribeEventsRequest) |
Describes events for a specified server. Results are ordered by time, with newest events first. This operation is synchronous.
A |
|
DescribeEventsAsync(DescribeEventsRequest, CancellationToken) |
Describes events for a specified server. Results are ordered by time, with newest events first. This operation is synchronous.
A |
|
DescribeNodeAssociationStatus(DescribeNodeAssociationStatusRequest) |
Returns the current status of an existing association or disassociation request.
A |
|
DescribeNodeAssociationStatusAsync(DescribeNodeAssociationStatusRequest, CancellationToken) |
Returns the current status of an existing association or disassociation request.
A |
|
DescribeServers(DescribeServersRequest) |
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. This operation is synchronous.
A |
|
DescribeServersAsync(DescribeServersRequest, CancellationToken) |
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. This operation is synchronous.
A |
|
DetermineServiceOperationEndpoint(AmazonWebServiceRequest) |
Returns the endpoint that will be used for a particular request. |
|
DisassociateNode(DisassociateNodeRequest) |
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 AssociateNode.
A node can can only be disassociated from a server that is in a |
|
DisassociateNodeAsync(DisassociateNodeRequest, CancellationToken) |
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 AssociateNode.
A node can can only be disassociated from a server that is in a |
|
ExportServerEngineAttribute(ExportServerEngineAttributeRequest) |
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 |
|
ExportServerEngineAttributeAsync(ExportServerEngineAttributeRequest, CancellationToken) |
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 |
|
ListTagsForResource(ListTagsForResourceRequest) |
Returns a list of tags that are applied to the specified AWS OpsWorks for Chef Automate or AWS OpsWorks for Puppet Enterprise servers or backups. |
|
ListTagsForResourceAsync(ListTagsForResourceRequest, CancellationToken) |
Returns a list of tags that are applied to the specified AWS OpsWorks for Chef Automate or AWS OpsWorks for Puppet Enterprise servers or backups. |
|
RestoreServer(RestoreServerRequest) |
Restores a backup to a server that is in a
Restoring from a backup is performed by creating a new EC2 instance. If restoration
is successful, and the server is in a This operation is asynchronous.
An |
|
RestoreServerAsync(RestoreServerRequest, CancellationToken) |
Restores a backup to a server that is in a
Restoring from a backup is performed by creating a new EC2 instance. If restoration
is successful, and the server is in a This operation is asynchronous.
An |
|
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
Maintenance can only be started on servers in |
|
StartMaintenanceAsync(StartMaintenanceRequest, CancellationToken) |
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
Maintenance can only be started on servers in |
|
TagResource(TagResourceRequest) |
Applies tags to an AWS OpsWorks for Chef Automate or AWS OpsWorks for Puppet Enterprise server, or to server backups. |
|
TagResourceAsync(TagResourceRequest, CancellationToken) |
Applies tags to an AWS OpsWorks for Chef Automate or AWS OpsWorks for Puppet Enterprise server, or to server backups. |
|
UntagResource(UntagResourceRequest) |
Removes specified tags from an AWS OpsWorks-CM server or backup. |
|
UntagResourceAsync(UntagResourceRequest, CancellationToken) |
Removes specified tags from an AWS OpsWorks-CM server or backup. |
|
UpdateServer(UpdateServerRequest) |
Updates settings for a server. This operation is synchronous. |
|
UpdateServerAsync(UpdateServerRequest, CancellationToken) |
Updates settings for a server. This operation is synchronous. |
|
UpdateServerEngineAttributes(UpdateServerEngineAttributesRequest) |
Updates engine-specific attributes on a specified server. The server enters the This operation is asynchronous.
This operation can only be called for servers in |
|
UpdateServerEngineAttributesAsync(UpdateServerEngineAttributesRequest, CancellationToken) |
Updates engine-specific attributes on a specified server. The server enters the This operation is asynchronous.
This operation can only be called for servers in |
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5, 4.0, 3.5