| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.OpsWorksCM
Contents
- Service Configuration
- Errors
- Waiters
- Operations
- AssociateNode
- CreateBackup
- CreateServer
- DeleteBackup
- DeleteServer
- DescribeAccountAttributes
- DescribeBackups (Paginated)
- DescribeEvents (Paginated)
- DescribeNodeAssociationStatus
- DescribeServers (Paginated)
- DisassociateNode
- ExportServerEngineAttribute
- ListTagsForResource (Paginated)
- RestoreServer
- StartMaintenance
- TagResource
- UntagResource
- UpdateServer
- UpdateServerEngineAttributes
- Types
Description
Derived from API version 2016-11-01 of the AWS service descriptions, licensed under Apache 2.0.
AWS OpsWorks CM
AWS 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
ChefAutomateandPuppet. - 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.
Synopsis
- defaultService :: Service
- _InvalidNextTokenException :: AsError a => Fold a ServiceError
- _InvalidStateException :: AsError a => Fold a ServiceError
- _LimitExceededException :: AsError a => Fold a ServiceError
- _ResourceAlreadyExistsException :: AsError a => Fold a ServiceError
- _ResourceNotFoundException :: AsError a => Fold a ServiceError
- _ValidationException :: AsError a => Fold a ServiceError
- newNodeAssociated :: Wait DescribeNodeAssociationStatus
- data AssociateNode = AssociateNode' Text Text [EngineAttribute]
- newAssociateNode :: Text -> Text -> AssociateNode
- data AssociateNodeResponse = AssociateNodeResponse' (Maybe Text) Int
- newAssociateNodeResponse :: Int -> AssociateNodeResponse
- data CreateBackup = CreateBackup' (Maybe Text) (Maybe [Tag]) Text
- newCreateBackup :: Text -> CreateBackup
- data CreateBackupResponse = CreateBackupResponse' (Maybe Backup) Int
- newCreateBackupResponse :: Int -> CreateBackupResponse
- data CreateServer = CreateServer' (Maybe Bool) (Maybe Text) (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe (Sensitive Text)) (Maybe Bool) (Maybe [EngineAttribute]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe [Text]) (Maybe [Tag]) Text Text Text Text Text
- newCreateServer :: Text -> Text -> Text -> Text -> Text -> CreateServer
- data CreateServerResponse = CreateServerResponse' (Maybe Server) Int
- newCreateServerResponse :: Int -> CreateServerResponse
- data DeleteBackup = DeleteBackup' Text
- newDeleteBackup :: Text -> DeleteBackup
- data DeleteBackupResponse = DeleteBackupResponse' Int
- newDeleteBackupResponse :: Int -> DeleteBackupResponse
- data DeleteServer = DeleteServer' Text
- newDeleteServer :: Text -> DeleteServer
- data DeleteServerResponse = DeleteServerResponse' Int
- newDeleteServerResponse :: Int -> DeleteServerResponse
- data DescribeAccountAttributes = DescribeAccountAttributes' {
- newDescribeAccountAttributes :: DescribeAccountAttributes
- data DescribeAccountAttributesResponse = DescribeAccountAttributesResponse' (Maybe [AccountAttribute]) Int
- newDescribeAccountAttributesResponse :: Int -> DescribeAccountAttributesResponse
- data DescribeBackups = DescribeBackups' (Maybe Text) (Maybe Natural) (Maybe Text) (Maybe Text)
- newDescribeBackups :: DescribeBackups
- data DescribeBackupsResponse = DescribeBackupsResponse' (Maybe [Backup]) (Maybe Text) Int
- newDescribeBackupsResponse :: Int -> DescribeBackupsResponse
- data DescribeEvents = DescribeEvents' (Maybe Natural) (Maybe Text) Text
- newDescribeEvents :: Text -> DescribeEvents
- data DescribeEventsResponse = DescribeEventsResponse' (Maybe Text) (Maybe [ServerEvent]) Int
- newDescribeEventsResponse :: Int -> DescribeEventsResponse
- data DescribeNodeAssociationStatus = DescribeNodeAssociationStatus' Text Text
- newDescribeNodeAssociationStatus :: Text -> Text -> DescribeNodeAssociationStatus
- data DescribeNodeAssociationStatusResponse = DescribeNodeAssociationStatusResponse' (Maybe [EngineAttribute]) Int NodeAssociationStatus
- newDescribeNodeAssociationStatusResponse :: Int -> NodeAssociationStatus -> DescribeNodeAssociationStatusResponse
- data DescribeServers = DescribeServers' (Maybe Natural) (Maybe Text) (Maybe Text)
- newDescribeServers :: DescribeServers
- data DescribeServersResponse = DescribeServersResponse' (Maybe Text) (Maybe [Server]) Int
- newDescribeServersResponse :: Int -> DescribeServersResponse
- data DisassociateNode = DisassociateNode' (Maybe [EngineAttribute]) Text Text
- newDisassociateNode :: Text -> Text -> DisassociateNode
- data DisassociateNodeResponse = DisassociateNodeResponse' (Maybe Text) Int
- newDisassociateNodeResponse :: Int -> DisassociateNodeResponse
- data ExportServerEngineAttribute = ExportServerEngineAttribute' (Maybe [EngineAttribute]) Text Text
- newExportServerEngineAttribute :: Text -> Text -> ExportServerEngineAttribute
- data ExportServerEngineAttributeResponse = ExportServerEngineAttributeResponse' (Maybe EngineAttribute) (Maybe Text) Int
- newExportServerEngineAttributeResponse :: Int -> ExportServerEngineAttributeResponse
- data ListTagsForResource = ListTagsForResource' (Maybe Natural) (Maybe Text) Text
- newListTagsForResource :: Text -> ListTagsForResource
- data ListTagsForResourceResponse = ListTagsForResourceResponse' (Maybe Text) (Maybe [Tag]) Int
- newListTagsForResourceResponse :: Int -> ListTagsForResourceResponse
- data RestoreServer = RestoreServer' (Maybe Text) (Maybe Text) Text Text
- newRestoreServer :: Text -> Text -> RestoreServer
- data RestoreServerResponse = RestoreServerResponse' (Maybe Server) Int
- newRestoreServerResponse :: Int -> RestoreServerResponse
- data StartMaintenance = StartMaintenance' (Maybe [EngineAttribute]) Text
- newStartMaintenance :: Text -> StartMaintenance
- data StartMaintenanceResponse = StartMaintenanceResponse' (Maybe Server) Int
- newStartMaintenanceResponse :: Int -> StartMaintenanceResponse
- data TagResource = TagResource' Text [Tag]
- newTagResource :: Text -> TagResource
- data TagResourceResponse = TagResourceResponse' Int
- newTagResourceResponse :: Int -> TagResourceResponse
- data UntagResource = UntagResource' Text [Text]
- newUntagResource :: Text -> UntagResource
- data UntagResourceResponse = UntagResourceResponse' Int
- newUntagResourceResponse :: Int -> UntagResourceResponse
- data UpdateServer = UpdateServer' (Maybe Int) (Maybe Bool) (Maybe Text) (Maybe Text) Text
- newUpdateServer :: Text -> UpdateServer
- data UpdateServerResponse = UpdateServerResponse' (Maybe Server) Int
- newUpdateServerResponse :: Int -> UpdateServerResponse
- data UpdateServerEngineAttributes = UpdateServerEngineAttributes' (Maybe Text) Text Text
- newUpdateServerEngineAttributes :: Text -> Text -> UpdateServerEngineAttributes
- data UpdateServerEngineAttributesResponse = UpdateServerEngineAttributesResponse' (Maybe Server) Int
- newUpdateServerEngineAttributesResponse :: Int -> UpdateServerEngineAttributesResponse
- newtype BackupStatus where
- BackupStatus' { }
- pattern BackupStatus_DELETING :: BackupStatus
- pattern BackupStatus_FAILED :: BackupStatus
- pattern BackupStatus_IN_PROGRESS :: BackupStatus
- pattern BackupStatus_OK :: BackupStatus
- newtype BackupType where
- BackupType' { }
- pattern BackupType_AUTOMATED :: BackupType
- pattern BackupType_MANUAL :: BackupType
- newtype MaintenanceStatus where
- MaintenanceStatus' { }
- pattern MaintenanceStatus_FAILED :: MaintenanceStatus
- pattern MaintenanceStatus_SUCCESS :: MaintenanceStatus
- newtype NodeAssociationStatus where
- newtype ServerStatus where
- ServerStatus' { }
- pattern ServerStatus_BACKING_UP :: ServerStatus
- pattern ServerStatus_CONNECTION_LOST :: ServerStatus
- pattern ServerStatus_CREATING :: ServerStatus
- pattern ServerStatus_DELETING :: ServerStatus
- pattern ServerStatus_FAILED :: ServerStatus
- pattern ServerStatus_HEALTHY :: ServerStatus
- pattern ServerStatus_MODIFYING :: ServerStatus
- pattern ServerStatus_RESTORING :: ServerStatus
- pattern ServerStatus_RUNNING :: ServerStatus
- pattern ServerStatus_SETUP :: ServerStatus
- pattern ServerStatus_TERMINATED :: ServerStatus
- pattern ServerStatus_UNDER_MAINTENANCE :: ServerStatus
- pattern ServerStatus_UNHEALTHY :: ServerStatus
- data AccountAttribute = AccountAttribute' (Maybe Int) (Maybe Text) (Maybe Int)
- newAccountAttribute :: AccountAttribute
- data Backup = Backup' (Maybe Text) (Maybe Text) (Maybe BackupType) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe BackupStatus) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Text)
- newBackup :: Backup
- data EngineAttribute = EngineAttribute' (Maybe Text) (Maybe (Sensitive Text))
- newEngineAttribute :: EngineAttribute
- data Server = Server' (Maybe Bool) (Maybe Int) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe [EngineAttribute]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe MaintenanceStatus) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe ServerStatus) (Maybe Text) (Maybe [Text])
- newServer :: Server
- data ServerEvent = ServerEvent' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text)
- newServerEvent :: ServerEvent
- data Tag = Tag' Text Text
- newTag :: Text -> Text -> Tag
Service Configuration
defaultService :: Service Source #
API version 2016-11-01 of the Amazon OpsWorks CM 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.
InvalidNextTokenException
_InvalidNextTokenException :: AsError a => Fold a ServiceError Source #
This occurs when the provided nextToken is not valid.
InvalidStateException
_InvalidStateException :: AsError a => Fold a ServiceError Source #
The resource is in a state that does not allow you to perform a specified action.
LimitExceededException
_LimitExceededException :: AsError a => Fold a ServiceError Source #
The limit of servers or backups has been reached.
ResourceAlreadyExistsException
_ResourceAlreadyExistsException :: AsError a => Fold a ServiceError Source #
The requested resource cannot be created because it already exists.
ResourceNotFoundException
_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #
The requested resource does not exist, or access was denied.
ValidationException
_ValidationException :: AsError a => Fold a ServiceError Source #
One or more of the provided request parameters are not valid.
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
newNodeAssociated :: 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
data AssociateNode Source #
See: newAssociateNode smart constructor.
Constructors
| AssociateNode' Text Text [EngineAttribute] |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> AssociateNode |
Create a value of AssociateNode with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
AssociateNode, associateNode_serverName - The name of the server with which to associate the node.
$sel:nodeName:AssociateNode', associateNode_nodeName - The name of the node.
AssociateNode, associateNode_engineAttributes - Engine attributes used for associating the node.
Attributes accepted in a AssociateNode request for Chef
CHEF_ORGANIZATION: The Chef organization with which the node is associated. By default only one organization nameddefaultcan exist.CHEF_NODE_PUBLIC_KEY: A PEM-formatted public key. This key is required for thechef-clientagent to access the Chef API.
Attributes accepted in a AssociateNode request for Puppet
PUPPET_NODE_CSR: A PEM-formatted certificate-signing request (CSR) that is created by the node.
data AssociateNodeResponse Source #
See: newAssociateNodeResponse smart constructor.
Constructors
| AssociateNodeResponse' (Maybe Text) Int |
Instances
newAssociateNodeResponse Source #
Create a value of AssociateNodeResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nodeAssociationStatusToken:AssociateNodeResponse', associateNodeResponse_nodeAssociationStatusToken - Contains a token which can be passed to the
DescribeNodeAssociationStatus API call to get the status of the
association request.
$sel:httpStatus:AssociateNodeResponse', associateNodeResponse_httpStatus - The response's http status code.
CreateBackup
data CreateBackup Source #
See: newCreateBackup smart constructor.
Instances
Arguments
| :: Text | |
| -> CreateBackup |
Create a value of CreateBackup with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateBackup, createBackup_description - A user-defined description of the backup.
$sel:tags:CreateBackup', createBackup_tags - A map that contains tag keys and tag values to attach to an AWS
OpsWorks-CM server backup.
- The key cannot be empty.
- The key can be a maximum of 127 characters, and can contain only
Unicode letters, numbers, or separators, or the following special
characters:
+ - = . _ : / - The value can be a maximum 255 characters, and contain only Unicode
letters, numbers, or separators, or the following special
characters:
+ - = . _ : / - Leading and trailing white spaces are trimmed from both the key and value.
- A maximum of 50 user-applied tags is allowed for tag-supported AWS OpsWorks-CM resources.
CreateBackup, createBackup_serverName - The name of the server that you want to back up.
data CreateBackupResponse Source #
See: newCreateBackupResponse smart constructor.
Constructors
| CreateBackupResponse' (Maybe Backup) Int |
Instances
newCreateBackupResponse Source #
Arguments
| :: Int | |
| -> CreateBackupResponse |
Create a value of CreateBackupResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:backup:CreateBackupResponse', createBackupResponse_backup - Backup created by request.
$sel:httpStatus:CreateBackupResponse', createBackupResponse_httpStatus - The response's http status code.
CreateServer
data CreateServer Source #
See: newCreateServer smart constructor.
Constructors
| CreateServer' (Maybe Bool) (Maybe Text) (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe (Sensitive Text)) (Maybe Bool) (Maybe [EngineAttribute]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe [Text]) (Maybe [Tag]) Text Text Text Text Text |
Instances
Create a value of CreateServer with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateServer, createServer_associatePublicIpAddress - Associate a public IP address with a server that you are launching.
Valid values are true or false. The default value is true.
CreateServer, createServer_backupId - If you specify this field, AWS OpsWorks CM creates the server by using
the backup represented by BackupId.
CreateServer, createServer_backupRetentionCount - The number of automated backups that you want to keep. Whenever a new
backup is created, AWS OpsWorks CM deletes the oldest backups if this
number is exceeded. The default value is 1.
$sel:customCertificate:CreateServer', createServer_customCertificate - A PEM-formatted HTTPS certificate. The value can be be a single,
self-signed certificate, or a certificate chain. If you specify a custom
certificate, you must also specify values for CustomDomain and
CustomPrivateKey. The following are requirements for the
CustomCertificate value:
- You can provide either a self-signed, custom certificate, or the full certificate chain.
- The certificate must be a valid X509 certificate, or a certificate chain in PEM format.
- The certificate must be valid at the time of upload. A certificate
can't be used before its validity period begins (the certificate's
NotBeforedate), or after it expires (the certificate'sNotAfterdate). - The certificate’s common name or subject alternative names (SANs),
if present, must match the value of
CustomDomain. - The certificate must match the value of
CustomPrivateKey.
CreateServer, createServer_customDomain - An optional public endpoint of a server, such as
https://aws.my-company.com. To access the server, create a CNAME DNS
record in your preferred DNS service that points the custom domain to
the endpoint that is generated when the server is created (the value of
the CreateServer Endpoint attribute). You cannot access the server by
using the generated Endpoint value if the server is using a custom
domain. If you specify a custom domain, you must also specify values for
CustomCertificate and CustomPrivateKey.
$sel:customPrivateKey:CreateServer', createServer_customPrivateKey - A private key in PEM format for connecting to the server by using HTTPS.
The private key must not be encrypted; it cannot be protected by a
password or passphrase. If you specify a custom private key, you must
also specify values for CustomDomain and CustomCertificate.
CreateServer, createServer_disableAutomatedBackup - Enable or disable scheduled backups. Valid values are true or false.
The default value is true.
CreateServer, createServer_engineAttributes - Optional engine attributes on a specified server.
Attributes accepted in a Chef createServer request:
CHEF_AUTOMATE_PIVOTAL_KEY: A base64-encoded RSA public key. The corresponding private key is required to access the Chef API. When no CHEF_AUTOMATE_PIVOTAL_KEY is set, a private key is generated and returned in the response.CHEF_AUTOMATE_ADMIN_PASSWORD: The password for the administrative user in the Chef Automate web-based dashboard. The password length is a minimum of eight characters, and a maximum of 32. The password can contain letters, numbers, and special characters (!/@#$%^&+=_). The password must contain at least one lower case letter, one upper case letter, one number, and one special character. When no CHEF_AUTOMATE_ADMIN_PASSWORD is set, one is generated and returned in the response.
Attributes accepted in a Puppet createServer request:
PUPPET_ADMIN_PASSWORD: To work with the Puppet Enterprise console, a password must use ASCII characters.PUPPET_R10K_REMOTE: The r10k remote is the URL of your control repository (for example, ssh://git@your.git-repo.com:user/control-repo.git). Specifying an r10k remote opens TCP port 8170.PUPPET_R10K_PRIVATE_KEY: If you are using a private Git repository, add PUPPET_R10K_PRIVATE_KEY to specify a PEM-encoded private SSH key.
CreateServer, createServer_engineModel - The engine model of the server. Valid values in this release include
Monolithic for Puppet and Single for Chef.
CreateServer, createServer_engineVersion - The major release version of the engine that you want to use. For a Chef
server, the valid value for EngineVersion is currently 2. For a Puppet
server, valid values are 2019 or 2017.
CreateServer, createServer_keyPair - The Amazon EC2 key pair to set for the instance. This parameter is
optional; if desired, you may specify this parameter to connect to your
instances by using SSH.
CreateServer, createServer_preferredBackupWindow - The start time for a one-hour period during which AWS OpsWorks CM backs
up application-level data on your server if automated backups are
enabled. Valid values must be specified in one of the following formats:
HH:MMfor daily backupsDDD:HH:MMfor weekly backups
MM must be specified as 00. The specified time is in coordinated
universal time (UTC). The default value is a random, daily start time.
Example: 08:00, which represents a daily start time of 08:00 UTC.
Example: Mon:08:00, which represents a start time of every Monday
at 08:00 UTC. (8:00 a.m.)
CreateServer, createServer_preferredMaintenanceWindow - The start time for a one-hour period each week during which AWS OpsWorks
CM performs maintenance on the instance. Valid values must be specified
in the following format: DDD:HH:MM. MM must be specified as 00.
The specified time is in coordinated universal time (UTC). The default
value is a random one-hour period on Tuesday, Wednesday, or Friday. See
TimeWindowDefinition for more information.
Example: Mon:08:00, which represents a start time of every Monday
at 08:00 UTC. (8:00 a.m.)
CreateServer, createServer_securityGroupIds - A list of security group IDs to attach to the Amazon EC2 instance. If
you add this parameter, the specified security groups must be within the
VPC that is specified by SubnetIds.
If you do not specify this parameter, AWS OpsWorks CM creates one new security group that uses TCP ports 22 and 443, open to 0.0.0.0/0 (everyone).
CreateServer, createServer_subnetIds - The IDs of subnets in which to launch the server EC2 instance.
Amazon EC2-Classic customers: This field is required. All servers must run within a VPC. The VPC must have "Auto Assign Public IP" enabled.
EC2-VPC customers: This field is optional. If you do not specify subnet IDs, your EC2 instances are created in a default subnet that is selected by Amazon EC2. If you specify subnet IDs, the VPC must have "Auto Assign Public IP" enabled.
For more information about supported Amazon EC2 platforms, see Supported Platforms.
$sel:tags:CreateServer', createServer_tags - A map that contains tag keys and tag values to attach to an AWS OpsWorks
for Chef Automate or AWS OpsWorks for Puppet Enterprise server.
- The key cannot be empty.
- The key can be a maximum of 127 characters, and can contain only
Unicode letters, numbers, or separators, or the following special
characters:
+ - = . _ : / @ - The value can be a maximum 255 characters, and contain only Unicode
letters, numbers, or separators, or the following special
characters:
+ - = . _ : / @ - Leading and trailing white spaces are trimmed from both the key and value.
- A maximum of 50 user-applied tags is allowed for any AWS OpsWorks-CM server.
CreateServer, createServer_engine - The configuration management engine to use. Valid values include
ChefAutomate and Puppet.
CreateServer, createServer_serverName - The name of the server. The server name must be unique within your AWS
account, within each region. Server names must start with a letter; then
letters, numbers, or hyphens (-) are allowed, up to a maximum of 40
characters.
CreateServer, createServer_instanceProfileArn - The ARN of the instance profile that your Amazon EC2 instances use.
Although the AWS OpsWorks console typically creates the instance profile
for you, if you are using API commands instead, run the
service-role-creation.yaml AWS CloudFormation template, located at
https://s3.amazonaws.com/opsworks-cm-us-east-1-prod-default-assets/misc/opsworks-cm-roles.yaml.
This template creates a CloudFormation stack that includes the instance
profile you need.
CreateServer, createServer_instanceType - The Amazon EC2 instance type to use. For example, m5.large.
CreateServer, createServer_serviceRoleArn - The service role that the AWS OpsWorks CM service backend uses to work
with your account. Although the AWS OpsWorks management console
typically creates the service role for you, if you are using the AWS CLI
or API commands, run the service-role-creation.yaml AWS CloudFormation
template, located at
https://s3.amazonaws.com/opsworks-cm-us-east-1-prod-default-assets/misc/opsworks-cm-roles.yaml.
This template creates a CloudFormation stack that includes the service
role and instance profile that you need.
data CreateServerResponse Source #
See: newCreateServerResponse smart constructor.
Constructors
| CreateServerResponse' (Maybe Server) Int |
Instances
newCreateServerResponse Source #
Arguments
| :: Int | |
| -> CreateServerResponse |
Create a value of CreateServerResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:server:CreateServerResponse', createServerResponse_server - The server that is created by the request.
$sel:httpStatus:CreateServerResponse', createServerResponse_httpStatus - The response's http status code.
DeleteBackup
data DeleteBackup Source #
See: newDeleteBackup smart constructor.
Constructors
| DeleteBackup' Text |
Instances
Arguments
| :: Text | |
| -> DeleteBackup |
Create a value of DeleteBackup with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteBackup, deleteBackup_backupId - The ID of the backup to delete. Run the DescribeBackups command to get a
list of backup IDs. Backup IDs are in the format
ServerName-yyyyMMddHHmmssSSS.
data DeleteBackupResponse Source #
See: newDeleteBackupResponse smart constructor.
Constructors
| DeleteBackupResponse' Int |
Instances
newDeleteBackupResponse Source #
Arguments
| :: Int | |
| -> DeleteBackupResponse |
Create a value of DeleteBackupResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteBackupResponse', deleteBackupResponse_httpStatus - The response's http status code.
DeleteServer
data DeleteServer Source #
See: newDeleteServer smart constructor.
Constructors
| DeleteServer' Text |
Instances
Arguments
| :: Text | |
| -> DeleteServer |
Create a value of DeleteServer with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteServer, deleteServer_serverName - The ID of the server to delete.
data DeleteServerResponse Source #
See: newDeleteServerResponse smart constructor.
Constructors
| DeleteServerResponse' Int |
Instances
newDeleteServerResponse Source #
Arguments
| :: Int | |
| -> DeleteServerResponse |
Create a value of DeleteServerResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteServerResponse', deleteServerResponse_httpStatus - The response's http status code.
DescribeAccountAttributes
data DescribeAccountAttributes Source #
See: newDescribeAccountAttributes smart constructor.
Constructors
| DescribeAccountAttributes' | |
Instances
newDescribeAccountAttributes :: DescribeAccountAttributes Source #
Create a value of DescribeAccountAttributes with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
data DescribeAccountAttributesResponse Source #
See: newDescribeAccountAttributesResponse smart constructor.
Constructors
| DescribeAccountAttributesResponse' (Maybe [AccountAttribute]) Int |
Instances
newDescribeAccountAttributesResponse Source #
Arguments
| :: Int | |
| -> DescribeAccountAttributesResponse |
Create a value of DescribeAccountAttributesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:attributes:DescribeAccountAttributesResponse', describeAccountAttributesResponse_attributes - The attributes that are currently set for the account.
$sel:httpStatus:DescribeAccountAttributesResponse', describeAccountAttributesResponse_httpStatus - The response's http status code.
DescribeBackups (Paginated)
data DescribeBackups Source #
See: newDescribeBackups smart constructor.
Instances
newDescribeBackups :: DescribeBackups Source #
Create a value of DescribeBackups with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeBackups, describeBackups_backupId - Describes a single backup.
$sel:maxResults:DescribeBackups', describeBackups_maxResults - This is not currently implemented for DescribeBackups requests.
DescribeBackups, describeBackups_nextToken - This is not currently implemented for DescribeBackups requests.
DescribeBackups, describeBackups_serverName - Returns backups for the server with the specified ServerName.
data DescribeBackupsResponse Source #
See: newDescribeBackupsResponse smart constructor.
Instances
newDescribeBackupsResponse Source #
Create a value of DescribeBackupsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:backups:DescribeBackupsResponse', describeBackupsResponse_backups - Contains the response to a DescribeBackups request.
DescribeBackups, describeBackupsResponse_nextToken - This is not currently implemented for DescribeBackups requests.
$sel:httpStatus:DescribeBackupsResponse', describeBackupsResponse_httpStatus - The response's http status code.
DescribeEvents (Paginated)
data DescribeEvents Source #
See: newDescribeEvents smart constructor.
Instances
Arguments
| :: Text | |
| -> DescribeEvents |
Create a value of DescribeEvents with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:DescribeEvents', describeEvents_maxResults - To receive a paginated response, use this parameter to specify the
maximum number of results to be returned with a single call. If the
number of available results exceeds this maximum, the response includes
a NextToken value that you can assign to the NextToken request
parameter to get the next set of results.
DescribeEvents, describeEvents_nextToken - NextToken is a string that is returned in some command responses. It
indicates that not all entries have been returned, and that you must run
at least one more request to get remaining items. To get remaining
results, call DescribeEvents again, and assign the token from the
previous results as the value of the nextToken parameter. If there are
no more results, the response object's nextToken parameter value is
null. Setting a nextToken value that was not returned in your
previous results causes an InvalidNextTokenException to occur.
DescribeEvents, describeEvents_serverName - The name of the server for which you want to view events.
data DescribeEventsResponse Source #
See: newDescribeEventsResponse smart constructor.
Constructors
| DescribeEventsResponse' (Maybe Text) (Maybe [ServerEvent]) Int |
Instances
newDescribeEventsResponse Source #
Create a value of DescribeEventsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeEvents, describeEventsResponse_nextToken - NextToken is a string that is returned in some command responses. It
indicates that not all entries have been returned, and that you must run
at least one more request to get remaining items. To get remaining
results, call DescribeEvents again, and assign the token from the
previous results as the value of the nextToken parameter. If there are
no more results, the response object's nextToken parameter value is
null. Setting a nextToken value that was not returned in your
previous results causes an InvalidNextTokenException to occur.
$sel:serverEvents:DescribeEventsResponse', describeEventsResponse_serverEvents - Contains the response to a DescribeEvents request.
$sel:httpStatus:DescribeEventsResponse', describeEventsResponse_httpStatus - The response's http status code.
DescribeNodeAssociationStatus
data DescribeNodeAssociationStatus Source #
See: newDescribeNodeAssociationStatus smart constructor.
Constructors
| DescribeNodeAssociationStatus' Text Text |
Instances
newDescribeNodeAssociationStatus Source #
Arguments
| :: Text |
|
| -> Text | |
| -> DescribeNodeAssociationStatus |
Create a value of DescribeNodeAssociationStatus with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nodeAssociationStatusToken:DescribeNodeAssociationStatus', describeNodeAssociationStatus_nodeAssociationStatusToken - The token returned in either the AssociateNodeResponse or the
DisassociateNodeResponse.
DescribeNodeAssociationStatus, describeNodeAssociationStatus_serverName - The name of the server from which to disassociate the node.
data DescribeNodeAssociationStatusResponse Source #
See: newDescribeNodeAssociationStatusResponse smart constructor.
Constructors
| DescribeNodeAssociationStatusResponse' (Maybe [EngineAttribute]) Int NodeAssociationStatus |
Instances
newDescribeNodeAssociationStatusResponse Source #
Arguments
| :: Int | |
| -> NodeAssociationStatus |
|
| -> DescribeNodeAssociationStatusResponse |
Create a value of DescribeNodeAssociationStatusResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeNodeAssociationStatusResponse, describeNodeAssociationStatusResponse_engineAttributes - Attributes specific to the node association. In Puppet, the attibute
PUPPET_NODE_CERT contains the signed certificate (the result of the
CSR).
$sel:httpStatus:DescribeNodeAssociationStatusResponse', describeNodeAssociationStatusResponse_httpStatus - The response's http status code.
$sel:nodeAssociationStatus:DescribeNodeAssociationStatusResponse', describeNodeAssociationStatusResponse_nodeAssociationStatus - 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.
DescribeServers (Paginated)
data DescribeServers Source #
See: newDescribeServers smart constructor.
Instances
newDescribeServers :: DescribeServers Source #
Create a value of DescribeServers with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:DescribeServers', describeServers_maxResults - This is not currently implemented for DescribeServers requests.
DescribeServers, describeServers_nextToken - This is not currently implemented for DescribeServers requests.
DescribeServers, describeServers_serverName - Describes the server with the specified ServerName.
data DescribeServersResponse Source #
See: newDescribeServersResponse smart constructor.
Instances
newDescribeServersResponse Source #
Create a value of DescribeServersResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeServers, describeServersResponse_nextToken - This is not currently implemented for DescribeServers requests.
$sel:servers:DescribeServersResponse', describeServersResponse_servers - Contains the response to a DescribeServers request.
For Chef Automate servers: If
DescribeServersResponse$Servers$EngineAttributes includes
CHEF_MAJOR_UPGRADE_AVAILABLE, you can upgrade the Chef Automate server
to Chef Automate 2. To be eligible for upgrade, a server running Chef
Automate 1 must have had at least one successful maintenance run after
November 1, 2019.
For Puppet servers: DescribeServersResponse$Servers$EngineAttributes
contains the following two responses:
PUPPET_API_CA_CERT, the PEM-encoded CA certificate that is used by the Puppet API over TCP port number 8140. The CA certificate is also used to sign node certificates.PUPPET_API_CRL, a certificate revocation list. The certificate revocation list is for internal maintenance purposes only. For more information about the Puppet certificate revocation list, see Man Page: puppet certificate_revocation_list in the Puppet documentation.
$sel:httpStatus:DescribeServersResponse', describeServersResponse_httpStatus - The response's http status code.
DisassociateNode
data DisassociateNode Source #
See: newDisassociateNode smart constructor.
Constructors
| DisassociateNode' (Maybe [EngineAttribute]) Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> DisassociateNode |
Create a value of DisassociateNode with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DisassociateNode, disassociateNode_engineAttributes - Engine attributes that are used for disassociating the node. No
attributes are required for Puppet.
Attributes required in a DisassociateNode request for Chef
CHEF_ORGANIZATION: The Chef organization with which the node was associated. By default only one organization nameddefaultcan exist.
DisassociateNode, disassociateNode_serverName - The name of the server from which to disassociate the node.
$sel:nodeName:DisassociateNode', disassociateNode_nodeName - The name of the client node.
data DisassociateNodeResponse Source #
See: newDisassociateNodeResponse smart constructor.
Constructors
| DisassociateNodeResponse' (Maybe Text) Int |
Instances
newDisassociateNodeResponse Source #
Create a value of DisassociateNodeResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nodeAssociationStatusToken:DisassociateNodeResponse', disassociateNodeResponse_nodeAssociationStatusToken - Contains a token which can be passed to the
DescribeNodeAssociationStatus API call to get the status of the
disassociation request.
$sel:httpStatus:DisassociateNodeResponse', disassociateNodeResponse_httpStatus - The response's http status code.
ExportServerEngineAttribute
data ExportServerEngineAttribute Source #
See: newExportServerEngineAttribute smart constructor.
Constructors
| ExportServerEngineAttribute' (Maybe [EngineAttribute]) Text Text |
Instances
newExportServerEngineAttribute Source #
Arguments
| :: Text | |
| -> Text | |
| -> ExportServerEngineAttribute |
Create a value of ExportServerEngineAttribute with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:inputAttributes:ExportServerEngineAttribute', exportServerEngineAttribute_inputAttributes - The list of engine attributes. The list type is EngineAttribute. An
EngineAttribute list item is a pair that includes an attribute name
and its value. For the Userdata ExportAttributeName, the following are
supported engine attribute names.
- RunList In Chef, a list of roles or recipes that are run in the specified order. In Puppet, this parameter is ignored.
- OrganizationName In Chef, an organization name. AWS OpsWorks for
Chef Automate always creates the organization
default. In Puppet, this parameter is ignored. - NodeEnvironment In Chef, a node environment (for example, development, staging, or one-box). In Puppet, this parameter is ignored.
- NodeClientVersion In Chef, the version of the Chef engine (three numbers separated by dots, such as 13.8.5). If this attribute is empty, OpsWorks for Chef Automate uses the most current version. In Puppet, this parameter is ignored.
$sel:exportAttributeName:ExportServerEngineAttribute', exportServerEngineAttribute_exportAttributeName - The name of the export attribute. Currently, the supported export
attribute is Userdata. This exports a user data script that includes
parameters and values provided in the InputAttributes list.
ExportServerEngineAttribute, exportServerEngineAttribute_serverName - The name of the server from which you are exporting the attribute.
data ExportServerEngineAttributeResponse Source #
See: newExportServerEngineAttributeResponse smart constructor.
Constructors
| ExportServerEngineAttributeResponse' (Maybe EngineAttribute) (Maybe Text) Int |
Instances
newExportServerEngineAttributeResponse Source #
Arguments
| :: Int | |
| -> ExportServerEngineAttributeResponse |
Create a value of ExportServerEngineAttributeResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:engineAttribute:ExportServerEngineAttributeResponse', exportServerEngineAttributeResponse_engineAttribute - The requested engine attribute pair with attribute name and value.
ExportServerEngineAttribute, exportServerEngineAttributeResponse_serverName - The server name used in the request.
$sel:httpStatus:ExportServerEngineAttributeResponse', exportServerEngineAttributeResponse_httpStatus - The response's http status code.
ListTagsForResource (Paginated)
data ListTagsForResource Source #
See: newListTagsForResource smart constructor.
Instances
newListTagsForResource Source #
Arguments
| :: Text | |
| -> ListTagsForResource |
Create a value of ListTagsForResource with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListTagsForResource', listTagsForResource_maxResults - To receive a paginated response, use this parameter to specify the
maximum number of results to be returned with a single call. If the
number of available results exceeds this maximum, the response includes
a NextToken value that you can assign to the NextToken request
parameter to get the next set of results.
ListTagsForResource, listTagsForResource_nextToken - NextToken is a string that is returned in some command responses. It
indicates that not all entries have been returned, and that you must run
at least one more request to get remaining items. To get remaining
results, call ListTagsForResource again, and assign the token from the
previous results as the value of the nextToken parameter. If there are
no more results, the response object's nextToken parameter value is
null. Setting a nextToken value that was not returned in your
previous results causes an InvalidNextTokenException to occur.
$sel:resourceArn:ListTagsForResource', listTagsForResource_resourceArn - The Amazon Resource Number (ARN) of an AWS OpsWorks for Chef Automate or
AWS OpsWorks for Puppet Enterprise server for which you want to show
applied tags. For example,
arn:aws:opsworks-cm:us-west-2:123456789012:server/test-owcm-server/EXAMPLE-66b0-4196-8274-d1a2bEXAMPLE.
data ListTagsForResourceResponse Source #
See: newListTagsForResourceResponse smart constructor.
Instances
newListTagsForResourceResponse Source #
Create a value of ListTagsForResourceResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListTagsForResource, listTagsForResourceResponse_nextToken - A token that you can use as the value of NextToken in subsequent calls
to the API to show more results.
$sel:tags:ListTagsForResourceResponse', listTagsForResourceResponse_tags - Tags that have been applied to the resource.
$sel:httpStatus:ListTagsForResourceResponse', listTagsForResourceResponse_httpStatus - The response's http status code.
RestoreServer
data RestoreServer Source #
See: newRestoreServer smart constructor.
Instances
Arguments
| :: Text | |
| -> Text | |
| -> RestoreServer |
Create a value of RestoreServer with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
RestoreServer, restoreServer_instanceType - The type of instance to restore. Valid values must be specified in the
following format: ^([cm][34]|t2).* For example, m5.large. Valid
values are m5.large, r5.xlarge, and r5.2xlarge. If you do not
specify this parameter, RestoreServer uses the instance type from the
specified backup.
RestoreServer, restoreServer_keyPair - The name of the key pair to set on the new EC2 instance. This can be
helpful if the administrator no longer has the SSH key.
RestoreServer, restoreServer_backupId - The ID of the backup that you want to use to restore a server.
RestoreServer, restoreServer_serverName - The name of the server that you want to restore.
data RestoreServerResponse Source #
See: newRestoreServerResponse smart constructor.
Constructors
| RestoreServerResponse' (Maybe Server) Int |
Instances
newRestoreServerResponse Source #
Create a value of RestoreServerResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:server:RestoreServerResponse', restoreServerResponse_server - Undocumented member.
$sel:httpStatus:RestoreServerResponse', restoreServerResponse_httpStatus - The response's http status code.
StartMaintenance
data StartMaintenance Source #
See: newStartMaintenance smart constructor.
Constructors
| StartMaintenance' (Maybe [EngineAttribute]) Text |
Instances
Arguments
| :: Text | |
| -> StartMaintenance |
Create a value of StartMaintenance with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
StartMaintenance, startMaintenance_engineAttributes - Engine attributes that are specific to the server on which you want to
run maintenance.
Attributes accepted in a StartMaintenance request for Chef
CHEF_MAJOR_UPGRADE: If a Chef Automate server is eligible for upgrade to Chef Automate 2, add this engine attribute to aStartMaintenancerequest and set the value totrueto upgrade the server to Chef Automate 2. For more information, see Upgrade an AWS OpsWorks for Chef Automate Server to Chef Automate 2.
StartMaintenance, startMaintenance_serverName - The name of the server on which to run maintenance.
data StartMaintenanceResponse Source #
See: newStartMaintenanceResponse smart constructor.
Constructors
| StartMaintenanceResponse' (Maybe Server) Int |
Instances
newStartMaintenanceResponse Source #
Create a value of StartMaintenanceResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:server:StartMaintenanceResponse', startMaintenanceResponse_server - Contains the response to a StartMaintenance request.
$sel:httpStatus:StartMaintenanceResponse', startMaintenanceResponse_httpStatus - The response's http status code.
TagResource
data TagResource Source #
See: newTagResource smart constructor.
Constructors
| TagResource' Text [Tag] |
Instances
Arguments
| :: Text | |
| -> TagResource |
Create a value of TagResource with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceArn:TagResource', tagResource_resourceArn - The Amazon Resource Number (ARN) of a resource to which you want to
apply tags. For example,
arn:aws:opsworks-cm:us-west-2:123456789012:server/test-owcm-server/EXAMPLE-66b0-4196-8274-d1a2bEXAMPLE.
$sel:tags:TagResource', tagResource_tags - A map that contains tag keys and tag values to attach to AWS OpsWorks-CM
servers or backups.
- The key cannot be empty.
- The key can be a maximum of 127 characters, and can contain only
Unicode letters, numbers, or separators, or the following special
characters:
+ - = . _ : / - The value can be a maximum 255 characters, and contain only Unicode
letters, numbers, or separators, or the following special
characters:
+ - = . _ : / - Leading and trailing white spaces are trimmed from both the key and value.
- A maximum of 50 user-applied tags is allowed for any AWS OpsWorks-CM server or backup.
data TagResourceResponse Source #
See: newTagResourceResponse smart constructor.
Constructors
| TagResourceResponse' Int |
Instances
newTagResourceResponse Source #
Arguments
| :: Int | |
| -> TagResourceResponse |
Create a value of TagResourceResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:TagResourceResponse', tagResourceResponse_httpStatus - The response's http status code.
UntagResource
data UntagResource Source #
See: newUntagResource smart constructor.
Constructors
| UntagResource' Text [Text] |
Instances
Arguments
| :: Text | |
| -> UntagResource |
Create a value of UntagResource with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceArn:UntagResource', untagResource_resourceArn - The Amazon Resource Number (ARN) of a resource from which you want to
remove tags. For example,
arn:aws:opsworks-cm:us-west-2:123456789012:server/test-owcm-server/EXAMPLE-66b0-4196-8274-d1a2bEXAMPLE.
$sel:tagKeys:UntagResource', untagResource_tagKeys - The keys of tags that you want to remove.
data UntagResourceResponse Source #
See: newUntagResourceResponse smart constructor.
Constructors
| UntagResourceResponse' Int |
Instances
newUntagResourceResponse Source #
Create a value of UntagResourceResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UntagResourceResponse', untagResourceResponse_httpStatus - The response's http status code.
UpdateServer
data UpdateServer Source #
See: newUpdateServer smart constructor.
Instances
Arguments
| :: Text | |
| -> UpdateServer |
Create a value of UpdateServer with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateServer, updateServer_backupRetentionCount - Sets the number of automated backups that you want to keep.
UpdateServer, updateServer_disableAutomatedBackup - Setting DisableAutomatedBackup to true disables automated or scheduled
backups. Automated backups are enabled by default.
UpdateServer, updateServer_preferredBackupWindow - Undocumented member.
UpdateServer, updateServer_preferredMaintenanceWindow - Undocumented member.
UpdateServer, updateServer_serverName - The name of the server to update.
data UpdateServerResponse Source #
See: newUpdateServerResponse smart constructor.
Constructors
| UpdateServerResponse' (Maybe Server) Int |
Instances
newUpdateServerResponse Source #
Arguments
| :: Int | |
| -> UpdateServerResponse |
Create a value of UpdateServerResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:server:UpdateServerResponse', updateServerResponse_server - Contains the response to a UpdateServer request.
$sel:httpStatus:UpdateServerResponse', updateServerResponse_httpStatus - The response's http status code.
UpdateServerEngineAttributes
data UpdateServerEngineAttributes Source #
See: newUpdateServerEngineAttributes smart constructor.
Constructors
| UpdateServerEngineAttributes' (Maybe Text) Text Text |
Instances
newUpdateServerEngineAttributes Source #
Arguments
| :: Text | |
| -> Text | |
| -> UpdateServerEngineAttributes |
Create a value of UpdateServerEngineAttributes with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:attributeValue:UpdateServerEngineAttributes', updateServerEngineAttributes_attributeValue - The value to set for the attribute.
UpdateServerEngineAttributes, updateServerEngineAttributes_serverName - The name of the server to update.
$sel:attributeName:UpdateServerEngineAttributes', updateServerEngineAttributes_attributeName - The name of the engine attribute to update.
data UpdateServerEngineAttributesResponse Source #
See: newUpdateServerEngineAttributesResponse smart constructor.
Constructors
| UpdateServerEngineAttributesResponse' (Maybe Server) Int |
Instances
newUpdateServerEngineAttributesResponse Source #
Arguments
| :: Int | |
| -> UpdateServerEngineAttributesResponse |
Create a value of UpdateServerEngineAttributesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:server:UpdateServerEngineAttributesResponse', updateServerEngineAttributesResponse_server - Contains the response to an UpdateServerEngineAttributes request.
$sel:httpStatus:UpdateServerEngineAttributesResponse', updateServerEngineAttributesResponse_httpStatus - The response's http status code.
Types
BackupStatus
newtype BackupStatus Source #
Constructors
| BackupStatus' | |
Fields | |
Bundled Patterns
| pattern BackupStatus_DELETING :: BackupStatus | |
| pattern BackupStatus_FAILED :: BackupStatus | |
| pattern BackupStatus_IN_PROGRESS :: BackupStatus | |
| pattern BackupStatus_OK :: BackupStatus |
Instances
BackupType
newtype BackupType Source #
Constructors
| BackupType' | |
Fields | |
Bundled Patterns
| pattern BackupType_AUTOMATED :: BackupType | |
| pattern BackupType_MANUAL :: BackupType |
Instances
MaintenanceStatus
newtype MaintenanceStatus Source #
Constructors
| MaintenanceStatus' | |
Fields | |
Bundled Patterns
| pattern MaintenanceStatus_FAILED :: MaintenanceStatus | |
| pattern MaintenanceStatus_SUCCESS :: MaintenanceStatus |
Instances
NodeAssociationStatus
newtype 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.
Constructors
| NodeAssociationStatus' | |
Fields | |
Bundled Patterns
| pattern NodeAssociationStatus_FAILED :: NodeAssociationStatus | |
| pattern NodeAssociationStatus_IN_PROGRESS :: NodeAssociationStatus | |
| pattern NodeAssociationStatus_SUCCESS :: NodeAssociationStatus |
Instances
ServerStatus
newtype ServerStatus Source #
Constructors
| ServerStatus' | |
Fields | |
Bundled Patterns
| pattern ServerStatus_BACKING_UP :: ServerStatus | |
| pattern ServerStatus_CONNECTION_LOST :: ServerStatus | |
| pattern ServerStatus_CREATING :: ServerStatus | |
| pattern ServerStatus_DELETING :: ServerStatus | |
| pattern ServerStatus_FAILED :: ServerStatus | |
| pattern ServerStatus_HEALTHY :: ServerStatus | |
| pattern ServerStatus_MODIFYING :: ServerStatus | |
| pattern ServerStatus_RESTORING :: ServerStatus | |
| pattern ServerStatus_RUNNING :: ServerStatus | |
| pattern ServerStatus_SETUP :: ServerStatus | |
| pattern ServerStatus_TERMINATED :: ServerStatus | |
| pattern ServerStatus_UNDER_MAINTENANCE :: ServerStatus | |
| pattern ServerStatus_UNHEALTHY :: ServerStatus |
Instances
AccountAttribute
data AccountAttribute Source #
Stores account attributes.
See: newAccountAttribute smart constructor.
Instances
newAccountAttribute :: AccountAttribute Source #
Create a value of AccountAttribute with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maximum:AccountAttribute', accountAttribute_maximum - The maximum allowed value.
$sel:name:AccountAttribute', accountAttribute_name - The attribute name. The following are supported attribute names.
- ServerLimit: The number of current servers/maximum number of servers allowed. By default, you can have a maximum of 10 servers.
- ManualBackupLimit: The number of current manual backups/maximum number of backups allowed. By default, you can have a maximum of 50 manual backups saved.
$sel:used:AccountAttribute', accountAttribute_used - The current usage, such as the current number of servers that are
associated with the account.
Backup
Describes a single backup.
See: newBackup smart constructor.
Constructors
| Backup' (Maybe Text) (Maybe Text) (Maybe BackupType) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe BackupStatus) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Text) |
Instances
Create a value of Backup with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:backupArn:Backup', backup_backupArn - The ARN of the backup.
$sel:backupId:Backup', backup_backupId - The generated ID of the backup. Example:
myServerName-yyyyMMddHHmmssSSS
$sel:backupType:Backup', backup_backupType - The backup type. Valid values are automated or manual.
$sel:createdAt:Backup', backup_createdAt - The time stamp when the backup was created in the database. Example:
2016-07-29T13:38:47.520Z
$sel:description:Backup', backup_description - A user-provided description for a manual backup. This field is empty for
automated backups.
$sel:engine:Backup', backup_engine - The engine type that is obtained from the server when the backup is
created.
$sel:engineModel:Backup', backup_engineModel - The engine model that is obtained from the server when the backup is
created.
$sel:engineVersion:Backup', backup_engineVersion - The engine version that is obtained from the server when the backup is
created.
$sel:instanceProfileArn:Backup', backup_instanceProfileArn - 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.
$sel:instanceType:Backup', backup_instanceType - The instance type that is obtained from the server when the backup is
created.
$sel:keyPair:Backup', backup_keyPair - The key pair that is obtained from the server when the backup is
created.
$sel:preferredBackupWindow:Backup', backup_preferredBackupWindow - The preferred backup period that is obtained from the server when the
backup is created.
$sel:preferredMaintenanceWindow:Backup', backup_preferredMaintenanceWindow - The preferred maintenance period that is obtained from the server when
the backup is created.
$sel:s3DataSize:Backup', backup_s3DataSize - This field is deprecated and is no longer used.
$sel:s3DataUrl:Backup', backup_s3DataUrl - This field is deprecated and is no longer used.
$sel:s3LogUrl:Backup', backup_s3LogUrl - The Amazon S3 URL of the backup's log file.
$sel:securityGroupIds:Backup', backup_securityGroupIds - The security group IDs that are obtained from the server when the backup
is created.
$sel:serverName:Backup', backup_serverName - The name of the server from which the backup was made.
$sel:serviceRoleArn:Backup', backup_serviceRoleArn - The service role ARN that is obtained from the server when the backup is
created.
$sel:status:Backup', backup_status - The status of a backup while in progress.
$sel:statusDescription:Backup', backup_statusDescription - An informational message about backup status.
$sel:subnetIds:Backup', backup_subnetIds - The subnet IDs that are obtained from the server when the backup is
created.
$sel:toolsVersion:Backup', backup_toolsVersion - The version of AWS OpsWorks CM-specific tools that is obtained from the
server when the backup is created.
$sel:userArn:Backup', backup_userArn - The IAM user ARN of the requester for manual backups. This field is
empty for automated backups.
EngineAttribute
data EngineAttribute Source #
A name and value pair that is specific to the engine of the server.
See: newEngineAttribute smart constructor.
Instances
newEngineAttribute :: EngineAttribute Source #
Create a value of EngineAttribute with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:EngineAttribute', engineAttribute_name - The name of the engine attribute.
$sel:value:EngineAttribute', engineAttribute_value - The value of the engine attribute.
Server
Describes a configuration management server.
See: newServer smart constructor.
Constructors
| Server' (Maybe Bool) (Maybe Int) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe [EngineAttribute]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe MaintenanceStatus) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe ServerStatus) (Maybe Text) (Maybe [Text]) |
Instances
Create a value of Server with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:associatePublicIpAddress:Server', server_associatePublicIpAddress - Associate a public IP address with a server that you are launching.
$sel:backupRetentionCount:Server', server_backupRetentionCount - The number of automated backups to keep.
$sel:cloudFormationStackArn:Server', server_cloudFormationStackArn - The ARN of the CloudFormation stack that was used to create the server.
$sel:createdAt:Server', server_createdAt - Time stamp of server creation. Example 2016-07-29T13:38:47.520Z
$sel:customDomain:Server', server_customDomain - An optional public endpoint of a server, such as
https://aws.my-company.com. You cannot access the server by using
the Endpoint value if the server has a CustomDomain specified.
$sel:disableAutomatedBackup:Server', server_disableAutomatedBackup - Disables automated backups. The number of stored backups is dependent on
the value of PreferredBackupCount.
$sel:endpoint:Server', server_endpoint - A DNS name that can be used to access the engine. Example:
myserver-asdfghjkl.us-east-1.opsworks.io. You cannot access the server
by using the Endpoint value if the server has a CustomDomain
specified.
$sel:engine:Server', server_engine - The engine type of the server. Valid values in this release include
ChefAutomate and Puppet.
$sel:engineAttributes:Server', server_engineAttributes - 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_AUTOMATE_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.
$sel:engineModel:Server', server_engineModel - The engine model of the server. Valid values in this release include
Monolithic for Puppet and Single for Chef.
$sel:engineVersion:Server', server_engineVersion - The engine version of the server. For a Chef server, the valid value for
EngineVersion is currently 2. For a Puppet server, specify either
2019 or 2017.
$sel:instanceProfileArn:Server', server_instanceProfileArn - The instance profile ARN of the server.
$sel:instanceType:Server', server_instanceType - 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.
$sel:keyPair:Server', server_keyPair - The key pair associated with the server.
$sel:maintenanceStatus:Server', server_maintenanceStatus - The status of the most recent server maintenance run. Shows SUCCESS or
FAILED.
$sel:preferredBackupWindow:Server', server_preferredBackupWindow - The preferred backup period specified for the server.
$sel:preferredMaintenanceWindow:Server', server_preferredMaintenanceWindow - The preferred maintenance period specified for the server.
$sel:securityGroupIds:Server', server_securityGroupIds - 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.
$sel:serverArn:Server', server_serverArn - The ARN of the server.
$sel:serverName:Server', server_serverName - The name of the server.
$sel:serviceRoleArn:Server', server_serviceRoleArn - The service role ARN used to create the server.
$sel:status:Server', server_status - 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.
$sel:statusReason:Server', server_statusReason - 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).
$sel:subnetIds:Server', server_subnetIds - The subnet IDs specified in a CreateServer request.
ServerEvent
data ServerEvent Source #
An event that is related to the server, such as the start of maintenance or backup.
See: newServerEvent smart constructor.
Instances
newServerEvent :: ServerEvent Source #
Create a value of ServerEvent with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:createdAt:ServerEvent', serverEvent_createdAt - The time when the event occurred.
$sel:logUrl:ServerEvent', serverEvent_logUrl - The Amazon S3 URL of the event's log file.
$sel:message:ServerEvent', serverEvent_message - A human-readable informational or status message.
$sel:serverName:ServerEvent', serverEvent_serverName - The name of the server on or for which the event occurred.
Tag
A map that contains tag keys and tag values to attach to an AWS OpsWorks for Chef Automate or AWS OpsWorks for Puppet Enterprise server. Leading and trailing white spaces are trimmed from both the key and value. A maximum of 50 user-applied tags is allowed for tag-supported AWS OpsWorks-CM resources.
See: newTag smart constructor.
Instances
| FromJSON Tag Source # | |
| ToJSON Tag Source # | |
Defined in Amazonka.OpsWorksCM.Types.Tag | |
| Generic Tag Source # | |
| Read Tag Source # | |
| Show Tag Source # | |
| NFData Tag Source # | |
Defined in Amazonka.OpsWorksCM.Types.Tag | |
| Eq Tag Source # | |
| Hashable Tag Source # | |
Defined in Amazonka.OpsWorksCM.Types.Tag | |
| type Rep Tag Source # | |
Defined in Amazonka.OpsWorksCM.Types.Tag type Rep Tag = D1 ('MetaData "Tag" "Amazonka.OpsWorksCM.Types.Tag" "amazonka-opsworks-cm-2.0-4eRKS676FdFBzYMnhnI9o" 'False) (C1 ('MetaCons "Tag'" 'PrefixI 'True) (S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) | |
Create a value of Tag with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:key:Tag', tag_key - A tag key, such as Stage or Name. A tag key cannot be empty. The key
can be a maximum of 127 characters, and can contain only Unicode
letters, numbers, or separators, or the following special characters:
+ - = . _ : /
$sel:value:Tag', tag_value - An optional tag value, such as Production or test-owcm-server. The
value can be a maximum of 255 characters, and contain only Unicode
letters, numbers, or separators, or the following special characters:
+ - = . _ : /