« blib/lib/Paws/EC2/AdvertiseByoipCidrResult.pm
↑ Summary
blib/lib/Paws/EC2/AllocateHostsResult.pm »
| 1 | |||
| 2 | package Paws::EC2::AllocateHosts; | ||
| 3 | use Moose; | ||
| 4 | has AutoPlacement => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'autoPlacement' ); | ||
| 5 | has AvailabilityZone => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'availabilityZone' , required => 1); | ||
| 6 | has ClientToken => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'clientToken' ); | ||
| 7 | has HostRecovery => (is => 'ro', isa => 'Str'); | ||
| 8 | has InstanceFamily => (is => 'ro', isa => 'Str'); | ||
| 9 | has InstanceType => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'instanceType' ); | ||
| 10 | has Quantity => (is => 'ro', isa => 'Int', traits => ['NameInRequest'], request_name => 'quantity' , required => 1); | ||
| 11 | has TagSpecifications => (is => 'ro', isa => 'ArrayRef[Paws::EC2::TagSpecification]', traits => ['NameInRequest'], request_name => 'TagSpecification' ); | ||
| 12 | |||
| 13 | use MooseX::ClassAttribute; | ||
| 14 | |||
| 15 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'AllocateHosts'); | ||
| 16 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::EC2::AllocateHostsResult'); | ||
| 17 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 18 | 1; | ||
| 19 | |||
| 20 | ### main pod documentation begin ### | ||
| 21 | |||
| 22 | =head1 NAME | ||
| 23 | |||
| 24 | Paws::EC2::AllocateHosts - Arguments for method AllocateHosts on L<Paws::EC2> | ||
| 25 | |||
| 26 | =head1 DESCRIPTION | ||
| 27 | |||
| 28 | This class represents the parameters used for calling the method AllocateHosts on the | ||
| 29 | L<Amazon Elastic Compute Cloud|Paws::EC2> service. Use the attributes of this class | ||
| 30 | as arguments to method AllocateHosts. | ||
| 31 | |||
| 32 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to AllocateHosts. | ||
| 33 | |||
| 34 | =head1 SYNOPSIS | ||
| 35 | |||
| 36 | my $ec2 = Paws->service('EC2'); | ||
| 37 | my $AllocateHostsResult = $ec2->AllocateHosts( | ||
| 38 | AvailabilityZone => 'MyString', | ||
| 39 | Quantity => 1, | ||
| 40 | AutoPlacement => 'on', # OPTIONAL | ||
| 41 | ClientToken => 'MyString', # OPTIONAL | ||
| 42 | HostRecovery => 'on', # OPTIONAL | ||
| 43 | InstanceFamily => 'MyString', # OPTIONAL | ||
| 44 | InstanceType => 'MyString', # OPTIONAL | ||
| 45 | TagSpecifications => [ | ||
| 46 | { | ||
| 47 | ResourceType => 'client-vpn-endpoint' | ||
| 48 | , # values: client-vpn-endpoint, customer-gateway, dedicated-host, dhcp-options, egress-only-internet-gateway, elastic-ip, elastic-gpu, export-image-task, export-instance-task, fleet, fpga-image, host-reservation, image, import-image-task, import-snapshot-task, instance, internet-gateway, key-pair, launch-template, local-gateway-route-table-vpc-association, natgateway, network-acl, network-interface, network-insights-analysis, network-insights-path, placement-group, reserved-instances, route-table, security-group, snapshot, spot-fleet-request, spot-instances-request, subnet, traffic-mirror-filter, traffic-mirror-session, traffic-mirror-target, transit-gateway, transit-gateway-attachment, transit-gateway-connect-peer, transit-gateway-multicast-domain, transit-gateway-route-table, volume, vpc, vpc-peering-connection, vpn-connection, vpn-gateway, vpc-flow-log; OPTIONAL | ||
| 49 | Tags => [ | ||
| 50 | { | ||
| 51 | Key => 'MyString', | ||
| 52 | Value => 'MyString', | ||
| 53 | }, | ||
| 54 | ... | ||
| 55 | ], # OPTIONAL | ||
| 56 | }, | ||
| 57 | ... | ||
| 58 | ], # OPTIONAL | ||
| 59 | ); | ||
| 60 | |||
| 61 | # Results: | ||
| 62 | my $HostIds = $AllocateHostsResult->HostIds; | ||
| 63 | |||
| 64 | # Returns a L<Paws::EC2::AllocateHostsResult> object. | ||
| 65 | |||
| 66 | 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. | ||
| 67 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/ec2/AllocateHosts> | ||
| 68 | |||
| 69 | =head1 ATTRIBUTES | ||
| 70 | |||
| 71 | |||
| 72 | =head2 AutoPlacement => Str | ||
| 73 | |||
| 74 | Indicates whether the host accepts any untargeted instance launches | ||
| 75 | that match its instance type configuration, or if it only accepts Host | ||
| 76 | tenancy instance launches that specify its unique host ID. For more | ||
| 77 | information, see Understanding auto-placement and affinity | ||
| 78 | (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/how-dedicated-hosts-work.html#dedicated-hosts-understanding) | ||
| 79 | in the I<Amazon EC2 User Guide>. | ||
| 80 | |||
| 81 | Default: C<on> | ||
| 82 | |||
| 83 | Valid values are: C<"on">, C<"off"> | ||
| 84 | |||
| 85 | =head2 B<REQUIRED> AvailabilityZone => Str | ||
| 86 | |||
| 87 | The Availability Zone in which to allocate the Dedicated Host. | ||
| 88 | |||
| 89 | |||
| 90 | |||
| 91 | =head2 ClientToken => Str | ||
| 92 | |||
| 93 | Unique, case-sensitive identifier that you provide to ensure the | ||
| 94 | idempotency of the request. For more information, see Ensuring | ||
| 95 | Idempotency | ||
| 96 | (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). | ||
| 97 | |||
| 98 | |||
| 99 | |||
| 100 | =head2 HostRecovery => Str | ||
| 101 | |||
| 102 | Indicates whether to enable or disable host recovery for the Dedicated | ||
| 103 | Host. Host recovery is disabled by default. For more information, see | ||
| 104 | Host recovery | ||
| 105 | (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/dedicated-hosts-recovery.html) | ||
| 106 | in the I<Amazon EC2 User Guide>. | ||
| 107 | |||
| 108 | Default: C<off> | ||
| 109 | |||
| 110 | Valid values are: C<"on">, C<"off"> | ||
| 111 | |||
| 112 | =head2 InstanceFamily => Str | ||
| 113 | |||
| 114 | Specifies the instance family to be supported by the Dedicated Hosts. | ||
| 115 | If you specify an instance family, the Dedicated Hosts support multiple | ||
| 116 | instance types within that instance family. | ||
| 117 | |||
| 118 | If you want the Dedicated Hosts to support a specific instance type | ||
| 119 | only, omit this parameter and specify B<InstanceType> instead. You | ||
| 120 | cannot specify B<InstanceFamily> and B<InstanceType> in the same | ||
| 121 | request. | ||
| 122 | |||
| 123 | |||
| 124 | |||
| 125 | =head2 InstanceType => Str | ||
| 126 | |||
| 127 | Specifies the instance type to be supported by the Dedicated Hosts. If | ||
| 128 | you specify an instance type, the Dedicated Hosts support instances of | ||
| 129 | the specified instance type only. | ||
| 130 | |||
| 131 | If you want the Dedicated Hosts to support multiple instance types in a | ||
| 132 | specific instance family, omit this parameter and specify | ||
| 133 | B<InstanceFamily> instead. You cannot specify B<InstanceType> and | ||
| 134 | B<InstanceFamily> in the same request. | ||
| 135 | |||
| 136 | |||
| 137 | |||
| 138 | =head2 B<REQUIRED> Quantity => Int | ||
| 139 | |||
| 140 | The number of Dedicated Hosts to allocate to your account with these | ||
| 141 | parameters. | ||
| 142 | |||
| 143 | |||
| 144 | |||
| 145 | =head2 TagSpecifications => ArrayRef[L<Paws::EC2::TagSpecification>] | ||
| 146 | |||
| 147 | The tags to apply to the Dedicated Host during creation. | ||
| 148 | |||
| 149 | |||
| 150 | |||
| 151 | |||
| 152 | =head1 SEE ALSO | ||
| 153 | |||
| 154 | This class forms part of L<Paws>, documenting arguments for method AllocateHosts in L<Paws::EC2> | ||
| 155 | |||
| 156 | =head1 BUGS and CONTRIBUTIONS | ||
| 157 | |||
| 158 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 159 | |||
| 160 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 161 | |||
| 162 | =cut | ||
| 163 |