Server
import type { Server } from "https://aws-api.deno.dev/v0.4/services/opsworkscm.ts?docs=full";
Describes a configuration management server.
§Properties
Associate a public IP address with a server that you are launching.
The ARN of the CloudFormation stack that was used to create the server.
Time stamp of server creation.
Example 2016-07-29T13:38:47.520Z
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.
Disables automated backups. The number of stored backups is dependent on the value of PreferredBackupCount.
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.
The engine type of the server.
Valid values in this release include ChefAutomate
and Puppet
.
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.
The engine model of the server.
Valid values in this release include Monolithic
for Puppet and Single
for Chef.
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
.
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.
The status of the most recent server maintenance run.
Shows SUCCESS
or FAILED
.
The preferred maintenance period specified for the server.
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.
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.