Paws::OpsWorksCM::CreateServer - Arguments for method CreateServer on Paws::OpsWorksCM
This class represents the parameters used for calling the method CreateServer on the AWS OpsWorks for Chef Automate service. Use the attributes of this class as arguments to method CreateServer.
You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateServer.
my $opsworks-cm = Paws->service('OpsWorksCM'); my $CreateServerResponse = $opsworks -cm->CreateServer( InstanceProfileArn => 'MyInstanceProfileArn', InstanceType => 'MyString', ServerName => 'MyServerName', ServiceRoleArn => 'MyServiceRoleArn', AssociatePublicIpAddress => 1, # OPTIONAL BackupId => 'MyBackupId', # OPTIONAL BackupRetentionCount => 1, # OPTIONAL DisableAutomatedBackup => 1, # OPTIONAL Engine => 'MyString', # OPTIONAL EngineAttributes => [ { Name => 'MyEngineAttributeName', # OPTIONAL Value => 'MyEngineAttributeValue', # OPTIONAL }, ... ], # OPTIONAL EngineModel => 'MyString', # OPTIONAL EngineVersion => 'MyString', # OPTIONAL KeyPair => 'MyKeyPair', # OPTIONAL PreferredBackupWindow => 'MyTimeWindowDefinition', # OPTIONAL PreferredMaintenanceWindow => 'MyTimeWindowDefinition', # OPTIONAL SecurityGroupIds => [ 'MyString', ... ], # OPTIONAL SubnetIds => [ 'MyString', ... ], # OPTIONAL ); # Results: my $Server = $CreateServerResponse->Server; # Returns a L<Paws::OpsWorksCM::CreateServerResponse> object.
Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/opsworks-cm/latest/APIReference/API_CreateServer.html
Associate a public IP address with a server that you are launching. Valid values are true or false. The default value is true.
true
false
If you specify this field, AWS OpsWorks CM creates the server by using the backup represented by BackupId.
The number of automated backups that you want to keep. Whenever a new backup is created, AWS OpsWorks CM deletes the oldest backups if this number is exceeded. The default value is 1.
1
Enable or disable scheduled backups. Valid values are true or false. The default value is true.
The configuration management engine to use. Valid values include Chef and Puppet.
Chef
Puppet
Optional engine attributes on a specified server.
Attributes accepted in a Chef createServer request:
CHEF_PIVOTAL_KEY: A base64-encoded RSA private key that is not stored by AWS OpsWorks for Chef Automate. This private key is required to access the Chef API. When no CHEF_PIVOTAL_KEY is set, one is generated and returned in the response.
CHEF_PIVOTAL_KEY
CHEF_DELIVERY_ADMIN_PASSWORD: The password for the administrative user in the Chef Automate GUI. The password length is a minimum of eight characters, and a maximum of 32. The password can contain letters, numbers, and special characters (!/@#$%^&+=_). The password must contain at least one lower case letter, one upper case letter, one number, and one special character. When no CHEF_DELIVERY_ADMIN_PASSWORD is set, one is generated and returned in the response.
CHEF_DELIVERY_ADMIN_PASSWORD
Attributes accepted in a Puppet createServer request:
PUPPET_ADMIN_PASSWORD: To work with the Puppet Enterprise console, a password must use ASCII characters.
PUPPET_ADMIN_PASSWORD
The engine model of the server. Valid values in this release include Monolithic for Puppet and Single for Chef.
Monolithic
Single
The major release version of the engine that you want to use. For a Chef server, the valid value for EngineVersion is currently 12. For a Puppet server, the valid value is 2017.
12
2017
The ARN of the instance profile that your Amazon EC2 instances use. Although the AWS OpsWorks console typically creates the instance profile for you, if you are using API commands instead, run the service-role-creation.yaml AWS CloudFormation template, located at https://s3.amazonaws.com/opsworks-cm-us-east-1-prod-default-assets/misc/opsworks-cm-roles.yaml. This template creates a CloudFormation stack that includes the instance profile you need.
The Amazon EC2 instance type to use. For example, m4.large. Recommended instance types include t2.medium and greater, m4.*, or c4.xlarge and greater.
m4.large
t2.medium
m4.*
c4.xlarge
The Amazon EC2 key pair to set for the instance. This parameter is optional; if desired, you may specify this parameter to connect to your instances by using SSH.
The start time for a one-hour period during which AWS OpsWorks CM backs up application-level data on your server if automated backups are enabled. Valid values must be specified in one of the following formats:
HH:MM for daily backups
HH:MM
DDD:HH:MM for weekly backups
DDD:HH:MM
The specified time is in coordinated universal time (UTC). The default value is a random, daily start time.
Example: 08:00, which represents a daily start time of 08:00 UTC.
08:00
Example: Mon:08:00, which represents a start time of every Monday at 08:00 UTC. (8:00 a.m.)
Mon:08:00
The start time for a one-hour period each week during which AWS OpsWorks CM performs maintenance on the instance. Valid values must be specified in the following format: DDD:HH:MM. The specified time is in coordinated universal time (UTC). The default value is a random one-hour period on Tuesday, Wednesday, or Friday. See TimeWindowDefinition for more information.
TimeWindowDefinition
A list of security group IDs to attach to the Amazon EC2 instance. If you add this parameter, the specified security groups must be within the VPC that is specified by SubnetIds.
SubnetIds
If you do not specify this parameter, AWS OpsWorks CM creates one new security group that uses TCP ports 22 and 443, open to 0.0.0.0/0 (everyone).
The name of the server. The server name must be unique within your AWS account, within each region. Server names must start with a letter; then letters, numbers, or hyphens (-) are allowed, up to a maximum of 40 characters.
The service role that the AWS OpsWorks CM service backend uses to work with your account. Although the AWS OpsWorks management console typically creates the service role for you, if you are using the AWS CLI or API commands, run the service-role-creation.yaml AWS CloudFormation template, located at https://s3.amazonaws.com/opsworks-cm-us-east-1-prod-default-assets/misc/opsworks-cm-roles.yaml. This template creates a CloudFormation stack that includes the service role and instance profile that you need.
The IDs of subnets in which to launch the server EC2 instance.
Amazon EC2-Classic customers: This field is required. All servers must run within a VPC. The VPC must have "Auto Assign Public IP" enabled.
EC2-VPC customers: This field is optional. If you do not specify subnet IDs, your EC2 instances are created in a default subnet that is selected by Amazon EC2. If you specify subnet IDs, the VPC must have "Auto Assign Public IP" enabled.
For more information about supported Amazon EC2 platforms, see Supported Platforms (http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-supported-platforms.html).
This class forms part of Paws, documenting arguments for method CreateServer in Paws::OpsWorksCM
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
To install Paws::SDK::Config, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Paws::SDK::Config
CPAN shell
perl -MCPAN -e shell install Paws::SDK::Config
For more information on module installation, please visit the detailed CPAN module installation guide.