Network.AWS.OpsWorksCM.CreateServer

Creates and immedately starts a new Server. The server can be used once it has reached the HEALTHY state.

This operation is asnychronous.

A LimitExceededException is thrown then the maximum number of server backup is reached. A ResourceAlreadyExistsException is raise when a server with the same name already exists in the account. A ResourceNotFoundException is thrown when a backupId is passed, but the backup does not exist. A ValidationException is thrown when parameters of the request are not valid.

By default 10 servers can be created. A LimitExceededException is raised when the limit is exceeded.

When no security groups are provided by using SecurityGroupIds , AWS OpsWorks creates a new security group. This security group opens the Chef server to the world on TCP port 443. If a KeyName is present, SSH access is enabled. SSH is also open to the world on TCP port 22.

By default, the Chef 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

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. Values depend on the engine that you choose.
• 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 for Chef Automate creates one new security group that uses TCP ports 22 and 443, open to 0.0.0.0/0 (everyone).
• 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. You may specify this parameter to connect to your instances by using SSH.
• csBackupId - If you specify this field, AWS OpsWorks for Chef Automate creates the server by using the backup represented by BackupId.
• csEngine - The configuration management engine to use. Valid values include Chef .
• csInstanceType - The Amazon EC2 instance type to use. Valid values must be specified in the following format: ^([cm][34]|t2).* For example, c3.large .
• csEngineModel - The engine model, or option. Valid values include Single .
• csEngineAttributes - Engine attributes on a specified server. Attributes accepted in a 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.
• csPreferredMaintenanceWindow - The start time for a one-hour period each week during which AWS OpsWorks for Chef Automate 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 for Chef Automate backs up application-level data on your server if 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 for Chef Automate 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 32 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, in this release of AWS OpsWorks for Chef Automate, run the service-role-creation.yaml AWS CloudFormation template, located at https://s3.amazonaws.com/opsworks-stuff/latest/service-role-creation.yaml. This template creates a stack that includes the instance profile you need.
• csServiceRoleARN - The service role that the AWS OpsWorks for Chef Automate service backend uses to work with your account. Although the AWS OpsWorks console typically creates the service role for you, in this release of AWS OpsWorks for Chef Automate, run the service-role-creation.yaml AWS CloudFormation template, located at https://s3.amazonaws.com/opsworks-stuff/latest/service-role-creation.yaml. This template creates a stack that includes the service role that you need.

data CreateServer

See: createServer smart constructor.

Instances

Eq CreateServer

Methods

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

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

Data 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

Read CreateServer

Methods

readsPrec :: Int -> ReadS CreateServer

readList :: ReadS [CreateServer]

readPrec :: ReadPrec CreateServer

readListPrec :: ReadPrec [CreateServer]

Show CreateServer

Methods

showsPrec :: Int -> CreateServer -> ShowS

show :: CreateServer -> String

showList :: [CreateServer] -> ShowS

Generic CreateServer

Associated Types

type Rep CreateServer :: * -> *

Methods

from :: CreateServer -> Rep CreateServer x

to :: Rep CreateServer x -> CreateServer

Hashable CreateServer

Methods

hashWithSalt :: Int -> CreateServer -> Int

hash :: CreateServer -> Int

ToJSON CreateServer

Methods

toJSON :: CreateServer -> Value

toEncoding :: CreateServer -> Encoding

toJSONList :: [CreateServer] -> Value

toEncodingList :: [CreateServer] -> Encoding

NFData CreateServer

Methods

rnf :: CreateServer -> ()

AWSRequest CreateServer

Associated Types

type Rs CreateServer :: *

Methods

request :: CreateServer -> Request CreateServer

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

ToPath CreateServer

Methods

toPath :: CreateServer -> ByteString

ToHeaders CreateServer

Methods

toHeaders :: CreateServer -> [Header]

ToQuery CreateServer

Methods

toQuery :: CreateServer -> QueryString

type Rep CreateServer

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

type Rs CreateServer

type Rs CreateServer = CreateServerResponse

Request Lenses

csEngineVersion :: Lens' CreateServer (Maybe Text)

The major release version of the engine that you want to use. Values depend on the engine that you choose.

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 for Chef Automate creates one new security group that uses TCP ports 22 and 443, open to 0.0.0.0/0 (everyone).

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. 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 for Chef Automate 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 .

csInstanceType :: Lens' CreateServer (Maybe Text)

The Amazon EC2 instance type to use. Valid values must be specified in the following format: ^([cm][34]|t2).* For example, c3.large .

csEngineModel :: Lens' CreateServer (Maybe Text)

The engine model, or option. Valid values include Single .

csEngineAttributes :: Lens' CreateServer [EngineAttribute]

Engine attributes on a specified server. Attributes accepted in a 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.

csPreferredMaintenanceWindow :: Lens' CreateServer (Maybe Text)

The start time for a one-hour period each week during which AWS OpsWorks for Chef Automate 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 for Chef Automate backs up application-level data on your server if 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 for Chef Automate 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 32 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, in this release of AWS OpsWorks for Chef Automate, run the service-role-creation.yaml AWS CloudFormation template, located at https://s3.amazonaws.com/opsworks-stuff/latest/service-role-creation.yaml. This template creates a stack that includes the instance profile you need.

csServiceRoleARN :: Lens' CreateServer Text

The service role that the AWS OpsWorks for Chef Automate service backend uses to work with your account. Although the AWS OpsWorks console typically creates the service role for you, in this release of AWS OpsWorks for Chef Automate, run the service-role-creation.yaml AWS CloudFormation template, located at https://s3.amazonaws.com/opsworks-stuff/latest/service-role-creation.yaml. This template creates a stack that includes the service role 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

Methods

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

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

Data CreateServerResponse

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

Read CreateServerResponse

Methods

readsPrec :: Int -> ReadS CreateServerResponse

readList :: ReadS [CreateServerResponse]

readPrec :: ReadPrec CreateServerResponse

readListPrec :: ReadPrec [CreateServerResponse]

Show CreateServerResponse

Methods

showsPrec :: Int -> CreateServerResponse -> ShowS

show :: CreateServerResponse -> String

showList :: [CreateServerResponse] -> ShowS

Generic CreateServerResponse

Associated Types

type Rep CreateServerResponse :: * -> *

Methods

from :: CreateServerResponse -> Rep CreateServerResponse x

to :: Rep CreateServerResponse x -> CreateServerResponse

NFData CreateServerResponse

Methods

rnf :: CreateServerResponse -> ()

type Rep CreateServerResponse

type Rep CreateServerResponse = D1 (MetaData "CreateServerResponse" "Network.AWS.OpsWorksCM.CreateServer" "amazonka-opsworks-cm-1.4.5-1gsJwLY5VN6CtZ9Orfu6eU" False) (C1 (MetaCons "CreateServerResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_csrsServer") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Server))) (S1 (MetaSel (Just Symbol "_csrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (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.