libZSservicesZSamazonka-cloudhsmv2ZSamazonka-cloudhsmv2
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.CloudHSMV2.InitializeCluster

Description

Claims an AWS CloudHSM cluster by submitting the cluster certificate issued by your issuing certificate authority (CA) and the CA's root certificate. Before you can claim a cluster, you must sign the cluster's certificate signing request (CSR) with your issuing CA. To get the cluster's CSR, use DescribeClusters.

Synopsis

Creating a Request

data InitializeCluster Source #

See: newInitializeCluster smart constructor.

Constructors

InitializeCluster' 

Fields

  • clusterId :: Text

    The identifier (ID) of the cluster that you are claiming. To find the cluster ID, use DescribeClusters.

  • signedCert :: Text

    The cluster certificate issued (signed) by your issuing certificate authority (CA). The certificate must be in PEM format and can contain a maximum of 5000 characters.

  • trustAnchor :: Text

    The issuing certificate of the issuing certificate authority (CA) that issued (signed) the cluster certificate. You must use a self-signed certificate. The certificate used to sign the HSM CSR must be directly available, and thus must be the root certificate. The certificate must be in PEM format and can contain a maximum of 5000 characters.

Instances

Instances details
Eq InitializeCluster Source # 
Instance details

Defined in Amazonka.CloudHSMV2.InitializeCluster

Methods

(==) :: InitializeCluster -> InitializeCluster -> Bool #

(/=) :: InitializeCluster -> InitializeCluster -> Bool #

Read InitializeCluster Source # 
Instance details

Defined in Amazonka.CloudHSMV2.InitializeCluster

Methods

readsPrec :: Int -> ReadS InitializeCluster #

readList :: ReadS [InitializeCluster] #

readPrec :: ReadPrec InitializeCluster #

readListPrec :: ReadPrec [InitializeCluster] #

Show InitializeCluster Source # 
Instance details

Defined in Amazonka.CloudHSMV2.InitializeCluster

Methods

showsPrec :: Int -> InitializeCluster -> ShowS #

show :: InitializeCluster -> String #

showList :: [InitializeCluster] -> ShowS #

Generic InitializeCluster Source # 
Instance details

Defined in Amazonka.CloudHSMV2.InitializeCluster

Associated Types

type Rep InitializeCluster :: Type -> Type #

Methods

from :: InitializeCluster -> Rep InitializeCluster x #

to :: Rep InitializeCluster x -> InitializeCluster #

NFData InitializeCluster Source # 
Instance details

Defined in Amazonka.CloudHSMV2.InitializeCluster

Methods

rnf :: InitializeCluster -> () #

Hashable InitializeCluster Source # 
Instance details

Defined in Amazonka.CloudHSMV2.InitializeCluster

Methods

hashWithSalt :: Int -> InitializeCluster -> Int #

hash :: InitializeCluster -> Int #

ToJSON InitializeCluster Source # 
Instance details

Defined in Amazonka.CloudHSMV2.InitializeCluster

Methods

toJSON :: InitializeCluster -> Value #

toEncoding :: InitializeCluster -> Encoding #

toJSONList :: [InitializeCluster] -> Value #

toEncodingList :: [InitializeCluster] -> Encoding #

AWSRequest InitializeCluster Source # 
Instance details

Defined in Amazonka.CloudHSMV2.InitializeCluster

Associated Types

type AWSResponse InitializeCluster #

Methods

request :: InitializeCluster -> Request InitializeCluster #

response :: MonadResource m => Logger -> Service -> Proxy InitializeCluster -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse InitializeCluster))) #

ToHeaders InitializeCluster Source # 
Instance details

Defined in Amazonka.CloudHSMV2.InitializeCluster

Methods

toHeaders :: InitializeCluster -> [Header] #

ToPath InitializeCluster Source # 
Instance details

Defined in Amazonka.CloudHSMV2.InitializeCluster

Methods

toPath :: InitializeCluster -> ByteString #

ToQuery InitializeCluster Source # 
Instance details

Defined in Amazonka.CloudHSMV2.InitializeCluster

Methods

toQuery :: InitializeCluster -> QueryString #

type Rep InitializeCluster Source # 
Instance details

Defined in Amazonka.CloudHSMV2.InitializeCluster

type Rep InitializeCluster = D1 ('MetaData "InitializeCluster" "Amazonka.CloudHSMV2.InitializeCluster" "libZSservicesZSamazonka-cloudhsmv2ZSamazonka-cloudhsmv2" 'False) (C1 ('MetaCons "InitializeCluster'" 'PrefixI 'True) (S1 ('MetaSel ('Just "clusterId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "signedCert") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "trustAnchor") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse InitializeCluster Source # 
Instance details

Defined in Amazonka.CloudHSMV2.InitializeCluster

type AWSResponse InitializeCluster = InitializeClusterResponse

newInitializeCluster Source #

Arguments

:: Text

$sel:clusterId:InitializeCluster'

-> Text

$sel:signedCert:InitializeCluster'

-> Text

$sel:trustAnchor:InitializeCluster'

-> InitializeCluster 

Create a value of InitializeCluster 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:clusterId:InitializeCluster', initializeCluster_clusterId - The identifier (ID) of the cluster that you are claiming. To find the cluster ID, use DescribeClusters.

$sel:signedCert:InitializeCluster', initializeCluster_signedCert - The cluster certificate issued (signed) by your issuing certificate authority (CA). The certificate must be in PEM format and can contain a maximum of 5000 characters.

$sel:trustAnchor:InitializeCluster', initializeCluster_trustAnchor - The issuing certificate of the issuing certificate authority (CA) that issued (signed) the cluster certificate. You must use a self-signed certificate. The certificate used to sign the HSM CSR must be directly available, and thus must be the root certificate. The certificate must be in PEM format and can contain a maximum of 5000 characters.

Request Lenses

initializeCluster_clusterId :: Lens' InitializeCluster Text Source #

The identifier (ID) of the cluster that you are claiming. To find the cluster ID, use DescribeClusters.

initializeCluster_signedCert :: Lens' InitializeCluster Text Source #

The cluster certificate issued (signed) by your issuing certificate authority (CA). The certificate must be in PEM format and can contain a maximum of 5000 characters.

initializeCluster_trustAnchor :: Lens' InitializeCluster Text Source #

The issuing certificate of the issuing certificate authority (CA) that issued (signed) the cluster certificate. You must use a self-signed certificate. The certificate used to sign the HSM CSR must be directly available, and thus must be the root certificate. The certificate must be in PEM format and can contain a maximum of 5000 characters.

Destructuring the Response

data InitializeClusterResponse Source #

See: newInitializeClusterResponse smart constructor.

Constructors

InitializeClusterResponse' 

Fields

Instances

Instances details
Eq InitializeClusterResponse Source # 
Instance details

Defined in Amazonka.CloudHSMV2.InitializeCluster

Methods

(==) :: InitializeClusterResponse -> InitializeClusterResponse -> Bool #

(/=) :: InitializeClusterResponse -> InitializeClusterResponse -> Bool #

Read InitializeClusterResponse Source # 
Instance details

Defined in Amazonka.CloudHSMV2.InitializeCluster

Methods

readsPrec :: Int -> ReadS InitializeClusterResponse #

readList :: ReadS [InitializeClusterResponse] #

readPrec :: ReadPrec InitializeClusterResponse #

readListPrec :: ReadPrec [InitializeClusterResponse] #

Show InitializeClusterResponse Source # 
Instance details

Defined in Amazonka.CloudHSMV2.InitializeCluster

Methods

showsPrec :: Int -> InitializeClusterResponse -> ShowS #

show :: InitializeClusterResponse -> String #

showList :: [InitializeClusterResponse] -> ShowS #

Generic InitializeClusterResponse Source # 
Instance details

Defined in Amazonka.CloudHSMV2.InitializeCluster

Associated Types

type Rep InitializeClusterResponse :: Type -> Type #

Methods

from :: InitializeClusterResponse -> Rep InitializeClusterResponse x #

to :: Rep InitializeClusterResponse x -> InitializeClusterResponse #

NFData InitializeClusterResponse Source # 
Instance details

Defined in Amazonka.CloudHSMV2.InitializeCluster

Methods

rnf :: InitializeClusterResponse -> () #

type Rep InitializeClusterResponse Source # 
Instance details

Defined in Amazonka.CloudHSMV2.InitializeCluster

type Rep InitializeClusterResponse = D1 ('MetaData "InitializeClusterResponse" "Amazonka.CloudHSMV2.InitializeCluster" "libZSservicesZSamazonka-cloudhsmv2ZSamazonka-cloudhsmv2" 'False) (C1 ('MetaCons "InitializeClusterResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "stateMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ClusterState)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newInitializeClusterResponse Source #

Arguments

:: Int

$sel:httpStatus:InitializeClusterResponse'

-> InitializeClusterResponse 

Create a value of InitializeClusterResponse 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:stateMessage:InitializeClusterResponse', initializeClusterResponse_stateMessage - A description of the cluster's state.

$sel:state:InitializeClusterResponse', initializeClusterResponse_state - The cluster's state.

$sel:httpStatus:InitializeClusterResponse', initializeClusterResponse_httpStatus - The response's http status code.

Response Lenses

initializeClusterResponse_stateMessage :: Lens' InitializeClusterResponse (Maybe Text) Source #

A description of the cluster's state.

initializeClusterResponse_state :: Lens' InitializeClusterResponse (Maybe ClusterState) Source #

The cluster's state.

initializeClusterResponse_httpStatus :: Lens' InitializeClusterResponse Int Source #

The response's http status code.