Network.AWS.OpsWorksCM.CreateServer

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.

Creating a Request

createServer

Arguments

:: Text

csServerName

-> Text

csInstanceProfileARN

-> Text

csInstanceType

-> Text

csServiceRoleARN

-> 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 currently 12 . For a Puppet server, the valid value is 2017 .
• csDisableAutomatedBackup - Enable or disable scheduled backups. Valid values are true or false . The default value is true .
• 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 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 - Associate a public IP address with a server that you are launching. Valid values are true or false . The default value is true .
• 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 include Chef and Puppet .
• csEngineModel - The engine model of the server. Valid values in this release include Monolithic for Puppet and Single 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. 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 - 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 is 1 .
• 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 include t2.medium and greater, m4.* , or c4.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

See: createServer smart constructor.

Instances

Eq CreateServer

Defined in Network.AWS.OpsWorksCM.CreateServer

Methods

(==) :: CreateServer -> CreateServer -> Bool

(/=) :: CreateServer -> CreateServer -> Bool

Data CreateServer

Defined in Network.AWS.OpsWorksCM.CreateServer

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreateServer -> c CreateServer

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreateServer

toConstr :: CreateServer -> Constr

dataTypeOf :: CreateServer -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c CreateServer)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreateServer)

gmapT :: (forall b. Data b => b -> b) -> CreateServer -> CreateServer

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreateServer -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreateServer -> r

gmapQ :: (forall d. Data d => d -> u) -> CreateServer -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> CreateServer -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreateServer -> m CreateServer

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateServer -> m CreateServer

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateServer -> m CreateServer

Show CreateServer

Defined in Network.AWS.OpsWorksCM.CreateServer

Methods

showsPrec :: Int -> CreateServer -> ShowS

show :: CreateServer -> String

showList :: [CreateServer] -> ShowS

Generic CreateServer

Defined in Network.AWS.OpsWorksCM.CreateServer

Associated Types

type Rep CreateServer :: Type -> Type

Methods

from :: CreateServer -> Rep CreateServer x

to :: Rep CreateServer x -> CreateServer

Hashable CreateServer

Defined in Network.AWS.OpsWorksCM.CreateServer

Methods

hashWithSalt :: Int -> CreateServer -> Int

hash :: CreateServer -> Int

ToJSON CreateServer

Defined in Network.AWS.OpsWorksCM.CreateServer

Methods

toJSON :: CreateServer -> Value

toEncoding :: CreateServer -> Encoding

toJSONList :: [CreateServer] -> Value

toEncodingList :: [CreateServer] -> Encoding

AWSRequest CreateServer

Defined in Network.AWS.OpsWorksCM.CreateServer

Associated Types

type Rs CreateServer :: Type

Methods

request :: CreateServer -> Request CreateServer

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy CreateServer -> ClientResponse -> m (Response CreateServer)

ToHeaders CreateServer

Defined in Network.AWS.OpsWorksCM.CreateServer

Methods

toHeaders :: CreateServer -> [Header]

ToPath CreateServer

Defined in Network.AWS.OpsWorksCM.CreateServer

Methods

toPath :: CreateServer -> ByteString

ToQuery CreateServer

Defined in Network.AWS.OpsWorksCM.CreateServer

Methods

toQuery :: CreateServer -> QueryString

NFData CreateServer

Defined in Network.AWS.OpsWorksCM.CreateServer

Methods

rnf :: CreateServer -> ()

type Rep CreateServer

Defined in Network.AWS.OpsWorksCM.CreateServer

type Rep CreateServer = D1 (MetaData "CreateServer" "Network.AWS.OpsWorksCM.CreateServer" "amazonka-opsworks-cm-1.6.1-DBtTlJOATBfGleOMllIGPs" False) (C1 (MetaCons "CreateServer'" PrefixI True) ((((S1 (MetaSel (Just "_csEngineVersion") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_csDisableAutomatedBackup") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 (MetaSel (Just "_csSecurityGroupIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 (MetaSel (Just "_csAssociatePublicIPAddress") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)))) :*: ((S1 (MetaSel (Just "_csSubnetIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 (MetaSel (Just "_csKeyPair") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_csBackupId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_csEngine") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) :*: (((S1 (MetaSel (Just "_csEngineModel") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_csEngineAttributes") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [EngineAttribute]))) :*: (S1 (MetaSel (Just "_csPreferredMaintenanceWindow") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_csPreferredBackupWindow") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 (MetaSel (Just "_csBackupRetentionCount") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat)) :*: S1 (MetaSel (Just "_csServerName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) :*: (S1 (MetaSel (Just "_csInstanceProfileARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: (S1 (MetaSel (Just "_csInstanceType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_csServiceRoleARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))))))

type Rs CreateServer

Defined in Network.AWS.OpsWorksCM.CreateServer

type Rs CreateServer = CreateServerResponse

Request Lenses

csEngineVersion :: Lens' CreateServer (Maybe Text)

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)

Enable or disable scheduled backups. Valid values are true or false . The default value is true .

csSecurityGroupIds :: Lens' CreateServer [Text]

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)

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]

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)

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)

If you specify this field, AWS OpsWorks CM creates the server by using the backup represented by BackupId.

csEngine :: Lens' CreateServer (Maybe Text)

The configuration management engine to use. Valid values include Chef and Puppet .

csEngineModel :: Lens' CreateServer (Maybe Text)

The engine model of the server. Valid values in this release include Monolithic for Puppet and Single for Chef.

csEngineAttributes :: Lens' CreateServer [EngineAttribute]

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)

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)

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)

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

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

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

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

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

createServerResponse

Arguments

:: Int

csrsResponseStatus

-> CreateServerResponse

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

See: createServerResponse smart constructor.

Instances

Eq CreateServerResponse

Defined in Network.AWS.OpsWorksCM.CreateServer

Methods

(==) :: CreateServerResponse -> CreateServerResponse -> Bool

(/=) :: CreateServerResponse -> CreateServerResponse -> Bool

Data CreateServerResponse

Defined in Network.AWS.OpsWorksCM.CreateServer

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreateServerResponse -> c CreateServerResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreateServerResponse

toConstr :: CreateServerResponse -> Constr

dataTypeOf :: CreateServerResponse -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c CreateServerResponse)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreateServerResponse)

gmapT :: (forall b. Data b => b -> b) -> CreateServerResponse -> CreateServerResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreateServerResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreateServerResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> CreateServerResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> CreateServerResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreateServerResponse -> m CreateServerResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateServerResponse -> m CreateServerResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateServerResponse -> m CreateServerResponse

Show CreateServerResponse

Defined in Network.AWS.OpsWorksCM.CreateServer

Methods

showsPrec :: Int -> CreateServerResponse -> ShowS

show :: CreateServerResponse -> String

showList :: [CreateServerResponse] -> ShowS

Generic CreateServerResponse

Defined in Network.AWS.OpsWorksCM.CreateServer

Associated Types

type Rep CreateServerResponse :: Type -> Type

Methods

from :: CreateServerResponse -> Rep CreateServerResponse x

to :: Rep CreateServerResponse x -> CreateServerResponse

NFData CreateServerResponse

Defined in Network.AWS.OpsWorksCM.CreateServer

Methods

rnf :: CreateServerResponse -> ()

type Rep CreateServerResponse

Defined in Network.AWS.OpsWorksCM.CreateServer

type Rep CreateServerResponse = D1 (MetaData "CreateServerResponse" "Network.AWS.OpsWorksCM.CreateServer" "amazonka-opsworks-cm-1.6.1-DBtTlJOATBfGleOMllIGPs" False) (C1 (MetaCons "CreateServerResponse'" PrefixI True) (S1 (MetaSel (Just "_csrsServer") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Server)) :*: S1 (MetaSel (Just "_csrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)))

Response Lenses

csrsServer :: Lens' CreateServerResponse (Maybe Server)

The server that is created by the request.

csrsResponseStatus :: Lens' CreateServerResponse Int

• - | The response status code.