Network.AWS.CloudHSM.GetConfig

This is documentation for AWS CloudHSM Classic . For more information, see AWS CloudHSM Classic FAQs , the AWS CloudHSM Classic User Guide , and the AWS CloudHSM Classic API Reference .

For information about the current version of AWS CloudHSM , see AWS CloudHSM , the AWS CloudHSM User Guide , and the AWS CloudHSM API Reference .

Gets the configuration files necessary to connect to all high availability partition groups the client is associated with.

Creating a Request

getConfig

Arguments

:: Text

gcClientARN

-> ClientVersion

gcClientVersion

-> GetConfig

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

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

• gcClientARN - The ARN of the client.
• gcClientVersion - The client version.
• gcHAPGList - A list of ARNs that identify the high-availability partition groups that are associated with the client.

data GetConfig

See: getConfig smart constructor.

Instances

Eq GetConfig

Methods

(==) :: GetConfig -> GetConfig -> Bool

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

Data GetConfig

Methods

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

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

toConstr :: GetConfig -> Constr

dataTypeOf :: GetConfig -> DataType

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

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

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

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

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

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

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

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

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

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

Read GetConfig

Methods

readsPrec :: Int -> ReadS GetConfig

readList :: ReadS [GetConfig]

readPrec :: ReadPrec GetConfig

readListPrec :: ReadPrec [GetConfig]

Show GetConfig

Methods

showsPrec :: Int -> GetConfig -> ShowS

show :: GetConfig -> String

showList :: [GetConfig] -> ShowS

Generic GetConfig

Associated Types

type Rep GetConfig :: * -> *

Methods

from :: GetConfig -> Rep GetConfig x

to :: Rep GetConfig x -> GetConfig

Hashable GetConfig

Methods

hashWithSalt :: Int -> GetConfig -> Int

hash :: GetConfig -> Int

ToJSON GetConfig

Methods

toJSON :: GetConfig -> Value

toEncoding :: GetConfig -> Encoding

toJSONList :: [GetConfig] -> Value

toEncodingList :: [GetConfig] -> Encoding

NFData GetConfig

Methods

rnf :: GetConfig -> ()

AWSRequest GetConfig

Associated Types

type Rs GetConfig :: *

Methods

request :: GetConfig -> Request GetConfig

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

ToQuery GetConfig

Methods

toQuery :: GetConfig -> QueryString

ToPath GetConfig

Methods

toPath :: GetConfig -> ByteString

ToHeaders GetConfig

Methods

toHeaders :: GetConfig -> [Header]

type Rep GetConfig

type Rep GetConfig = D1 (MetaData "GetConfig" "Network.AWS.CloudHSM.GetConfig" "amazonka-cloudhsm-1.5.0-Ia9d98G2z3xfu0k5IeYfS" False) (C1 (MetaCons "GetConfig'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_gcClientARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) ((:*:) (S1 (MetaSel (Just Symbol "_gcClientVersion") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 ClientVersion)) (S1 (MetaSel (Just Symbol "_gcHAPGList") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 [Text])))))

type Rs GetConfig

type Rs GetConfig = GetConfigResponse

Request Lenses

gcClientARN :: Lens' GetConfig Text

The ARN of the client.

gcClientVersion :: Lens' GetConfig ClientVersion

The client version.

gcHAPGList :: Lens' GetConfig [Text]

A list of ARNs that identify the high-availability partition groups that are associated with the client.

Destructuring the Response

getConfigResponse

Arguments

:: Int

gcrsResponseStatus

-> GetConfigResponse

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

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

• gcrsConfigFile - The chrystoki.conf configuration file.
• gcrsConfigCred - The certificate file containing the server.pem files of the HSMs.
• gcrsConfigType - The type of credentials.
• gcrsResponseStatus - -- | The response status code.

data GetConfigResponse

See: getConfigResponse smart constructor.

Instances

Eq GetConfigResponse

Methods

(==) :: GetConfigResponse -> GetConfigResponse -> Bool

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

Data GetConfigResponse

Methods

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

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

toConstr :: GetConfigResponse -> Constr

dataTypeOf :: GetConfigResponse -> DataType

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

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

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

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

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

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

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

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

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

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

Read GetConfigResponse

Methods

readsPrec :: Int -> ReadS GetConfigResponse

readList :: ReadS [GetConfigResponse]

readPrec :: ReadPrec GetConfigResponse

readListPrec :: ReadPrec [GetConfigResponse]

Show GetConfigResponse

Methods

showsPrec :: Int -> GetConfigResponse -> ShowS

show :: GetConfigResponse -> String

showList :: [GetConfigResponse] -> ShowS

Generic GetConfigResponse

Associated Types

type Rep GetConfigResponse :: * -> *

Methods

from :: GetConfigResponse -> Rep GetConfigResponse x

to :: Rep GetConfigResponse x -> GetConfigResponse

NFData GetConfigResponse

Methods

rnf :: GetConfigResponse -> ()

type Rep GetConfigResponse

type Rep GetConfigResponse = D1 (MetaData "GetConfigResponse" "Network.AWS.CloudHSM.GetConfig" "amazonka-cloudhsm-1.5.0-Ia9d98G2z3xfu0k5IeYfS" False) (C1 (MetaCons "GetConfigResponse'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_gcrsConfigFile") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_gcrsConfigCred") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_gcrsConfigType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_gcrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)))))

Response Lenses

gcrsConfigFile :: Lens' GetConfigResponse (Maybe Text)

The chrystoki.conf configuration file.

gcrsConfigCred :: Lens' GetConfigResponse (Maybe Text)

The certificate file containing the server.pem files of the HSMs.

gcrsConfigType :: Lens' GetConfigResponse (Maybe Text)

The type of credentials.

gcrsResponseStatus :: Lens' GetConfigResponse Int

• - | The response status code.