Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.EC2.AllocateHosts

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Allocates a Dedicated Host to your account. At a minimum, specify the supported instance type or instance family, the Availability Zone in which to allocate the host, and the number of hosts to allocate.

Synopsis

data AllocateHosts = AllocateHosts' {
- autoPlacement :: Maybe AutoPlacement
- clientToken :: Maybe Text
- hostRecovery :: Maybe HostRecovery
- instanceFamily :: Maybe Text
- instanceType :: Maybe Text
- outpostArn :: Maybe Text
- tagSpecifications :: Maybe [TagSpecification]
- availabilityZone :: Text
- quantity :: Int
}
newAllocateHosts :: Text -> Int -> AllocateHosts
allocateHosts_autoPlacement :: Lens' AllocateHosts (Maybe AutoPlacement)
allocateHosts_clientToken :: Lens' AllocateHosts (Maybe Text)
allocateHosts_hostRecovery :: Lens' AllocateHosts (Maybe HostRecovery)
allocateHosts_instanceFamily :: Lens' AllocateHosts (Maybe Text)
allocateHosts_instanceType :: Lens' AllocateHosts (Maybe Text)
allocateHosts_outpostArn :: Lens' AllocateHosts (Maybe Text)
allocateHosts_tagSpecifications :: Lens' AllocateHosts (Maybe [TagSpecification])
allocateHosts_availabilityZone :: Lens' AllocateHosts Text
allocateHosts_quantity :: Lens' AllocateHosts Int
data AllocateHostsResponse = AllocateHostsResponse' {
- hostIds :: Maybe [Text]
- httpStatus :: Int
}
newAllocateHostsResponse :: Int -> AllocateHostsResponse
allocateHostsResponse_hostIds :: Lens' AllocateHostsResponse (Maybe [Text])
allocateHostsResponse_httpStatus :: Lens' AllocateHostsResponse Int

Creating a Request

data AllocateHosts Source #

See: newAllocateHosts smart constructor.

Constructors

AllocateHosts'

Fields

autoPlacement :: Maybe AutoPlacement
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 in the Amazon EC2 User Guide.
Default: on
clientToken :: Maybe Text
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.
hostRecovery :: Maybe HostRecovery
Indicates whether to enable or disable host recovery for the Dedicated Host. Host recovery is disabled by default. For more information, see Host recovery in the Amazon EC2 User Guide.
Default: off
instanceFamily :: Maybe Text
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 :: Maybe Text
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.
outpostArn :: Maybe Text
The Amazon Resource Name (ARN) of the Amazon Web Services Outpost on which to allocate the Dedicated Host.
tagSpecifications :: Maybe [TagSpecification]
The tags to apply to the Dedicated Host during creation.
availabilityZone :: Text
The Availability Zone in which to allocate the Dedicated Host.
quantity :: Int
The number of Dedicated Hosts to allocate to your account with these parameters.

Instances

Instances details

ToHeaders AllocateHosts Source #
Instance details Defined in Amazonka.EC2.AllocateHosts Methods toHeaders :: AllocateHosts -> [Header] #
ToPath AllocateHosts Source #
Instance details Defined in Amazonka.EC2.AllocateHosts Methods toPath :: AllocateHosts -> ByteString #
ToQuery AllocateHosts Source #
Instance details Defined in Amazonka.EC2.AllocateHosts Methods toQuery :: AllocateHosts -> QueryString #
AWSRequest AllocateHosts Source #
Instance details Defined in Amazonka.EC2.AllocateHosts Associated Types type AWSResponse AllocateHosts # Methods request :: (Service -> Service) -> AllocateHosts -> Request AllocateHosts # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy AllocateHosts -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse AllocateHosts))) #
Generic AllocateHosts Source #
Instance details Defined in Amazonka.EC2.AllocateHosts Associated Types type Rep AllocateHosts :: Type -> Type # Methods from :: AllocateHosts -> Rep AllocateHosts x # to :: Rep AllocateHosts x -> AllocateHosts #
Read AllocateHosts Source #
Instance details Defined in Amazonka.EC2.AllocateHosts Methods readsPrec :: Int -> ReadS AllocateHosts # readList :: ReadS [AllocateHosts] # readPrec :: ReadPrec AllocateHosts # readListPrec :: ReadPrec [AllocateHosts] #
Show AllocateHosts Source #
Instance details Defined in Amazonka.EC2.AllocateHosts Methods showsPrec :: Int -> AllocateHosts -> ShowS # show :: AllocateHosts -> String # showList :: [AllocateHosts] -> ShowS #
NFData AllocateHosts Source #
Instance details Defined in Amazonka.EC2.AllocateHosts Methods rnf :: AllocateHosts -> () #
Eq AllocateHosts Source #
Instance details Defined in Amazonka.EC2.AllocateHosts Methods (==) :: AllocateHosts -> AllocateHosts -> Bool # (/=) :: AllocateHosts -> AllocateHosts -> Bool #
Hashable AllocateHosts Source #
Instance details Defined in Amazonka.EC2.AllocateHosts Methods hashWithSalt :: Int -> AllocateHosts -> Int # hash :: AllocateHosts -> Int #
type AWSResponse AllocateHosts Source #
Instance details Defined in Amazonka.EC2.AllocateHosts type AWSResponse AllocateHosts = AllocateHostsResponse
type Rep AllocateHosts Source #
Instance details Defined in Amazonka.EC2.AllocateHosts type Rep AllocateHosts = D1 ('MetaData "AllocateHosts" "Amazonka.EC2.AllocateHosts" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "AllocateHosts'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "autoPlacement") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AutoPlacement)) :: S1 ('MetaSel ('Just "clientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "hostRecovery") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe HostRecovery)) :: S1 ('MetaSel ('Just "instanceFamily") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "instanceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "outpostArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "tagSpecifications") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [TagSpecification])) :: (S1 ('MetaSel ('Just "availabilityZone") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "quantity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newAllocateHosts Source #

Arguments

:: Text	`AllocateHosts`
-> Int	`$sel:quantity:AllocateHosts'`
-> AllocateHosts

Create a value of AllocateHosts with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

AllocateHosts, allocateHosts_autoPlacement - 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 in the Amazon EC2 User Guide.

Default: on

AllocateHosts, allocateHosts_clientToken - Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.

AllocateHosts, allocateHosts_hostRecovery - Indicates whether to enable or disable host recovery for the Dedicated Host. Host recovery is disabled by default. For more information, see Host recovery in the Amazon EC2 User Guide.

Default: off

AllocateHosts, allocateHosts_instanceFamily - 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.

AllocateHosts, allocateHosts_instanceType - 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.

AllocateHosts, allocateHosts_outpostArn - The Amazon Resource Name (ARN) of the Amazon Web Services Outpost on which to allocate the Dedicated Host.

AllocateHosts, allocateHosts_tagSpecifications - The tags to apply to the Dedicated Host during creation.

AllocateHosts, allocateHosts_availabilityZone - The Availability Zone in which to allocate the Dedicated Host.

$sel:quantity:AllocateHosts', allocateHosts_quantity - The number of Dedicated Hosts to allocate to your account with these parameters.

Request Lenses

allocateHosts_autoPlacement :: Lens' AllocateHosts (Maybe AutoPlacement) Source #

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 in the Amazon EC2 User Guide.

Default: on

allocateHosts_clientToken :: Lens' AllocateHosts (Maybe Text) Source #

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.

allocateHosts_hostRecovery :: Lens' AllocateHosts (Maybe HostRecovery) Source #

Indicates whether to enable or disable host recovery for the Dedicated Host. Host recovery is disabled by default. For more information, see Host recovery in the Amazon EC2 User Guide.

Default: off

allocateHosts_instanceFamily :: Lens' AllocateHosts (Maybe Text) Source #

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.

allocateHosts_instanceType :: Lens' AllocateHosts (Maybe Text) Source #

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.

allocateHosts_outpostArn :: Lens' AllocateHosts (Maybe Text) Source #

The Amazon Resource Name (ARN) of the Amazon Web Services Outpost on which to allocate the Dedicated Host.

allocateHosts_tagSpecifications :: Lens' AllocateHosts (Maybe [TagSpecification]) Source #

The tags to apply to the Dedicated Host during creation.

allocateHosts_availabilityZone :: Lens' AllocateHosts Text Source #

The Availability Zone in which to allocate the Dedicated Host.

allocateHosts_quantity :: Lens' AllocateHosts Int Source #

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

Destructuring the Response

data AllocateHostsResponse Source #

Contains the output of AllocateHosts.

See: newAllocateHostsResponse smart constructor.

Constructors

AllocateHostsResponse'
Fields hostIds :: Maybe [Text] The ID of the allocated Dedicated Host. This is used to launch an instance onto a specific host. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic AllocateHostsResponse Source #
Instance details Defined in Amazonka.EC2.AllocateHosts Associated Types type Rep AllocateHostsResponse :: Type -> Type # Methods from :: AllocateHostsResponse -> Rep AllocateHostsResponse x # to :: Rep AllocateHostsResponse x -> AllocateHostsResponse #
Read AllocateHostsResponse Source #
Instance details Defined in Amazonka.EC2.AllocateHosts Methods readsPrec :: Int -> ReadS AllocateHostsResponse # readList :: ReadS [AllocateHostsResponse] # readPrec :: ReadPrec AllocateHostsResponse # readListPrec :: ReadPrec [AllocateHostsResponse] #
Show AllocateHostsResponse Source #
Instance details Defined in Amazonka.EC2.AllocateHosts Methods showsPrec :: Int -> AllocateHostsResponse -> ShowS # show :: AllocateHostsResponse -> String # showList :: [AllocateHostsResponse] -> ShowS #
NFData AllocateHostsResponse Source #
Instance details Defined in Amazonka.EC2.AllocateHosts Methods rnf :: AllocateHostsResponse -> () #
Eq AllocateHostsResponse Source #
Instance details Defined in Amazonka.EC2.AllocateHosts Methods (==) :: AllocateHostsResponse -> AllocateHostsResponse -> Bool # (/=) :: AllocateHostsResponse -> AllocateHostsResponse -> Bool #
type Rep AllocateHostsResponse Source #
Instance details Defined in Amazonka.EC2.AllocateHosts type Rep AllocateHostsResponse = D1 ('MetaData "AllocateHostsResponse" "Amazonka.EC2.AllocateHosts" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "AllocateHostsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "hostIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newAllocateHostsResponse Source #

Arguments

:: Int	`$sel:httpStatus:AllocateHostsResponse'`
-> AllocateHostsResponse

Create a value of AllocateHostsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:hostIds:AllocateHostsResponse', allocateHostsResponse_hostIds - The ID of the allocated Dedicated Host. This is used to launch an instance onto a specific host.

$sel:httpStatus:AllocateHostsResponse', allocateHostsResponse_httpStatus - The response's http status code.

Response Lenses

allocateHostsResponse_hostIds :: Lens' AllocateHostsResponse (Maybe [Text]) Source #

The ID of the allocated Dedicated Host. This is used to launch an instance onto a specific host.

allocateHostsResponse_httpStatus :: Lens' AllocateHostsResponse Int Source #

The response's http status code.