hapgs

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

Overview

Name	hapgs
Type	Resource
Id	aws.cloudhsm.hapgs

Fields

The following fields are returned by SELECT queries:

describe_hapg

Name	Datatype	Description
hapg_arn	string	The ARN of the high-availability partition group. (pattern: <code>arn:aws(-iso)?:cloudhsm:[a-zA-Z0-9-]*:[0-9]{12}:hapg-[0-9a-f]{8}</code>)
hapg_serial	string	The serial number of the high-availability partition group. (pattern: <code>[\w :+=./\-]*</code>)
hsms_last_action_failed	array	Contains a list of ARNs that identify the HSMs.
hsms_pending_deletion	array	Contains a list of ARNs that identify the HSMs.
hsms_pending_registration	array	Contains a list of ARNs that identify the HSMs.
label	string	The label for the high-availability partition group. (pattern: <code>[a-zA-Z0-9_.-]{1,64}</code>)
last_modified_timestamp	string	The date and time the high-availability partition group was last modified. (pattern: <code>\d*</code>)
partition_serial_list	array	The list of partition serial numbers that belong to the high-availability partition group.
state	string	The state of the high-availability partition group. (READY, UPDATING, DEGRADED)

list_hapgs

Name	Datatype	Description
hapg	string	The list of high-availability partition groups.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_hapg	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 a high-availability partition group.
list_hapgs	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. Lists the high-availability partition groups for the account. 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 ListHapgs to retrieve the next set of items.
create_hapg	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 a high-availability partition group. A high-availability partition group is a group of partitions that spans multiple physical HSMs.
modify_hapg	update	region, HapgArn		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 existing high-availability partition group.
delete_hapg	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 high-availability partition group.

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_hapg

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 a high-availability partition group.

SELECT
hapg_arn,
hapg_serial,
hsms_last_action_failed,
hsms_pending_deletion,
hsms_pending_registration,
label,
last_modified_timestamp,
partition_serial_list,
state
FROM aws.cloudhsm.hapgs
WHERE region = '{{ region }}' -- required
;

list_hapgs

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 the high-availability partition groups for the account. 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 ListHapgs to retrieve the next set of items.

SELECT
hapg
FROM aws.cloudhsm.hapgs
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_hapg

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 a high-availability partition group. A high-availability partition group is a group of partitions that spans multiple physical HSMs.

INSERT INTO aws.cloudhsm.hapgs (
Label,
region
)
SELECT 
'{{ Label }}',
'{{ region }}'
RETURNING
hapg_arn
;

Manifest

# Description fields are for documentation purposes
- name: hapgs
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the hapgs resource.
  - name: Label
    value: "{{ Label }}"
    description: |
      The label of the new high-availability partition group.

UPDATE examples

modify_hapg

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 existing high-availability partition group.

UPDATE aws.cloudhsm.hapgs
SET 
HapgArn = '{{ HapgArn }}',
Label = '{{ Label }}',
PartitionSerialList = '{{ PartitionSerialList }}'
WHERE 
region = '{{ region }}' --required
AND HapgArn = '{{ HapgArn }}' --required
RETURNING
hapg_arn;

DELETE examples

delete_hapg

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 high-availability partition group.

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