« blib/lib/Paws/AutoScaling/CompleteLifecycleActionAnswer.pm
↑ Summary
blib/lib/Paws/AutoScaling/CreateOrUpdateTags.pm »
| 1 | |||
| 2 | package Paws::AutoScaling::CreateLaunchConfiguration; | ||
| 3 | use Moose; | ||
| 4 | has AssociatePublicIpAddress => (is => 'ro', isa => 'Bool'); | ||
| 5 | has BlockDeviceMappings => (is => 'ro', isa => 'ArrayRef[Paws::AutoScaling::BlockDeviceMapping]'); | ||
| 6 | has ClassicLinkVPCId => (is => 'ro', isa => 'Str'); | ||
| 7 | has ClassicLinkVPCSecurityGroups => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 8 | has EbsOptimized => (is => 'ro', isa => 'Bool'); | ||
| 9 | has IamInstanceProfile => (is => 'ro', isa => 'Str'); | ||
| 10 | has ImageId => (is => 'ro', isa => 'Str'); | ||
| 11 | has InstanceId => (is => 'ro', isa => 'Str'); | ||
| 12 | has InstanceMonitoring => (is => 'ro', isa => 'Paws::AutoScaling::InstanceMonitoring'); | ||
| 13 | has InstanceType => (is => 'ro', isa => 'Str'); | ||
| 14 | has KernelId => (is => 'ro', isa => 'Str'); | ||
| 15 | has KeyName => (is => 'ro', isa => 'Str'); | ||
| 16 | has LaunchConfigurationName => (is => 'ro', isa => 'Str', required => 1); | ||
| 17 | has MetadataOptions => (is => 'ro', isa => 'Paws::AutoScaling::InstanceMetadataOptions'); | ||
| 18 | has PlacementTenancy => (is => 'ro', isa => 'Str'); | ||
| 19 | has RamdiskId => (is => 'ro', isa => 'Str'); | ||
| 20 | has SecurityGroups => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 21 | has SpotPrice => (is => 'ro', isa => 'Str'); | ||
| 22 | has UserData => (is => 'ro', isa => 'Str'); | ||
| 23 | |||
| 24 | use MooseX::ClassAttribute; | ||
| 25 | |||
| 26 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateLaunchConfiguration'); | ||
| 27 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::API::Response'); | ||
| 28 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 29 | 1; | ||
| 30 | |||
| 31 | ### main pod documentation begin ### | ||
| 32 | |||
| 33 | =head1 NAME | ||
| 34 | |||
| 35 | Paws::AutoScaling::CreateLaunchConfiguration - Arguments for method CreateLaunchConfiguration on L<Paws::AutoScaling> | ||
| 36 | |||
| 37 | =head1 DESCRIPTION | ||
| 38 | |||
| 39 | This class represents the parameters used for calling the method CreateLaunchConfiguration on the | ||
| 40 | L<Auto Scaling|Paws::AutoScaling> service. Use the attributes of this class | ||
| 41 | as arguments to method CreateLaunchConfiguration. | ||
| 42 | |||
| 43 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateLaunchConfiguration. | ||
| 44 | |||
| 45 | =head1 SYNOPSIS | ||
| 46 | |||
| 47 | my $autoscaling = Paws->service('AutoScaling'); | ||
| 48 | # To create a launch configuration | ||
| 49 | # This example creates a launch configuration. | ||
| 50 | $autoscaling->CreateLaunchConfiguration( | ||
| 51 | 'IamInstanceProfile' => 'my-iam-role', | ||
| 52 | 'ImageId' => 'ami-12345678', | ||
| 53 | 'InstanceType' => 'm3.medium', | ||
| 54 | 'LaunchConfigurationName' => 'my-launch-config', | ||
| 55 | 'SecurityGroups' => ['sg-eb2af88e'] | ||
| 56 | ); | ||
| 57 | |||
| 58 | |||
| 59 | 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. | ||
| 60 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/autoscaling/CreateLaunchConfiguration> | ||
| 61 | |||
| 62 | =head1 ATTRIBUTES | ||
| 63 | |||
| 64 | |||
| 65 | =head2 AssociatePublicIpAddress => Bool | ||
| 66 | |||
| 67 | For Auto Scaling groups that are running in a virtual private cloud | ||
| 68 | (VPC), specifies whether to assign a public IP address to the group's | ||
| 69 | instances. If you specify C<true>, each instance in the Auto Scaling | ||
| 70 | group receives a unique public IP address. For more information, see | ||
| 71 | Launching Auto Scaling instances in a VPC | ||
| 72 | (https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-in-vpc.html) | ||
| 73 | in the I<Amazon EC2 Auto Scaling User Guide>. | ||
| 74 | |||
| 75 | If you specify this parameter, you must specify at least one subnet for | ||
| 76 | C<VPCZoneIdentifier> when you create your group. | ||
| 77 | |||
| 78 | If the instance is launched into a default subnet, the default is to | ||
| 79 | assign a public IP address, unless you disabled the option to assign a | ||
| 80 | public IP address on the subnet. If the instance is launched into a | ||
| 81 | nondefault subnet, the default is not to assign a public IP address, | ||
| 82 | unless you enabled the option to assign a public IP address on the | ||
| 83 | subnet. | ||
| 84 | |||
| 85 | |||
| 86 | |||
| 87 | =head2 BlockDeviceMappings => ArrayRef[L<Paws::AutoScaling::BlockDeviceMapping>] | ||
| 88 | |||
| 89 | A block device mapping, which specifies the block devices for the | ||
| 90 | instance. You can specify virtual devices and EBS volumes. For more | ||
| 91 | information, see Block Device Mapping | ||
| 92 | (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html) | ||
| 93 | in the I<Amazon EC2 User Guide for Linux Instances>. | ||
| 94 | |||
| 95 | |||
| 96 | |||
| 97 | =head2 ClassicLinkVPCId => Str | ||
| 98 | |||
| 99 | The ID of a ClassicLink-enabled VPC to link your EC2-Classic instances | ||
| 100 | to. For more information, see ClassicLink | ||
| 101 | (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-classiclink.html) | ||
| 102 | in the I<Amazon EC2 User Guide for Linux Instances> and Linking | ||
| 103 | EC2-Classic instances to a VPC | ||
| 104 | (https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-in-vpc.html#as-ClassicLink) | ||
| 105 | in the I<Amazon EC2 Auto Scaling User Guide>. | ||
| 106 | |||
| 107 | This parameter can only be used if you are launching EC2-Classic | ||
| 108 | instances. | ||
| 109 | |||
| 110 | |||
| 111 | |||
| 112 | =head2 ClassicLinkVPCSecurityGroups => ArrayRef[Str|Undef] | ||
| 113 | |||
| 114 | The IDs of one or more security groups for the specified | ||
| 115 | ClassicLink-enabled VPC. For more information, see ClassicLink | ||
| 116 | (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-classiclink.html) | ||
| 117 | in the I<Amazon EC2 User Guide for Linux Instances> and Linking | ||
| 118 | EC2-Classic instances to a VPC | ||
| 119 | (https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-in-vpc.html#as-ClassicLink) | ||
| 120 | in the I<Amazon EC2 Auto Scaling User Guide>. | ||
| 121 | |||
| 122 | If you specify the C<ClassicLinkVPCId> parameter, you must specify this | ||
| 123 | parameter. | ||
| 124 | |||
| 125 | |||
| 126 | |||
| 127 | =head2 EbsOptimized => Bool | ||
| 128 | |||
| 129 | Specifies whether the launch configuration is optimized for EBS I/O | ||
| 130 | (C<true>) or not (C<false>). The optimization provides dedicated | ||
| 131 | throughput to Amazon EBS and an optimized configuration stack to | ||
| 132 | provide optimal I/O performance. This optimization is not available | ||
| 133 | with all instance types. Additional fees are incurred when you enable | ||
| 134 | EBS optimization for an instance type that is not EBS-optimized by | ||
| 135 | default. For more information, see Amazon EBS-Optimized Instances | ||
| 136 | (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSOptimized.html) | ||
| 137 | in the I<Amazon EC2 User Guide for Linux Instances>. | ||
| 138 | |||
| 139 | The default value is C<false>. | ||
| 140 | |||
| 141 | |||
| 142 | |||
| 143 | =head2 IamInstanceProfile => Str | ||
| 144 | |||
| 145 | The name or the Amazon Resource Name (ARN) of the instance profile | ||
| 146 | associated with the IAM role for the instance. The instance profile | ||
| 147 | contains the IAM role. | ||
| 148 | |||
| 149 | For more information, see IAM role for applications that run on Amazon | ||
| 150 | EC2 instances | ||
| 151 | (https://docs.aws.amazon.com/autoscaling/ec2/userguide/us-iam-role.html) | ||
| 152 | in the I<Amazon EC2 Auto Scaling User Guide>. | ||
| 153 | |||
| 154 | |||
| 155 | |||
| 156 | =head2 ImageId => Str | ||
| 157 | |||
| 158 | The ID of the Amazon Machine Image (AMI) that was assigned during | ||
| 159 | registration. For more information, see Finding an AMI | ||
| 160 | (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/finding-an-ami.html) | ||
| 161 | in the I<Amazon EC2 User Guide for Linux Instances>. | ||
| 162 | |||
| 163 | If you do not specify C<InstanceId>, you must specify C<ImageId>. | ||
| 164 | |||
| 165 | |||
| 166 | |||
| 167 | =head2 InstanceId => Str | ||
| 168 | |||
| 169 | The ID of the instance to use to create the launch configuration. The | ||
| 170 | new launch configuration derives attributes from the instance, except | ||
| 171 | for the block device mapping. | ||
| 172 | |||
| 173 | To create a launch configuration with a block device mapping or | ||
| 174 | override any other instance attributes, specify them as part of the | ||
| 175 | same request. | ||
| 176 | |||
| 177 | For more information, see Creating a launch configuration using an EC2 | ||
| 178 | instance | ||
| 179 | (https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-lc-with-instanceID.html) | ||
| 180 | in the I<Amazon EC2 Auto Scaling User Guide>. | ||
| 181 | |||
| 182 | If you do not specify C<InstanceId>, you must specify both C<ImageId> | ||
| 183 | and C<InstanceType>. | ||
| 184 | |||
| 185 | |||
| 186 | |||
| 187 | =head2 InstanceMonitoring => L<Paws::AutoScaling::InstanceMonitoring> | ||
| 188 | |||
| 189 | Controls whether instances in this group are launched with detailed | ||
| 190 | (C<true>) or basic (C<false>) monitoring. | ||
| 191 | |||
| 192 | The default value is C<true> (enabled). | ||
| 193 | |||
| 194 | When detailed monitoring is enabled, Amazon CloudWatch generates | ||
| 195 | metrics every minute and your account is charged a fee. When you | ||
| 196 | disable detailed monitoring, CloudWatch generates metrics every 5 | ||
| 197 | minutes. For more information, see Configure Monitoring for Auto | ||
| 198 | Scaling Instances | ||
| 199 | (https://docs.aws.amazon.com/autoscaling/latest/userguide/enable-as-instance-metrics.html) | ||
| 200 | in the I<Amazon EC2 Auto Scaling User Guide>. | ||
| 201 | |||
| 202 | |||
| 203 | |||
| 204 | =head2 InstanceType => Str | ||
| 205 | |||
| 206 | Specifies the instance type of the EC2 instance. | ||
| 207 | |||
| 208 | For information about available instance types, see Available Instance | ||
| 209 | Types | ||
| 210 | (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#AvailableInstanceTypes) | ||
| 211 | in the I<Amazon EC2 User Guide for Linux Instances>. | ||
| 212 | |||
| 213 | If you do not specify C<InstanceId>, you must specify C<InstanceType>. | ||
| 214 | |||
| 215 | |||
| 216 | |||
| 217 | =head2 KernelId => Str | ||
| 218 | |||
| 219 | The ID of the kernel associated with the AMI. | ||
| 220 | |||
| 221 | |||
| 222 | |||
| 223 | =head2 KeyName => Str | ||
| 224 | |||
| 225 | The name of the key pair. For more information, see Amazon EC2 Key | ||
| 226 | Pairs | ||
| 227 | (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html) | ||
| 228 | in the I<Amazon EC2 User Guide for Linux Instances>. | ||
| 229 | |||
| 230 | |||
| 231 | |||
| 232 | =head2 B<REQUIRED> LaunchConfigurationName => Str | ||
| 233 | |||
| 234 | The name of the launch configuration. This name must be unique per | ||
| 235 | Region per account. | ||
| 236 | |||
| 237 | |||
| 238 | |||
| 239 | =head2 MetadataOptions => L<Paws::AutoScaling::InstanceMetadataOptions> | ||
| 240 | |||
| 241 | The metadata options for the instances. For more information, see | ||
| 242 | Configuring the Instance Metadata Options | ||
| 243 | (https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-launch-config.html#launch-configurations-imds) | ||
| 244 | in the I<Amazon EC2 Auto Scaling User Guide>. | ||
| 245 | |||
| 246 | |||
| 247 | |||
| 248 | =head2 PlacementTenancy => Str | ||
| 249 | |||
| 250 | The tenancy of the instance. An instance with C<dedicated> tenancy runs | ||
| 251 | on isolated, single-tenant hardware and can only be launched into a | ||
| 252 | VPC. | ||
| 253 | |||
| 254 | To launch dedicated instances into a shared tenancy VPC (a VPC with the | ||
| 255 | instance placement tenancy attribute set to C<default>), you must set | ||
| 256 | the value of this parameter to C<dedicated>. | ||
| 257 | |||
| 258 | If you specify C<PlacementTenancy>, you must specify at least one | ||
| 259 | subnet for C<VPCZoneIdentifier> when you create your group. | ||
| 260 | |||
| 261 | For more information, see Configuring instance tenancy with Amazon EC2 | ||
| 262 | Auto Scaling | ||
| 263 | (https://docs.aws.amazon.com/autoscaling/ec2/userguide/auto-scaling-dedicated-instances.html) | ||
| 264 | in the I<Amazon EC2 Auto Scaling User Guide>. | ||
| 265 | |||
| 266 | Valid Values: C<default> | C<dedicated> | ||
| 267 | |||
| 268 | |||
| 269 | |||
| 270 | =head2 RamdiskId => Str | ||
| 271 | |||
| 272 | The ID of the RAM disk to select. | ||
| 273 | |||
| 274 | |||
| 275 | |||
| 276 | =head2 SecurityGroups => ArrayRef[Str|Undef] | ||
| 277 | |||
| 278 | A list that contains the security groups to assign to the instances in | ||
| 279 | the Auto Scaling group. | ||
| 280 | |||
| 281 | [EC2-VPC] Specify the security group IDs. For more information, see | ||
| 282 | Security Groups for Your VPC | ||
| 283 | (https://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_SecurityGroups.html) | ||
| 284 | in the I<Amazon Virtual Private Cloud User Guide>. | ||
| 285 | |||
| 286 | [EC2-Classic] Specify either the security group names or the security | ||
| 287 | group IDs. For more information, see Amazon EC2 Security Groups | ||
| 288 | (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-network-security.html) | ||
| 289 | in the I<Amazon EC2 User Guide for Linux Instances>. | ||
| 290 | |||
| 291 | |||
| 292 | |||
| 293 | =head2 SpotPrice => Str | ||
| 294 | |||
| 295 | The maximum hourly price to be paid for any Spot Instance launched to | ||
| 296 | fulfill the request. Spot Instances are launched when the price you | ||
| 297 | specify exceeds the current Spot price. For more information, see | ||
| 298 | Requesting Spot Instances | ||
| 299 | (https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-launch-spot-instances.html) | ||
| 300 | in the I<Amazon EC2 Auto Scaling User Guide>. | ||
| 301 | |||
| 302 | When you change your maximum price by creating a new launch | ||
| 303 | configuration, running instances will continue to run as long as the | ||
| 304 | maximum price for those running instances is higher than the current | ||
| 305 | Spot price. | ||
| 306 | |||
| 307 | |||
| 308 | |||
| 309 | =head2 UserData => Str | ||
| 310 | |||
| 311 | The user data to make available to the launched EC2 instances. For more | ||
| 312 | information, see Instance metadata and user data | ||
| 313 | (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html) | ||
| 314 | (Linux) and Instance metadata and user data | ||
| 315 | (https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/ec2-instance-metadata.html) | ||
| 316 | (Windows). If you are using a command line tool, base64-encoding is | ||
| 317 | performed for you, and you can load the text from a file. Otherwise, | ||
| 318 | you must provide base64-encoded text. User data is limited to 16 KB. | ||
| 319 | |||
| 320 | |||
| 321 | |||
| 322 | |||
| 323 | =head1 SEE ALSO | ||
| 324 | |||
| 325 | This class forms part of L<Paws>, documenting arguments for method CreateLaunchConfiguration in L<Paws::AutoScaling> | ||
| 326 | |||
| 327 | =head1 BUGS and CONTRIBUTIONS | ||
| 328 | |||
| 329 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 330 | |||
| 331 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 332 | |||
| 333 | =cut | ||
| 334 |