libZSservicesZSamazonka-cloudhsmZSamazonka-cloudhsm
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.CloudHSM.Lens

Description

 
Synopsis

Operations

DeleteHapg

deleteHapg_hapgArn :: Lens' DeleteHapg Text Source #

The ARN of the high-availability partition group to delete.

ListHapgs

listHapgs_nextToken :: Lens' ListHapgs (Maybe Text) Source #

The NextToken value from a previous call to ListHapgs. Pass null if this is the first call.

listHapgsResponse_nextToken :: Lens' ListHapgsResponse (Maybe Text) Source #

If not null, more results are available. Pass this value to ListHapgs to retrieve the next set of items.

listHapgsResponse_httpStatus :: Lens' ListHapgsResponse Int Source #

The response's http status code.

listHapgsResponse_hapgList :: Lens' ListHapgsResponse [Text] Source #

The list of high-availability partition groups.

ModifyLunaClient

modifyLunaClient_certificate :: Lens' ModifyLunaClient Text Source #

The new certificate for the client.

ListHsms

listHsms_nextToken :: Lens' ListHsms (Maybe Text) Source #

The NextToken value from a previous call to ListHsms. Pass null if this is the first call.

listHsmsResponse_nextToken :: Lens' ListHsmsResponse (Maybe Text) Source #

If not null, more results are available. Pass this value to ListHsms to retrieve the next set of items.

listHsmsResponse_hsmList :: Lens' ListHsmsResponse (Maybe [Text]) Source #

The list of ARNs that identify the HSMs.

listHsmsResponse_httpStatus :: Lens' ListHsmsResponse Int Source #

The response's http status code.

DescribeLunaClient

describeLunaClientResponse_certificate :: Lens' DescribeLunaClientResponse (Maybe Text) Source #

The certificate installed on the HSMs used by this client.

ListTagsForResource

listTagsForResource_resourceArn :: Lens' ListTagsForResource Text Source #

The Amazon Resource Name (ARN) of the AWS CloudHSM resource.

CreateHapg

createHapg_label :: Lens' CreateHapg Text Source #

The label of the new high-availability partition group.

createHapgResponse_hapgArn :: Lens' CreateHapgResponse (Maybe Text) Source #

The ARN of the high-availability partition group.

CreateHsm

createHsm_clientToken :: Lens' CreateHsm (Maybe Text) Source #

A user-defined token to ensure idempotence. Subsequent calls to this operation with the same token will be ignored.

createHsm_syslogIp :: Lens' CreateHsm (Maybe Text) Source #

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

createHsm_externalId :: Lens' CreateHsm (Maybe Text) Source #

The external ID from IamRoleArn, if present.

createHsm_eniIp :: Lens' CreateHsm (Maybe Text) Source #

The IP address to assign to the HSM's ENI.

If an IP address is not specified, an IP address will be randomly chosen from the CIDR range of the subnet.

createHsm_subnetId :: Lens' CreateHsm Text Source #

The identifier of the subnet in your VPC in which to place the HSM.

createHsm_sshKey :: Lens' CreateHsm Text Source #

The SSH public key to install on the HSM.

createHsm_iamRoleArn :: Lens' CreateHsm Text Source #

The ARN of an IAM role to enable the AWS CloudHSM service to allocate an ENI on your behalf.

createHsmResponse_httpStatus :: Lens' CreateHsmResponse Int Source #

The response's http status code.

RemoveTagsFromResource

removeTagsFromResource_resourceArn :: Lens' RemoveTagsFromResource Text Source #

The Amazon Resource Name (ARN) of the AWS CloudHSM resource.

removeTagsFromResource_tagKeyList :: Lens' RemoveTagsFromResource [Text] Source #

The tag key or keys to remove.

Specify only the tag key to remove (not the value). To overwrite the value for an existing tag, use AddTagsToResource.

DescribeHapg

describeHapg_hapgArn :: Lens' DescribeHapg Text Source #

The ARN of the high-availability partition group to describe.

describeHapgResponse_state :: Lens' DescribeHapgResponse (Maybe CloudHsmObjectState) Source #

The state of the high-availability partition group.

describeHapgResponse_lastModifiedTimestamp :: Lens' DescribeHapgResponse (Maybe Text) Source #

The date and time the high-availability partition group was last modified.

describeHapgResponse_hapgSerial :: Lens' DescribeHapgResponse (Maybe Text) Source #

The serial number of the high-availability partition group.

describeHapgResponse_partitionSerialList :: Lens' DescribeHapgResponse (Maybe [Text]) Source #

The list of partition serial numbers that belong to the high-availability partition group.

describeHapgResponse_hapgArn :: Lens' DescribeHapgResponse (Maybe Text) Source #

The ARN of the high-availability partition group.

describeHapgResponse_label :: Lens' DescribeHapgResponse (Maybe Text) Source #

The label for the high-availability partition group.

CreateLunaClient

createLunaClient_certificate :: Lens' CreateLunaClient Text Source #

The contents of a Base64-Encoded X.509 v3 certificate to be installed on the HSMs used by this client.

ListLunaClients

listLunaClients_nextToken :: Lens' ListLunaClients (Maybe Text) Source #

The NextToken value from a previous call to ListLunaClients. Pass null if this is the first call.

listLunaClientsResponse_nextToken :: Lens' ListLunaClientsResponse (Maybe Text) Source #

If not null, more results are available. Pass this to ListLunaClients to retrieve the next set of items.

AddTagsToResource

addTagsToResource_resourceArn :: Lens' AddTagsToResource Text Source #

The Amazon Resource Name (ARN) of the AWS CloudHSM resource to tag.

GetConfig

getConfig_clientArn :: Lens' GetConfig Text Source #

The ARN of the client.

getConfig_hapgList :: Lens' GetConfig [Text] Source #

A list of ARNs that identify the high-availability partition groups that are associated with the client.

getConfigResponse_configFile :: Lens' GetConfigResponse (Maybe Text) Source #

The chrystoki.conf configuration file.

getConfigResponse_configCred :: Lens' GetConfigResponse (Maybe Text) Source #

The certificate file containing the server.pem files of the HSMs.

getConfigResponse_httpStatus :: Lens' GetConfigResponse Int Source #

The response's http status code.

DeleteHsm

deleteHsm_hsmArn :: Lens' DeleteHsm Text Source #

The ARN of the HSM to delete.

deleteHsmResponse_httpStatus :: Lens' DeleteHsmResponse Int Source #

The response's http status code.

DescribeHsm

describeHsm_hsmSerialNumber :: Lens' DescribeHsm (Maybe Text) Source #

The serial number of the HSM. Either the HsmArn or the HsmSerialNumber parameter must be specified.

describeHsm_hsmArn :: Lens' DescribeHsm (Maybe Text) Source #

The ARN of the HSM. Either the HsmArn or the SerialNumber parameter must be specified.

describeHsmResponse_iamRoleArn :: Lens' DescribeHsmResponse (Maybe Text) Source #

The ARN of the IAM role assigned to the HSM.

describeHsmResponse_eniId :: Lens' DescribeHsmResponse (Maybe Text) Source #

The identifier of the elastic network interface (ENI) attached to the HSM.

describeHsmResponse_vpcId :: Lens' DescribeHsmResponse (Maybe Text) Source #

The identifier of the VPC that the HSM is in.

describeHsmResponse_sshKeyLastUpdated :: Lens' DescribeHsmResponse (Maybe Text) Source #

The date and time that the SSH key was last updated.

describeHsmResponse_subnetId :: Lens' DescribeHsmResponse (Maybe Text) Source #

The identifier of the subnet that the HSM is in.

describeHsmResponse_statusDetails :: Lens' DescribeHsmResponse (Maybe Text) Source #

Contains additional information about the status of the HSM.

describeHsmResponse_partitions :: Lens' DescribeHsmResponse (Maybe [Text]) Source #

The list of partitions on the HSM.

describeHsmResponse_availabilityZone :: Lens' DescribeHsmResponse (Maybe Text) Source #

The Availability Zone that the HSM is in.

describeHsmResponse_serverCertLastUpdated :: Lens' DescribeHsmResponse (Maybe Text) Source #

The date and time that the server certificate was last updated.

describeHsmResponse_eniIp :: Lens' DescribeHsmResponse (Maybe Text) Source #

The IP address assigned to the HSM's ENI.

ModifyHapg

modifyHapg_partitionSerialList :: Lens' ModifyHapg (Maybe [Text]) Source #

The list of partition serial numbers to make members of the high-availability partition group.

modifyHapg_label :: Lens' ModifyHapg (Maybe Text) Source #

The new label for the high-availability partition group.

modifyHapg_hapgArn :: Lens' ModifyHapg Text Source #

The ARN of the high-availability partition group to modify.

modifyHapgResponse_hapgArn :: Lens' ModifyHapgResponse (Maybe Text) Source #

The ARN of the high-availability partition group.

DeleteLunaClient

deleteLunaClient_clientArn :: Lens' DeleteLunaClient Text Source #

The ARN of the client to delete.

ModifyHsm

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

modifyHsmResponse_httpStatus :: Lens' ModifyHsmResponse Int Source #

The response's http status code.

ListAvailableZones

listAvailableZonesResponse_aZList :: Lens' ListAvailableZonesResponse (Maybe [Text]) Source #

The list of Availability Zones that have available AWS CloudHSM capacity.

Types

Tag

tag_key :: Lens' Tag Text Source #

The key of the tag.

tag_value :: Lens' Tag Text Source #

The value of the tag.