amazonka-cloudhsm-2.0: Amazon CloudHSM SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.CloudHSM.CreateHsm

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.

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

Creating a Request

data CreateHsm Source #

Contains the inputs for the CreateHsm operation.

See: newCreateHsm smart constructor.

Constructors

CreateHsm' 

Fields

  • clientToken :: Maybe Text

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

  • eniIp :: 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.

  • externalId :: Maybe Text

    The external ID from IamRoleArn, if present.

  • syslogIp :: Maybe Text

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

  • subnetId :: Text

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

  • sshKey :: Text

    The SSH public key to install on the HSM.

  • iamRoleArn :: Text

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

  • subscriptionType :: SubscriptionType
     

Instances

Instances details
ToJSON CreateHsm Source # 
Instance details

Defined in Amazonka.CloudHSM.CreateHsm

ToHeaders CreateHsm Source # 
Instance details

Defined in Amazonka.CloudHSM.CreateHsm

Methods

toHeaders :: CreateHsm -> [Header] #

ToPath CreateHsm Source # 
Instance details

Defined in Amazonka.CloudHSM.CreateHsm

ToQuery CreateHsm Source # 
Instance details

Defined in Amazonka.CloudHSM.CreateHsm

AWSRequest CreateHsm Source # 
Instance details

Defined in Amazonka.CloudHSM.CreateHsm

Associated Types

type AWSResponse CreateHsm #

Generic CreateHsm Source # 
Instance details

Defined in Amazonka.CloudHSM.CreateHsm

Associated Types

type Rep CreateHsm :: Type -> Type #

Read CreateHsm Source # 
Instance details

Defined in Amazonka.CloudHSM.CreateHsm

Show CreateHsm Source # 
Instance details

Defined in Amazonka.CloudHSM.CreateHsm

NFData CreateHsm Source # 
Instance details

Defined in Amazonka.CloudHSM.CreateHsm

Methods

rnf :: CreateHsm -> () #

Eq CreateHsm Source # 
Instance details

Defined in Amazonka.CloudHSM.CreateHsm

Hashable CreateHsm Source # 
Instance details

Defined in Amazonka.CloudHSM.CreateHsm

type AWSResponse CreateHsm Source # 
Instance details

Defined in Amazonka.CloudHSM.CreateHsm

type Rep CreateHsm Source # 
Instance details

Defined in Amazonka.CloudHSM.CreateHsm

newCreateHsm Source #

Create a value of CreateHsm 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:clientToken:CreateHsm', createHsm_clientToken - A user-defined token to ensure idempotence. Subsequent calls to this operation with the same token will be ignored.

$sel:eniIp:CreateHsm', createHsm_eniIp - 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.

$sel:externalId:CreateHsm', createHsm_externalId - The external ID from IamRoleArn, if present.

$sel:syslogIp:CreateHsm', createHsm_syslogIp - The IP address for the syslog monitoring server. The AWS CloudHSM service only supports one syslog monitoring server.

$sel:subnetId:CreateHsm', createHsm_subnetId - The identifier of the subnet in your VPC in which to place the HSM.

$sel:sshKey:CreateHsm', createHsm_sshKey - The SSH public key to install on the HSM.

$sel:iamRoleArn:CreateHsm', createHsm_iamRoleArn - The ARN of an IAM role to enable the AWS CloudHSM service to allocate an ENI on your behalf.

$sel:subscriptionType:CreateHsm', createHsm_subscriptionType - Undocumented member.

Request Lenses

createHsm_clientToken :: Lens' CreateHsm (Maybe Text) Source #

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

createHsm_eniIp :: 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.

createHsm_externalId :: Lens' CreateHsm (Maybe Text) Source #

The external ID from IamRoleArn, if present.

createHsm_syslogIp :: Lens' CreateHsm (Maybe Text) Source #

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

createHsm_subnetId :: Lens' CreateHsm Text Source #

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

createHsm_sshKey :: Lens' CreateHsm Text Source #

The SSH public key to install on the HSM.

createHsm_iamRoleArn :: Lens' CreateHsm Text Source #

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

Destructuring the Response

data CreateHsmResponse Source #

Contains the output of the CreateHsm operation.

See: newCreateHsmResponse smart constructor.

Constructors

CreateHsmResponse' 

Fields

Instances

Instances details
Generic CreateHsmResponse Source # 
Instance details

Defined in Amazonka.CloudHSM.CreateHsm

Associated Types

type Rep CreateHsmResponse :: Type -> Type #

Read CreateHsmResponse Source # 
Instance details

Defined in Amazonka.CloudHSM.CreateHsm

Show CreateHsmResponse Source # 
Instance details

Defined in Amazonka.CloudHSM.CreateHsm

NFData CreateHsmResponse Source # 
Instance details

Defined in Amazonka.CloudHSM.CreateHsm

Methods

rnf :: CreateHsmResponse -> () #

Eq CreateHsmResponse Source # 
Instance details

Defined in Amazonka.CloudHSM.CreateHsm

type Rep CreateHsmResponse Source # 
Instance details

Defined in Amazonka.CloudHSM.CreateHsm

type Rep CreateHsmResponse = D1 ('MetaData "CreateHsmResponse" "Amazonka.CloudHSM.CreateHsm" "amazonka-cloudhsm-2.0-AR9j2lWCpfn9LR8RFi06vA" 'False) (C1 ('MetaCons "CreateHsmResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "hsmArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateHsmResponse Source #

Create a value of CreateHsmResponse 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:hsmArn:CreateHsmResponse', createHsmResponse_hsmArn - The ARN of the HSM.

$sel:httpStatus:CreateHsmResponse', createHsmResponse_httpStatus - The response's http status code.

Response Lenses

createHsmResponse_httpStatus :: Lens' CreateHsmResponse Int Source #

The response's http status code.