Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Redshift.CreateHsmConfiguration

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates an HSM configuration that contains the information required by an Amazon Redshift cluster to store and use database encryption keys in a Hardware Security Module (HSM). After creating the HSM configuration, you can specify it as a parameter when creating a cluster. The cluster will then store its encryption keys in the HSM.

In addition to creating an HSM configuration, you must also create an HSM client certificate. For more information, go to Hardware Security Modules in the Amazon Redshift Cluster Management Guide.

Synopsis

Creating a Request

data CreateHsmConfiguration Source #

See: newCreateHsmConfiguration smart constructor.

Constructors

CreateHsmConfiguration'

Fields

tags :: Maybe [Tag]
A list of tag instances.
hsmConfigurationIdentifier :: Text
The identifier to be assigned to the new Amazon Redshift HSM configuration.
description :: Text
A text description of the HSM configuration to be created.
hsmIpAddress :: Text
The IP address that the Amazon Redshift cluster must use to access the HSM.
hsmPartitionName :: Text
The name of the partition in the HSM where the Amazon Redshift clusters will store their database encryption keys.
hsmPartitionPassword :: Text
The password required to access the HSM partition.
hsmServerPublicCertificate :: Text
The HSMs public certificate file. When using Cloud HSM, the file name is server.pem.

Instances

Instances details

Eq CreateHsmConfiguration Source #
Instance details Defined in Amazonka.Redshift.CreateHsmConfiguration Methods (==) :: CreateHsmConfiguration -> CreateHsmConfiguration -> Bool # (/=) :: CreateHsmConfiguration -> CreateHsmConfiguration -> Bool #
Read CreateHsmConfiguration Source #
Instance details Defined in Amazonka.Redshift.CreateHsmConfiguration Methods readsPrec :: Int -> ReadS CreateHsmConfiguration # readList :: ReadS [CreateHsmConfiguration] # readPrec :: ReadPrec CreateHsmConfiguration # readListPrec :: ReadPrec [CreateHsmConfiguration] #
Show CreateHsmConfiguration Source #
Instance details Defined in Amazonka.Redshift.CreateHsmConfiguration Methods showsPrec :: Int -> CreateHsmConfiguration -> ShowS # show :: CreateHsmConfiguration -> String # showList :: [CreateHsmConfiguration] -> ShowS #
Generic CreateHsmConfiguration Source #
Instance details Defined in Amazonka.Redshift.CreateHsmConfiguration Associated Types type Rep CreateHsmConfiguration :: Type -> Type # Methods from :: CreateHsmConfiguration -> Rep CreateHsmConfiguration x # to :: Rep CreateHsmConfiguration x -> CreateHsmConfiguration #
NFData CreateHsmConfiguration Source #
Instance details Defined in Amazonka.Redshift.CreateHsmConfiguration Methods rnf :: CreateHsmConfiguration -> () #
Hashable CreateHsmConfiguration Source #
Instance details Defined in Amazonka.Redshift.CreateHsmConfiguration Methods hashWithSalt :: Int -> CreateHsmConfiguration -> Int # hash :: CreateHsmConfiguration -> Int #
AWSRequest CreateHsmConfiguration Source #
Instance details Defined in Amazonka.Redshift.CreateHsmConfiguration Associated Types type AWSResponse CreateHsmConfiguration # Methods request :: CreateHsmConfiguration -> Request CreateHsmConfiguration # response :: MonadResource m => Logger -> Service -> Proxy CreateHsmConfiguration -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateHsmConfiguration))) #
ToHeaders CreateHsmConfiguration Source #
Instance details Defined in Amazonka.Redshift.CreateHsmConfiguration Methods toHeaders :: CreateHsmConfiguration -> [Header] #
ToPath CreateHsmConfiguration Source #
Instance details Defined in Amazonka.Redshift.CreateHsmConfiguration Methods toPath :: CreateHsmConfiguration -> ByteString #
ToQuery CreateHsmConfiguration Source #
Instance details Defined in Amazonka.Redshift.CreateHsmConfiguration Methods toQuery :: CreateHsmConfiguration -> QueryString #
type Rep CreateHsmConfiguration Source #
Instance details Defined in Amazonka.Redshift.CreateHsmConfiguration type Rep CreateHsmConfiguration = D1 ('MetaData "CreateHsmConfiguration" "Amazonka.Redshift.CreateHsmConfiguration" "libZSservicesZSamazonka-redshiftZSamazonka-redshift" 'False) (C1 ('MetaCons "CreateHsmConfiguration'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :: (S1 ('MetaSel ('Just "hsmConfigurationIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :: ((S1 ('MetaSel ('Just "hsmIpAddress") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "hsmPartitionName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "hsmPartitionPassword") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "hsmServerPublicCertificate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))
type AWSResponse CreateHsmConfiguration Source #
Instance details Defined in Amazonka.Redshift.CreateHsmConfiguration type AWSResponse CreateHsmConfiguration = CreateHsmConfigurationResponse

newCreateHsmConfiguration Source #

Arguments

:: Text	`$sel:hsmConfigurationIdentifier:CreateHsmConfiguration'`
-> Text	`$sel:description:CreateHsmConfiguration'`
-> Text	`$sel:hsmIpAddress:CreateHsmConfiguration'`
-> Text	`$sel:hsmPartitionName:CreateHsmConfiguration'`
-> Text	`$sel:hsmPartitionPassword:CreateHsmConfiguration'`
-> Text	`$sel:hsmServerPublicCertificate:CreateHsmConfiguration'`
-> CreateHsmConfiguration

Create a value of CreateHsmConfiguration 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:tags:CreateHsmConfiguration', createHsmConfiguration_tags - A list of tag instances.

$sel:hsmConfigurationIdentifier:CreateHsmConfiguration', createHsmConfiguration_hsmConfigurationIdentifier - The identifier to be assigned to the new Amazon Redshift HSM configuration.

$sel:description:CreateHsmConfiguration', createHsmConfiguration_description - A text description of the HSM configuration to be created.

$sel:hsmIpAddress:CreateHsmConfiguration', createHsmConfiguration_hsmIpAddress - The IP address that the Amazon Redshift cluster must use to access the HSM.

$sel:hsmPartitionName:CreateHsmConfiguration', createHsmConfiguration_hsmPartitionName - The name of the partition in the HSM where the Amazon Redshift clusters will store their database encryption keys.

$sel:hsmPartitionPassword:CreateHsmConfiguration', createHsmConfiguration_hsmPartitionPassword - The password required to access the HSM partition.

$sel:hsmServerPublicCertificate:CreateHsmConfiguration', createHsmConfiguration_hsmServerPublicCertificate - The HSMs public certificate file. When using Cloud HSM, the file name is server.pem.

Request Lenses

createHsmConfiguration_tags :: Lens' CreateHsmConfiguration (Maybe [Tag]) Source #

A list of tag instances.

createHsmConfiguration_hsmConfigurationIdentifier :: Lens' CreateHsmConfiguration Text Source #

The identifier to be assigned to the new Amazon Redshift HSM configuration.

createHsmConfiguration_description :: Lens' CreateHsmConfiguration Text Source #

A text description of the HSM configuration to be created.

createHsmConfiguration_hsmIpAddress :: Lens' CreateHsmConfiguration Text Source #

The IP address that the Amazon Redshift cluster must use to access the HSM.

createHsmConfiguration_hsmPartitionName :: Lens' CreateHsmConfiguration Text Source #

The name of the partition in the HSM where the Amazon Redshift clusters will store their database encryption keys.

createHsmConfiguration_hsmPartitionPassword :: Lens' CreateHsmConfiguration Text Source #

The password required to access the HSM partition.

createHsmConfiguration_hsmServerPublicCertificate :: Lens' CreateHsmConfiguration Text Source #

The HSMs public certificate file. When using Cloud HSM, the file name is server.pem.

Destructuring the Response

data CreateHsmConfigurationResponse Source #

See: newCreateHsmConfigurationResponse smart constructor.

Constructors

CreateHsmConfigurationResponse'
Fields hsmConfiguration :: Maybe HsmConfiguration httpStatus :: Int The response's http status code.

Instances

Instances details

Eq CreateHsmConfigurationResponse Source #
Instance details Defined in Amazonka.Redshift.CreateHsmConfiguration Methods (==) :: CreateHsmConfigurationResponse -> CreateHsmConfigurationResponse -> Bool # (/=) :: CreateHsmConfigurationResponse -> CreateHsmConfigurationResponse -> Bool #
Read CreateHsmConfigurationResponse Source #
Instance details Defined in Amazonka.Redshift.CreateHsmConfiguration Methods readsPrec :: Int -> ReadS CreateHsmConfigurationResponse # readList :: ReadS [CreateHsmConfigurationResponse] # readPrec :: ReadPrec CreateHsmConfigurationResponse # readListPrec :: ReadPrec [CreateHsmConfigurationResponse] #
Show CreateHsmConfigurationResponse Source #
Instance details Defined in Amazonka.Redshift.CreateHsmConfiguration Methods showsPrec :: Int -> CreateHsmConfigurationResponse -> ShowS # show :: CreateHsmConfigurationResponse -> String # showList :: [CreateHsmConfigurationResponse] -> ShowS #
Generic CreateHsmConfigurationResponse Source #
Instance details Defined in Amazonka.Redshift.CreateHsmConfiguration Associated Types type Rep CreateHsmConfigurationResponse :: Type -> Type # Methods from :: CreateHsmConfigurationResponse -> Rep CreateHsmConfigurationResponse x # to :: Rep CreateHsmConfigurationResponse x -> CreateHsmConfigurationResponse #
NFData CreateHsmConfigurationResponse Source #
Instance details Defined in Amazonka.Redshift.CreateHsmConfiguration Methods rnf :: CreateHsmConfigurationResponse -> () #
type Rep CreateHsmConfigurationResponse Source #
Instance details Defined in Amazonka.Redshift.CreateHsmConfiguration type Rep CreateHsmConfigurationResponse = D1 ('MetaData "CreateHsmConfigurationResponse" "Amazonka.Redshift.CreateHsmConfiguration" "libZSservicesZSamazonka-redshiftZSamazonka-redshift" 'False) (C1 ('MetaCons "CreateHsmConfigurationResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "hsmConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe HsmConfiguration)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateHsmConfigurationResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateHsmConfigurationResponse'`
-> CreateHsmConfigurationResponse

Create a value of CreateHsmConfigurationResponse 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:hsmConfiguration:CreateHsmConfigurationResponse', createHsmConfigurationResponse_hsmConfiguration - Undocumented member.

$sel:httpStatus:CreateHsmConfigurationResponse', createHsmConfigurationResponse_httpStatus - The response's http status code.

Response Lenses

createHsmConfigurationResponse_hsmConfiguration :: Lens' CreateHsmConfigurationResponse (Maybe HsmConfiguration) Source #

Undocumented member.

createHsmConfigurationResponse_httpStatus :: Lens' CreateHsmConfigurationResponse Int Source #

The response's http status code.