Amazonka.CloudHSMV2.InitializeCluster

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.

Creating a Request

data InitializeCluster

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

ToJSON InitializeCluster

Defined in Amazonka.CloudHSMV2.InitializeCluster

Methods

toJSON :: InitializeCluster -> Value

toEncoding :: InitializeCluster -> Encoding

toJSONList :: [InitializeCluster] -> Value

toEncodingList :: [InitializeCluster] -> Encoding

ToHeaders InitializeCluster

Defined in Amazonka.CloudHSMV2.InitializeCluster

Methods

toHeaders :: InitializeCluster -> [Header]

ToPath InitializeCluster

Defined in Amazonka.CloudHSMV2.InitializeCluster

Methods

toPath :: InitializeCluster -> ByteString

ToQuery InitializeCluster

Defined in Amazonka.CloudHSMV2.InitializeCluster

Methods

toQuery :: InitializeCluster -> QueryString

AWSRequest InitializeCluster

Defined in Amazonka.CloudHSMV2.InitializeCluster

Associated Types

type AWSResponse InitializeCluster

Methods

request :: (Service -> Service) -> InitializeCluster -> Request InitializeCluster

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

Generic InitializeCluster

Defined in Amazonka.CloudHSMV2.InitializeCluster

Associated Types

type Rep InitializeCluster :: Type -> Type

Methods

from :: InitializeCluster -> Rep InitializeCluster x

to :: Rep InitializeCluster x -> InitializeCluster

Read InitializeCluster

Defined in Amazonka.CloudHSMV2.InitializeCluster

Methods

readsPrec :: Int -> ReadS InitializeCluster

readList :: ReadS [InitializeCluster]

readPrec :: ReadPrec InitializeCluster

readListPrec :: ReadPrec [InitializeCluster]

Show InitializeCluster

Defined in Amazonka.CloudHSMV2.InitializeCluster

Methods

showsPrec :: Int -> InitializeCluster -> ShowS

show :: InitializeCluster -> String

showList :: [InitializeCluster] -> ShowS

NFData InitializeCluster

Defined in Amazonka.CloudHSMV2.InitializeCluster

Methods

rnf :: InitializeCluster -> ()

Eq InitializeCluster

Defined in Amazonka.CloudHSMV2.InitializeCluster

Methods

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

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

Hashable InitializeCluster

Defined in Amazonka.CloudHSMV2.InitializeCluster

Methods

hashWithSalt :: Int -> InitializeCluster -> Int

hash :: InitializeCluster -> Int

type AWSResponse InitializeCluster

Defined in Amazonka.CloudHSMV2.InitializeCluster

type AWSResponse InitializeCluster = InitializeClusterResponse

type Rep InitializeCluster

Defined in Amazonka.CloudHSMV2.InitializeCluster

type Rep InitializeCluster = D1 ('MetaData "InitializeCluster" "Amazonka.CloudHSMV2.InitializeCluster" "amazonka-cloudhsmv2-2.0-JPONnjzt63Q1wP3HCntyXZ" '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))))

newInitializeCluster

Arguments

:: Text

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:

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

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

initializeCluster_signedCert :: Lens' InitializeCluster 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.

initializeCluster_trustAnchor :: Lens' InitializeCluster 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.

Destructuring the Response

data InitializeClusterResponse

See: newInitializeClusterResponse smart constructor.

Constructors

InitializeClusterResponse'

Fields

• state :: Maybe ClusterState

  The cluster's state.

• stateMessage :: Maybe Text

  A description of the cluster's state.

• httpStatus :: Int

  The response's http status code.

Instances

Generic InitializeClusterResponse

Defined in Amazonka.CloudHSMV2.InitializeCluster

Associated Types

type Rep InitializeClusterResponse :: Type -> Type

Methods

from :: InitializeClusterResponse -> Rep InitializeClusterResponse x

to :: Rep InitializeClusterResponse x -> InitializeClusterResponse

Read InitializeClusterResponse

Defined in Amazonka.CloudHSMV2.InitializeCluster

Methods

readsPrec :: Int -> ReadS InitializeClusterResponse

readList :: ReadS [InitializeClusterResponse]

readPrec :: ReadPrec InitializeClusterResponse

readListPrec :: ReadPrec [InitializeClusterResponse]

Show InitializeClusterResponse

Defined in Amazonka.CloudHSMV2.InitializeCluster

Methods

showsPrec :: Int -> InitializeClusterResponse -> ShowS

show :: InitializeClusterResponse -> String

showList :: [InitializeClusterResponse] -> ShowS

NFData InitializeClusterResponse

Defined in Amazonka.CloudHSMV2.InitializeCluster

Methods

rnf :: InitializeClusterResponse -> ()

Eq InitializeClusterResponse

Defined in Amazonka.CloudHSMV2.InitializeCluster

Methods

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

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

type Rep InitializeClusterResponse

Defined in Amazonka.CloudHSMV2.InitializeCluster

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

newInitializeClusterResponse

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:

InitializeClusterResponse, initializeClusterResponse_state - The cluster's state.

InitializeClusterResponse, initializeClusterResponse_stateMessage - A description of the cluster's state.

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

Response Lenses

initializeClusterResponse_state :: Lens' InitializeClusterResponse (Maybe ClusterState)

The cluster's state.

initializeClusterResponse_stateMessage :: Lens' InitializeClusterResponse (Maybe Text)

A description of the cluster's state.

initializeClusterResponse_httpStatus :: Lens' InitializeClusterResponse Int

The response's http status code.