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 |
Synopsis
- data Server = Server' {
- associatePublicIpAddress :: Maybe Bool
- backupRetentionCount :: Maybe Int
- cloudFormationStackArn :: Maybe Text
- createdAt :: Maybe POSIX
- customDomain :: Maybe Text
- disableAutomatedBackup :: Maybe Bool
- endpoint :: Maybe Text
- engine :: Maybe Text
- engineAttributes :: Maybe [EngineAttribute]
- engineModel :: Maybe Text
- engineVersion :: Maybe Text
- instanceProfileArn :: Maybe Text
- instanceType :: Maybe Text
- keyPair :: Maybe Text
- maintenanceStatus :: Maybe MaintenanceStatus
- preferredBackupWindow :: Maybe Text
- preferredMaintenanceWindow :: Maybe Text
- securityGroupIds :: Maybe [Text]
- serverArn :: Maybe Text
- serverName :: Maybe Text
- serviceRoleArn :: Maybe Text
- status :: Maybe ServerStatus
- statusReason :: Maybe Text
- subnetIds :: Maybe [Text]
- newServer :: Server
- server_associatePublicIpAddress :: Lens' Server (Maybe Bool)
- server_backupRetentionCount :: Lens' Server (Maybe Int)
- server_cloudFormationStackArn :: Lens' Server (Maybe Text)
- server_createdAt :: Lens' Server (Maybe UTCTime)
- server_customDomain :: Lens' Server (Maybe Text)
- server_disableAutomatedBackup :: Lens' Server (Maybe Bool)
- server_endpoint :: Lens' Server (Maybe Text)
- server_engine :: Lens' Server (Maybe Text)
- server_engineAttributes :: Lens' Server (Maybe [EngineAttribute])
- server_engineModel :: Lens' Server (Maybe Text)
- server_engineVersion :: Lens' Server (Maybe Text)
- server_instanceProfileArn :: Lens' Server (Maybe Text)
- server_instanceType :: Lens' Server (Maybe Text)
- server_keyPair :: Lens' Server (Maybe Text)
- server_maintenanceStatus :: Lens' Server (Maybe MaintenanceStatus)
- server_preferredBackupWindow :: Lens' Server (Maybe Text)
- server_preferredMaintenanceWindow :: Lens' Server (Maybe Text)
- server_securityGroupIds :: Lens' Server (Maybe [Text])
- server_serverArn :: Lens' Server (Maybe Text)
- server_serverName :: Lens' Server (Maybe Text)
- server_serviceRoleArn :: Lens' Server (Maybe Text)
- server_status :: Lens' Server (Maybe ServerStatus)
- server_statusReason :: Lens' Server (Maybe Text)
- server_subnetIds :: Lens' Server (Maybe [Text])
Documentation
Describes a configuration management server.
See: newServer
smart constructor.
Server' | |
|
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.
server_associatePublicIpAddress :: Lens' Server (Maybe Bool) Source #
Associate a public IP address with a server that you are launching.
server_backupRetentionCount :: Lens' Server (Maybe Int) Source #
The number of automated backups to keep.
server_cloudFormationStackArn :: Lens' Server (Maybe Text) Source #
The ARN of the CloudFormation stack that was used to create the server.
server_createdAt :: Lens' Server (Maybe UTCTime) Source #
Time stamp of server creation. Example 2016-07-29T13:38:47.520Z
server_customDomain :: Lens' Server (Maybe Text) Source #
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.
server_disableAutomatedBackup :: Lens' Server (Maybe Bool) Source #
Disables automated backups. The number of stored backups is dependent on the value of PreferredBackupCount.
server_endpoint :: Lens' Server (Maybe Text) Source #
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.
server_engine :: Lens' Server (Maybe Text) Source #
The engine type of the server. Valid values in this release include
ChefAutomate
and Puppet
.
server_engineAttributes :: Lens' Server (Maybe [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_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.
server_engineModel :: Lens' Server (Maybe Text) Source #
The engine model of the server. Valid values in this release include
Monolithic
for Puppet and Single
for Chef.
server_engineVersion :: Lens' Server (Maybe Text) Source #
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
.
server_instanceProfileArn :: Lens' Server (Maybe Text) Source #
The instance profile ARN of the server.
server_instanceType :: 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.
server_maintenanceStatus :: Lens' Server (Maybe MaintenanceStatus) Source #
The status of the most recent server maintenance run. Shows SUCCESS
or
FAILED
.
server_preferredBackupWindow :: Lens' Server (Maybe Text) Source #
The preferred backup period specified for the server.
server_preferredMaintenanceWindow :: Lens' Server (Maybe Text) Source #
The preferred maintenance period specified for the server.
server_securityGroupIds :: Lens' Server (Maybe [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.
server_serviceRoleArn :: Lens' Server (Maybe Text) Source #
The service role ARN used to create the server.
server_status :: 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.