Network.AWS.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

initializeCluster

Arguments

:: Text

icClusterId

-> Text

icSignedCert

-> Text

icTrustAnchor

-> InitializeCluster

Creates a value of InitializeCluster with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• icClusterId - The identifier (ID) of the cluster that you are claiming. To find the cluster ID, use DescribeClusters .
• icSignedCert - 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.
• icTrustAnchor - The issuing certificate of the issuing certificate authority (CA) that issued (signed) the cluster certificate. This can be a root (self-signed) certificate or a certificate chain that begins with the certificate that issued the cluster certificate and ends with a root certificate. The certificate or certificate chain must be in PEM format and can contain a maximum of 5000 characters.

data InitializeCluster

See: initializeCluster smart constructor.

Instances

Eq InitializeCluster

Methods

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

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

Data InitializeCluster

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> InitializeCluster -> c InitializeCluster

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c InitializeCluster

toConstr :: InitializeCluster -> Constr

dataTypeOf :: InitializeCluster -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c InitializeCluster)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c InitializeCluster)

gmapT :: (forall b. Data b => b -> b) -> InitializeCluster -> InitializeCluster

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> InitializeCluster -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> InitializeCluster -> r

gmapQ :: (forall d. Data d => d -> u) -> InitializeCluster -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> InitializeCluster -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> InitializeCluster -> m InitializeCluster

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> InitializeCluster -> m InitializeCluster

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> InitializeCluster -> m InitializeCluster

Read InitializeCluster

Methods

readsPrec :: Int -> ReadS InitializeCluster

readList :: ReadS [InitializeCluster]

readPrec :: ReadPrec InitializeCluster

readListPrec :: ReadPrec [InitializeCluster]

Show InitializeCluster

Methods

showsPrec :: Int -> InitializeCluster -> ShowS

show :: InitializeCluster -> String

showList :: [InitializeCluster] -> ShowS

Generic InitializeCluster

Associated Types

type Rep InitializeCluster :: * -> *

Methods

from :: InitializeCluster -> Rep InitializeCluster x

to :: Rep InitializeCluster x -> InitializeCluster

Hashable InitializeCluster

Methods

hashWithSalt :: Int -> InitializeCluster -> Int

hash :: InitializeCluster -> Int

ToJSON InitializeCluster

Methods

toJSON :: InitializeCluster -> Value

toEncoding :: InitializeCluster -> Encoding

toJSONList :: [InitializeCluster] -> Value

toEncodingList :: [InitializeCluster] -> Encoding

NFData InitializeCluster

Methods

rnf :: InitializeCluster -> ()

AWSRequest InitializeCluster

Associated Types

type Rs InitializeCluster :: *

Methods

request :: InitializeCluster -> Request InitializeCluster

response :: MonadResource m => Logger -> Service -> Proxy * InitializeCluster -> ClientResponse -> m (Response InitializeCluster)

ToQuery InitializeCluster

Methods

toQuery :: InitializeCluster -> QueryString

ToPath InitializeCluster

Methods

toPath :: InitializeCluster -> ByteString

ToHeaders InitializeCluster

Methods

toHeaders :: InitializeCluster -> [Header]

type Rep InitializeCluster

type Rep InitializeCluster = D1 (MetaData "InitializeCluster" "Network.AWS.CloudHSMv2.InitializeCluster" "amazonka-cloudhsmv2-1.5.0-9gkNObchpN7FWF7WWGRIob" False) (C1 (MetaCons "InitializeCluster'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_icClusterId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) ((:*:) (S1 (MetaSel (Just Symbol "_icSignedCert") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_icTrustAnchor") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))))

type Rs InitializeCluster

type Rs InitializeCluster = InitializeClusterResponse

Request Lenses

icClusterId :: Lens' InitializeCluster Text

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

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

icTrustAnchor :: Lens' InitializeCluster Text

The issuing certificate of the issuing certificate authority (CA) that issued (signed) the cluster certificate. This can be a root (self-signed) certificate or a certificate chain that begins with the certificate that issued the cluster certificate and ends with a root certificate. The certificate or certificate chain must be in PEM format and can contain a maximum of 5000 characters.

Destructuring the Response

initializeClusterResponse

Arguments

:: Int

icrsResponseStatus

-> InitializeClusterResponse

Creates a value of InitializeClusterResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• icrsStateMessage - A description of the cluster's state.
• icrsState - The cluster's state.
• icrsResponseStatus - -- | The response status code.

data InitializeClusterResponse

See: initializeClusterResponse smart constructor.

Instances

Eq InitializeClusterResponse

Methods

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

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

Data InitializeClusterResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> InitializeClusterResponse -> c InitializeClusterResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c InitializeClusterResponse

toConstr :: InitializeClusterResponse -> Constr

dataTypeOf :: InitializeClusterResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c InitializeClusterResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c InitializeClusterResponse)

gmapT :: (forall b. Data b => b -> b) -> InitializeClusterResponse -> InitializeClusterResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> InitializeClusterResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> InitializeClusterResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> InitializeClusterResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> InitializeClusterResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> InitializeClusterResponse -> m InitializeClusterResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> InitializeClusterResponse -> m InitializeClusterResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> InitializeClusterResponse -> m InitializeClusterResponse

Read InitializeClusterResponse

Methods

readsPrec :: Int -> ReadS InitializeClusterResponse

readList :: ReadS [InitializeClusterResponse]

readPrec :: ReadPrec InitializeClusterResponse

readListPrec :: ReadPrec [InitializeClusterResponse]

Show InitializeClusterResponse

Methods

showsPrec :: Int -> InitializeClusterResponse -> ShowS

show :: InitializeClusterResponse -> String

showList :: [InitializeClusterResponse] -> ShowS

Generic InitializeClusterResponse

Associated Types

type Rep InitializeClusterResponse :: * -> *

Methods

from :: InitializeClusterResponse -> Rep InitializeClusterResponse x

to :: Rep InitializeClusterResponse x -> InitializeClusterResponse

NFData InitializeClusterResponse

Methods

rnf :: InitializeClusterResponse -> ()

type Rep InitializeClusterResponse

type Rep InitializeClusterResponse = D1 (MetaData "InitializeClusterResponse" "Network.AWS.CloudHSMv2.InitializeCluster" "amazonka-cloudhsmv2-1.5.0-9gkNObchpN7FWF7WWGRIob" False) (C1 (MetaCons "InitializeClusterResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_icrsStateMessage") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_icrsState") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe ClusterState))) (S1 (MetaSel (Just Symbol "_icrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)))))

Response Lenses

icrsStateMessage :: Lens' InitializeClusterResponse (Maybe Text)

A description of the cluster's state.

icrsState :: Lens' InitializeClusterResponse (Maybe ClusterState)

The cluster's state.

icrsResponseStatus :: Lens' InitializeClusterResponse Int

• - | The response status code.