C# (CSharp) Amazon.OpsWorksCM.Model Namespace

Nested Namespaces

Amazon.OpsWorksCM.Model.Internal

Classes

Name Description
AccountAttribute Stores account attributes.
AssociateNodeRequest Container for the parameters to the AssociateNode operation.
AssociateNodeResponse This is the response object from the AssociateNode operation.
Backup Describes a single backup.
CMServer Describes a configuration management server.
CreateBackupRequest Container for the parameters to the CreateBackup operation. Creates an application-level backup of a server. While the server is BACKING_UP, the server can not be modified and no additional backup can be created.

Backups can be created for RUNNING, HEALTHY and UNHEALTHY servers.

This operation is asnychronous.

By default 50 manual backups can be created.

A LimitExceededException is thrown then the maximum number of manual backup is reached. A InvalidStateException is thrown when the server is not in any of RUNNING, HEALTHY, UNHEALTHY. A ResourceNotFoundException is thrown when the server is not found. A ValidationException is thrown when parameters of the request are not valid.

CreateBackupResponse This is the response object from the CreateBackup operation.
CreateServerRequest Container for the parameters to the CreateServer operation. Creates and immedately starts a new Server. The server can be used once it has reached the HEALTHY state.

This operation is asnychronous.

A LimitExceededException is thrown then the maximum number of server backup is reached. A ResourceAlreadyExistsException is raise when a server with the same name already exists in the account. A ResourceNotFoundException is thrown when a backupId is passed, but the backup does not exist. A ValidationException is thrown when parameters of the request are not valid.

By default 10 servers can be created. A LimitExceededException is raised when the limit is exceeded.

When no security groups are provided by using SecurityGroupIds, AWS OpsWorks creates a new security group. This security group opens the Chef server to the world on TCP port 443. If a KeyName is present, SSH access is enabled. 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.

CreateServerResponse This is the response object from the CreateServer operation.
DeleteBackupRequest Container for the parameters to the DeleteBackup operation. Deletes a backup. You can delete both manual and automated backups.

This operation is asynchronous.

A InvalidStateException is thrown then a backup is already deleting. A ResourceNotFoundException is thrown when the backup does not exist. A ValidationException is thrown when parameters of the request are not valid.

DescribeAccountAttributesResponse This is the response object from the DescribeAccountAttributes operation.
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 invalid.

DescribeBackupsResponse This is the response object from the DescribeBackups operation.
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 invalid.

DescribeEventsResponse This is the response object from the DescribeEvents operation.
DescribeNodeAssociationStatusRequest Container for the parameters to the DescribeNodeAssociationStatus operation.
DescribeNodeAssociationStatusResponse This is the response object from the DescribeNodeAssociationStatus operation.
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 invalid.

DescribeServersResponse This is the response object from the DescribeServers operation.
DisassociateNodeRequest Container for the parameters to the DisassociateNode operation.
DisassociateNodeResponse This is the response object from the DisassociateNode operation.
EngineAttribute A name/value pair that is specific to the engine of the server.
InvalidNextTokenException
InvalidStateException
LimitExceededException
ResourceAlreadyExistsException
ResourceNotFoundException
RestoreServerRequest Container for the parameters to the RestoreServer operation. Restores a backup to a server that is in a RUNNING, FAILED, or HEALTHY 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 all of the server's client devices should continue to work.

This operation is asynchronous.

A 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 invalid.

ServerEvent An event that is related to the server, such as the start of maintenance or backup.
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 will switch to UNDER_MAINTENANCE state, while maintenace is in progress.

Maintenace can only be started for HEALTHY and UNHEALTHY servers. A InvalidStateException is thrown otherwise. A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are invalid.

StartMaintenanceResponse This is the response object from the StartMaintenance operation.
UpdateServerEngineAttributesRequest Container for the parameters to the UpdateServerEngineAttributes operation. Updates engine specific attributes on a specified server. Server will enter the MODIFYING state when this operation is in progress. Only one update can take place at a time.

This operation can be use to reset Chef Server main API key (CHEF_PIVOTAL_KEY).

This operation is asynchronous.

This operation can only be called for HEALTHY and UNHEALTHY servers. Otherwise a InvalidStateException is raised. A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are invalid.

UpdateServerEngineAttributesResponse This is the response object from the UpdateServerEngineAttributes operation.
UpdateServerRequest Container for the parameters to the UpdateServer operation. Updates settings for a server.

This operation is synchronous.

UpdateServerResponse This is the response object from the UpdateServer operation.
ValidationException