Copyright | (c) 2013-2018 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 |
Language | Haskell2010 |
Network.AWS.CloudHSM.ModifyHSM
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.
Important: 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
- modifyHSM :: Text -> ModifyHSM
- data ModifyHSM
- mhIAMRoleARN :: Lens' ModifyHSM (Maybe Text)
- mhSubnetId :: Lens' ModifyHSM (Maybe Text)
- mhSyslogIP :: Lens' ModifyHSM (Maybe Text)
- mhExternalId :: Lens' ModifyHSM (Maybe Text)
- mhEniIP :: Lens' ModifyHSM (Maybe Text)
- mhHSMARN :: Lens' ModifyHSM Text
- modifyHSMResponse :: Int -> ModifyHSMResponse
- data ModifyHSMResponse
- mhsmrsHSMARN :: Lens' ModifyHSMResponse (Maybe Text)
- mhsmrsResponseStatus :: Lens' ModifyHSMResponse Int
Creating a Request
Creates a value of ModifyHSM
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
mhIAMRoleARN
- The new IAM role ARN.mhSubnetId
- 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.mhSyslogIP
- The new IP address for the syslog monitoring server. The AWS CloudHSM service only supports one syslog monitoring server.mhExternalId
- The new external ID.mhEniIP
- 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.mhHSMARN
- The ARN of the HSM to modify.
Contains the inputs for the ModifyHsm
operation.
See: modifyHSM
smart constructor.
Instances
Request Lenses
mhSubnetId :: 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.
mhSyslogIP :: Lens' ModifyHSM (Maybe Text) Source #
The new IP address for the syslog monitoring server. The AWS CloudHSM service only supports one syslog monitoring server.
mhEniIP :: 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.
Destructuring the Response
Arguments
:: Int | |
-> ModifyHSMResponse |
Creates a value of ModifyHSMResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
mhsmrsHSMARN
- The ARN of the HSM.mhsmrsResponseStatus
- -- | The response status code.
data ModifyHSMResponse Source #
Contains the output of the ModifyHsm
operation.
See: modifyHSMResponse
smart constructor.
Instances
Response Lenses
mhsmrsHSMARN :: Lens' ModifyHSMResponse (Maybe Text) Source #
The ARN of the HSM.
mhsmrsResponseStatus :: Lens' ModifyHSMResponse Int Source #
- - | The response status code.