« blib/lib/Paws/Lightsail/CreateInstanceSnapshotResult.pm
↑ Summary
blib/lib/Paws/Lightsail/CreateInstancesFromSnapshot.pm »
| 1 | |||
| 2 | package Paws::Lightsail::CreateInstances; | ||
| 3 | use Moose; | ||
| 4 | has AddOns => (is => 'ro', isa => 'ArrayRef[Paws::Lightsail::AddOnRequest]', traits => ['NameInRequest'], request_name => 'addOns' ); | ||
| 5 | has AvailabilityZone => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'availabilityZone' , required => 1); | ||
| 6 | has BlueprintId => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'blueprintId' , required => 1); | ||
| 7 | has BundleId => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'bundleId' , required => 1); | ||
| 8 | has CustomImageName => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'customImageName' ); | ||
| 9 | has InstanceNames => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['NameInRequest'], request_name => 'instanceNames' , required => 1); | ||
| 10 | has IpAddressType => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'ipAddressType' ); | ||
| 11 | has KeyPairName => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'keyPairName' ); | ||
| 12 | has Tags => (is => 'ro', isa => 'ArrayRef[Paws::Lightsail::Tag]', traits => ['NameInRequest'], request_name => 'tags' ); | ||
| 13 | has UserData => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'userData' ); | ||
| 14 | |||
| 15 | use MooseX::ClassAttribute; | ||
| 16 | |||
| 17 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateInstances'); | ||
| 18 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Lightsail::CreateInstancesResult'); | ||
| 19 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 20 | 1; | ||
| 21 | |||
| 22 | ### main pod documentation begin ### | ||
| 23 | |||
| 24 | =head1 NAME | ||
| 25 | |||
| 26 | Paws::Lightsail::CreateInstances - Arguments for method CreateInstances on L<Paws::Lightsail> | ||
| 27 | |||
| 28 | =head1 DESCRIPTION | ||
| 29 | |||
| 30 | This class represents the parameters used for calling the method CreateInstances on the | ||
| 31 | L<Amazon Lightsail|Paws::Lightsail> service. Use the attributes of this class | ||
| 32 | as arguments to method CreateInstances. | ||
| 33 | |||
| 34 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateInstances. | ||
| 35 | |||
| 36 | =head1 SYNOPSIS | ||
| 37 | |||
| 38 | my $lightsail = Paws->service('Lightsail'); | ||
| 39 | my $CreateInstancesResult = $lightsail->CreateInstances( | ||
| 40 | AvailabilityZone => 'Mystring', | ||
| 41 | BlueprintId => 'MyNonEmptyString', | ||
| 42 | BundleId => 'MyNonEmptyString', | ||
| 43 | InstanceNames => [ 'Mystring', ... ], | ||
| 44 | AddOns => [ | ||
| 45 | { | ||
| 46 | AddOnType => 'AutoSnapshot', # values: AutoSnapshot | ||
| 47 | AutoSnapshotAddOnRequest => { | ||
| 48 | SnapshotTimeOfDay => 'MyTimeOfDay', # OPTIONAL | ||
| 49 | }, # OPTIONAL | ||
| 50 | }, | ||
| 51 | ... | ||
| 52 | ], # OPTIONAL | ||
| 53 | CustomImageName => 'MyResourceName', # OPTIONAL | ||
| 54 | IpAddressType => 'dualstack', # OPTIONAL | ||
| 55 | KeyPairName => 'MyResourceName', # OPTIONAL | ||
| 56 | Tags => [ | ||
| 57 | { | ||
| 58 | Key => 'MyTagKey', # OPTIONAL | ||
| 59 | Value => 'MyTagValue', # OPTIONAL | ||
| 60 | }, | ||
| 61 | ... | ||
| 62 | ], # OPTIONAL | ||
| 63 | UserData => 'Mystring', # OPTIONAL | ||
| 64 | ); | ||
| 65 | |||
| 66 | # Results: | ||
| 67 | my $Operations = $CreateInstancesResult->Operations; | ||
| 68 | |||
| 69 | # Returns a L<Paws::Lightsail::CreateInstancesResult> object. | ||
| 70 | |||
| 71 | 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. | ||
| 72 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/lightsail/CreateInstances> | ||
| 73 | |||
| 74 | =head1 ATTRIBUTES | ||
| 75 | |||
| 76 | |||
| 77 | =head2 AddOns => ArrayRef[L<Paws::Lightsail::AddOnRequest>] | ||
| 78 | |||
| 79 | An array of objects representing the add-ons to enable for the new | ||
| 80 | instance. | ||
| 81 | |||
| 82 | |||
| 83 | |||
| 84 | =head2 B<REQUIRED> AvailabilityZone => Str | ||
| 85 | |||
| 86 | The Availability Zone in which to create your instance. Use the | ||
| 87 | following format: C<us-east-2a> (case sensitive). You can get a list of | ||
| 88 | Availability Zones by using the get regions | ||
| 89 | (http://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_GetRegions.html) | ||
| 90 | operation. Be sure to add the C<include Availability Zones> parameter | ||
| 91 | to your request. | ||
| 92 | |||
| 93 | |||
| 94 | |||
| 95 | =head2 B<REQUIRED> BlueprintId => Str | ||
| 96 | |||
| 97 | The ID for a virtual private server image (e.g., C<app_wordpress_4_4> | ||
| 98 | or C<app_lamp_7_0>). Use the C<get blueprints> operation to return a | ||
| 99 | list of available images (or I<blueprints>). | ||
| 100 | |||
| 101 | Use active blueprints when creating new instances. Inactive blueprints | ||
| 102 | are listed to support customers with existing instances and are not | ||
| 103 | necessarily available to create new instances. Blueprints are marked | ||
| 104 | inactive when they become outdated due to operating system updates or | ||
| 105 | new application releases. | ||
| 106 | |||
| 107 | |||
| 108 | |||
| 109 | =head2 B<REQUIRED> BundleId => Str | ||
| 110 | |||
| 111 | The bundle of specification information for your virtual private server | ||
| 112 | (or I<instance>), including the pricing plan (e.g., C<micro_1_0>). | ||
| 113 | |||
| 114 | |||
| 115 | |||
| 116 | =head2 CustomImageName => Str | ||
| 117 | |||
| 118 | (Deprecated) The name for your custom image. | ||
| 119 | |||
| 120 | In releases prior to June 12, 2017, this parameter was ignored by the | ||
| 121 | API. It is now deprecated. | ||
| 122 | |||
| 123 | |||
| 124 | |||
| 125 | =head2 B<REQUIRED> InstanceNames => ArrayRef[Str|Undef] | ||
| 126 | |||
| 127 | The names to use for your new Lightsail instances. Separate multiple | ||
| 128 | values using quotation marks and commas, for example: | ||
| 129 | C<["MyFirstInstance","MySecondInstance"]> | ||
| 130 | |||
| 131 | |||
| 132 | |||
| 133 | =head2 IpAddressType => Str | ||
| 134 | |||
| 135 | The IP address type for the instance. | ||
| 136 | |||
| 137 | The possible values are C<ipv4> for IPv4 only, and C<dualstack> for | ||
| 138 | IPv4 and IPv6. | ||
| 139 | |||
| 140 | The default value is C<dualstack>. | ||
| 141 | |||
| 142 | Valid values are: C<"dualstack">, C<"ipv4"> | ||
| 143 | |||
| 144 | =head2 KeyPairName => Str | ||
| 145 | |||
| 146 | The name of your key pair. | ||
| 147 | |||
| 148 | |||
| 149 | |||
| 150 | =head2 Tags => ArrayRef[L<Paws::Lightsail::Tag>] | ||
| 151 | |||
| 152 | The tag keys and optional values to add to the resource during create. | ||
| 153 | |||
| 154 | Use the C<TagResource> action to tag a resource after it's created. | ||
| 155 | |||
| 156 | |||
| 157 | |||
| 158 | =head2 UserData => Str | ||
| 159 | |||
| 160 | A launch script you can create that configures a server with additional | ||
| 161 | user data. For example, you might want to run C<apt-get -y update>. | ||
| 162 | |||
| 163 | Depending on the machine image you choose, the command to get software | ||
| 164 | on your instance varies. Amazon Linux and CentOS use C<yum>, Debian and | ||
| 165 | Ubuntu use C<apt-get>, and FreeBSD uses C<pkg>. For a complete list, | ||
| 166 | see the Dev Guide | ||
| 167 | (https://lightsail.aws.amazon.com/ls/docs/getting-started/article/compare-options-choose-lightsail-instance-image). | ||
| 168 | |||
| 169 | |||
| 170 | |||
| 171 | |||
| 172 | =head1 SEE ALSO | ||
| 173 | |||
| 174 | This class forms part of L<Paws>, documenting arguments for method CreateInstances in L<Paws::Lightsail> | ||
| 175 | |||
| 176 | =head1 BUGS and CONTRIBUTIONS | ||
| 177 | |||
| 178 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 179 | |||
| 180 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 181 | |||
| 182 | =cut | ||
| 183 |