/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::OpsWorksCM::Server

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 2016-07-29T13:38:47.520Z

CustomDomain => Str

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.

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: 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 => Str

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

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

EngineModel => Str

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

EngineVersion => Str

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.

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 SUCCESS or 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