NAME

Paws::EC2::AllocateHosts - Arguments for method AllocateHosts on Paws::EC2

DESCRIPTION

This class represents the parameters used for calling the method AllocateHosts on the Amazon Elastic Compute Cloud service. Use the attributes of this class as arguments to method AllocateHosts.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to AllocateHosts.

SYNOPSIS

my $ec2 = Paws->service('EC2');
my $AllocateHostsResult = $ec2->AllocateHosts(
  AvailabilityZone  => 'MyString',
  Quantity          => 1,
  AutoPlacement     => 'on',          # OPTIONAL
  ClientToken       => 'MyString',    # OPTIONAL
  HostRecovery      => 'on',          # OPTIONAL
  InstanceFamily    => 'MyString',    # OPTIONAL
  InstanceType      => 'MyString',    # OPTIONAL
  TagSpecifications => [
    {
      ResourceType => 'client-vpn-endpoint'
      , # 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
      Tags => [
        {
          Key   => 'MyString',
          Value => 'MyString',
        },
        ...
      ],    # OPTIONAL
    },
    ...
  ],    # OPTIONAL
);

# Results:
my $HostIds = $AllocateHostsResult->HostIds;

# Returns a L<Paws::EC2::AllocateHostsResult> 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/goto/WebAPI/ec2/AllocateHosts

ATTRIBUTES

AutoPlacement => Str

Indicates whether the host accepts any untargeted instance launches that match its instance type configuration, or if it only accepts Host tenancy instance launches that specify its unique host ID. For more information, see Understanding auto-placement and affinity (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/how-dedicated-hosts-work.html#dedicated-hosts-understanding) in the Amazon EC2 User Guide.

Default: on

Valid values are: "on", "off"

REQUIRED AvailabilityZone => Str

The Availability Zone in which to allocate the Dedicated Host.

ClientToken => Str

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html).

HostRecovery => Str

Indicates whether to enable or disable host recovery for the Dedicated Host. Host recovery is disabled by default. For more information, see Host recovery (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/dedicated-hosts-recovery.html) in the Amazon EC2 User Guide.

Default: off

Valid values are: "on", "off"

InstanceFamily => Str

Specifies the instance family to be supported by the Dedicated Hosts. If you specify an instance family, the Dedicated Hosts support multiple instance types within that instance family.

If you want the Dedicated Hosts to support a specific instance type only, omit this parameter and specify InstanceType instead. You cannot specify InstanceFamily and InstanceType in the same request.

InstanceType => Str

Specifies the instance type to be supported by the Dedicated Hosts. If you specify an instance type, the Dedicated Hosts support instances of the specified instance type only.

If you want the Dedicated Hosts to support multiple instance types in a specific instance family, omit this parameter and specify InstanceFamily instead. You cannot specify InstanceType and InstanceFamily in the same request.

REQUIRED Quantity => Int

The number of Dedicated Hosts to allocate to your account with these parameters.

TagSpecifications => ArrayRef[Paws::EC2::TagSpecification]

The tags to apply to the Dedicated Host during creation.

SEE ALSO

This class forms part of Paws, documenting arguments for method AllocateHosts in Paws::EC2

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