2017/03/06 - AWS OpsWorks for Chef Automate - 5 updated api methods
Changes OpsWorks for Chef Automate has added a new field "AssociatePublicIpAddress" to the CreateServer request, "CloudFormationStackArn" to the Server model and "TERMINATED" server state.
{'AssociatePublicIpAddress': 'boolean'}
Response {'Server': {'AssociatePublicIpAddress': 'boolean',
'CloudFormationStackArn': 'string',
'Status': ['RESTORING', 'TERMINATED']}}
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. 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.
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.
See also: AWS API Documentation
Request Syntax
client.create_server(
AssociatePublicIpAddress=True|False,
DisableAutomatedBackup=True|False,
Engine='string',
EngineModel='string',
EngineVersion='string',
EngineAttributes=[
{
'Name': 'string',
'Value': 'string'
},
],
BackupRetentionCount=123,
ServerName='string',
InstanceProfileArn='string',
InstanceType='string',
KeyPair='string',
PreferredMaintenanceWindow='string',
PreferredBackupWindow='string',
SecurityGroupIds=[
'string',
],
ServiceRoleArn='string',
SubnetIds=[
'string',
],
BackupId='string'
)
boolean
Associate a public IP address with a server that you are launching. Valid values are true or false . The default value is true .
boolean
Enable or disable scheduled backups. Valid values are true or false . The default value is true .
string
The configuration management engine to use. Valid values include Chef .
string
The engine model, or option. Valid values include Single .
string
The major release version of the engine that you want to use. Values depend on the engine that you choose.
list
Optional 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. 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.
(dict) --
A name and value pair that is specific to the engine of the server.
Name (string) --
The name of the engine attribute.
Value (string) --
The value of the engine attribute.
integer
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 .
string
[REQUIRED]
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.
string
[REQUIRED]
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.
string
[REQUIRED]
The Amazon EC2 instance type to use. Valid values must be specified in the following format: ^([cm][34]|t2).* For example, m4.large . Valid values are t2.medium , m4.large , or m4.2xlarge .
string
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.
string
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.)
string
The start time for a one-hour period during which AWS OpsWorks for Chef Automate 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.)
list
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).
(string) --
string
[REQUIRED]
The service role that the AWS OpsWorks for Chef Automate 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-stuff/latest/service-role-creation.yaml. This template creates a CloudFormation stack that includes the service role that you need.
list
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 .
(string) --
string
If you specify this field, AWS OpsWorks for Chef Automate creates the server by using the backup represented by BackupId.
dict
Response Syntax
{
'Server': {
'AssociatePublicIpAddress': True|False,
'BackupRetentionCount': 123,
'ServerName': 'string',
'CreatedAt': datetime(2015, 1, 1),
'CloudFormationStackArn': 'string',
'DisableAutomatedBackup': True|False,
'Endpoint': 'string',
'Engine': 'string',
'EngineModel': 'string',
'EngineAttributes': [
{
'Name': 'string',
'Value': 'string'
},
],
'EngineVersion': 'string',
'InstanceProfileArn': 'string',
'InstanceType': 'string',
'KeyPair': 'string',
'MaintenanceStatus': 'SUCCESS'|'FAILED',
'PreferredMaintenanceWindow': 'string',
'PreferredBackupWindow': 'string',
'SecurityGroupIds': [
'string',
],
'ServiceRoleArn': 'string',
'Status': 'BACKING_UP'|'CONNECTION_LOST'|'CREATING'|'DELETING'|'MODIFYING'|'FAILED'|'HEALTHY'|'RUNNING'|'RESTORING'|'SETUP'|'UNDER_MAINTENANCE'|'UNHEALTHY'|'TERMINATED',
'StatusReason': 'string',
'SubnetIds': [
'string',
],
'ServerArn': 'string'
}
}
Response Structure
(dict) --
Server (dict) --
The server that is created by the request.
AssociatePublicIpAddress (boolean) --
Associate a public IP address with a server that you are launching.
BackupRetentionCount (integer) --
The number of automated backups to keep.
ServerName (string) --
The name of the server.
CreatedAt (datetime) --
Time stamp of server creation. Example 2016-07-29T13:38:47.520Z
CloudFormationStackArn (string) --
The ARN of the CloudFormation stack that was used to create the server.
DisableAutomatedBackup (boolean) --
Disables automated backups. The number of stored backups is dependent on the value of PreferredBackupCount.
Endpoint (string) --
A DNS name that can be used to access the engine. Example: myserver-asdfghjkl.us-east-1.opsworks.io
Engine (string) --
The engine type of the server. The valid value in this release is Chef .
EngineModel (string) --
The engine model of the server. The valid value in this release is Single .
EngineAttributes (list) --
The response of a createServer() request returns the master credential to access the server in EngineAttributes. These credentials are not stored by AWS OpsWorks for Chef Automate; they are returned only as part of the result of createServer().
Attributes returned in a createServer response:
CHEF_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.
(dict) --
A name and value pair that is specific to the engine of the server.
Name (string) --
The name of the engine attribute.
Value (string) --
The value of the engine attribute.
EngineVersion (string) --
The engine version of the server. Because Chef is the engine available in this release, the valid value for EngineVersion is 12 .
InstanceProfileArn (string) --
The instance profile ARN of the server.
InstanceType (string) --
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.
KeyPair (string) --
The key pair associated with the server.
MaintenanceStatus (string) --
The status of the most recent server maintenance run. Shows SUCCESS or FAILED .
PreferredMaintenanceWindow (string) --
The preferred maintenance period specified for the server.
PreferredBackupWindow (string) --
The preferred backup period specified for the server.
SecurityGroupIds (list) --
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.
(string) --
ServiceRoleArn (string) --
The service role ARN used to create the server.
Status (string) --
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.
StatusReason (string) --
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).
SubnetIds (list) --
The subnet IDs specified in a CreateServer request.
(string) --
ServerArn (string) --
The ARN of the server.
{'Servers': {'AssociatePublicIpAddress': 'boolean',
'CloudFormationStackArn': 'string',
'Status': ['RESTORING', 'TERMINATED']}}
Lists all configuration management servers that are identified with your account. Only the stored results from Amazon DynamoDB are returned. AWS OpsWorks for Chef Automate does not query other services.
This operation is synchronous.
A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are not valid.
See also: AWS API Documentation
Request Syntax
client.describe_servers(
ServerName='string',
NextToken='string',
MaxResults=123
)
string
Describes the server with the specified ServerName.
string
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 DescribeServers 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.
integer
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.
dict
Response Syntax
{
'Servers': [
{
'AssociatePublicIpAddress': True|False,
'BackupRetentionCount': 123,
'ServerName': 'string',
'CreatedAt': datetime(2015, 1, 1),
'CloudFormationStackArn': 'string',
'DisableAutomatedBackup': True|False,
'Endpoint': 'string',
'Engine': 'string',
'EngineModel': 'string',
'EngineAttributes': [
{
'Name': 'string',
'Value': 'string'
},
],
'EngineVersion': 'string',
'InstanceProfileArn': 'string',
'InstanceType': 'string',
'KeyPair': 'string',
'MaintenanceStatus': 'SUCCESS'|'FAILED',
'PreferredMaintenanceWindow': 'string',
'PreferredBackupWindow': 'string',
'SecurityGroupIds': [
'string',
],
'ServiceRoleArn': 'string',
'Status': 'BACKING_UP'|'CONNECTION_LOST'|'CREATING'|'DELETING'|'MODIFYING'|'FAILED'|'HEALTHY'|'RUNNING'|'RESTORING'|'SETUP'|'UNDER_MAINTENANCE'|'UNHEALTHY'|'TERMINATED',
'StatusReason': 'string',
'SubnetIds': [
'string',
],
'ServerArn': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Servers (list) --
Contains the response to a DescribeServers request.
(dict) --
Describes a configuration management server.
AssociatePublicIpAddress (boolean) --
Associate a public IP address with a server that you are launching.
BackupRetentionCount (integer) --
The number of automated backups to keep.
ServerName (string) --
The name of the server.
CreatedAt (datetime) --
Time stamp of server creation. Example 2016-07-29T13:38:47.520Z
CloudFormationStackArn (string) --
The ARN of the CloudFormation stack that was used to create the server.
DisableAutomatedBackup (boolean) --
Disables automated backups. The number of stored backups is dependent on the value of PreferredBackupCount.
Endpoint (string) --
A DNS name that can be used to access the engine. Example: myserver-asdfghjkl.us-east-1.opsworks.io
Engine (string) --
The engine type of the server. The valid value in this release is Chef .
EngineModel (string) --
The engine model of the server. The valid value in this release is Single .
EngineAttributes (list) --
The response of a createServer() request returns the master credential to access the server in EngineAttributes. These credentials are not stored by AWS OpsWorks for Chef Automate; they are returned only as part of the result of createServer().
Attributes returned in a createServer response:
CHEF_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.
(dict) --
A name and value pair that is specific to the engine of the server.
Name (string) --
The name of the engine attribute.
Value (string) --
The value of the engine attribute.
EngineVersion (string) --
The engine version of the server. Because Chef is the engine available in this release, the valid value for EngineVersion is 12 .
InstanceProfileArn (string) --
The instance profile ARN of the server.
InstanceType (string) --
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.
KeyPair (string) --
The key pair associated with the server.
MaintenanceStatus (string) --
The status of the most recent server maintenance run. Shows SUCCESS or FAILED .
PreferredMaintenanceWindow (string) --
The preferred maintenance period specified for the server.
PreferredBackupWindow (string) --
The preferred backup period specified for the server.
SecurityGroupIds (list) --
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.
(string) --
ServiceRoleArn (string) --
The service role ARN used to create the server.
Status (string) --
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.
StatusReason (string) --
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).
SubnetIds (list) --
The subnet IDs specified in a CreateServer request.
(string) --
ServerArn (string) --
The ARN of the server.
NextToken (string) --
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 DescribeServers 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.
{'Server': {'AssociatePublicIpAddress': 'boolean',
'CloudFormationStackArn': 'string',
'Status': ['RESTORING', 'TERMINATED']}}
Manually starts server maintenance. This command can be useful if an earlier maintenance attempt failed, and the underlying cause of maintenance failure has been resolved. The server is in an UNDER_MAINTENANCE state while maintenance is in progress.
Maintenance can only be started on servers in HEALTHY and UNHEALTHY states. Otherwise, an InvalidStateException is thrown. A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are not valid.
See also: AWS API Documentation
Request Syntax
client.start_maintenance(
ServerName='string'
)
string
[REQUIRED]
The name of the server on which to run maintenance.
dict
Response Syntax
{
'Server': {
'AssociatePublicIpAddress': True|False,
'BackupRetentionCount': 123,
'ServerName': 'string',
'CreatedAt': datetime(2015, 1, 1),
'CloudFormationStackArn': 'string',
'DisableAutomatedBackup': True|False,
'Endpoint': 'string',
'Engine': 'string',
'EngineModel': 'string',
'EngineAttributes': [
{
'Name': 'string',
'Value': 'string'
},
],
'EngineVersion': 'string',
'InstanceProfileArn': 'string',
'InstanceType': 'string',
'KeyPair': 'string',
'MaintenanceStatus': 'SUCCESS'|'FAILED',
'PreferredMaintenanceWindow': 'string',
'PreferredBackupWindow': 'string',
'SecurityGroupIds': [
'string',
],
'ServiceRoleArn': 'string',
'Status': 'BACKING_UP'|'CONNECTION_LOST'|'CREATING'|'DELETING'|'MODIFYING'|'FAILED'|'HEALTHY'|'RUNNING'|'RESTORING'|'SETUP'|'UNDER_MAINTENANCE'|'UNHEALTHY'|'TERMINATED',
'StatusReason': 'string',
'SubnetIds': [
'string',
],
'ServerArn': 'string'
}
}
Response Structure
(dict) --
Server (dict) --
Contains the response to a StartMaintenance request.
AssociatePublicIpAddress (boolean) --
Associate a public IP address with a server that you are launching.
BackupRetentionCount (integer) --
The number of automated backups to keep.
ServerName (string) --
The name of the server.
CreatedAt (datetime) --
Time stamp of server creation. Example 2016-07-29T13:38:47.520Z
CloudFormationStackArn (string) --
The ARN of the CloudFormation stack that was used to create the server.
DisableAutomatedBackup (boolean) --
Disables automated backups. The number of stored backups is dependent on the value of PreferredBackupCount.
Endpoint (string) --
A DNS name that can be used to access the engine. Example: myserver-asdfghjkl.us-east-1.opsworks.io
Engine (string) --
The engine type of the server. The valid value in this release is Chef .
EngineModel (string) --
The engine model of the server. The valid value in this release is Single .
EngineAttributes (list) --
The response of a createServer() request returns the master credential to access the server in EngineAttributes. These credentials are not stored by AWS OpsWorks for Chef Automate; they are returned only as part of the result of createServer().
Attributes returned in a createServer response:
CHEF_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.
(dict) --
A name and value pair that is specific to the engine of the server.
Name (string) --
The name of the engine attribute.
Value (string) --
The value of the engine attribute.
EngineVersion (string) --
The engine version of the server. Because Chef is the engine available in this release, the valid value for EngineVersion is 12 .
InstanceProfileArn (string) --
The instance profile ARN of the server.
InstanceType (string) --
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.
KeyPair (string) --
The key pair associated with the server.
MaintenanceStatus (string) --
The status of the most recent server maintenance run. Shows SUCCESS or FAILED .
PreferredMaintenanceWindow (string) --
The preferred maintenance period specified for the server.
PreferredBackupWindow (string) --
The preferred backup period specified for the server.
SecurityGroupIds (list) --
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.
(string) --
ServiceRoleArn (string) --
The service role ARN used to create the server.
Status (string) --
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.
StatusReason (string) --
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).
SubnetIds (list) --
The subnet IDs specified in a CreateServer request.
(string) --
ServerArn (string) --
The ARN of the server.
{'Server': {'AssociatePublicIpAddress': 'boolean',
'CloudFormationStackArn': 'string',
'Status': ['RESTORING', 'TERMINATED']}}
Updates settings for a server.
This operation is synchronous.
See also: AWS API Documentation
Request Syntax
client.update_server(
DisableAutomatedBackup=True|False,
BackupRetentionCount=123,
ServerName='string',
PreferredMaintenanceWindow='string',
PreferredBackupWindow='string'
)
boolean
Setting DisableAutomatedBackup to true disables automated or scheduled backups. Automated backups are enabled by default.
integer
Sets the number of automated backups that you want to keep.
string
[REQUIRED]
The name of the server to update.
string
DDD:HH:MM (weekly start time) or HH:MM (daily start time).
Time windows always use coordinated universal time (UTC). Valid strings for day of week (DDD ) are: Mon , Tue , Wed , Thr , Fri , Sat , or Sun .
string
DDD:HH:MM (weekly start time) or HH:MM (daily start time).
Time windows always use coordinated universal time (UTC). Valid strings for day of week (DDD ) are: Mon , Tue , Wed , Thr , Fri , Sat , or Sun .
dict
Response Syntax
{
'Server': {
'AssociatePublicIpAddress': True|False,
'BackupRetentionCount': 123,
'ServerName': 'string',
'CreatedAt': datetime(2015, 1, 1),
'CloudFormationStackArn': 'string',
'DisableAutomatedBackup': True|False,
'Endpoint': 'string',
'Engine': 'string',
'EngineModel': 'string',
'EngineAttributes': [
{
'Name': 'string',
'Value': 'string'
},
],
'EngineVersion': 'string',
'InstanceProfileArn': 'string',
'InstanceType': 'string',
'KeyPair': 'string',
'MaintenanceStatus': 'SUCCESS'|'FAILED',
'PreferredMaintenanceWindow': 'string',
'PreferredBackupWindow': 'string',
'SecurityGroupIds': [
'string',
],
'ServiceRoleArn': 'string',
'Status': 'BACKING_UP'|'CONNECTION_LOST'|'CREATING'|'DELETING'|'MODIFYING'|'FAILED'|'HEALTHY'|'RUNNING'|'RESTORING'|'SETUP'|'UNDER_MAINTENANCE'|'UNHEALTHY'|'TERMINATED',
'StatusReason': 'string',
'SubnetIds': [
'string',
],
'ServerArn': 'string'
}
}
Response Structure
(dict) --
Server (dict) --
Contains the response to a UpdateServer request.
AssociatePublicIpAddress (boolean) --
Associate a public IP address with a server that you are launching.
BackupRetentionCount (integer) --
The number of automated backups to keep.
ServerName (string) --
The name of the server.
CreatedAt (datetime) --
Time stamp of server creation. Example 2016-07-29T13:38:47.520Z
CloudFormationStackArn (string) --
The ARN of the CloudFormation stack that was used to create the server.
DisableAutomatedBackup (boolean) --
Disables automated backups. The number of stored backups is dependent on the value of PreferredBackupCount.
Endpoint (string) --
A DNS name that can be used to access the engine. Example: myserver-asdfghjkl.us-east-1.opsworks.io
Engine (string) --
The engine type of the server. The valid value in this release is Chef .
EngineModel (string) --
The engine model of the server. The valid value in this release is Single .
EngineAttributes (list) --
The response of a createServer() request returns the master credential to access the server in EngineAttributes. These credentials are not stored by AWS OpsWorks for Chef Automate; they are returned only as part of the result of createServer().
Attributes returned in a createServer response:
CHEF_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.
(dict) --
A name and value pair that is specific to the engine of the server.
Name (string) --
The name of the engine attribute.
Value (string) --
The value of the engine attribute.
EngineVersion (string) --
The engine version of the server. Because Chef is the engine available in this release, the valid value for EngineVersion is 12 .
InstanceProfileArn (string) --
The instance profile ARN of the server.
InstanceType (string) --
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.
KeyPair (string) --
The key pair associated with the server.
MaintenanceStatus (string) --
The status of the most recent server maintenance run. Shows SUCCESS or FAILED .
PreferredMaintenanceWindow (string) --
The preferred maintenance period specified for the server.
PreferredBackupWindow (string) --
The preferred backup period specified for the server.
SecurityGroupIds (list) --
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.
(string) --
ServiceRoleArn (string) --
The service role ARN used to create the server.
Status (string) --
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.
StatusReason (string) --
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).
SubnetIds (list) --
The subnet IDs specified in a CreateServer request.
(string) --
ServerArn (string) --
The ARN of the server.
{'Server': {'AssociatePublicIpAddress': 'boolean',
'CloudFormationStackArn': 'string',
'Status': ['RESTORING', 'TERMINATED']}}
Updates engine-specific attributes on a specified server. The server enters the MODIFYING state when this operation is in progress. Only one update can occur at a time. You can use this command to reset the Chef server's private key (CHEF_PIVOTAL_KEY ).
This operation is asynchronous.
This operation can only be called for servers in HEALTHY or UNHEALTHY states. Otherwise, an InvalidStateException is raised. A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are not valid.
See also: AWS API Documentation
Request Syntax
client.update_server_engine_attributes(
ServerName='string',
AttributeName='string',
AttributeValue='string'
)
string
[REQUIRED]
The name of the server to update.
string
[REQUIRED]
The name of the engine attribute to update.
string
The value to set for the attribute.
dict
Response Syntax
{
'Server': {
'AssociatePublicIpAddress': True|False,
'BackupRetentionCount': 123,
'ServerName': 'string',
'CreatedAt': datetime(2015, 1, 1),
'CloudFormationStackArn': 'string',
'DisableAutomatedBackup': True|False,
'Endpoint': 'string',
'Engine': 'string',
'EngineModel': 'string',
'EngineAttributes': [
{
'Name': 'string',
'Value': 'string'
},
],
'EngineVersion': 'string',
'InstanceProfileArn': 'string',
'InstanceType': 'string',
'KeyPair': 'string',
'MaintenanceStatus': 'SUCCESS'|'FAILED',
'PreferredMaintenanceWindow': 'string',
'PreferredBackupWindow': 'string',
'SecurityGroupIds': [
'string',
],
'ServiceRoleArn': 'string',
'Status': 'BACKING_UP'|'CONNECTION_LOST'|'CREATING'|'DELETING'|'MODIFYING'|'FAILED'|'HEALTHY'|'RUNNING'|'RESTORING'|'SETUP'|'UNDER_MAINTENANCE'|'UNHEALTHY'|'TERMINATED',
'StatusReason': 'string',
'SubnetIds': [
'string',
],
'ServerArn': 'string'
}
}
Response Structure
(dict) --
Server (dict) --
Contains the response to an UpdateServerEngineAttributes request.
AssociatePublicIpAddress (boolean) --
Associate a public IP address with a server that you are launching.
BackupRetentionCount (integer) --
The number of automated backups to keep.
ServerName (string) --
The name of the server.
CreatedAt (datetime) --
Time stamp of server creation. Example 2016-07-29T13:38:47.520Z
CloudFormationStackArn (string) --
The ARN of the CloudFormation stack that was used to create the server.
DisableAutomatedBackup (boolean) --
Disables automated backups. The number of stored backups is dependent on the value of PreferredBackupCount.
Endpoint (string) --
A DNS name that can be used to access the engine. Example: myserver-asdfghjkl.us-east-1.opsworks.io
Engine (string) --
The engine type of the server. The valid value in this release is Chef .
EngineModel (string) --
The engine model of the server. The valid value in this release is Single .
EngineAttributes (list) --
The response of a createServer() request returns the master credential to access the server in EngineAttributes. These credentials are not stored by AWS OpsWorks for Chef Automate; they are returned only as part of the result of createServer().
Attributes returned in a createServer response:
CHEF_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.
(dict) --
A name and value pair that is specific to the engine of the server.
Name (string) --
The name of the engine attribute.
Value (string) --
The value of the engine attribute.
EngineVersion (string) --
The engine version of the server. Because Chef is the engine available in this release, the valid value for EngineVersion is 12 .
InstanceProfileArn (string) --
The instance profile ARN of the server.
InstanceType (string) --
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.
KeyPair (string) --
The key pair associated with the server.
MaintenanceStatus (string) --
The status of the most recent server maintenance run. Shows SUCCESS or FAILED .
PreferredMaintenanceWindow (string) --
The preferred maintenance period specified for the server.
PreferredBackupWindow (string) --
The preferred backup period specified for the server.
SecurityGroupIds (list) --
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.
(string) --
ServiceRoleArn (string) --
The service role ARN used to create the server.
Status (string) --
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.
StatusReason (string) --
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).
SubnetIds (list) --
The subnet IDs specified in a CreateServer request.
(string) --
ServerArn (string) --
The ARN of the server.