class Aws::OpsWorksCM::Types::Server

Describes a configuration management server.

@!attribute [rw] associate_public_ip_address

Associate a public IP address with a server that you are launching.
@return [Boolean]

@!attribute [rw] backup_retention_count

The number of automated backups to keep.
@return [Integer]

@!attribute [rw] server_name

The name of the server.
@return [String]

@!attribute [rw] created_at

Time stamp of server creation. Example `2016-07-29T13:38:47.520Z`
@return [Time]

@!attribute [rw] cloud_formation_stack_arn

The ARN of the CloudFormation stack that was used to create the
server.
@return [String]

@!attribute [rw] custom_domain

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.
@return [String]

@!attribute [rw] disable_automated_backup

Disables automated backups. The number of stored backups is
dependent on the value of PreferredBackupCount.
@return [Boolean]

@!attribute [rw] endpoint

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.
@return [String]

@!attribute [rw] engine

The engine type of the server. Valid values in this release include
`ChefAutomate` and `Puppet`.
@return [String]

@!attribute [rw] engine_model

The engine model of the server. Valid values in this release include
`Monolithic` for Puppet and `Single` for Chef.
@return [String]

@!attribute [rw] engine_attributes

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.
@return [Array<Types::EngineAttribute>]

@!attribute [rw] engine_version

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`.
@return [String]

@!attribute [rw] instance_profile_arn

The instance profile ARN of the server.
@return [String]

@!attribute [rw] instance_type

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.
@return [String]

@!attribute [rw] key_pair

The key pair associated with the server.
@return [String]

@!attribute [rw] maintenance_status

The status of the most recent server maintenance run. Shows
`SUCCESS` or `FAILED`.
@return [String]

@!attribute [rw] preferred_maintenance_window

The preferred maintenance period specified for the server.
@return [String]

@!attribute [rw] preferred_backup_window

The preferred backup period specified for the server.
@return [String]

@!attribute [rw] security_group_ids

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.
@return [Array<String>]

@!attribute [rw] service_role_arn

The service role ARN used to create the server.
@return [String]

@!attribute [rw] status

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.
@return [String]

@!attribute [rw] status_reason

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).
@return [String]

@!attribute [rw] subnet_ids

The subnet IDs specified in a CreateServer request.
@return [Array<String>]

@!attribute [rw] server_arn

The ARN of the server.
@return [String]

@see docs.aws.amazon.com/goto/WebAPI/opsworkscm-2016-11-01/Server AWS API Documentation

Constants

SENSITIVE