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.CloudHSM.ModifyHsm

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

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.

Modifies an HSM.

This operation can result in the HSM being offline for up to 15 minutes while the AWS CloudHSM service is reconfigured. If you are modifying a production HSM, you should ensure that your AWS CloudHSM service is configured for high availability, and consider executing this operation during a maintenance window.

Synopsis

data ModifyHsm = ModifyHsm' {
- iamRoleArn :: Maybe Text
- subnetId :: Maybe Text
- syslogIp :: Maybe Text
- externalId :: Maybe Text
- eniIp :: Maybe Text
- hsmArn :: Text
}
newModifyHsm :: Text -> ModifyHsm
modifyHsm_iamRoleArn :: Lens' ModifyHsm (Maybe Text)
modifyHsm_subnetId :: Lens' ModifyHsm (Maybe Text)
modifyHsm_syslogIp :: Lens' ModifyHsm (Maybe Text)
modifyHsm_externalId :: Lens' ModifyHsm (Maybe Text)
modifyHsm_eniIp :: Lens' ModifyHsm (Maybe Text)
modifyHsm_hsmArn :: Lens' ModifyHsm Text
data ModifyHsmResponse = ModifyHsmResponse' {
- hsmArn :: Maybe Text
- httpStatus :: Int
}
newModifyHsmResponse :: Int -> ModifyHsmResponse
modifyHsmResponse_hsmArn :: Lens' ModifyHsmResponse (Maybe Text)
modifyHsmResponse_httpStatus :: Lens' ModifyHsmResponse Int

Creating a Request

data ModifyHsm Source #

Contains the inputs for the ModifyHsm operation.

See: newModifyHsm smart constructor.

Constructors

ModifyHsm'

Fields

iamRoleArn :: Maybe Text
The new IAM role ARN.
subnetId :: Maybe Text
The new identifier of the subnet that the HSM is in. The new subnet must be in the same Availability Zone as the current subnet.
syslogIp :: Maybe Text
The new IP address for the syslog monitoring server. The AWS CloudHSM service only supports one syslog monitoring server.
externalId :: Maybe Text
The new external ID.
eniIp :: Maybe Text
The new IP address for the elastic network interface (ENI) attached to the HSM.
If the HSM is moved to a different subnet, and an IP address is not specified, an IP address will be randomly chosen from the CIDR range of the new subnet.
hsmArn :: Text
The ARN of the HSM to modify.

Instances

Instances details

Eq ModifyHsm Source #
Instance details Defined in Amazonka.CloudHSM.ModifyHsm Methods (==) :: ModifyHsm -> ModifyHsm -> Bool # (/=) :: ModifyHsm -> ModifyHsm -> Bool #
Read ModifyHsm Source #
Instance details Defined in Amazonka.CloudHSM.ModifyHsm Methods readsPrec :: Int -> ReadS ModifyHsm # readList :: ReadS [ModifyHsm] # readPrec :: ReadPrec ModifyHsm # readListPrec :: ReadPrec [ModifyHsm] #
Show ModifyHsm Source #
Instance details Defined in Amazonka.CloudHSM.ModifyHsm Methods showsPrec :: Int -> ModifyHsm -> ShowS # show :: ModifyHsm -> String # showList :: [ModifyHsm] -> ShowS #
Generic ModifyHsm Source #
Instance details Defined in Amazonka.CloudHSM.ModifyHsm Associated Types type Rep ModifyHsm :: Type -> Type # Methods from :: ModifyHsm -> Rep ModifyHsm x # to :: Rep ModifyHsm x -> ModifyHsm #
NFData ModifyHsm Source #
Instance details Defined in Amazonka.CloudHSM.ModifyHsm Methods rnf :: ModifyHsm -> () #
Hashable ModifyHsm Source #
Instance details Defined in Amazonka.CloudHSM.ModifyHsm Methods hashWithSalt :: Int -> ModifyHsm -> Int # hash :: ModifyHsm -> Int #
ToJSON ModifyHsm Source #
Instance details Defined in Amazonka.CloudHSM.ModifyHsm Methods toJSON :: ModifyHsm -> Value # toEncoding :: ModifyHsm -> Encoding # toJSONList :: [ModifyHsm] -> Value # toEncodingList :: [ModifyHsm] -> Encoding #
AWSRequest ModifyHsm Source #
Instance details Defined in Amazonka.CloudHSM.ModifyHsm Associated Types type AWSResponse ModifyHsm # Methods request :: ModifyHsm -> Request ModifyHsm # response :: MonadResource m => Logger -> Service -> Proxy ModifyHsm -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ModifyHsm))) #
ToHeaders ModifyHsm Source #
Instance details Defined in Amazonka.CloudHSM.ModifyHsm Methods toHeaders :: ModifyHsm -> [Header] #
ToPath ModifyHsm Source #
Instance details Defined in Amazonka.CloudHSM.ModifyHsm Methods toPath :: ModifyHsm -> ByteString #
ToQuery ModifyHsm Source #
Instance details Defined in Amazonka.CloudHSM.ModifyHsm Methods toQuery :: ModifyHsm -> QueryString #
type Rep ModifyHsm Source #
Instance details Defined in Amazonka.CloudHSM.ModifyHsm type Rep ModifyHsm = D1 ('MetaData "ModifyHsm" "Amazonka.CloudHSM.ModifyHsm" "libZSservicesZSamazonka-cloudhsmZSamazonka-cloudhsm" 'False) (C1 ('MetaCons "ModifyHsm'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "iamRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "subnetId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "syslogIp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "externalId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "eniIp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "hsmArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))
type AWSResponse ModifyHsm Source #
Instance details Defined in Amazonka.CloudHSM.ModifyHsm type AWSResponse ModifyHsm = ModifyHsmResponse

newModifyHsm Source #

Arguments

:: Text	`$sel:hsmArn:ModifyHsm'`
-> ModifyHsm

Create a value of ModifyHsm 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:iamRoleArn:ModifyHsm', modifyHsm_iamRoleArn - The new IAM role ARN.

$sel:subnetId:ModifyHsm', modifyHsm_subnetId - The new identifier of the subnet that the HSM is in. The new subnet must be in the same Availability Zone as the current subnet.

$sel:syslogIp:ModifyHsm', modifyHsm_syslogIp - The new IP address for the syslog monitoring server. The AWS CloudHSM service only supports one syslog monitoring server.

$sel:externalId:ModifyHsm', modifyHsm_externalId - The new external ID.

$sel:eniIp:ModifyHsm', modifyHsm_eniIp - The new IP address for the elastic network interface (ENI) attached to the HSM.

If the HSM is moved to a different subnet, and an IP address is not specified, an IP address will be randomly chosen from the CIDR range of the new subnet.

$sel:hsmArn:ModifyHsm', modifyHsm_hsmArn - The ARN of the HSM to modify.

Request Lenses

modifyHsm_iamRoleArn :: Lens' ModifyHsm (Maybe Text) Source #

The new IAM role ARN.

modifyHsm_subnetId :: Lens' ModifyHsm (Maybe Text) Source #

The new identifier of the subnet that the HSM is in. The new subnet must be in the same Availability Zone as the current subnet.

modifyHsm_syslogIp :: Lens' ModifyHsm (Maybe Text) Source #

The new IP address for the syslog monitoring server. The AWS CloudHSM service only supports one syslog monitoring server.

modifyHsm_externalId :: Lens' ModifyHsm (Maybe Text) Source #

The new external ID.

modifyHsm_eniIp :: Lens' ModifyHsm (Maybe Text) Source #

The new IP address for the elastic network interface (ENI) attached to the HSM.

If the HSM is moved to a different subnet, and an IP address is not specified, an IP address will be randomly chosen from the CIDR range of the new subnet.

modifyHsm_hsmArn :: Lens' ModifyHsm Text Source #

The ARN of the HSM to modify.

Destructuring the Response

data ModifyHsmResponse Source #

Contains the output of the ModifyHsm operation.

See: newModifyHsmResponse smart constructor.

Constructors

ModifyHsmResponse'
Fields hsmArn :: Maybe Text The ARN of the HSM. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newModifyHsmResponse Source #

Arguments

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

Create a value of ModifyHsmResponse 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:hsmArn:ModifyHsm', modifyHsmResponse_hsmArn - The ARN of the HSM.

$sel:httpStatus:ModifyHsmResponse', modifyHsmResponse_httpStatus - The response's http status code.

Response Lenses

modifyHsmResponse_hsmArn :: Lens' ModifyHsmResponse (Maybe Text) Source #

The ARN of the HSM.

modifyHsmResponse_httpStatus :: Lens' ModifyHsmResponse Int Source #

The response's http status code.