Skip to content

Modify Hsm

cloudhsm_modify_hsm R Documentation

This is documentation for AWS CloudHSM Classic

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.

Usage

cloudhsm_modify_hsm(HsmArn, SubnetId, EniIp, IamRoleArn, ExternalId,
  SyslogIp)

Arguments

HsmArn

[required] The ARN of the HSM to modify.

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.

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.

IamRoleArn

The new IAM role ARN.

ExternalId

The new external ID.

SyslogIp

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

Value

A list with the following syntax: 

list(
  HsmArn = "string"
)

Request syntax

svc$modify_hsm(
  HsmArn = "string",
  SubnetId = "string",
  EniIp = "string",
  IamRoleArn = "string",
  ExternalId = "string",
  SyslogIp = "string"
)