Network.AWS.CloudHSM.ModifyHSM

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.

Creating a Request

modifyHSM

Arguments

:: Text

mhHSMARN

-> ModifyHSM

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
• mhSubnetId
• mhSyslogIP
• mhExternalId
• mhEniIP
• mhHSMARN

data ModifyHSM

Contains the inputs for the ModifyHsm operation.

See: modifyHSM smart constructor.

Instances

Eq ModifyHSM

Data ModifyHSM

Read ModifyHSM

Show ModifyHSM

Generic ModifyHSM

ToJSON ModifyHSM

Hashable ModifyHSM

AWSRequest ModifyHSM

ToPath ModifyHSM

ToHeaders ModifyHSM

ToQuery ModifyHSM

type Rep ModifyHSM

type Rs ModifyHSM = ModifyHSMResponse

Request Lenses

mhIAMRoleARN :: Lens' ModifyHSM (Maybe Text)

The new IAM role ARN.

mhSubnetId :: Lens' ModifyHSM (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.

mhSyslogIP :: Lens' ModifyHSM (Maybe Text)

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

mhExternalId :: Lens' ModifyHSM (Maybe Text)

The new external ID.

mhEniIP :: Lens' ModifyHSM (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.

mhHSMARN :: Lens' ModifyHSM Text

The ARN of the HSM to modify.

Destructuring the Response

modifyHSMResponse

Arguments

:: Int

mhsmrsResponseStatus

-> 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
• mhsmrsResponseStatus

data ModifyHSMResponse

Contains the output of the ModifyHsm operation.

See: modifyHSMResponse smart constructor.

Instances

Eq ModifyHSMResponse

Data ModifyHSMResponse

Read ModifyHSMResponse

Show ModifyHSMResponse

Generic ModifyHSMResponse

type Rep ModifyHSMResponse

Response Lenses

mhsmrsHSMARN :: Lens' ModifyHSMResponse (Maybe Text)

The ARN of the HSM.

mhsmrsResponseStatus :: Lens' ModifyHSMResponse Int

The response status code.