You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::OpsWorksCM::Types::Server
- Inherits:
-
Struct
- Object
- Struct
- Aws::OpsWorksCM::Types::Server
- Defined in:
- (unknown)
Overview
Describes a configuration management server.
Returned by:
Instance Attribute Summary collapse
-
#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.
#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. Example 2016-07-29T13:38:47.520Z
#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.
#disable_automated_backup ⇒ Boolean
Disables automated backups. The number of stored backups is dependent on the value of PreferredBackupCount.
#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.
#engine ⇒ String
The engine type of the server. Valid values in this release include
ChefAutomate
and Puppet
.
#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 .title
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 .title
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.
#engine_model ⇒ String
The engine model of the server. Valid values in this release include
Monolithic
for Puppet and Single
for Chef.
#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, the valid value is
2017
.
#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. This might not be the same instance type that is shown in the EC2 console.
#key_pair ⇒ String
The key pair associated with the server.
#maintenance_status ⇒ String
The status of the most recent server maintenance run. Shows SUCCESS
or
FAILED
.
Possible values:
- SUCCESS
- FAILED
#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. These might not be the same security groups that are shown in the EC2 console.
#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. 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.
Possible values:
- BACKING_UP
- CONNECTION_LOST
- CREATING
- DELETING
- MODIFYING
- FAILED
- HEALTHY
- RUNNING
- RESTORING
- SETUP
- UNDER_MAINTENANCE
- UNHEALTHY
- TERMINATED
#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.