NAME
Paws::OpsWorksCM::Server
USAGE
This class represents one of two things:
Arguments in a call to a service
Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. Each attribute should be used as a named argument in the calls that expect this type of object.
As an example, if Att1 is expected to be a Paws::OpsWorksCM::Server object:
$service_obj->Method(Att1 => { AssociatePublicIpAddress => $value, ..., SubnetIds => $value });
Results returned from an API call
Use accessors for each attribute. If Att1 is expected to be an Paws::OpsWorksCM::Server object:
$result = $service_obj->Method(...);
$result->Att1->AssociatePublicIpAddress
DESCRIPTION
Describes a configuration management server.
ATTRIBUTES
AssociatePublicIpAddress => Bool
Associate a public IP address with a server that you are launching.
BackupRetentionCount => Int
The number of automated backups to keep.
CloudFormationStackArn => Str
The ARN of the CloudFormation stack that was used to create the server.
CreatedAt => Str
Time stamp of server creation. Example C<2016-07-29T13:38:47.520Z>
DisableAutomatedBackup => Bool
Disables automated backups. The number of stored backups is dependent
on the value of PreferredBackupCount.
Endpoint => Str
A DNS name that can be used to access the engine. Example:
C<myserver-asdfghjkl.us-east-1.opsworks.io>
Engine => Str
The engine type of the server. The valid value in this release is
C<Chef>.
EngineAttributes => ArrayRef[Paws::OpsWorksCM::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.
EngineModel => Str
The engine model of the server. The valid value in this release is
C<Single>.
EngineVersion => Str
The engine version of the server. Because Chef is the engine available
in this release, the valid value for EngineVersion is C<12>.
InstanceProfileArn => Str
The instance profile ARN of the server.
InstanceType => Str
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.
KeyPair => Str
The key pair associated with the server.
MaintenanceStatus => Str
The status of the most recent server maintenance run. Shows C<SUCCESS>
or C<FAILED>.
PreferredBackupWindow => Str
The preferred backup period specified for the server.
PreferredMaintenanceWindow => Str
The preferred maintenance period specified for the server.
SecurityGroupIds => ArrayRef[Str|Undef]
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.
ServerArn => Str
The ARN of the server.
ServerName => Str
The name of the server.
ServiceRoleArn => Str
The service role ARN used to create the server.
Status => Str
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.
StatusReason => Str
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).
SubnetIds => ArrayRef[Str|Undef]
The subnet IDs specified in a CreateServer request.
SEE ALSO
This class forms part of Paws, describing an object used in Paws::OpsWorksCM
BUGS and CONTRIBUTIONS
The source code is located here: https://github.com/pplu/aws-sdk-perl
Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues