Copyright | (c) 2013-2018 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
AWS OpsWorks CM
AWS OpsWorks for configuration management (CM) is a service that runs and manages configuration management servers.
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
Chef
andPuppet
. - 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-west-2.amazonaws.com
- opsworks-cm.eu-west-1.amazonaws.com
Throttling limits
All API operations allow for five requests per second with a burst of 10 requests per second.
Synopsis
- opsWorksCM :: Service
- _ValidationException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceAlreadyExistsException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidNextTokenException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidStateException :: AsError a => Getting (First ServiceError) a ServiceError
- _LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- nodeAssociated :: Wait DescribeNodeAssociationStatus
- module Network.AWS.OpsWorksCM.AssociateNode
- module Network.AWS.OpsWorksCM.UpdateServer
- module Network.AWS.OpsWorksCM.DeleteServer
- module Network.AWS.OpsWorksCM.DeleteBackup
- module Network.AWS.OpsWorksCM.DescribeEvents
- module Network.AWS.OpsWorksCM.DisassociateNode
- module Network.AWS.OpsWorksCM.CreateBackup
- module Network.AWS.OpsWorksCM.UpdateServerEngineAttributes
- module Network.AWS.OpsWorksCM.StartMaintenance
- module Network.AWS.OpsWorksCM.DescribeBackups
- module Network.AWS.OpsWorksCM.CreateServer
- module Network.AWS.OpsWorksCM.RestoreServer
- module Network.AWS.OpsWorksCM.DescribeNodeAssociationStatus
- module Network.AWS.OpsWorksCM.DescribeAccountAttributes
- module Network.AWS.OpsWorksCM.DescribeServers
- data BackupStatus
- data BackupType
- data MaintenanceStatus
- data NodeAssociationStatus
- data ServerStatus
- data AccountAttribute
- accountAttribute :: AccountAttribute
- aaUsed :: Lens' AccountAttribute (Maybe Int)
- aaMaximum :: Lens' AccountAttribute (Maybe Int)
- aaName :: Lens' AccountAttribute (Maybe Text)
- data Backup
- backup :: Backup
- bEngineVersion :: Lens' Backup (Maybe Text)
- bServiceRoleARN :: Lens' Backup (Maybe Text)
- bStatus :: Lens' Backup (Maybe BackupStatus)
- bInstanceProfileARN :: Lens' Backup (Maybe Text)
- bSecurityGroupIds :: Lens' Backup [Text]
- bStatusDescription :: Lens' Backup (Maybe Text)
- bServerName :: Lens' Backup (Maybe Text)
- bSubnetIds :: Lens' Backup [Text]
- bKeyPair :: Lens' Backup (Maybe Text)
- bCreatedAt :: Lens' Backup (Maybe UTCTime)
- bBackupId :: Lens' Backup (Maybe Text)
- bEngine :: Lens' Backup (Maybe Text)
- bInstanceType :: Lens' Backup (Maybe Text)
- bEngineModel :: Lens' Backup (Maybe Text)
- bPreferredMaintenanceWindow :: Lens' Backup (Maybe Text)
- bUserARN :: Lens' Backup (Maybe Text)
- bPreferredBackupWindow :: Lens' Backup (Maybe Text)
- bS3LogURL :: Lens' Backup (Maybe Text)
- bS3DataSize :: Lens' Backup (Maybe Int)
- bBackupARN :: Lens' Backup (Maybe Text)
- bS3DataURL :: Lens' Backup (Maybe Text)
- bDescription :: Lens' Backup (Maybe Text)
- bBackupType :: Lens' Backup (Maybe BackupType)
- bToolsVersion :: Lens' Backup (Maybe Text)
- data EngineAttribute
- engineAttribute :: EngineAttribute
- eaValue :: Lens' EngineAttribute (Maybe Text)
- eaName :: Lens' EngineAttribute (Maybe Text)
- data Server
- server :: Server
- sEngineVersion :: Lens' Server (Maybe Text)
- sServiceRoleARN :: Lens' Server (Maybe Text)
- sDisableAutomatedBackup :: Lens' Server (Maybe Bool)
- sStatus :: Lens' Server (Maybe ServerStatus)
- sInstanceProfileARN :: Lens' Server (Maybe Text)
- sSecurityGroupIds :: Lens' Server [Text]
- sAssociatePublicIPAddress :: Lens' Server (Maybe Bool)
- sServerName :: Lens' Server (Maybe Text)
- sSubnetIds :: Lens' Server [Text]
- sKeyPair :: Lens' Server (Maybe Text)
- sCreatedAt :: Lens' Server (Maybe UTCTime)
- sServerARN :: Lens' Server (Maybe Text)
- sEngine :: Lens' Server (Maybe Text)
- sMaintenanceStatus :: Lens' Server (Maybe MaintenanceStatus)
- sInstanceType :: Lens' Server (Maybe Text)
- sEngineModel :: Lens' Server (Maybe Text)
- sEngineAttributes :: Lens' Server [EngineAttribute]
- sPreferredMaintenanceWindow :: Lens' Server (Maybe Text)
- sPreferredBackupWindow :: Lens' Server (Maybe Text)
- sStatusReason :: Lens' Server (Maybe Text)
- sEndpoint :: Lens' Server (Maybe Text)
- sCloudFormationStackARN :: Lens' Server (Maybe Text)
- sBackupRetentionCount :: Lens' Server (Maybe Int)
- data ServerEvent
- serverEvent :: ServerEvent
- seLogURL :: Lens' ServerEvent (Maybe Text)
- seServerName :: Lens' ServerEvent (Maybe Text)
- seCreatedAt :: Lens' ServerEvent (Maybe UTCTime)
- seMessage :: Lens' ServerEvent (Maybe Text)
Service Configuration
opsWorksCM :: Service Source #
API version 2016-11-01
of the Amazon OpsWorks for Chef Automate SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by OpsWorksCM
.
ValidationException
_ValidationException :: AsError a => Getting (First ServiceError) a ServiceError Source #
One or more of the provided request parameters are not valid.
ResourceAlreadyExistsException
_ResourceAlreadyExistsException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The requested resource cannot be created because it already exists.
InvalidNextTokenException
_InvalidNextTokenException :: AsError a => Getting (First ServiceError) a ServiceError Source #
This occurs when the provided nextToken is not valid.
ResourceNotFoundException
_ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The requested resource does not exist, or access was denied.
InvalidStateException
_InvalidStateException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The resource is in a state that does not allow you to perform a specified action.
LimitExceededException
_LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The limit of servers or backups has been reached.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait
specification is fulfilled. The Wait
specification
determines how many attempts should be made, in addition to delay and retry strategies.
NodeAssociated
nodeAssociated :: Wait DescribeNodeAssociationStatus Source #
Polls DescribeNodeAssociationStatus
every 15 seconds until a successful state is reached. An error is returned after 15 failed checks.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects
operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager
instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
AssociateNode
UpdateServer
DeleteServer
DeleteBackup
DescribeEvents
DisassociateNode
CreateBackup
UpdateServerEngineAttributes
StartMaintenance
DescribeBackups
CreateServer
RestoreServer
DescribeNodeAssociationStatus
DescribeAccountAttributes
DescribeServers
Types
BackupStatus
data BackupStatus Source #
Instances
BackupType
data BackupType Source #
Instances
MaintenanceStatus
data MaintenanceStatus Source #
Instances
NodeAssociationStatus
data NodeAssociationStatus Source #
The status of the association or disassociation request.
Possible values:
SUCCESS
: The association or disassociation succeeded.FAILED
: The association or disassociation failed.IN_PROGRESS
: The association or disassociation is still in progress.
Instances
ServerStatus
data ServerStatus Source #
BackingUp | |
ConnectionLost | |
Creating | |
Deleting | |
Failed | |
Healthy | |
Modifying | |
Restoring | |
Running | |
Setup | |
Terminated | |
UnderMaintenance | |
Unhealthy |
Instances
AccountAttribute
data AccountAttribute Source #
Stores account attributes.
See: accountAttribute
smart constructor.
Instances
accountAttribute :: AccountAttribute Source #
Creates a value of AccountAttribute
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
aaUsed
- The current usage, such as the current number of servers that are associated with the account.aaMaximum
- The maximum allowed value.aaName
- The attribute name. The following are supported attribute names. * ServerLimit: The number of current serversmaximum number of servers allowed. By default, you can have a maximum of 10 servers. * ManualBackupLimit: The number of current manual backupsmaximum number of backups allowed. By default, you can have a maximum of 50 manual backups saved.
aaUsed :: Lens' AccountAttribute (Maybe Int) Source #
The current usage, such as the current number of servers that are associated with the account.
aaName :: Lens' AccountAttribute (Maybe Text) Source #
The attribute name. The following are supported attribute names. * ServerLimit: The number of current serversmaximum number of servers allowed. By default, you can have a maximum of 10 servers. * ManualBackupLimit: The number of current manual backupsmaximum number of backups allowed. By default, you can have a maximum of 50 manual backups saved.
Backup
Describes a single backup.
See: backup
smart constructor.
Instances
Creates a value of Backup
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
bEngineVersion
- The engine version that is obtained from the server when the backup is created.bServiceRoleARN
- The service role ARN that is obtained from the server when the backup is created.bStatus
- The status of a backup while in progress.bInstanceProfileARN
- The EC2 instance profile ARN that is obtained from the server when the backup is created. Because this value is stored, you are not required to provide the InstanceProfileArn again if you restore a backup.bSecurityGroupIds
- The security group IDs that are obtained from the server when the backup is created.bStatusDescription
- An informational message about backup status.bServerName
- The name of the server from which the backup was made.bSubnetIds
- The subnet IDs that are obtained from the server when the backup is created.bKeyPair
- The key pair that is obtained from the server when the backup is created.bCreatedAt
- The time stamp when the backup was created in the database. Example:2016-07-29T13:38:47.520Z
bBackupId
- The generated ID of the backup. Example:myServerName-yyyyMMddHHmmssSSS
bEngine
- The engine type that is obtained from the server when the backup is created.bInstanceType
- The instance type that is obtained from the server when the backup is created.bEngineModel
- The engine model that is obtained from the server when the backup is created.bPreferredMaintenanceWindow
- The preferred maintenance period that is obtained from the server when the backup is created.bUserARN
- The IAM user ARN of the requester for manual backups. This field is empty for automated backups.bPreferredBackupWindow
- The preferred backup period that is obtained from the server when the backup is created.bS3LogURL
- The Amazon S3 URL of the backup's log file.bS3DataSize
- This field is deprecated and is no longer used.bBackupARN
- The ARN of the backup.bS3DataURL
- This field is deprecated and is no longer used.bDescription
- A user-provided description for a manual backup. This field is empty for automated backups.bBackupType
- The backup type. Valid values areautomated
ormanual
.bToolsVersion
- The version of AWS OpsWorks CM-specific tools that is obtained from the server when the backup is created.
bEngineVersion :: Lens' Backup (Maybe Text) Source #
The engine version that is obtained from the server when the backup is created.
bServiceRoleARN :: Lens' Backup (Maybe Text) Source #
The service role ARN that is obtained from the server when the backup is created.
bInstanceProfileARN :: Lens' Backup (Maybe Text) Source #
The EC2 instance profile ARN that is obtained from the server when the backup is created. Because this value is stored, you are not required to provide the InstanceProfileArn again if you restore a backup.
bSecurityGroupIds :: Lens' Backup [Text] Source #
The security group IDs that are obtained from the server when the backup is created.
bStatusDescription :: Lens' Backup (Maybe Text) Source #
An informational message about backup status.
bServerName :: Lens' Backup (Maybe Text) Source #
The name of the server from which the backup was made.
bSubnetIds :: Lens' Backup [Text] Source #
The subnet IDs that are obtained from the server when the backup is created.
bKeyPair :: Lens' Backup (Maybe Text) Source #
The key pair that is obtained from the server when the backup is created.
bCreatedAt :: Lens' Backup (Maybe UTCTime) Source #
The time stamp when the backup was created in the database. Example: 2016-07-29T13:38:47.520Z
bBackupId :: Lens' Backup (Maybe Text) Source #
The generated ID of the backup. Example: myServerName-yyyyMMddHHmmssSSS
bEngine :: Lens' Backup (Maybe Text) Source #
The engine type that is obtained from the server when the backup is created.
bInstanceType :: Lens' Backup (Maybe Text) Source #
The instance type that is obtained from the server when the backup is created.
bEngineModel :: Lens' Backup (Maybe Text) Source #
The engine model that is obtained from the server when the backup is created.
bPreferredMaintenanceWindow :: Lens' Backup (Maybe Text) Source #
The preferred maintenance period that is obtained from the server when the backup is created.
bUserARN :: Lens' Backup (Maybe Text) Source #
The IAM user ARN of the requester for manual backups. This field is empty for automated backups.
bPreferredBackupWindow :: Lens' Backup (Maybe Text) Source #
The preferred backup period that is obtained from the server when the backup is created.
bDescription :: Lens' Backup (Maybe Text) Source #
A user-provided description for a manual backup. This field is empty for automated backups.
bBackupType :: Lens' Backup (Maybe BackupType) Source #
The backup type. Valid values are automated
or manual
.
bToolsVersion :: Lens' Backup (Maybe Text) Source #
The version of AWS OpsWorks CM-specific tools that is obtained from the server when the backup is created.
EngineAttribute
data EngineAttribute Source #
A name and value pair that is specific to the engine of the server.
See: engineAttribute
smart constructor.
Instances
engineAttribute :: EngineAttribute Source #
Creates a value of EngineAttribute
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
Server
Describes a configuration management server.
See: server
smart constructor.
Instances
Creates a value of Server
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sEngineVersion
- The engine version of the server. For a Chef server, the valid value for EngineVersion is currently12
. For a Puppet server, the valid value is2017
.sServiceRoleARN
- The service role ARN used to create the server.sDisableAutomatedBackup
- Disables automated backups. The number of stored backups is dependent on the value of PreferredBackupCount.sStatus
- The server's status. This field displays the states of actions in progress, such as creating, running, or backing up the server, as well as the server's health state.sInstanceProfileARN
- The instance profile ARN of the server.sSecurityGroupIds
- The security group IDs for the server, as specified in the CloudFormation stack. These might not be the same security groups that are shown in the EC2 console.sAssociatePublicIPAddress
- Associate a public IP address with a server that you are launching.sServerName
- The name of the server.sSubnetIds
- The subnet IDs specified in a CreateServer request.sKeyPair
- The key pair associated with the server.sCreatedAt
- Time stamp of server creation. Example2016-07-29T13:38:47.520Z
sServerARN
- The ARN of the server.sEngine
- The engine type of the server. Valid values in this release includeChef
andPuppet
.sMaintenanceStatus
- The status of the most recent server maintenance run. ShowsSUCCESS
orFAILED
.sInstanceType
- The instance type for the server, as specified in the CloudFormation stack. This might not be the same instance type that is shown in the EC2 console.sEngineModel
- The engine model of the server. Valid values in this release includeMonolithic
for Puppet andSingle
for Chef.sEngineAttributes
- The response of a createServer() request returns the master credential to access the server in EngineAttributes. These credentials are not stored by AWS OpsWorks CM; they are returned only as part of the result of createServer(). Attributes returned in a createServer response for Chef *CHEF_PIVOTAL_KEY
: A base64-encoded RSA private key that is generated by AWS OpsWorks for Chef Automate. This private key is required to access the Chef API. *CHEF_STARTER_KIT
: A base64-encoded ZIP file. The ZIP file contains a Chef starter kit, which includes a README, a configuration file, and the required RSA private key. Save this file, unzip it, and then change to the directory where you've unzipped the file contents. From this directory, you can run Knife commands. Attributes returned in a createServer response for Puppet *PUPPET_STARTER_KIT
: A base64-encoded ZIP file. The ZIP file contains a Puppet starter kit, including a README and a required private key. Save this file, unzip it, and then change to the directory where you've unzipped the file contents. *PUPPET_ADMIN_PASSWORD
: An administrator password that you can use to sign in to the Puppet Enterprise console after the server is online.sPreferredMaintenanceWindow
- The preferred maintenance period specified for the server.sPreferredBackupWindow
- The preferred backup period specified for the server.sStatusReason
- Depending on the server status, this field has either a human-readable message (such as a create or backup error), or an escaped block of JSON (used for health check results).sEndpoint
- A DNS name that can be used to access the engine. Example:myserver-asdfghjkl.us-east-1.opsworks.io
sCloudFormationStackARN
- The ARN of the CloudFormation stack that was used to create the server.sBackupRetentionCount
- The number of automated backups to keep.
sEngineVersion :: Lens' Server (Maybe Text) Source #
The engine version of the server. For a Chef server, the valid value for EngineVersion is currently 12
. For a Puppet server, the valid value is 2017
.
sServiceRoleARN :: Lens' Server (Maybe Text) Source #
The service role ARN used to create the server.
sDisableAutomatedBackup :: Lens' Server (Maybe Bool) Source #
Disables automated backups. The number of stored backups is dependent on the value of PreferredBackupCount.
sStatus :: Lens' Server (Maybe ServerStatus) Source #
The server's status. This field displays the states of actions in progress, such as creating, running, or backing up the server, as well as the server's health state.
sSecurityGroupIds :: Lens' Server [Text] Source #
The security group IDs for the server, as specified in the CloudFormation stack. These might not be the same security groups that are shown in the EC2 console.
sAssociatePublicIPAddress :: Lens' Server (Maybe Bool) Source #
Associate a public IP address with a server that you are launching.
sCreatedAt :: Lens' Server (Maybe UTCTime) Source #
Time stamp of server creation. Example 2016-07-29T13:38:47.520Z
sEngine :: Lens' Server (Maybe Text) Source #
The engine type of the server. Valid values in this release include Chef
and Puppet
.
sMaintenanceStatus :: Lens' Server (Maybe MaintenanceStatus) Source #
The status of the most recent server maintenance run. Shows SUCCESS
or FAILED
.
sInstanceType :: Lens' Server (Maybe Text) Source #
The instance type for the server, as specified in the CloudFormation stack. This might not be the same instance type that is shown in the EC2 console.
sEngineModel :: Lens' Server (Maybe Text) Source #
The engine model of the server. Valid values in this release include Monolithic
for Puppet and Single
for Chef.
sEngineAttributes :: Lens' Server [EngineAttribute] Source #
The response of a createServer() request returns the master credential to access the server in EngineAttributes. These credentials are not stored by AWS OpsWorks CM; they are returned only as part of the result of createServer(). Attributes returned in a createServer response for Chef * CHEF_PIVOTAL_KEY
: A base64-encoded RSA private key that is generated by AWS OpsWorks for Chef Automate. This private key is required to access the Chef API. * CHEF_STARTER_KIT
: A base64-encoded ZIP file. The ZIP file contains a Chef starter kit, which includes a README, a configuration file, and the required RSA private key. Save this file, unzip it, and then change to the directory where you've unzipped the file contents. From this directory, you can run Knife commands. Attributes returned in a createServer response for Puppet * PUPPET_STARTER_KIT
: A base64-encoded ZIP file. The ZIP file contains a Puppet starter kit, including a README and a required private key. Save this file, unzip it, and then change to the directory where you've unzipped the file contents. * PUPPET_ADMIN_PASSWORD
: An administrator password that you can use to sign in to the Puppet Enterprise console after the server is online.
sPreferredMaintenanceWindow :: Lens' Server (Maybe Text) Source #
The preferred maintenance period specified for the server.
sPreferredBackupWindow :: Lens' Server (Maybe Text) Source #
The preferred backup period specified for the server.
sStatusReason :: Lens' Server (Maybe Text) Source #
Depending on the server status, this field has either a human-readable message (such as a create or backup error), or an escaped block of JSON (used for health check results).
sEndpoint :: Lens' Server (Maybe Text) Source #
A DNS name that can be used to access the engine. Example: myserver-asdfghjkl.us-east-1.opsworks.io
sCloudFormationStackARN :: Lens' Server (Maybe Text) Source #
The ARN of the CloudFormation stack that was used to create the server.
ServerEvent
data ServerEvent Source #
An event that is related to the server, such as the start of maintenance or backup.
See: serverEvent
smart constructor.
Instances
serverEvent :: ServerEvent Source #
Creates a value of ServerEvent
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
seLogURL
- The Amazon S3 URL of the event's log file.seServerName
- The name of the server on or for which the event occurred.seCreatedAt
- The time when the event occurred.seMessage
- A human-readable informational or status message.
seServerName :: Lens' ServerEvent (Maybe Text) Source #
The name of the server on or for which the event occurred.
seCreatedAt :: Lens' ServerEvent (Maybe UTCTime) Source #
The time when the event occurred.