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.

Classes

NameDescription
Class AccountAttribute

Stores account attributes.

Class AssociateNodeRequest

Container for the parameters to the AssociateNode operation. 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"

Class AssociateNodeResponse

This is the response object from the AssociateNode operation.

Class Backup

Describes a single backup.

Class CMServer

Describes a configuration management server.

Class CreateBackupRequest

Container for the parameters to the CreateBackup operation. 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.

Class CreateBackupResponse

This is the response object from the CreateBackup operation.

Class CreateServerRequest

Container for the parameters to the CreateServer operation. 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.

Class CreateServerResponse

This is the response object from the CreateServer operation.

Class DeleteBackupRequest

Container for the parameters to the DeleteBackup operation. 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.

Class DeleteBackupResponse

This is the response object from the DeleteBackup operation.

Class DeleteServerRequest

Container for the parameters to the DeleteServer operation. 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.

Class DeleteServerResponse

This is the response object from the DeleteServer operation.

Class DescribeAccountAttributesRequest

Container for the parameters to the DescribeAccountAttributes operation. Describes your account attributes, and creates requests to increase limits before they are reached or exceeded.

This operation is synchronous.

Class DescribeAccountAttributesResponse

This is the response object from the DescribeAccountAttributes operation.

Class DescribeBackupsRequest

Container for the parameters to the DescribeBackups operation. 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.

Class DescribeBackupsResponse

This is the response object from the DescribeBackups operation.

Class DescribeEventsRequest

Container for the parameters to the DescribeEvents operation. 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.

Class DescribeEventsResponse

This is the response object from the DescribeEvents operation.

Class DescribeNodeAssociationStatusRequest

Container for the parameters to the DescribeNodeAssociationStatus operation. 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.

Class DescribeNodeAssociationStatusResponse

This is the response object from the DescribeNodeAssociationStatus operation.

Class DescribeServersRequest

Container for the parameters to the DescribeServers operation. 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.

Class DescribeServersResponse

This is the response object from the DescribeServers operation.

Class DisassociateNodeRequest

Container for the parameters to the DisassociateNode operation. 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.

Class DisassociateNodeResponse

This is the response object from the DisassociateNode operation.

Class EngineAttribute

A name and value pair that is specific to the engine of the server.

Class InvalidNextTokenException

OpsWorksCM exception

Class InvalidStateException

OpsWorksCM exception

Class LimitExceededException

OpsWorksCM exception

Class ResourceAlreadyExistsException

OpsWorksCM exception

Class ResourceNotFoundException

OpsWorksCM exception

Class RestoreServerRequest

Container for the parameters to the RestoreServer operation. 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.

Class RestoreServerResponse

This is the response object from the RestoreServer operation.

Class ServerEvent

An event that is related to the server, such as the start of maintenance or backup.

Class StartMaintenanceRequest

Container for the parameters to the StartMaintenance operation. 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.

Class StartMaintenanceResponse

This is the response object from the StartMaintenance operation.

Class UpdateServerEngineAttributesRequest

Container for the parameters to the UpdateServerEngineAttributes operation. 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.

Class UpdateServerEngineAttributesResponse

This is the response object from the UpdateServerEngineAttributes operation.

Class UpdateServerRequest

Container for the parameters to the UpdateServer operation. Updates settings for a server.

This operation is synchronous.

Class UpdateServerResponse

This is the response object from the UpdateServer operation.

Class ValidationException

OpsWorksCM exception