aws-elixir

v0.4.0

aws-elixir v0.4.0 AWS.OpsWorks.ChefAutomate

AWS OpsWorks for Chef Automate

A service that runs and manages configuration management servers.

Glossary of terms

  • **Server**: A server is a configuration management server, and can be highly-available. The configuration manager runs on your instances by using various AWS services, such as Amazon Elastic Compute Cloud (EC2), and potentially Amazon Relational Database Service (RDS). A server is a generic abstraction over the configuration manager that you want to use, much like Amazon RDS. In AWS OpsWorks for Chef Automate, you do not start or stop servers. After you create servers, they continue to run until they are deleted.
  • **Engine**: The specific configuration manager that you want to use (such as `Chef`) is the engine.
  • **Backup**: This is an application-level backup of the data that the configuration manager stores. A backup creates a .tar.gz file that is stored in an Amazon Simple Storage Service (S3) bucket in your account. AWS OpsWorks for Chef Automate creates the S3 bucket when you launch the first instance. A backup maintains a snapshot of all of a server's important attributes at the time of the backup.
  • **Events**: Events are always related to a server. Events are written during server creation, when health checks run, when backups are created, etc. When you delete a server, the server's events are also deleted.
  • **AccountAttributes**: Every account has attributes that are assigned in the AWS OpsWorks for Chef Automate database. These attributes store information about configuration limits (servers, backups, etc.) and your customer account.
Throttling limits All API operations allow for 5 requests per second with a burst of 10 requests per second.

Summary

Functions

associate_node(client, input, options \\ [])
create_backup(client, input, options \\ [])

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

create_server(client, input, options \\ [])

Creates and immedately starts a new Server. The server can be used once it has reached the HEALTHY state

delete_backup(client, input, options \\ [])

Deletes a backup. You can delete both manual and automated backups

delete_server(client, input, options \\ [])

Deletes the server and the underlying AWS CloudFormation stack (including the server’s EC2 instance). The server status updated to DELETING. Once the server is successfully deleted, it will no longer be returned by DescribeServer requests. If the AWS CloudFormation stack cannot be deleted, the server cannot be deleted

describe_account_attributes(client, input, options \\ [])

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

describe_backups(client, input, options \\ [])

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

describe_events(client, input, options \\ [])

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

describe_node_association_status(client, input, options \\ [])
describe_servers(client, input, options \\ [])

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

disassociate_node(client, input, options \\ [])
restore_server(client, input, options \\ [])

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

start_maintenance(client, input, options \\ [])

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

update_server(client, input, options \\ [])

Updates settings for a server

update_server_engine_attributes(client, input, options \\ [])

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

Functions

associate_node(client, input, options \\ [])
create_backup(client, input, options \\ [])

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.

create_server(client, input, options \\ [])

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.

delete_backup(client, input, options \\ [])

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.

delete_server(client, input, options \\ [])

Deletes the server and the underlying AWS CloudFormation stack (including the server’s EC2 instance). The server status updated to DELETING. Once the server is successfully deleted, it will no longer be returned by DescribeServer requests. If the AWS CloudFormation stack cannot be deleted, the server cannot be deleted.

This operation is asynchronous.

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

describe_account_attributes(client, input, options \\ [])

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

This operation is synchronous.

describe_backups(client, input, options \\ [])

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.

describe_events(client, input, options \\ [])

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.

describe_node_association_status(client, input, options \\ [])
describe_servers(client, input, options \\ [])

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.

disassociate_node(client, input, options \\ [])
restore_server(client, input, options \\ [])

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.

start_maintenance(client, input, options \\ [])

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.

update_server(client, input, options \\ [])

Updates settings for a server.

This operation is synchronous.

update_server_engine_attributes(client, input, options \\ [])

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.