NAME

Paws::CloudHSM - Perl Interface to AWS Amazon CloudHSM

SYNOPSIS

  use Paws;

  my $obj = Paws->service('CloudHSM');
  my $res = $obj->Method(
    Arg1 => $val1,
    Arg2 => [ 'V1', 'V2' ],
    # if Arg3 is an object, the HashRef will be used as arguments to the constructor
    # of the arguments type
    Arg3 => { Att1 => 'Val1' },
    # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
    # the constructor of the arguments type
    Arg4 => [ { Att1 => 'Val1'  }, { Att1 => 'Val2' } ],
  );

DESCRIPTION

AWS CloudHSM Service

This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs (http://aws.amazon.com/cloudhsm/faqs-classic/), the AWS CloudHSM Classic User Guide (https://docs.aws.amazon.com/cloudhsm/classic/userguide/), and the AWS CloudHSM Classic API Reference (https://docs.aws.amazon.com/cloudhsm/classic/APIReference/).

For information about the current version of AWS CloudHSM, see AWS CloudHSM (http://aws.amazon.com/cloudhsm/), the AWS CloudHSM User Guide (https://docs.aws.amazon.com/cloudhsm/latest/userguide/), and the AWS CloudHSM API Reference (https://docs.aws.amazon.com/cloudhsm/latest/APIReference/).

For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/cloudhsm-2014-05-30

METHODS

AddTagsToResource

ResourceArn => Str
TagList => ArrayRef[Paws::CloudHSM::Tag]

Each argument is described in detail in: Paws::CloudHSM::AddTagsToResource

Returns: a Paws::CloudHSM::AddTagsToResourceResponse instance

Adds or overwrites one or more tags for the specified AWS CloudHSM resource.

Each tag consists of a key and a value. Tag keys must be unique to each resource.

CreateHapg

Label => Str

Each argument is described in detail in: Paws::CloudHSM::CreateHapg

Returns: a Paws::CloudHSM::CreateHapgResponse instance

Creates a high-availability partition group. A high-availability partition group is a group of partitions that spans multiple physical HSMs.

CreateHsm

IamRoleArn => Str
SshKey => Str
SubnetId => Str
SubscriptionType => Str
[ClientToken => Str]
[EniIp => Str]
[ExternalId => Str]
[SyslogIp => Str]

Each argument is described in detail in: Paws::CloudHSM::CreateHsm

Returns: a Paws::CloudHSM::CreateHsmResponse instance

Creates an uninitialized HSM instance.

There is an upfront fee charged for each HSM instance that you create with the CreateHsm operation. If you accidentally provision an HSM and want to request a refund, delete the instance using the DeleteHsm operation, go to the AWS Support Center (https://console.aws.amazon.com/support/home), create a new case, and select Account and Billing Support.

It can take up to 20 minutes to create and provision an HSM. You can monitor the status of the HSM with the DescribeHsm operation. The HSM is ready to be initialized when the status changes to RUNNING.

CreateLunaClient

Certificate => Str
[Label => Str]

Each argument is described in detail in: Paws::CloudHSM::CreateLunaClient

Returns: a Paws::CloudHSM::CreateLunaClientResponse instance

Creates an HSM client.

DeleteHapg

HapgArn => Str

Each argument is described in detail in: Paws::CloudHSM::DeleteHapg

Returns: a Paws::CloudHSM::DeleteHapgResponse instance

Deletes a high-availability partition group.

DeleteHsm

HsmArn => Str

Each argument is described in detail in: Paws::CloudHSM::DeleteHsm

Returns: a Paws::CloudHSM::DeleteHsmResponse instance

Deletes an HSM. After completion, this operation cannot be undone and your key material cannot be recovered.

DeleteLunaClient

ClientArn => Str

Each argument is described in detail in: Paws::CloudHSM::DeleteLunaClient

Returns: a Paws::CloudHSM::DeleteLunaClientResponse instance

Deletes a client.

DescribeHapg

HapgArn => Str

Each argument is described in detail in: Paws::CloudHSM::DescribeHapg

Returns: a Paws::CloudHSM::DescribeHapgResponse instance

Retrieves information about a high-availability partition group.

DescribeHsm

[HsmArn => Str]
[HsmSerialNumber => Str]

Each argument is described in detail in: Paws::CloudHSM::DescribeHsm

Returns: a Paws::CloudHSM::DescribeHsmResponse instance

Retrieves information about an HSM. You can identify the HSM by its ARN or its serial number.

DescribeLunaClient

[CertificateFingerprint => Str]
[ClientArn => Str]

Each argument is described in detail in: Paws::CloudHSM::DescribeLunaClient

Returns: a Paws::CloudHSM::DescribeLunaClientResponse instance

Retrieves information about an HSM client.

GetConfig

ClientArn => Str
ClientVersion => Str
HapgList => ArrayRef[Str|Undef]

Each argument is described in detail in: Paws::CloudHSM::GetConfig

Returns: a Paws::CloudHSM::GetConfigResponse instance

Gets the configuration files necessary to connect to all high availability partition groups the client is associated with.

ListAvailableZones

Each argument is described in detail in: Paws::CloudHSM::ListAvailableZones

Returns: a Paws::CloudHSM::ListAvailableZonesResponse instance

Lists the Availability Zones that have available AWS CloudHSM capacity.

ListHapgs

[NextToken => Str]

Each argument is described in detail in: Paws::CloudHSM::ListHapgs

Returns: a Paws::CloudHSM::ListHapgsResponse instance

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.

ListHsms

[NextToken => Str]

Each argument is described in detail in: Paws::CloudHSM::ListHsms

Returns: a Paws::CloudHSM::ListHsmsResponse instance

Retrieves the identifiers of all of the HSMs provisioned for the current customer.

ListLunaClients

[NextToken => Str]

Each argument is described in detail in: Paws::CloudHSM::ListLunaClients

Returns: a Paws::CloudHSM::ListLunaClientsResponse instance

Lists all of the clients.

ListTagsForResource

ResourceArn => Str

Each argument is described in detail in: Paws::CloudHSM::ListTagsForResource

Returns: a Paws::CloudHSM::ListTagsForResourceResponse instance

Returns a list of all tags for the specified AWS CloudHSM resource.

ModifyHapg

HapgArn => Str
[Label => Str]
[PartitionSerialList => ArrayRef[Str|Undef]]

Each argument is described in detail in: Paws::CloudHSM::ModifyHapg

Returns: a Paws::CloudHSM::ModifyHapgResponse instance

Modifies an existing high-availability partition group.

ModifyHsm

HsmArn => Str
[EniIp => Str]
[ExternalId => Str]
[IamRoleArn => Str]
[SubnetId => Str]
[SyslogIp => Str]

Each argument is described in detail in: Paws::CloudHSM::ModifyHsm

Returns: a Paws::CloudHSM::ModifyHsmResponse instance

Modifies an HSM.

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.

ModifyLunaClient

Certificate => Str
ClientArn => Str

Each argument is described in detail in: Paws::CloudHSM::ModifyLunaClient

Returns: a Paws::CloudHSM::ModifyLunaClientResponse instance

Modifies the certificate used by the client.

This action can potentially start a workflow to install the new certificate on the client's HSMs.

RemoveTagsFromResource

ResourceArn => Str
TagKeyList => ArrayRef[Str|Undef]

Each argument is described in detail in: Paws::CloudHSM::RemoveTagsFromResource

Returns: a Paws::CloudHSM::RemoveTagsFromResourceResponse instance

Removes one or more tags from the specified AWS CloudHSM resource.

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

PAGINATORS

Paginator methods are helpers that repetively call methods that return partial results

ListAllHapgs(sub { },[NextToken => Str])

ListAllHapgs([NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - HapgList, passing the object as the first parameter, and the string 'HapgList' as the second parameter

If not, it will return a a Paws::CloudHSM::ListHapgsResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllHsms(sub { },[NextToken => Str])

ListAllHsms([NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - HsmList, passing the object as the first parameter, and the string 'HsmList' as the second parameter

If not, it will return a a Paws::CloudHSM::ListHsmsResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllLunaClients(sub { },[NextToken => Str])

ListAllLunaClients([NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - ClientList, passing the object as the first parameter, and the string 'ClientList' as the second parameter

If not, it will return a a Paws::CloudHSM::ListLunaClientsResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues

To install Paws, copy and paste the appropriate command in to your terminal.

cpanm

cpanm Paws

CPAN shell

perl -MCPAN -e shell
install Paws

For more information on module installation, please visit the detailed CPAN module installation guide.

	Global
`s`	Focus search bar
`?`	Bring up this help dialog

	GitHub
`g` `p`	Go to pull requests
`g` `i`	go to github issues (only if github is preferred repository)

	POD
`g` `a`	Go to author
`g` `c`	Go to changes
`g` `i`	Go to issues
`g` `d`	Go to dist
`g` `r`	Go to repository/SCM
`g` `s`	Go to source
`g` `b`	Go to file browse

	Search terms
module: (e.g. module:Plugin)
distribution: (e.g. distribution:Dancer auth)
author: (e.g. author:SONGMU Redis)
version: (e.g. version:1.00)

NAME

SYNOPSIS

DESCRIPTION

METHODS

AddTagsToResource

CreateHapg

CreateHsm

CreateLunaClient

DeleteHapg

DeleteHsm

DeleteLunaClient

DescribeHapg

DescribeHsm

DescribeLunaClient

GetConfig

ListAvailableZones

ListHapgs

ListHsms

ListLunaClients

ListTagsForResource

ModifyHapg

ModifyHsm

ModifyLunaClient

RemoveTagsFromResource

PAGINATORS

ListAllHapgs(sub { },[NextToken => Str])

ListAllHapgs([NextToken => Str])

ListAllHsms(sub { },[NextToken => Str])

ListAllHsms([NextToken => Str])

ListAllLunaClients(sub { },[NextToken => Str])

ListAllLunaClients([NextToken => Str])

SEE ALSO

BUGS and CONTRIBUTIONS

Module Install Instructions