Class: Aws::OpsWorksCM::Types::Server

Inherits:

Struct

• Object
• Struct
• Aws::OpsWorksCM::Types::Server

Defined in:

gems/aws-sdk-opsworkscm/lib/aws-sdk-opsworkscm/types.rb

Overview

Describes a configuration management server.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #associate_public_ip_address ⇒ Boolean

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

• #backup_retention_count ⇒ Integer

  The number of automated backups to keep.

• #cloud_formation_stack_arn ⇒ String

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

• #created_at ⇒ Time

  Time stamp of server creation.

• #custom_domain ⇒ String

  An optional public endpoint of a server, such as https://aws.my-company.com.

• #disable_automated_backup ⇒ Boolean

  Disables automated backups.

• #endpoint ⇒ String

  A DNS name that can be used to access the engine.

• #engine ⇒ String

  The engine type of the server.

• #engine_attributes ⇒ Array<Types::EngineAttribute>

  The response of a createServer() request returns the master credential to access the server in EngineAttributes.

• #engine_model ⇒ String

  The engine model of the server.

• #engine_version ⇒ String

  The engine version of the server.

• #instance_profile_arn ⇒ String

  The instance profile ARN of the server.

• #instance_type ⇒ String

  The instance type for the server, as specified in the CloudFormation stack.

• #key_pair ⇒ String

  The key pair associated with the server.

• #maintenance_status ⇒ String

  The status of the most recent server maintenance run.

• #preferred_backup_window ⇒ String

  The preferred backup period specified for the server.

• #preferred_maintenance_window ⇒ String

  The preferred maintenance period specified for the server.

• #security_group_ids ⇒ Array<String>

  The security group IDs for the server, as specified in the CloudFormation stack.

• #server_arn ⇒ String

  The ARN of the server.

• #server_name ⇒ String

  The name of the server.

• #service_role_arn ⇒ String

  The service role ARN used to create the server.

• #status ⇒ String

  The server's status.

• #status_reason ⇒ 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).

• #subnet_ids ⇒ Array<String>

  The subnet IDs specified in a CreateServer request.

Instance Attribute Details

#associate_public_ip_address ⇒ Boolean

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

Returns:

• (Boolean)

# File 'gems/aws-sdk-opsworkscm/lib/aws-sdk-opsworkscm/types.rb', line 1287

class Server < Struct.new(
  :associate_public_ip_address,
  :backup_retention_count,
  :server_name,
  :created_at,
  :cloud_formation_stack_arn,
  :custom_domain,
  :disable_automated_backup,
  :endpoint,
  :engine,
  :engine_model,
  :engine_attributes,
  :engine_version,
  :instance_profile_arn,
  :instance_type,
  :key_pair,
  :maintenance_status,
  :preferred_maintenance_window,
  :preferred_backup_window,
  :security_group_ids,
  :service_role_arn,
  :status,
  :status_reason,
  :subnet_ids,
  :server_arn)
  SENSITIVE = []
  include Aws::Structure
end

#backup_retention_count ⇒ Integer

The number of automated backups to keep.

Returns:

• (Integer)

# File 'gems/aws-sdk-opsworkscm/lib/aws-sdk-opsworkscm/types.rb', line 1287

class Server < Struct.new(
  :associate_public_ip_address,
  :backup_retention_count,
  :server_name,
  :created_at,
  :cloud_formation_stack_arn,
  :custom_domain,
  :disable_automated_backup,
  :endpoint,
  :engine,
  :engine_model,
  :engine_attributes,
  :engine_version,
  :instance_profile_arn,
  :instance_type,
  :key_pair,
  :maintenance_status,
  :preferred_maintenance_window,
  :preferred_backup_window,
  :security_group_ids,
  :service_role_arn,
  :status,
  :status_reason,
  :subnet_ids,
  :server_arn)
  SENSITIVE = []
  include Aws::Structure
end

#cloud_formation_stack_arn ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-opsworkscm/lib/aws-sdk-opsworkscm/types.rb', line 1287

class Server < Struct.new(
  :associate_public_ip_address,
  :backup_retention_count,
  :server_name,
  :created_at,
  :cloud_formation_stack_arn,
  :custom_domain,
  :disable_automated_backup,
  :endpoint,
  :engine,
  :engine_model,
  :engine_attributes,
  :engine_version,
  :instance_profile_arn,
  :instance_type,
  :key_pair,
  :maintenance_status,
  :preferred_maintenance_window,
  :preferred_backup_window,
  :security_group_ids,
  :service_role_arn,
  :status,
  :status_reason,
  :subnet_ids,
  :server_arn)
  SENSITIVE = []
  include Aws::Structure
end

#created_at ⇒ Time

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

Returns:

• (Time)

# File 'gems/aws-sdk-opsworkscm/lib/aws-sdk-opsworkscm/types.rb', line 1287

class Server < Struct.new(
  :associate_public_ip_address,
  :backup_retention_count,
  :server_name,
  :created_at,
  :cloud_formation_stack_arn,
  :custom_domain,
  :disable_automated_backup,
  :endpoint,
  :engine,
  :engine_model,
  :engine_attributes,
  :engine_version,
  :instance_profile_arn,
  :instance_type,
  :key_pair,
  :maintenance_status,
  :preferred_maintenance_window,
  :preferred_backup_window,
  :security_group_ids,
  :service_role_arn,
  :status,
  :status_reason,
  :subnet_ids,
  :server_arn)
  SENSITIVE = []
  include Aws::Structure
end

#custom_domain ⇒ String

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.

Returns:

• (String)

# File 'gems/aws-sdk-opsworkscm/lib/aws-sdk-opsworkscm/types.rb', line 1287

class Server < Struct.new(
  :associate_public_ip_address,
  :backup_retention_count,
  :server_name,
  :created_at,
  :cloud_formation_stack_arn,
  :custom_domain,
  :disable_automated_backup,
  :endpoint,
  :engine,
  :engine_model,
  :engine_attributes,
  :engine_version,
  :instance_profile_arn,
  :instance_type,
  :key_pair,
  :maintenance_status,
  :preferred_maintenance_window,
  :preferred_backup_window,
  :security_group_ids,
  :service_role_arn,
  :status,
  :status_reason,
  :subnet_ids,
  :server_arn)
  SENSITIVE = []
  include Aws::Structure
end

#disable_automated_backup ⇒ Boolean

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

Returns:

• (Boolean)

# File 'gems/aws-sdk-opsworkscm/lib/aws-sdk-opsworkscm/types.rb', line 1287

class Server < Struct.new(
  :associate_public_ip_address,
  :backup_retention_count,
  :server_name,
  :created_at,
  :cloud_formation_stack_arn,
  :custom_domain,
  :disable_automated_backup,
  :endpoint,
  :engine,
  :engine_model,
  :engine_attributes,
  :engine_version,
  :instance_profile_arn,
  :instance_type,
  :key_pair,
  :maintenance_status,
  :preferred_maintenance_window,
  :preferred_backup_window,
  :security_group_ids,
  :service_role_arn,
  :status,
  :status_reason,
  :subnet_ids,
  :server_arn)
  SENSITIVE = []
  include Aws::Structure
end

#endpoint ⇒ String

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.

Returns:

• (String)

# File 'gems/aws-sdk-opsworkscm/lib/aws-sdk-opsworkscm/types.rb', line 1287

class Server < Struct.new(
  :associate_public_ip_address,
  :backup_retention_count,
  :server_name,
  :created_at,
  :cloud_formation_stack_arn,
  :custom_domain,
  :disable_automated_backup,
  :endpoint,
  :engine,
  :engine_model,
  :engine_attributes,
  :engine_version,
  :instance_profile_arn,
  :instance_type,
  :key_pair,
  :maintenance_status,
  :preferred_maintenance_window,
  :preferred_backup_window,
  :security_group_ids,
  :service_role_arn,
  :status,
  :status_reason,
  :subnet_ids,
  :server_arn)
  SENSITIVE = []
  include Aws::Structure
end

#engine ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-opsworkscm/lib/aws-sdk-opsworkscm/types.rb', line 1287

class Server < Struct.new(
  :associate_public_ip_address,
  :backup_retention_count,
  :server_name,
  :created_at,
  :cloud_formation_stack_arn,
  :custom_domain,
  :disable_automated_backup,
  :endpoint,
  :engine,
  :engine_model,
  :engine_attributes,
  :engine_version,
  :instance_profile_arn,
  :instance_type,
  :key_pair,
  :maintenance_status,
  :preferred_maintenance_window,
  :preferred_backup_window,
  :security_group_ids,
  :service_role_arn,
  :status,
  :status_reason,
  :subnet_ids,
  :server_arn)
  SENSITIVE = []
  include Aws::Structure
end

#engine_attributes ⇒ Array<Types::EngineAttribute>

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.

Returns:

• (Array<Types::EngineAttribute>)

# File 'gems/aws-sdk-opsworkscm/lib/aws-sdk-opsworkscm/types.rb', line 1287

class Server < Struct.new(
  :associate_public_ip_address,
  :backup_retention_count,
  :server_name,
  :created_at,
  :cloud_formation_stack_arn,
  :custom_domain,
  :disable_automated_backup,
  :endpoint,
  :engine,
  :engine_model,
  :engine_attributes,
  :engine_version,
  :instance_profile_arn,
  :instance_type,
  :key_pair,
  :maintenance_status,
  :preferred_maintenance_window,
  :preferred_backup_window,
  :security_group_ids,
  :service_role_arn,
  :status,
  :status_reason,
  :subnet_ids,
  :server_arn)
  SENSITIVE = []
  include Aws::Structure
end

#engine_model ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-opsworkscm/lib/aws-sdk-opsworkscm/types.rb', line 1287

class Server < Struct.new(
  :associate_public_ip_address,
  :backup_retention_count,
  :server_name,
  :created_at,
  :cloud_formation_stack_arn,
  :custom_domain,
  :disable_automated_backup,
  :endpoint,
  :engine,
  :engine_model,
  :engine_attributes,
  :engine_version,
  :instance_profile_arn,
  :instance_type,
  :key_pair,
  :maintenance_status,
  :preferred_maintenance_window,
  :preferred_backup_window,
  :security_group_ids,
  :service_role_arn,
  :status,
  :status_reason,
  :subnet_ids,
  :server_arn)
  SENSITIVE = []
  include Aws::Structure
end

#engine_version ⇒ String

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.

Returns:

• (String)

# File 'gems/aws-sdk-opsworkscm/lib/aws-sdk-opsworkscm/types.rb', line 1287

class Server < Struct.new(
  :associate_public_ip_address,
  :backup_retention_count,
  :server_name,
  :created_at,
  :cloud_formation_stack_arn,
  :custom_domain,
  :disable_automated_backup,
  :endpoint,
  :engine,
  :engine_model,
  :engine_attributes,
  :engine_version,
  :instance_profile_arn,
  :instance_type,
  :key_pair,
  :maintenance_status,
  :preferred_maintenance_window,
  :preferred_backup_window,
  :security_group_ids,
  :service_role_arn,
  :status,
  :status_reason,
  :subnet_ids,
  :server_arn)
  SENSITIVE = []
  include Aws::Structure
end

#instance_profile_arn ⇒ String

The instance profile ARN of the server.

Returns:

• (String)

# File 'gems/aws-sdk-opsworkscm/lib/aws-sdk-opsworkscm/types.rb', line 1287

class Server < Struct.new(
  :associate_public_ip_address,
  :backup_retention_count,
  :server_name,
  :created_at,
  :cloud_formation_stack_arn,
  :custom_domain,
  :disable_automated_backup,
  :endpoint,
  :engine,
  :engine_model,
  :engine_attributes,
  :engine_version,
  :instance_profile_arn,
  :instance_type,
  :key_pair,
  :maintenance_status,
  :preferred_maintenance_window,
  :preferred_backup_window,
  :security_group_ids,
  :service_role_arn,
  :status,
  :status_reason,
  :subnet_ids,
  :server_arn)
  SENSITIVE = []
  include Aws::Structure
end

#instance_type ⇒ 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.

Returns:

• (String)

# File 'gems/aws-sdk-opsworkscm/lib/aws-sdk-opsworkscm/types.rb', line 1287

class Server < Struct.new(
  :associate_public_ip_address,
  :backup_retention_count,
  :server_name,
  :created_at,
  :cloud_formation_stack_arn,
  :custom_domain,
  :disable_automated_backup,
  :endpoint,
  :engine,
  :engine_model,
  :engine_attributes,
  :engine_version,
  :instance_profile_arn,
  :instance_type,
  :key_pair,
  :maintenance_status,
  :preferred_maintenance_window,
  :preferred_backup_window,
  :security_group_ids,
  :service_role_arn,
  :status,
  :status_reason,
  :subnet_ids,
  :server_arn)
  SENSITIVE = []
  include Aws::Structure
end

#key_pair ⇒ String

The key pair associated with the server.

Returns:

• (String)

# File 'gems/aws-sdk-opsworkscm/lib/aws-sdk-opsworkscm/types.rb', line 1287

class Server < Struct.new(
  :associate_public_ip_address,
  :backup_retention_count,
  :server_name,
  :created_at,
  :cloud_formation_stack_arn,
  :custom_domain,
  :disable_automated_backup,
  :endpoint,
  :engine,
  :engine_model,
  :engine_attributes,
  :engine_version,
  :instance_profile_arn,
  :instance_type,
  :key_pair,
  :maintenance_status,
  :preferred_maintenance_window,
  :preferred_backup_window,
  :security_group_ids,
  :service_role_arn,
  :status,
  :status_reason,
  :subnet_ids,
  :server_arn)
  SENSITIVE = []
  include Aws::Structure
end

#maintenance_status ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-opsworkscm/lib/aws-sdk-opsworkscm/types.rb', line 1287

class Server < Struct.new(
  :associate_public_ip_address,
  :backup_retention_count,
  :server_name,
  :created_at,
  :cloud_formation_stack_arn,
  :custom_domain,
  :disable_automated_backup,
  :endpoint,
  :engine,
  :engine_model,
  :engine_attributes,
  :engine_version,
  :instance_profile_arn,
  :instance_type,
  :key_pair,
  :maintenance_status,
  :preferred_maintenance_window,
  :preferred_backup_window,
  :security_group_ids,
  :service_role_arn,
  :status,
  :status_reason,
  :subnet_ids,
  :server_arn)
  SENSITIVE = []
  include Aws::Structure
end

#preferred_backup_window ⇒ String

The preferred backup period specified for the server.

Returns:

• (String)

# File 'gems/aws-sdk-opsworkscm/lib/aws-sdk-opsworkscm/types.rb', line 1287

class Server < Struct.new(
  :associate_public_ip_address,
  :backup_retention_count,
  :server_name,
  :created_at,
  :cloud_formation_stack_arn,
  :custom_domain,
  :disable_automated_backup,
  :endpoint,
  :engine,
  :engine_model,
  :engine_attributes,
  :engine_version,
  :instance_profile_arn,
  :instance_type,
  :key_pair,
  :maintenance_status,
  :preferred_maintenance_window,
  :preferred_backup_window,
  :security_group_ids,
  :service_role_arn,
  :status,
  :status_reason,
  :subnet_ids,
  :server_arn)
  SENSITIVE = []
  include Aws::Structure
end

#preferred_maintenance_window ⇒ String

The preferred maintenance period specified for the server.

Returns:

• (String)

# File 'gems/aws-sdk-opsworkscm/lib/aws-sdk-opsworkscm/types.rb', line 1287

class Server < Struct.new(
  :associate_public_ip_address,
  :backup_retention_count,
  :server_name,
  :created_at,
  :cloud_formation_stack_arn,
  :custom_domain,
  :disable_automated_backup,
  :endpoint,
  :engine,
  :engine_model,
  :engine_attributes,
  :engine_version,
  :instance_profile_arn,
  :instance_type,
  :key_pair,
  :maintenance_status,
  :preferred_maintenance_window,
  :preferred_backup_window,
  :security_group_ids,
  :service_role_arn,
  :status,
  :status_reason,
  :subnet_ids,
  :server_arn)
  SENSITIVE = []
  include Aws::Structure
end

#security_group_ids ⇒ Array<String>

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.

Returns:

• (Array<String>)

# File 'gems/aws-sdk-opsworkscm/lib/aws-sdk-opsworkscm/types.rb', line 1287

class Server < Struct.new(
  :associate_public_ip_address,
  :backup_retention_count,
  :server_name,
  :created_at,
  :cloud_formation_stack_arn,
  :custom_domain,
  :disable_automated_backup,
  :endpoint,
  :engine,
  :engine_model,
  :engine_attributes,
  :engine_version,
  :instance_profile_arn,
  :instance_type,
  :key_pair,
  :maintenance_status,
  :preferred_maintenance_window,
  :preferred_backup_window,
  :security_group_ids,
  :service_role_arn,
  :status,
  :status_reason,
  :subnet_ids,
  :server_arn)
  SENSITIVE = []
  include Aws::Structure
end

#server_arn ⇒ String

The ARN of the server.

Returns:

• (String)

# File 'gems/aws-sdk-opsworkscm/lib/aws-sdk-opsworkscm/types.rb', line 1287

class Server < Struct.new(
  :associate_public_ip_address,
  :backup_retention_count,
  :server_name,
  :created_at,
  :cloud_formation_stack_arn,
  :custom_domain,
  :disable_automated_backup,
  :endpoint,
  :engine,
  :engine_model,
  :engine_attributes,
  :engine_version,
  :instance_profile_arn,
  :instance_type,
  :key_pair,
  :maintenance_status,
  :preferred_maintenance_window,
  :preferred_backup_window,
  :security_group_ids,
  :service_role_arn,
  :status,
  :status_reason,
  :subnet_ids,
  :server_arn)
  SENSITIVE = []
  include Aws::Structure
end

#server_name ⇒ String

The name of the server.

Returns:

• (String)

# File 'gems/aws-sdk-opsworkscm/lib/aws-sdk-opsworkscm/types.rb', line 1287

class Server < Struct.new(
  :associate_public_ip_address,
  :backup_retention_count,
  :server_name,
  :created_at,
  :cloud_formation_stack_arn,
  :custom_domain,
  :disable_automated_backup,
  :endpoint,
  :engine,
  :engine_model,
  :engine_attributes,
  :engine_version,
  :instance_profile_arn,
  :instance_type,
  :key_pair,
  :maintenance_status,
  :preferred_maintenance_window,
  :preferred_backup_window,
  :security_group_ids,
  :service_role_arn,
  :status,
  :status_reason,
  :subnet_ids,
  :server_arn)
  SENSITIVE = []
  include Aws::Structure
end

#service_role_arn ⇒ String

The service role ARN used to create the server.

Returns:

• (String)

# File 'gems/aws-sdk-opsworkscm/lib/aws-sdk-opsworkscm/types.rb', line 1287

class Server < Struct.new(
  :associate_public_ip_address,
  :backup_retention_count,
  :server_name,
  :created_at,
  :cloud_formation_stack_arn,
  :custom_domain,
  :disable_automated_backup,
  :endpoint,
  :engine,
  :engine_model,
  :engine_attributes,
  :engine_version,
  :instance_profile_arn,
  :instance_type,
  :key_pair,
  :maintenance_status,
  :preferred_maintenance_window,
  :preferred_backup_window,
  :security_group_ids,
  :service_role_arn,
  :status,
  :status_reason,
  :subnet_ids,
  :server_arn)
  SENSITIVE = []
  include Aws::Structure
end

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

Returns:

• (String)

# File 'gems/aws-sdk-opsworkscm/lib/aws-sdk-opsworkscm/types.rb', line 1287

class Server < Struct.new(
  :associate_public_ip_address,
  :backup_retention_count,
  :server_name,
  :created_at,
  :cloud_formation_stack_arn,
  :custom_domain,
  :disable_automated_backup,
  :endpoint,
  :engine,
  :engine_model,
  :engine_attributes,
  :engine_version,
  :instance_profile_arn,
  :instance_type,
  :key_pair,
  :maintenance_status,
  :preferred_maintenance_window,
  :preferred_backup_window,
  :security_group_ids,
  :service_role_arn,
  :status,
  :status_reason,
  :subnet_ids,
  :server_arn)
  SENSITIVE = []
  include Aws::Structure
end

#status_reason ⇒ 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).

Returns:

• (String)

# File 'gems/aws-sdk-opsworkscm/lib/aws-sdk-opsworkscm/types.rb', line 1287

class Server < Struct.new(
  :associate_public_ip_address,
  :backup_retention_count,
  :server_name,
  :created_at,
  :cloud_formation_stack_arn,
  :custom_domain,
  :disable_automated_backup,
  :endpoint,
  :engine,
  :engine_model,
  :engine_attributes,
  :engine_version,
  :instance_profile_arn,
  :instance_type,
  :key_pair,
  :maintenance_status,
  :preferred_maintenance_window,
  :preferred_backup_window,
  :security_group_ids,
  :service_role_arn,
  :status,
  :status_reason,
  :subnet_ids,
  :server_arn)
  SENSITIVE = []
  include Aws::Structure
end

#subnet_ids ⇒ Array<String>

The subnet IDs specified in a CreateServer request.

Returns:

• (Array<String>)

# File 'gems/aws-sdk-opsworkscm/lib/aws-sdk-opsworkscm/types.rb', line 1287

class Server < Struct.new(
  :associate_public_ip_address,
  :backup_retention_count,
  :server_name,
  :created_at,
  :cloud_formation_stack_arn,
  :custom_domain,
  :disable_automated_backup,
  :endpoint,
  :engine,
  :engine_model,
  :engine_attributes,
  :engine_version,
  :instance_profile_arn,
  :instance_type,
  :key_pair,
  :maintenance_status,
  :preferred_maintenance_window,
  :preferred_backup_window,
  :security_group_ids,
  :service_role_arn,
  :status,
  :status_reason,
  :subnet_ids,
  :server_arn)
  SENSITIVE = []
  include Aws::Structure
end