Copyright	(c) 2013-2021 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

Amazonka.CloudHSMV2.CreateHsm

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a new hardware security module (HSM) in the specified AWS CloudHSM cluster.

Synopsis

data CreateHsm = CreateHsm' {
- ipAddress :: Maybe Text
- clusterId :: Text
- availabilityZone :: Text
}
newCreateHsm :: Text -> Text -> CreateHsm
createHsm_ipAddress :: Lens' CreateHsm (Maybe Text)
createHsm_clusterId :: Lens' CreateHsm Text
createHsm_availabilityZone :: Lens' CreateHsm Text
data CreateHsmResponse = CreateHsmResponse' {
- hsm :: Maybe Hsm
- httpStatus :: Int
}
newCreateHsmResponse :: Int -> CreateHsmResponse
createHsmResponse_hsm :: Lens' CreateHsmResponse (Maybe Hsm)
createHsmResponse_httpStatus :: Lens' CreateHsmResponse Int

Creating a Request

data CreateHsm Source #

See: newCreateHsm smart constructor.

Constructors

CreateHsm'

Fields

ipAddress :: Maybe Text
The HSM's IP address. If you specify an IP address, use an available address from the subnet that maps to the Availability Zone where you are creating the HSM. If you don't specify an IP address, one is chosen for you from that subnet.
clusterId :: Text
The identifier (ID) of the HSM's cluster. To find the cluster ID, use DescribeClusters.
availabilityZone :: Text
The Availability Zone where you are creating the HSM. To find the cluster's Availability Zones, use DescribeClusters.

Instances

Instances details

Eq CreateHsm Source #
Instance details Defined in Amazonka.CloudHSMV2.CreateHsm Methods (==) :: CreateHsm -> CreateHsm -> Bool # (/=) :: CreateHsm -> CreateHsm -> Bool #
Read CreateHsm Source #
Instance details Defined in Amazonka.CloudHSMV2.CreateHsm Methods readsPrec :: Int -> ReadS CreateHsm # readList :: ReadS [CreateHsm] # readPrec :: ReadPrec CreateHsm # readListPrec :: ReadPrec [CreateHsm] #
Show CreateHsm Source #
Instance details Defined in Amazonka.CloudHSMV2.CreateHsm Methods showsPrec :: Int -> CreateHsm -> ShowS # show :: CreateHsm -> String # showList :: [CreateHsm] -> ShowS #
Generic CreateHsm Source #
Instance details Defined in Amazonka.CloudHSMV2.CreateHsm Associated Types type Rep CreateHsm :: Type -> Type # Methods from :: CreateHsm -> Rep CreateHsm x # to :: Rep CreateHsm x -> CreateHsm #
NFData CreateHsm Source #
Instance details Defined in Amazonka.CloudHSMV2.CreateHsm Methods rnf :: CreateHsm -> () #
Hashable CreateHsm Source #
Instance details Defined in Amazonka.CloudHSMV2.CreateHsm Methods hashWithSalt :: Int -> CreateHsm -> Int # hash :: CreateHsm -> Int #
ToJSON CreateHsm Source #
Instance details Defined in Amazonka.CloudHSMV2.CreateHsm Methods toJSON :: CreateHsm -> Value # toEncoding :: CreateHsm -> Encoding # toJSONList :: [CreateHsm] -> Value # toEncodingList :: [CreateHsm] -> Encoding #
AWSRequest CreateHsm Source #
Instance details Defined in Amazonka.CloudHSMV2.CreateHsm Associated Types type AWSResponse CreateHsm # Methods request :: CreateHsm -> Request CreateHsm # response :: MonadResource m => Logger -> Service -> Proxy CreateHsm -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateHsm))) #
ToHeaders CreateHsm Source #
Instance details Defined in Amazonka.CloudHSMV2.CreateHsm Methods toHeaders :: CreateHsm -> [Header] #
ToPath CreateHsm Source #
Instance details Defined in Amazonka.CloudHSMV2.CreateHsm Methods toPath :: CreateHsm -> ByteString #
ToQuery CreateHsm Source #
Instance details Defined in Amazonka.CloudHSMV2.CreateHsm Methods toQuery :: CreateHsm -> QueryString #
type Rep CreateHsm Source #
Instance details Defined in Amazonka.CloudHSMV2.CreateHsm type Rep CreateHsm = D1 ('MetaData "CreateHsm" "Amazonka.CloudHSMV2.CreateHsm" "libZSservicesZSamazonka-cloudhsmv2ZSamazonka-cloudhsmv2" 'False) (C1 ('MetaCons "CreateHsm'" 'PrefixI 'True) (S1 ('MetaSel ('Just "ipAddress") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "clusterId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "availabilityZone") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse CreateHsm Source #
Instance details Defined in Amazonka.CloudHSMV2.CreateHsm type AWSResponse CreateHsm = CreateHsmResponse

newCreateHsm Source #

Arguments

:: Text	`$sel:clusterId:CreateHsm'`
-> Text	`$sel:availabilityZone:CreateHsm'`
-> CreateHsm

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:ipAddress:CreateHsm', createHsm_ipAddress - The HSM's IP address. If you specify an IP address, use an available address from the subnet that maps to the Availability Zone where you are creating the HSM. If you don't specify an IP address, one is chosen for you from that subnet.

$sel:clusterId:CreateHsm', createHsm_clusterId - The identifier (ID) of the HSM's cluster. To find the cluster ID, use DescribeClusters.

$sel:availabilityZone:CreateHsm', createHsm_availabilityZone - The Availability Zone where you are creating the HSM. To find the cluster's Availability Zones, use DescribeClusters.

Request Lenses

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

The HSM's IP address. If you specify an IP address, use an available address from the subnet that maps to the Availability Zone where you are creating the HSM. If you don't specify an IP address, one is chosen for you from that subnet.

createHsm_clusterId :: Lens' CreateHsm Text Source #

The identifier (ID) of the HSM's cluster. To find the cluster ID, use DescribeClusters.

createHsm_availabilityZone :: Lens' CreateHsm Text Source #

The Availability Zone where you are creating the HSM. To find the cluster's Availability Zones, use DescribeClusters.

Destructuring the Response

data CreateHsmResponse Source #

See: newCreateHsmResponse smart constructor.

Constructors

CreateHsmResponse'
Fields hsm :: Maybe Hsm Information about the HSM that was created. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq CreateHsmResponse Source #
Instance details Defined in Amazonka.CloudHSMV2.CreateHsm Methods (==) :: CreateHsmResponse -> CreateHsmResponse -> Bool # (/=) :: CreateHsmResponse -> CreateHsmResponse -> Bool #
Read CreateHsmResponse Source #
Instance details Defined in Amazonka.CloudHSMV2.CreateHsm Methods readsPrec :: Int -> ReadS CreateHsmResponse # readList :: ReadS [CreateHsmResponse] # readPrec :: ReadPrec CreateHsmResponse # readListPrec :: ReadPrec [CreateHsmResponse] #
Show CreateHsmResponse Source #
Instance details Defined in Amazonka.CloudHSMV2.CreateHsm Methods showsPrec :: Int -> CreateHsmResponse -> ShowS # show :: CreateHsmResponse -> String # showList :: [CreateHsmResponse] -> ShowS #
Generic CreateHsmResponse Source #
Instance details Defined in Amazonka.CloudHSMV2.CreateHsm Associated Types type Rep CreateHsmResponse :: Type -> Type # Methods from :: CreateHsmResponse -> Rep CreateHsmResponse x # to :: Rep CreateHsmResponse x -> CreateHsmResponse #
NFData CreateHsmResponse Source #
Instance details Defined in Amazonka.CloudHSMV2.CreateHsm Methods rnf :: CreateHsmResponse -> () #
type Rep CreateHsmResponse Source #
Instance details Defined in Amazonka.CloudHSMV2.CreateHsm type Rep CreateHsmResponse = D1 ('MetaData "CreateHsmResponse" "Amazonka.CloudHSMV2.CreateHsm" "libZSservicesZSamazonka-cloudhsmv2ZSamazonka-cloudhsmv2" 'False) (C1 ('MetaCons "CreateHsmResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "hsm") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Hsm)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateHsmResponse Source #

Arguments

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

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:hsm:CreateHsmResponse', createHsmResponse_hsm - Information about the HSM that was created.

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

Response Lenses

createHsmResponse_hsm :: Lens' CreateHsmResponse (Maybe Hsm) Source #

Information about the HSM that was created.

createHsmResponse_httpStatus :: Lens' CreateHsmResponse Int Source #

The response's http status code.