luna_clients

Creates, updates, deletes, gets or lists a luna_clients resource.

Overview

Name	`luna_clients`
Type	Resource
Id	`aws.cloudhsm.luna_clients`

Fields

The following fields are returned by SELECT queries:

describe_luna_client

Name	Datatype	Description
`certificate`	`string`	The certificate installed on the HSMs used by this client. (pattern: <code>[\w :+=./\n-]*</code>)
`certificate_fingerprint`	`string`	The certificate fingerprint. (pattern: <code>([0-9a-fA-F][0-9a-fA-F]:){15}[0-9a-fA-F][0-9a-fA-F]</code>)
`client_arn`	`string`	The ARN of the client. (pattern: <code>arn:aws(-iso)?:cloudhsm:[a-zA-Z0-9-]*:[0-9]{12}:client-[0-9a-f]{8}</code>)
`label`	`string`	The label of the client. (pattern: <code>[a-zA-Z0-9_.-]{1,64}</code>)
`last_modified_timestamp`	`string`	The date and time the client was last modified. (pattern: <code>\d*</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Description
`describe_luna_client`	`select`	`region`	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. Retrieves information about an HSM client.
`create_luna_client`	`insert`	`region`	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. Creates an HSM client.
`modify_luna_client`	`update`	`region`, `ClientArn`	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 the certificate used by the client. This action can potentially start a workflow to install the new certificate on the client's HSMs.
`delete_luna_client`	`delete`	`region`	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. Deletes a client.
`list_luna_clients`	`exec`	`region`	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. Lists all of the clients. This operation supports pagination with the use of the NextToken member. If more results are available, the NextToken member of the response contains a token that you pass in the next call to ListLunaClients to retrieve the next set of items.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
`region`	`string`	AWS region (default: us-east-1)

`SELECT` examples

describe_luna_client

SELECT
certificate,
certificate_fingerprint,
client_arn,
label,
last_modified_timestamp
FROM aws.cloudhsm.luna_clients
WHERE region = '{{ region }}' -- required
;

`INSERT` examples

create_luna_client
Manifest

INSERT INTO aws.cloudhsm.luna_clients (
Label,
Certificate,
region
)
SELECT 
'{{ Label }}',
'{{ Certificate }}',
'{{ region }}'
RETURNING
client_arn
;

# Description fields are for documentation purposes
- name: luna_clients
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the luna_clients resource.
  - name: Label
    value: "{{ Label }}"
    description: |
      The label for the client.
  - name: Certificate
    value: "{{ Certificate }}"
    description: |
      The contents of a Base64-Encoded X.509 v3 certificate to be installed on the HSMs used by this client.

`UPDATE` examples

modify_luna_client

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 the certificate used by the client. This action can potentially start a workflow to install the new certificate on the client's HSMs.

UPDATE aws.cloudhsm.luna_clients
SET 
ClientArn = '{{ ClientArn }}',
Certificate = '{{ Certificate }}'
WHERE 
region = '{{ region }}' --required
AND ClientArn = '{{ ClientArn }}' --required
RETURNING
client_arn;

`DELETE` examples

delete_luna_client

DELETE FROM aws.cloudhsm.luna_clients
WHERE region = '{{ region }}' --required
;

Lifecycle Methods

list_luna_clients

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. Lists all of the clients. This operation supports pagination with the use of the NextToken member. If more results are available, the NextToken member of the response contains a token that you pass in the next call to ListLunaClients to retrieve the next set of items.

EXEC aws.cloudhsm.luna_clients.list_luna_clients 
@region='{{ region }}' --required 
@@json=
'{
"NextToken": "{{ NextToken }}"
}'
;

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

INSERT examples​

UPDATE examples​

DELETE examples​

Lifecycle Methods​