amazonka-cloudhsm-2.0: Amazon CloudHSM SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.CloudHSM.GetConfig

Description

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.

Synopsis

Creating a Request

data GetConfig Source #

See: newGetConfig smart constructor.

Constructors

GetConfig' 

Fields

Instances

Instances details
ToJSON GetConfig Source # 
Instance details

Defined in Amazonka.CloudHSM.GetConfig

ToHeaders GetConfig Source # 
Instance details

Defined in Amazonka.CloudHSM.GetConfig

Methods

toHeaders :: GetConfig -> [Header] #

ToPath GetConfig Source # 
Instance details

Defined in Amazonka.CloudHSM.GetConfig

ToQuery GetConfig Source # 
Instance details

Defined in Amazonka.CloudHSM.GetConfig

AWSRequest GetConfig Source # 
Instance details

Defined in Amazonka.CloudHSM.GetConfig

Associated Types

type AWSResponse GetConfig #

Generic GetConfig Source # 
Instance details

Defined in Amazonka.CloudHSM.GetConfig

Associated Types

type Rep GetConfig :: Type -> Type #

Read GetConfig Source # 
Instance details

Defined in Amazonka.CloudHSM.GetConfig

Show GetConfig Source # 
Instance details

Defined in Amazonka.CloudHSM.GetConfig

NFData GetConfig Source # 
Instance details

Defined in Amazonka.CloudHSM.GetConfig

Methods

rnf :: GetConfig -> () #

Eq GetConfig Source # 
Instance details

Defined in Amazonka.CloudHSM.GetConfig

Hashable GetConfig Source # 
Instance details

Defined in Amazonka.CloudHSM.GetConfig

type AWSResponse GetConfig Source # 
Instance details

Defined in Amazonka.CloudHSM.GetConfig

type Rep GetConfig Source # 
Instance details

Defined in Amazonka.CloudHSM.GetConfig

type Rep GetConfig = D1 ('MetaData "GetConfig" "Amazonka.CloudHSM.GetConfig" "amazonka-cloudhsm-2.0-AR9j2lWCpfn9LR8RFi06vA" 'False) (C1 ('MetaCons "GetConfig'" 'PrefixI 'True) (S1 ('MetaSel ('Just "clientArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "clientVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ClientVersion) :*: S1 ('MetaSel ('Just "hapgList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text]))))

newGetConfig Source #

Create a value of GetConfig 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:clientArn:GetConfig', getConfig_clientArn - The ARN of the client.

$sel:clientVersion:GetConfig', getConfig_clientVersion - The client version.

$sel:hapgList:GetConfig', getConfig_hapgList - A list of ARNs that identify the high-availability partition groups that are associated with the client.

Request Lenses

getConfig_clientArn :: Lens' GetConfig Text Source #

The ARN of the client.

getConfig_hapgList :: Lens' GetConfig [Text] Source #

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

Destructuring the Response

data GetConfigResponse Source #

See: newGetConfigResponse smart constructor.

Constructors

GetConfigResponse' 

Fields

Instances

Instances details
Generic GetConfigResponse Source # 
Instance details

Defined in Amazonka.CloudHSM.GetConfig

Associated Types

type Rep GetConfigResponse :: Type -> Type #

Read GetConfigResponse Source # 
Instance details

Defined in Amazonka.CloudHSM.GetConfig

Show GetConfigResponse Source # 
Instance details

Defined in Amazonka.CloudHSM.GetConfig

NFData GetConfigResponse Source # 
Instance details

Defined in Amazonka.CloudHSM.GetConfig

Methods

rnf :: GetConfigResponse -> () #

Eq GetConfigResponse Source # 
Instance details

Defined in Amazonka.CloudHSM.GetConfig

type Rep GetConfigResponse Source # 
Instance details

Defined in Amazonka.CloudHSM.GetConfig

type Rep GetConfigResponse = D1 ('MetaData "GetConfigResponse" "Amazonka.CloudHSM.GetConfig" "amazonka-cloudhsm-2.0-AR9j2lWCpfn9LR8RFi06vA" 'False) (C1 ('MetaCons "GetConfigResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "configCred") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "configFile") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "configType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetConfigResponse Source #

Create a value of GetConfigResponse 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:configCred:GetConfigResponse', getConfigResponse_configCred - The certificate file containing the server.pem files of the HSMs.

$sel:configFile:GetConfigResponse', getConfigResponse_configFile - The chrystoki.conf configuration file.

$sel:configType:GetConfigResponse', getConfigResponse_configType - The type of credentials.

$sel:httpStatus:GetConfigResponse', getConfigResponse_httpStatus - The response's http status code.

Response Lenses

getConfigResponse_configCred :: Lens' GetConfigResponse (Maybe Text) Source #

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

getConfigResponse_configFile :: Lens' GetConfigResponse (Maybe Text) Source #

The chrystoki.conf configuration file.

getConfigResponse_httpStatus :: Lens' GetConfigResponse Int Source #

The response's http status code.