Copyright | (c) 2013-2017 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 |
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
.
- 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
:: Text | |
-> Text | |
-> Text | |
-> SubscriptionType | |
-> 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 fromIamRoleArn
, 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.
Contains the inputs for the CreateHsm
operation.
See: createHSM
smart constructor.
Request Lenses
chClientToken :: Lens' CreateHSM (Maybe Text) Source #
A user-defined token to ensure idempotence. Subsequent calls to this operation with the same token will be ignored.
chSyslogIP :: Lens' CreateHSM (Maybe Text) Source #
The IP address for the syslog monitoring server. The AWS CloudHSM service only supports one syslog monitoring server.
chEniIP :: Lens' CreateHSM (Maybe Text) Source #
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 Source #
The identifier of the subnet in your VPC in which to place the HSM.
chIAMRoleARN :: Lens' CreateHSM Text Source #
The ARN of an IAM role to enable the AWS CloudHSM service to allocate an ENI on your behalf.
chSubscriptionType :: Lens' CreateHSM SubscriptionType Source #
Undocumented member.
Destructuring the Response
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 Source #
Contains the output of the CreateHsm
operation.
See: createHSMResponse
smart constructor.
Response Lenses
chrsHSMARN :: Lens' CreateHSMResponse (Maybe Text) Source #
The ARN of the HSM.
chrsResponseStatus :: Lens' CreateHSMResponse Int Source #
- - | The response status code.