Copyright	(c) 2013-2018 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None
Language	Haskell2010

Network.AWS.CloudHSM.CreateHSM

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

This is documentation for AWS CloudHSM Classic . For more information, see AWS CloudHSM Classic FAQs , the AWS CloudHSM Classic User Guide , and the AWS CloudHSM Classic API Reference .

For information about the current version of AWS CloudHSM , see AWS CloudHSM , the AWS CloudHSM User Guide , and the AWS CloudHSM API Reference .

Creates an uninitialized HSM instance.

There is an upfront fee charged for each HSM instance that you create with the CreateHsm operation. If you accidentally provision an HSM and want to request a refund, delete the instance using the DeleteHsm operation, go to the AWS Support Center , create a new case, and select Account and Billing Support .

Important: It can take up to 20 minutes to create and provision an HSM. You can monitor the status of the HSM with the DescribeHsm operation. The HSM is ready to be initialized when the status changes to RUNNING .

Synopsis

createHSM :: Text -> Text -> Text -> SubscriptionType -> CreateHSM
data CreateHSM
chClientToken :: Lens' CreateHSM (Maybe Text)
chSyslogIP :: Lens' CreateHSM (Maybe Text)
chExternalId :: Lens' CreateHSM (Maybe Text)
chEniIP :: Lens' CreateHSM (Maybe Text)
chSubnetId :: Lens' CreateHSM Text
chSSHKey :: Lens' CreateHSM Text
chIAMRoleARN :: Lens' CreateHSM Text
chSubscriptionType :: Lens' CreateHSM SubscriptionType
createHSMResponse :: Int -> CreateHSMResponse
data CreateHSMResponse
chrsHSMARN :: Lens' CreateHSMResponse (Maybe Text)
chrsResponseStatus :: Lens' CreateHSMResponse Int

Creating a Request

createHSM #

Arguments

:: Text	`chSubnetId`
-> Text	`chSSHKey`
-> Text	`chIAMRoleARN`
-> SubscriptionType	`chSubscriptionType`
-> CreateHSM

Creates a value of CreateHSM with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

chClientToken - A user-defined token to ensure idempotence. Subsequent calls to this operation with the same token will be ignored.
chSyslogIP - The IP address for the syslog monitoring server. The AWS CloudHSM service only supports one syslog monitoring server.
chExternalId - The external ID from IamRoleArn , if present.
chEniIP - The IP address to assign to the HSM's ENI. If an IP address is not specified, an IP address will be randomly chosen from the CIDR range of the subnet.
chSubnetId - The identifier of the subnet in your VPC in which to place the HSM.
chSSHKey - The SSH public key to install on the HSM.
chIAMRoleARN - The ARN of an IAM role to enable the AWS CloudHSM service to allocate an ENI on your behalf.
chSubscriptionType - Undocumented member.

data CreateHSM #

Contains the inputs for the CreateHsm operation.

See: createHSM smart constructor.

Instances

Eq CreateHSM #
Instance details Defined in Network.AWS.CloudHSM.CreateHSM Methods (==) :: CreateHSM -> CreateHSM -> Bool # (/=) :: CreateHSM -> CreateHSM -> Bool #
Data CreateHSM #
Instance details Defined in Network.AWS.CloudHSM.CreateHSM Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreateHSM -> c CreateHSM # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreateHSM # toConstr :: CreateHSM -> Constr # dataTypeOf :: CreateHSM -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c CreateHSM) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreateHSM) # gmapT :: (forall b. Data b => b -> b) -> CreateHSM -> CreateHSM # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreateHSM -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreateHSM -> r # gmapQ :: (forall d. Data d => d -> u) -> CreateHSM -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> CreateHSM -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreateHSM -> m CreateHSM # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateHSM -> m CreateHSM # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateHSM -> m CreateHSM #
Read CreateHSM #
Instance details Defined in Network.AWS.CloudHSM.CreateHSM Methods readsPrec :: Int -> ReadS CreateHSM # readList :: ReadS [CreateHSM] # readPrec :: ReadPrec CreateHSM # readListPrec :: ReadPrec [CreateHSM] #
Show CreateHSM #
Instance details Defined in Network.AWS.CloudHSM.CreateHSM Methods showsPrec :: Int -> CreateHSM -> ShowS # show :: CreateHSM -> String # showList :: [CreateHSM] -> ShowS #
Generic CreateHSM #
Instance details Defined in Network.AWS.CloudHSM.CreateHSM Associated Types type Rep CreateHSM :: * -> * # Methods from :: CreateHSM -> Rep CreateHSM x # to :: Rep CreateHSM x -> CreateHSM #
Hashable CreateHSM #
Instance details Defined in Network.AWS.CloudHSM.CreateHSM Methods hashWithSalt :: Int -> CreateHSM -> Int # hash :: CreateHSM -> Int #
ToJSON CreateHSM #
Instance details Defined in Network.AWS.CloudHSM.CreateHSM Methods toJSON :: CreateHSM -> Value # toEncoding :: CreateHSM -> Encoding # toJSONList :: [CreateHSM] -> Value # toEncodingList :: [CreateHSM] -> Encoding #
AWSRequest CreateHSM #
Instance details Defined in Network.AWS.CloudHSM.CreateHSM Associated Types type Rs CreateHSM :: * # Methods request :: CreateHSM -> Request CreateHSM # response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy CreateHSM -> ClientResponse -> m (Response CreateHSM) #
ToHeaders CreateHSM #
Instance details Defined in Network.AWS.CloudHSM.CreateHSM Methods toHeaders :: CreateHSM -> [Header] #
ToPath CreateHSM #
Instance details Defined in Network.AWS.CloudHSM.CreateHSM Methods toPath :: CreateHSM -> ByteString #
ToQuery CreateHSM #
Instance details Defined in Network.AWS.CloudHSM.CreateHSM Methods toQuery :: CreateHSM -> QueryString #
NFData CreateHSM #
Instance details Defined in Network.AWS.CloudHSM.CreateHSM Methods rnf :: CreateHSM -> () #
type Rep CreateHSM #
Instance details Defined in Network.AWS.CloudHSM.CreateHSM type Rep CreateHSM = D1 (MetaData "CreateHSM" "Network.AWS.CloudHSM.CreateHSM" "amazonka-cloudhsm-1.6.0-8mtI1KULp3eAyp2v4HWjSZ" False) (C1 (MetaCons "CreateHSM'" PrefixI True) (((S1 (MetaSel (Just "_chClientToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_chSyslogIP") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :: (S1 (MetaSel (Just "_chExternalId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_chEniIP") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 (MetaSel (Just "_chSubnetId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :: S1 (MetaSel (Just "_chSSHKey") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) :: (S1 (MetaSel (Just "_chIAMRoleARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_chSubscriptionType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 SubscriptionType)))))
type Rs CreateHSM #
Instance details Defined in Network.AWS.CloudHSM.CreateHSM type Rs CreateHSM = CreateHSMResponse

Request Lenses

chClientToken :: Lens' CreateHSM (Maybe Text) #

A user-defined token to ensure idempotence. Subsequent calls to this operation with the same token will be ignored.

chSyslogIP :: Lens' CreateHSM (Maybe Text) #

The IP address for the syslog monitoring server. The AWS CloudHSM service only supports one syslog monitoring server.

chExternalId :: Lens' CreateHSM (Maybe Text) #

The external ID from IamRoleArn , if present.

chEniIP :: Lens' CreateHSM (Maybe Text) #

The IP address to assign to the HSM's ENI. If an IP address is not specified, an IP address will be randomly chosen from the CIDR range of the subnet.

chSubnetId :: Lens' CreateHSM Text #

The identifier of the subnet in your VPC in which to place the HSM.

chSSHKey :: Lens' CreateHSM Text #

The SSH public key to install on the HSM.

chIAMRoleARN :: Lens' CreateHSM Text #

The ARN of an IAM role to enable the AWS CloudHSM service to allocate an ENI on your behalf.

chSubscriptionType :: Lens' CreateHSM SubscriptionType #

Undocumented member.

Destructuring the Response

createHSMResponse #

Arguments

:: Int	`chrsResponseStatus`
-> CreateHSMResponse

Creates a value of CreateHSMResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

chrsHSMARN - The ARN of the HSM.
chrsResponseStatus - -- | The response status code.

data CreateHSMResponse #

Contains the output of the CreateHsm operation.

See: createHSMResponse smart constructor.

Instances

Eq CreateHSMResponse #
Instance details Defined in Network.AWS.CloudHSM.CreateHSM Methods (==) :: CreateHSMResponse -> CreateHSMResponse -> Bool # (/=) :: CreateHSMResponse -> CreateHSMResponse -> Bool #
Data CreateHSMResponse #
Instance details Defined in Network.AWS.CloudHSM.CreateHSM Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreateHSMResponse -> c CreateHSMResponse # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreateHSMResponse # toConstr :: CreateHSMResponse -> Constr # dataTypeOf :: CreateHSMResponse -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c CreateHSMResponse) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreateHSMResponse) # gmapT :: (forall b. Data b => b -> b) -> CreateHSMResponse -> CreateHSMResponse # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreateHSMResponse -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreateHSMResponse -> r # gmapQ :: (forall d. Data d => d -> u) -> CreateHSMResponse -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> CreateHSMResponse -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreateHSMResponse -> m CreateHSMResponse # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateHSMResponse -> m CreateHSMResponse # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateHSMResponse -> m CreateHSMResponse #
Read CreateHSMResponse #
Instance details Defined in Network.AWS.CloudHSM.CreateHSM Methods readsPrec :: Int -> ReadS CreateHSMResponse # readList :: ReadS [CreateHSMResponse] # readPrec :: ReadPrec CreateHSMResponse # readListPrec :: ReadPrec [CreateHSMResponse] #
Show CreateHSMResponse #
Instance details Defined in Network.AWS.CloudHSM.CreateHSM Methods showsPrec :: Int -> CreateHSMResponse -> ShowS # show :: CreateHSMResponse -> String # showList :: [CreateHSMResponse] -> ShowS #
Generic CreateHSMResponse #
Instance details Defined in Network.AWS.CloudHSM.CreateHSM Associated Types type Rep CreateHSMResponse :: * -> * # Methods from :: CreateHSMResponse -> Rep CreateHSMResponse x # to :: Rep CreateHSMResponse x -> CreateHSMResponse #
NFData CreateHSMResponse #
Instance details Defined in Network.AWS.CloudHSM.CreateHSM Methods rnf :: CreateHSMResponse -> () #
type Rep CreateHSMResponse #
Instance details Defined in Network.AWS.CloudHSM.CreateHSM type Rep CreateHSMResponse = D1 (MetaData "CreateHSMResponse" "Network.AWS.CloudHSM.CreateHSM" "amazonka-cloudhsm-1.6.0-8mtI1KULp3eAyp2v4HWjSZ" False) (C1 (MetaCons "CreateHSMResponse'" PrefixI True) (S1 (MetaSel (Just "_chrsHSMARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_chrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)))

Response Lenses

chrsHSMARN :: Lens' CreateHSMResponse (Maybe Text) #

The ARN of the HSM.

chrsResponseStatus :: Lens' CreateHSMResponse Int #

- | The response status code.