{-# LANGUAGE DeriveGeneric #-} {-# LANGUAGE DuplicateRecordFields #-} {-# LANGUAGE NamedFieldPuns #-} {-# LANGUAGE OverloadedStrings #-} {-# LANGUAGE RecordWildCards #-} {-# LANGUAGE StrictData #-} {-# LANGUAGE TypeFamilies #-} {-# LANGUAGE NoImplicitPrelude #-} {-# OPTIONS_GHC -fno-warn-unused-binds #-} {-# OPTIONS_GHC -fno-warn-unused-imports #-} {-# OPTIONS_GHC -fno-warn-unused-matches #-} -- Derived from AWS service descriptions, licensed under Apache 2.0. -- | -- Module : Amazonka.CloudHSMV2.InitializeCluster -- Copyright : (c) 2013-2023 Brendan Hay -- License : Mozilla Public License, v. 2.0. -- Maintainer : Brendan Hay -- Stability : auto-generated -- Portability : non-portable (GHC extensions) -- -- 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. module Amazonka.CloudHSMV2.InitializeCluster ( -- * Creating a Request InitializeCluster (..), newInitializeCluster, -- * Request Lenses initializeCluster_clusterId, initializeCluster_signedCert, initializeCluster_trustAnchor, -- * Destructuring the Response InitializeClusterResponse (..), newInitializeClusterResponse, -- * Response Lenses initializeClusterResponse_state, initializeClusterResponse_stateMessage, initializeClusterResponse_httpStatus, ) where import Amazonka.CloudHSMV2.Types import qualified Amazonka.Core as Core import qualified Amazonka.Core.Lens.Internal as Lens import qualified Amazonka.Data as Data import qualified Amazonka.Prelude as Prelude import qualified Amazonka.Request as Request import qualified Amazonka.Response as Response -- | /See:/ 'newInitializeCluster' smart constructor. data InitializeCluster = InitializeCluster' { -- | The identifier (ID) of the cluster that you are claiming. To find the -- cluster ID, use DescribeClusters. clusterId :: Prelude.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. signedCert :: Prelude.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. trustAnchor :: Prelude.Text } deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic) -- | -- Create a value of 'InitializeCluster' with all optional fields omitted. -- -- Use or to modify other optional fields. -- -- The following record fields are available, with the corresponding lenses provided -- for backwards compatibility: -- -- 'clusterId', 'initializeCluster_clusterId' - The identifier (ID) of the cluster that you are claiming. To find the -- cluster ID, use DescribeClusters. -- -- 'signedCert', '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. -- -- 'trustAnchor', '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. newInitializeCluster :: -- | 'clusterId' Prelude.Text -> -- | 'signedCert' Prelude.Text -> -- | 'trustAnchor' Prelude.Text -> InitializeCluster newInitializeCluster pClusterId_ pSignedCert_ pTrustAnchor_ = InitializeCluster' { clusterId = pClusterId_, signedCert = pSignedCert_, trustAnchor = pTrustAnchor_ } -- | The identifier (ID) of the cluster that you are claiming. To find the -- cluster ID, use DescribeClusters. initializeCluster_clusterId :: Lens.Lens' InitializeCluster Prelude.Text initializeCluster_clusterId = Lens.lens (\InitializeCluster' {clusterId} -> clusterId) (\s@InitializeCluster' {} a -> s {clusterId = a} :: InitializeCluster) -- | 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_signedCert :: Lens.Lens' InitializeCluster Prelude.Text initializeCluster_signedCert = Lens.lens (\InitializeCluster' {signedCert} -> signedCert) (\s@InitializeCluster' {} a -> s {signedCert = a} :: InitializeCluster) -- | 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. initializeCluster_trustAnchor :: Lens.Lens' InitializeCluster Prelude.Text initializeCluster_trustAnchor = Lens.lens (\InitializeCluster' {trustAnchor} -> trustAnchor) (\s@InitializeCluster' {} a -> s {trustAnchor = a} :: InitializeCluster) instance Core.AWSRequest InitializeCluster where type AWSResponse InitializeCluster = InitializeClusterResponse request overrides = Request.postJSON (overrides defaultService) response = Response.receiveJSON ( \s h x -> InitializeClusterResponse' Prelude.<$> (x Data..?> "State") Prelude.<*> (x Data..?> "StateMessage") Prelude.<*> (Prelude.pure (Prelude.fromEnum s)) ) instance Prelude.Hashable InitializeCluster where hashWithSalt _salt InitializeCluster' {..} = _salt `Prelude.hashWithSalt` clusterId `Prelude.hashWithSalt` signedCert `Prelude.hashWithSalt` trustAnchor instance Prelude.NFData InitializeCluster where rnf InitializeCluster' {..} = Prelude.rnf clusterId `Prelude.seq` Prelude.rnf signedCert `Prelude.seq` Prelude.rnf trustAnchor instance Data.ToHeaders InitializeCluster where toHeaders = Prelude.const ( Prelude.mconcat [ "X-Amz-Target" Data.=# ( "BaldrApiService.InitializeCluster" :: Prelude.ByteString ), "Content-Type" Data.=# ( "application/x-amz-json-1.1" :: Prelude.ByteString ) ] ) instance Data.ToJSON InitializeCluster where toJSON InitializeCluster' {..} = Data.object ( Prelude.catMaybes [ Prelude.Just ("ClusterId" Data..= clusterId), Prelude.Just ("SignedCert" Data..= signedCert), Prelude.Just ("TrustAnchor" Data..= trustAnchor) ] ) instance Data.ToPath InitializeCluster where toPath = Prelude.const "/" instance Data.ToQuery InitializeCluster where toQuery = Prelude.const Prelude.mempty -- | /See:/ 'newInitializeClusterResponse' smart constructor. data InitializeClusterResponse = InitializeClusterResponse' { -- | The cluster\'s state. state :: Prelude.Maybe ClusterState, -- | A description of the cluster\'s state. stateMessage :: Prelude.Maybe Prelude.Text, -- | The response's http status code. httpStatus :: Prelude.Int } deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic) -- | -- Create a value of 'InitializeClusterResponse' with all optional fields omitted. -- -- Use or to modify other optional fields. -- -- The following record fields are available, with the corresponding lenses provided -- for backwards compatibility: -- -- 'state', 'initializeClusterResponse_state' - The cluster\'s state. -- -- 'stateMessage', 'initializeClusterResponse_stateMessage' - A description of the cluster\'s state. -- -- 'httpStatus', 'initializeClusterResponse_httpStatus' - The response's http status code. newInitializeClusterResponse :: -- | 'httpStatus' Prelude.Int -> InitializeClusterResponse newInitializeClusterResponse pHttpStatus_ = InitializeClusterResponse' { state = Prelude.Nothing, stateMessage = Prelude.Nothing, httpStatus = pHttpStatus_ } -- | The cluster\'s state. initializeClusterResponse_state :: Lens.Lens' InitializeClusterResponse (Prelude.Maybe ClusterState) initializeClusterResponse_state = Lens.lens (\InitializeClusterResponse' {state} -> state) (\s@InitializeClusterResponse' {} a -> s {state = a} :: InitializeClusterResponse) -- | A description of the cluster\'s state. initializeClusterResponse_stateMessage :: Lens.Lens' InitializeClusterResponse (Prelude.Maybe Prelude.Text) initializeClusterResponse_stateMessage = Lens.lens (\InitializeClusterResponse' {stateMessage} -> stateMessage) (\s@InitializeClusterResponse' {} a -> s {stateMessage = a} :: InitializeClusterResponse) -- | The response's http status code. initializeClusterResponse_httpStatus :: Lens.Lens' InitializeClusterResponse Prelude.Int initializeClusterResponse_httpStatus = Lens.lens (\InitializeClusterResponse' {httpStatus} -> httpStatus) (\s@InitializeClusterResponse' {} a -> s {httpStatus = a} :: InitializeClusterResponse) instance Prelude.NFData InitializeClusterResponse where rnf InitializeClusterResponse' {..} = Prelude.rnf state `Prelude.seq` Prelude.rnf stateMessage `Prelude.seq` Prelude.rnf httpStatus