Network.AWS.CloudHSM.ModifyHSM

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.

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

data ModifyHSM

Contains the inputs for the ModifyHsm operation.

See: modifyHSM smart constructor.

Instances

Eq ModifyHSM

Methods

(==) :: ModifyHSM -> ModifyHSM -> Bool

(/=) :: ModifyHSM -> ModifyHSM -> Bool

Data ModifyHSM

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ModifyHSM -> c ModifyHSM

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ModifyHSM

toConstr :: ModifyHSM -> Constr

dataTypeOf :: ModifyHSM -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ModifyHSM)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ModifyHSM)

gmapT :: (forall b. Data b => b -> b) -> ModifyHSM -> ModifyHSM

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ModifyHSM -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ModifyHSM -> r

gmapQ :: (forall d. Data d => d -> u) -> ModifyHSM -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> ModifyHSM -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ModifyHSM -> m ModifyHSM

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ModifyHSM -> m ModifyHSM

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ModifyHSM -> m ModifyHSM

Read ModifyHSM

Methods

readsPrec :: Int -> ReadS ModifyHSM

readList :: ReadS [ModifyHSM]

readPrec :: ReadPrec ModifyHSM

readListPrec :: ReadPrec [ModifyHSM]

Show ModifyHSM

Methods

showsPrec :: Int -> ModifyHSM -> ShowS

show :: ModifyHSM -> String

showList :: [ModifyHSM] -> ShowS

Generic ModifyHSM

Associated Types

type Rep ModifyHSM :: * -> *

Methods

from :: ModifyHSM -> Rep ModifyHSM x

to :: Rep ModifyHSM x -> ModifyHSM

Hashable ModifyHSM

Methods

hashWithSalt :: Int -> ModifyHSM -> Int

hash :: ModifyHSM -> Int

ToJSON ModifyHSM

Methods

toJSON :: ModifyHSM -> Value

toEncoding :: ModifyHSM -> Encoding

toJSONList :: [ModifyHSM] -> Value

toEncodingList :: [ModifyHSM] -> Encoding

NFData ModifyHSM

Methods

rnf :: ModifyHSM -> ()

AWSRequest ModifyHSM

Associated Types

type Rs ModifyHSM :: *

Methods

request :: ModifyHSM -> Request ModifyHSM

response :: MonadResource m => Logger -> Service -> Proxy * ModifyHSM -> ClientResponse -> m (Response ModifyHSM)

ToPath ModifyHSM

Methods

toPath :: ModifyHSM -> ByteString

ToHeaders ModifyHSM

Methods

toHeaders :: ModifyHSM -> [Header]

ToQuery ModifyHSM

Methods

toQuery :: ModifyHSM -> QueryString

type Rep ModifyHSM

type Rep ModifyHSM = D1 (MetaData "ModifyHSM" "Network.AWS.CloudHSM.ModifyHSM" "amazonka-cloudhsm-1.4.5-2qw2RsgWv1x7RV995HoL3s" False) (C1 (MetaCons "ModifyHSM'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_mhIAMRoleARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_mhSubnetId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_mhSyslogIP") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) ((:*:) (S1 (MetaSel (Just Symbol "_mhExternalId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_mhEniIP") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_mhHSMARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))))

type Rs 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 - The ARN of the HSM.
• mhsmrsResponseStatus - -- | The response status code.

data ModifyHSMResponse

Contains the output of the ModifyHsm operation.

See: modifyHSMResponse smart constructor.

Instances

Eq ModifyHSMResponse

Methods

(==) :: ModifyHSMResponse -> ModifyHSMResponse -> Bool

(/=) :: ModifyHSMResponse -> ModifyHSMResponse -> Bool

Data ModifyHSMResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ModifyHSMResponse -> c ModifyHSMResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ModifyHSMResponse

toConstr :: ModifyHSMResponse -> Constr

dataTypeOf :: ModifyHSMResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ModifyHSMResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ModifyHSMResponse)

gmapT :: (forall b. Data b => b -> b) -> ModifyHSMResponse -> ModifyHSMResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ModifyHSMResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ModifyHSMResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> ModifyHSMResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> ModifyHSMResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ModifyHSMResponse -> m ModifyHSMResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ModifyHSMResponse -> m ModifyHSMResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ModifyHSMResponse -> m ModifyHSMResponse

Read ModifyHSMResponse

Methods

readsPrec :: Int -> ReadS ModifyHSMResponse

readList :: ReadS [ModifyHSMResponse]

readPrec :: ReadPrec ModifyHSMResponse

readListPrec :: ReadPrec [ModifyHSMResponse]

Show ModifyHSMResponse

Methods

showsPrec :: Int -> ModifyHSMResponse -> ShowS

show :: ModifyHSMResponse -> String

showList :: [ModifyHSMResponse] -> ShowS

Generic ModifyHSMResponse

Associated Types

type Rep ModifyHSMResponse :: * -> *

Methods

from :: ModifyHSMResponse -> Rep ModifyHSMResponse x

to :: Rep ModifyHSMResponse x -> ModifyHSMResponse

NFData ModifyHSMResponse

Methods

rnf :: ModifyHSMResponse -> ()

type Rep ModifyHSMResponse

type Rep ModifyHSMResponse = D1 (MetaData "ModifyHSMResponse" "Network.AWS.CloudHSM.ModifyHSM" "amazonka-cloudhsm-1.4.5-2qw2RsgWv1x7RV995HoL3s" False) (C1 (MetaCons "ModifyHSMResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_mhsmrsHSMARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_mhsmrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int))))

Response Lenses

mhsmrsHSMARN :: Lens' ModifyHSMResponse (Maybe Text)

The ARN of the HSM.

mhsmrsResponseStatus :: Lens' ModifyHSMResponse Int

• - | The response status code.