Actions, resources, and condition keys for AWS CloudHSM - Service Authorization Reference

Actions, resources, and condition keys for AWS CloudHSM

AWS CloudHSM (service prefix: cloudhsm) provides the following service-specific resources, actions, and condition context keys for use in IAM permission policies.

References:

Actions defined by AWS CloudHSM

You can specify the following actions in the Action element of an IAM policy statement. Use policies to grant permissions to perform an operation in AWS. When you use an action in a policy, you usually allow or deny access to the API operation or CLI command with the same name. However, in some cases, a single action controls access to more than one operation. Alternatively, some operations require several different actions.

The Resource types column indicates whether each action supports resource-level permissions. If there is no value for this column, you must specify all resources ("*") in the Resource element of your policy statement. If the column includes a resource type, then you can specify an ARN of that type in a statement with that action. Required resources are indicated in the table with an asterisk (*). If you specify a resource-level permission ARN in a statement using this action, then it must be of this type. Some actions support multiple resource types. If the resource type is optional (not indicated as required), then you can choose to use one but not the other.

For details about the columns in the following table, see The actions table.

Actions Description Access level Resource types (*required) Condition keys Dependent actions
AddTagsToResource Adds or overwrites one or more tags for the specified AWS CloudHSM resource Tagging
CopyBackupToRegion Creates a copy of a backup in the specified region Write

backup*

aws:RequestTag/${TagKey}

aws:TagKeys

CreateCluster Creates a new AWS CloudHSM cluster Write

backup

aws:RequestTag/${TagKey}

aws:TagKeys

CreateHapg Creates a high-availability partition group Write
CreateHsm Creates a new hardware security module (HSM) in the specified AWS CloudHSM cluster Write

cluster*

CreateLunaClient Creates an HSM client Write
DeleteBackup Deletes the specified CloudHSM backup Write

backup*

DeleteCluster Deletes the specified AWS CloudHSM cluster Write

cluster*

DeleteHapg Deletes a high-availability partition group Write
DeleteHsm Deletes the specified HSM Write
DeleteLunaClient Deletes a client Write
DescribeBackups Gets information about backups of AWS CloudHSM clusters Read
DescribeClusters Gets information about AWS CloudHSM clusters Read
DescribeHapg Retrieves information about a high-availability partition group Read
DescribeHsm Retrieves information about an HSM. You can identify the HSM by its ARN or its serial number Read
DescribeLunaClient Retrieves information about an HSM client Read
GetConfig Gets the configuration files necessary to connect to all high availability partition groups the client is associated with Read
InitializeCluster Claims an AWS CloudHSM cluster Write

cluster*

ListAvailableZones Lists the Availability Zones that have available AWS CloudHSM capacity List
ListHapgs Lists the high-availability partition groups for the account List
ListHsms Retrieves the identifiers of all of the HSMs provisioned for the current customer List
ListLunaClients Lists all of the clients List
ListTags Gets a list of tags for the specified AWS CloudHSM cluster Read

backup

cluster

ListTagsForResource Returns a list of all tags for the specified AWS CloudHSM resource Read
ModifyHapg Modifies an existing high-availability partition group Write
ModifyHsm Modifies an HSM Write
ModifyLunaClient Modifies the certificate used by the client Write
RemoveTagsFromResource Removes one or more tags from the specified AWS CloudHSM resource Tagging
RestoreBackup Restores the specified CloudHSM backup Write

backup*

TagResource Adds or overwrites one or more tags for the specified AWS CloudHSM cluster Tagging

backup

cluster

aws:RequestTag/${TagKey}

aws:TagKeys

UntagResource Removes the specified tag or tags from the specified AWS CloudHSM cluster Tagging

backup

cluster

aws:TagKeys

Resource types defined by AWS CloudHSM

The following resource types are defined by this service and can be used in the Resource element of IAM permission policy statements. Each action in the Actions table identifies the resource types that can be specified with that action. A resource type can also define which condition keys you can include in a policy. These keys are displayed in the last column of the table. For details about the columns in the following table, see The resource types table.

Resource types ARN Condition keys
backup arn:${Partition}:cloudhsm:${Region}:${Account}:backup/${CloudHsmBackupInstanceName}

aws:ResourceTag/${TagKey}

cluster arn:${Partition}:cloudhsm:${Region}:${Account}:cluster/${CloudHsmClusterInstanceName}

aws:ResourceTag/${TagKey}

Condition keys for AWS CloudHSM

AWS CloudHSM defines the following condition keys that can be used in the Condition element of an IAM policy. You can use these keys to further refine the conditions under which the policy statement applies. For details about the columns in the following table, see The condition keys table.

To view the global condition keys that are available to all services, see Available global condition keys.

Condition keys Description Type
aws:RequestTag/${TagKey} Filters actions based on the presence of tag key-value pairs in the request String
aws:ResourceTag/${TagKey} Filters actions based on tag key-value pairs attached to the resource String
aws:TagKeys Filters actions based on the presence of tag keys in the request String