You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-opsworkscm/lib/aws-sdk-opsworkscm/types.rb

Overview

Describes a configuration management server.

Instance Attribute Summary collapse

Instance Attribute Details

#associate_public_ip_addressBoolean

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

Returns:

  • (Boolean)


1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
# File 'gems/aws-sdk-opsworkscm/lib/aws-sdk-opsworkscm/types.rb', line 1071

class Server < Struct.new(
  :associate_public_ip_address,
  :backup_retention_count,
  :server_name,
  :created_at,
  :cloud_formation_stack_arn,
  :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)
  include Aws::Structure
end

#backup_retention_countInteger

The number of automated backups to keep.

Returns:

  • (Integer)


1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
# File 'gems/aws-sdk-opsworkscm/lib/aws-sdk-opsworkscm/types.rb', line 1071

class Server < Struct.new(
  :associate_public_ip_address,
  :backup_retention_count,
  :server_name,
  :created_at,
  :cloud_formation_stack_arn,
  :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)
  include Aws::Structure
end

#cloud_formation_stack_arnString

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

Returns:

  • (String)


1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
# File 'gems/aws-sdk-opsworkscm/lib/aws-sdk-opsworkscm/types.rb', line 1071

class Server < Struct.new(
  :associate_public_ip_address,
  :backup_retention_count,
  :server_name,
  :created_at,
  :cloud_formation_stack_arn,
  :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)
  include Aws::Structure
end

#created_atTime

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

Returns:

  • (Time)


1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
# File 'gems/aws-sdk-opsworkscm/lib/aws-sdk-opsworkscm/types.rb', line 1071

class Server < Struct.new(
  :associate_public_ip_address,
  :backup_retention_count,
  :server_name,
  :created_at,
  :cloud_formation_stack_arn,
  :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)
  include Aws::Structure
end

#disable_automated_backupBoolean

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

Returns:

  • (Boolean)


1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
# File 'gems/aws-sdk-opsworkscm/lib/aws-sdk-opsworkscm/types.rb', line 1071

class Server < Struct.new(
  :associate_public_ip_address,
  :backup_retention_count,
  :server_name,
  :created_at,
  :cloud_formation_stack_arn,
  :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)
  include Aws::Structure
end

#endpointString

A DNS name that can be used to access the engine. Example: myserver-asdfghjkl.us-east-1.opsworks.io

Returns:

  • (String)


1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
# File 'gems/aws-sdk-opsworkscm/lib/aws-sdk-opsworkscm/types.rb', line 1071

class Server < Struct.new(
  :associate_public_ip_address,
  :backup_retention_count,
  :server_name,
  :created_at,
  :cloud_formation_stack_arn,
  :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)
  include Aws::Structure
end

#engineString

The engine type of the server. The valid value in this release is Chef.

Returns:

  • (String)


1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
# File 'gems/aws-sdk-opsworkscm/lib/aws-sdk-opsworkscm/types.rb', line 1071

class Server < Struct.new(
  :associate_public_ip_address,
  :backup_retention_count,
  :server_name,
  :created_at,
  :cloud_formation_stack_arn,
  :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)
  include Aws::Structure
end

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

Returns:



1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
# File 'gems/aws-sdk-opsworkscm/lib/aws-sdk-opsworkscm/types.rb', line 1071

class Server < Struct.new(
  :associate_public_ip_address,
  :backup_retention_count,
  :server_name,
  :created_at,
  :cloud_formation_stack_arn,
  :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)
  include Aws::Structure
end

#engine_modelString

The engine model of the server. The valid value in this release is Single.

Returns:

  • (String)


1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
# File 'gems/aws-sdk-opsworkscm/lib/aws-sdk-opsworkscm/types.rb', line 1071

class Server < Struct.new(
  :associate_public_ip_address,
  :backup_retention_count,
  :server_name,
  :created_at,
  :cloud_formation_stack_arn,
  :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)
  include Aws::Structure
end

#engine_versionString

The engine version of the server. Because Chef is the engine available in this release, the valid value for EngineVersion is 12.

Returns:

  • (String)


1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
# File 'gems/aws-sdk-opsworkscm/lib/aws-sdk-opsworkscm/types.rb', line 1071

class Server < Struct.new(
  :associate_public_ip_address,
  :backup_retention_count,
  :server_name,
  :created_at,
  :cloud_formation_stack_arn,
  :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)
  include Aws::Structure
end

#instance_profile_arnString

The instance profile ARN of the server.

Returns:

  • (String)


1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
# File 'gems/aws-sdk-opsworkscm/lib/aws-sdk-opsworkscm/types.rb', line 1071

class Server < Struct.new(
  :associate_public_ip_address,
  :backup_retention_count,
  :server_name,
  :created_at,
  :cloud_formation_stack_arn,
  :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)
  include Aws::Structure
end

#instance_typeString

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)


1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
# File 'gems/aws-sdk-opsworkscm/lib/aws-sdk-opsworkscm/types.rb', line 1071

class Server < Struct.new(
  :associate_public_ip_address,
  :backup_retention_count,
  :server_name,
  :created_at,
  :cloud_formation_stack_arn,
  :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)
  include Aws::Structure
end

#key_pairString

The key pair associated with the server.

Returns:

  • (String)


1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
# File 'gems/aws-sdk-opsworkscm/lib/aws-sdk-opsworkscm/types.rb', line 1071

class Server < Struct.new(
  :associate_public_ip_address,
  :backup_retention_count,
  :server_name,
  :created_at,
  :cloud_formation_stack_arn,
  :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)
  include Aws::Structure
end

#maintenance_statusString

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

Returns:

  • (String)


1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
# File 'gems/aws-sdk-opsworkscm/lib/aws-sdk-opsworkscm/types.rb', line 1071

class Server < Struct.new(
  :associate_public_ip_address,
  :backup_retention_count,
  :server_name,
  :created_at,
  :cloud_formation_stack_arn,
  :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)
  include Aws::Structure
end

#preferred_backup_windowString

The preferred backup period specified for the server.

Returns:

  • (String)


1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
# File 'gems/aws-sdk-opsworkscm/lib/aws-sdk-opsworkscm/types.rb', line 1071

class Server < Struct.new(
  :associate_public_ip_address,
  :backup_retention_count,
  :server_name,
  :created_at,
  :cloud_formation_stack_arn,
  :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)
  include Aws::Structure
end

#preferred_maintenance_windowString

The preferred maintenance period specified for the server.

Returns:

  • (String)


1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
# File 'gems/aws-sdk-opsworkscm/lib/aws-sdk-opsworkscm/types.rb', line 1071

class Server < Struct.new(
  :associate_public_ip_address,
  :backup_retention_count,
  :server_name,
  :created_at,
  :cloud_formation_stack_arn,
  :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)
  include Aws::Structure
end

#security_group_idsArray<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>)


1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
# File 'gems/aws-sdk-opsworkscm/lib/aws-sdk-opsworkscm/types.rb', line 1071

class Server < Struct.new(
  :associate_public_ip_address,
  :backup_retention_count,
  :server_name,
  :created_at,
  :cloud_formation_stack_arn,
  :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)
  include Aws::Structure
end

#server_arnString

The ARN of the server.

Returns:

  • (String)


1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
# File 'gems/aws-sdk-opsworkscm/lib/aws-sdk-opsworkscm/types.rb', line 1071

class Server < Struct.new(
  :associate_public_ip_address,
  :backup_retention_count,
  :server_name,
  :created_at,
  :cloud_formation_stack_arn,
  :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)
  include Aws::Structure
end

#server_nameString

The name of the server.

Returns:

  • (String)


1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
# File 'gems/aws-sdk-opsworkscm/lib/aws-sdk-opsworkscm/types.rb', line 1071

class Server < Struct.new(
  :associate_public_ip_address,
  :backup_retention_count,
  :server_name,
  :created_at,
  :cloud_formation_stack_arn,
  :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)
  include Aws::Structure
end

#service_role_arnString

The service role ARN used to create the server.

Returns:

  • (String)


1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
# File 'gems/aws-sdk-opsworkscm/lib/aws-sdk-opsworkscm/types.rb', line 1071

class Server < Struct.new(
  :associate_public_ip_address,
  :backup_retention_count,
  :server_name,
  :created_at,
  :cloud_formation_stack_arn,
  :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)
  include Aws::Structure
end

#statusString

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)


1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
# File 'gems/aws-sdk-opsworkscm/lib/aws-sdk-opsworkscm/types.rb', line 1071

class Server < Struct.new(
  :associate_public_ip_address,
  :backup_retention_count,
  :server_name,
  :created_at,
  :cloud_formation_stack_arn,
  :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)
  include Aws::Structure
end

#status_reasonString

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)


1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
# File 'gems/aws-sdk-opsworkscm/lib/aws-sdk-opsworkscm/types.rb', line 1071

class Server < Struct.new(
  :associate_public_ip_address,
  :backup_retention_count,
  :server_name,
  :created_at,
  :cloud_formation_stack_arn,
  :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)
  include Aws::Structure
end

#subnet_idsArray<String>

The subnet IDs specified in a CreateServer request.

Returns:

  • (Array<String>)


1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
# File 'gems/aws-sdk-opsworkscm/lib/aws-sdk-opsworkscm/types.rb', line 1071

class Server < Struct.new(
  :associate_public_ip_address,
  :backup_retention_count,
  :server_name,
  :created_at,
  :cloud_formation_stack_arn,
  :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)
  include Aws::Structure
end