Server

class Server

Describes a configuration management server.

Types

Link copied to clipboard
class Builder
Link copied to clipboard
object Companion

Properties

Link copied to clipboard

Associate a public IP address with a server that you are launching.

Link copied to clipboard

The number of automated backups to keep.

Link copied to clipboard

The ARN of the CloudFormation stack that was used to create the server.

Link copied to clipboard

Time stamp of server creation. Example 2016-07-29T13:38:47.520Z

Link copied to clipboard

An optional public endpoint of a server, such as http://aws.my-company.com. You cannot access the server by using the Endpoint value if the server has a CustomDomain specified.

Link copied to clipboard

Disables automated backups. The number of stored backups is dependent on the value of PreferredBackupCount.

Link copied to clipboard

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.

Link copied to clipboard

The engine type of the server. Valid values in this release include ChefAutomate and Puppet.

Link copied to clipboard

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().

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

The instance profile ARN of the server.

Link copied to clipboard

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.

Link copied to clipboard

The key pair associated with the server.

Link copied to clipboard

The status of the most recent server maintenance run. Shows SUCCESS or FAILED.

Link copied to clipboard

The preferred backup period specified for the server.

Link copied to clipboard

The preferred maintenance period specified for the server.

Link copied to clipboard

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.

Link copied to clipboard

The ARN of the server.

Link copied to clipboard

The name of the server.

Link copied to clipboard

The service role ARN used to create the server.

Link copied to clipboard

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.

Link copied to clipboard

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).

Link copied to clipboard

The subnet IDs specified in a CreateServer request.

Functions

Link copied to clipboard
inline fun copy(block: Server.Builder.() -> Unit = {}): Server
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard
open override fun toString(): String