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 |
Creates and immedately starts a new server. The server is ready to use when it is in the HEALTHY
state. By default, you can create a maximum of 10 servers.
This operation is asynchronous.
A LimitExceededException
is thrown when you have created the maximum number of servers (10). A ResourceAlreadyExistsException
is thrown when a server with the same name already exists in the account. A ResourceNotFoundException
is thrown when you specify a backup ID that is not valid or is for a backup that does not exist. A ValidationException
is thrown when parameters of the request are not valid.
If you do not specify a security group by adding the SecurityGroupIds
parameter, AWS OpsWorks creates a new security group.
Chef Automate: The default security group opens the Chef server to the world on TCP port 443. If a KeyName is present, AWS OpsWorks enables SSH access. SSH is also open to the world on TCP port 22.
Puppet Enterprise: The default security group opens TCP ports 22, 443, 4433, 8140, 8142, 8143, and 8170. If a KeyName is present, AWS OpsWorks enables SSH access. SSH is also open to the world on TCP port 22.
By default, your server is accessible from any IP address. We recommend that you update your security group rules to allow access from known IP addresses and address ranges only. To edit security group rules, open Security Groups in the navigation pane of the EC2 management console.
- createServer :: Text -> Text -> Text -> Text -> CreateServer
- data CreateServer
- csEngineVersion :: Lens' CreateServer (Maybe Text)
- csDisableAutomatedBackup :: Lens' CreateServer (Maybe Bool)
- csSecurityGroupIds :: Lens' CreateServer [Text]
- csAssociatePublicIPAddress :: Lens' CreateServer (Maybe Bool)
- csSubnetIds :: Lens' CreateServer [Text]
- csKeyPair :: Lens' CreateServer (Maybe Text)
- csBackupId :: Lens' CreateServer (Maybe Text)
- csEngine :: Lens' CreateServer (Maybe Text)
- csEngineModel :: Lens' CreateServer (Maybe Text)
- csEngineAttributes :: Lens' CreateServer [EngineAttribute]
- csPreferredMaintenanceWindow :: Lens' CreateServer (Maybe Text)
- csPreferredBackupWindow :: Lens' CreateServer (Maybe Text)
- csBackupRetentionCount :: Lens' CreateServer (Maybe Natural)
- csServerName :: Lens' CreateServer Text
- csInstanceProfileARN :: Lens' CreateServer Text
- csInstanceType :: Lens' CreateServer Text
- csServiceRoleARN :: Lens' CreateServer Text
- createServerResponse :: Int -> CreateServerResponse
- data CreateServerResponse
- csrsServer :: Lens' CreateServerResponse (Maybe Server)
- csrsResponseStatus :: Lens' CreateServerResponse Int
Creating a Request
:: Text | |
-> Text | |
-> Text | |
-> Text | |
-> CreateServer |
Creates a value of CreateServer
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
csEngineVersion
- The major release version of the engine that you want to use. For a Chef server, the valid value for EngineVersion is currently12
. For a Puppet server, the valid value is2017
.csDisableAutomatedBackup
- Enable or disable scheduled backups. Valid values aretrue
orfalse
. The default value istrue
.csSecurityGroupIds
- 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 bySubnetIds
. 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).csAssociatePublicIPAddress
- Associate a public IP address with a server that you are launching. Valid values aretrue
orfalse
. The default value istrue
.csSubnetIds
- 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 .csKeyPair
- 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.csBackupId
- If you specify this field, AWS OpsWorks CM creates the server by using the backup represented by BackupId.csEngine
- The configuration management engine to use. Valid values includeChef
andPuppet
.csEngineModel
- The engine model of the server. Valid values in this release includeMonolithic
for Puppet andSingle
for Chef.csEngineAttributes
- Optional engine attributes on a specified server. Attributes accepted in a Chef createServer request: *CHEF_PIVOTAL_KEY
: A base64-encoded RSA private key that is not stored by AWS OpsWorks for Chef Automate. This private key is required to access the Chef API. When no CHEF_PIVOTAL_KEY is set, one is generated and returned in the response. *CHEF_DELIVERY_ADMIN_PASSWORD
: The password for the administrative user in the Chef Automate GUI. 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_DELIVERY_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.csPreferredMaintenanceWindow
- 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
. The specified time is in coordinated universal time (UTC). The default value is a random one-hour period on Tuesday, Wednesday, or Friday. SeeTimeWindowDefinition
for more information. Example:Mon:08:00
, which represents a start time of every Monday at 08:00 UTC. (8:00 a.m.)csPreferredBackupWindow
- 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:MM
for daily backups *DDD:HH:MM
for weekly backups 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.)csBackupRetentionCount
- 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 is1
.csServerName
- 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.csInstanceProfileARN
- 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.csInstanceType
- The Amazon EC2 instance type to use. For example,m4.large
. Recommended instance types includet2.medium
and greater,m4.*
, orc4.xlarge
and greater.csServiceRoleARN
- 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 CreateServer Source #
See: createServer
smart constructor.
Request Lenses
csEngineVersion :: Lens' CreateServer (Maybe Text) Source #
The major release version of the engine that you want to use. For a Chef server, the valid value for EngineVersion is currently 12
. For a Puppet server, the valid value is 2017
.
csDisableAutomatedBackup :: Lens' CreateServer (Maybe Bool) Source #
Enable or disable scheduled backups. Valid values are true
or false
. The default value is true
.
csSecurityGroupIds :: Lens' CreateServer [Text] Source #
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).
csAssociatePublicIPAddress :: Lens' CreateServer (Maybe Bool) Source #
Associate a public IP address with a server that you are launching. Valid values are true
or false
. The default value is true
.
csSubnetIds :: Lens' CreateServer [Text] Source #
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 .
csKeyPair :: Lens' CreateServer (Maybe Text) Source #
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.
csBackupId :: Lens' CreateServer (Maybe Text) Source #
If you specify this field, AWS OpsWorks CM creates the server by using the backup represented by BackupId.
csEngine :: Lens' CreateServer (Maybe Text) Source #
The configuration management engine to use. Valid values include Chef
and Puppet
.
csEngineModel :: Lens' CreateServer (Maybe Text) Source #
The engine model of the server. Valid values in this release include Monolithic
for Puppet and Single
for Chef.
csEngineAttributes :: Lens' CreateServer [EngineAttribute] Source #
Optional engine attributes on a specified server. Attributes accepted in a Chef createServer request: * CHEF_PIVOTAL_KEY
: A base64-encoded RSA private key that is not stored by AWS OpsWorks for Chef Automate. This private key is required to access the Chef API. When no CHEF_PIVOTAL_KEY is set, one is generated and returned in the response. * CHEF_DELIVERY_ADMIN_PASSWORD
: The password for the administrative user in the Chef Automate GUI. 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_DELIVERY_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.
csPreferredMaintenanceWindow :: Lens' CreateServer (Maybe Text) Source #
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
. 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.)
csPreferredBackupWindow :: Lens' CreateServer (Maybe Text) Source #
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:MM
for daily backups * DDD:HH:MM
for weekly backups 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.)
csBackupRetentionCount :: Lens' CreateServer (Maybe Natural) Source #
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
.
csServerName :: Lens' CreateServer Text Source #
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.
csInstanceProfileARN :: Lens' CreateServer Text Source #
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.
csInstanceType :: Lens' CreateServer Text Source #
The Amazon EC2 instance type to use. For example, m4.large
. Recommended instance types include t2.medium
and greater, m4.*
, or c4.xlarge
and greater.
csServiceRoleARN :: Lens' CreateServer Text Source #
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.
Destructuring the Response
Creates a value of CreateServerResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
csrsServer
- The server that is created by the request.csrsResponseStatus
- -- | The response status code.
data CreateServerResponse Source #
See: createServerResponse
smart constructor.
Response Lenses
csrsServer :: Lens' CreateServerResponse (Maybe Server) Source #
The server that is created by the request.
csrsResponseStatus :: Lens' CreateServerResponse Int Source #
- - | The response status code.