/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::CloudHSMv2

NAME

Paws::CloudHSMv2 - Perl Interface to AWS AWS CloudHSM V2

SYNOPSIS

use Paws;

my $obj = Paws->service('CloudHSMv2');
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

For more information about AWS CloudHSM, see AWS CloudHSM (http://aws.amazon.com/cloudhsm/) and the AWS CloudHSM User Guide (https://docs.aws.amazon.com/cloudhsm/latest/userguide/).

For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28

METHODS

CopyBackupToRegion

BackupId => Str
DestinationRegion => Str
[TagList => ArrayRef[Paws::CloudHSMv2::Tag]]

Each argument is described in detail in: Paws::CloudHSMv2::CopyBackupToRegion

Returns: a Paws::CloudHSMv2::CopyBackupToRegionResponse instance

Copy an AWS CloudHSM cluster backup to a different region.

CreateCluster

HsmType => Str
SubnetIds => ArrayRef[Str|Undef]
[BackupRetentionPolicy => Paws::CloudHSMv2::BackupRetentionPolicy]
[SourceBackupId => Str]
[TagList => ArrayRef[Paws::CloudHSMv2::Tag]]

Each argument is described in detail in: Paws::CloudHSMv2::CreateCluster

Returns: a Paws::CloudHSMv2::CreateClusterResponse instance

Creates a new AWS CloudHSM cluster.

CreateHsm

AvailabilityZone => Str
ClusterId => Str
[IpAddress => Str]

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

Returns: a Paws::CloudHSMv2::CreateHsmResponse instance

Creates a new hardware security module (HSM) in the specified AWS CloudHSM cluster.

DeleteBackup

BackupId => Str

Each argument is described in detail in: Paws::CloudHSMv2::DeleteBackup

Returns: a Paws::CloudHSMv2::DeleteBackupResponse instance

Deletes a specified AWS CloudHSM backup. A backup can be restored up to 7 days after the DeleteBackup request is made. For more information on restoring a backup, see RestoreBackup.

DeleteCluster

ClusterId => Str

Each argument is described in detail in: Paws::CloudHSMv2::DeleteCluster

Returns: a Paws::CloudHSMv2::DeleteClusterResponse instance

Deletes the specified AWS CloudHSM cluster. Before you can delete a cluster, you must delete all HSMs in the cluster. To see if the cluster contains any HSMs, use DescribeClusters. To delete an HSM, use DeleteHsm.

DeleteHsm

ClusterId => Str
[EniId => Str]
[EniIp => Str]
[HsmId => Str]

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

Returns: a Paws::CloudHSMv2::DeleteHsmResponse instance

Deletes the specified HSM. To specify an HSM, you can use its identifier (ID), the IP address of the HSM's elastic network interface (ENI), or the ID of the HSM's ENI. You need to specify only one of these values. To find these values, use DescribeClusters.

DescribeBackups

[Filters => Paws::CloudHSMv2::Filters]
[MaxResults => Int]
[NextToken => Str]
[SortAscending => Bool]

Each argument is described in detail in: Paws::CloudHSMv2::DescribeBackups

Returns: a Paws::CloudHSMv2::DescribeBackupsResponse instance

Gets information about backups of AWS CloudHSM clusters.

This is a paginated operation, which means that each response might contain only a subset of all the backups. When the response contains only a subset of backups, it includes a NextToken value. Use this value in a subsequent DescribeBackups request to get more backups. When you receive a response with no NextToken (or an empty or null value), that means there are no more backups to get.

DescribeClusters

[Filters => Paws::CloudHSMv2::Filters]
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::CloudHSMv2::DescribeClusters

Returns: a Paws::CloudHSMv2::DescribeClustersResponse instance

Gets information about AWS CloudHSM clusters.

This is a paginated operation, which means that each response might contain only a subset of all the clusters. When the response contains only a subset of clusters, it includes a NextToken value. Use this value in a subsequent DescribeClusters request to get more clusters. When you receive a response with no NextToken (or an empty or null value), that means there are no more clusters to get.

InitializeCluster

ClusterId => Str
SignedCert => Str
TrustAnchor => Str

Each argument is described in detail in: Paws::CloudHSMv2::InitializeCluster

Returns: a Paws::CloudHSMv2::InitializeClusterResponse instance

Claims an AWS CloudHSM cluster by submitting the cluster certificate issued by your issuing certificate authority (CA) and the CA's root certificate. Before you can claim a cluster, you must sign the cluster's certificate signing request (CSR) with your issuing CA. To get the cluster's CSR, use DescribeClusters.

ListTags

ResourceId => Str
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::CloudHSMv2::ListTags

Returns: a Paws::CloudHSMv2::ListTagsResponse instance

Gets a list of tags for the specified AWS CloudHSM cluster.

This is a paginated operation, which means that each response might contain only a subset of all the tags. When the response contains only a subset of tags, it includes a NextToken value. Use this value in a subsequent ListTags request to get more tags. When you receive a response with no NextToken (or an empty or null value), that means there are no more tags to get.

ModifyBackupAttributes

BackupId => Str
NeverExpires => Bool

Each argument is described in detail in: Paws::CloudHSMv2::ModifyBackupAttributes

Returns: a Paws::CloudHSMv2::ModifyBackupAttributesResponse instance

Modifies attributes for AWS CloudHSM backup.

ModifyCluster

BackupRetentionPolicy => Paws::CloudHSMv2::BackupRetentionPolicy
ClusterId => Str

Each argument is described in detail in: Paws::CloudHSMv2::ModifyCluster

Returns: a Paws::CloudHSMv2::ModifyClusterResponse instance

Modifies AWS CloudHSM cluster.

RestoreBackup

BackupId => Str

Each argument is described in detail in: Paws::CloudHSMv2::RestoreBackup

Returns: a Paws::CloudHSMv2::RestoreBackupResponse instance

Restores a specified AWS CloudHSM backup that is in the PENDING_DELETION state. For mor information on deleting a backup, see DeleteBackup.

TagResource

ResourceId => Str
TagList => ArrayRef[Paws::CloudHSMv2::Tag]

Each argument is described in detail in: Paws::CloudHSMv2::TagResource

Returns: a Paws::CloudHSMv2::TagResourceResponse instance

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

UntagResource

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

Each argument is described in detail in: Paws::CloudHSMv2::UntagResource

Returns: a Paws::CloudHSMv2::UntagResourceResponse instance

Removes the specified tag or tags from the specified AWS CloudHSM cluster.

PAGINATORS

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

DescribeAllBackups(sub { },[Filters => Paws::CloudHSMv2::Filters, MaxResults => Int, NextToken => Str, SortAscending => Bool])

DescribeAllBackups([Filters => Paws::CloudHSMv2::Filters, MaxResults => Int, NextToken => Str, SortAscending => Bool])

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

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

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

DescribeAllClusters(sub { },[Filters => Paws::CloudHSMv2::Filters, MaxResults => Int, NextToken => Str])

DescribeAllClusters([Filters => Paws::CloudHSMv2::Filters, MaxResults => Int, NextToken => Str])

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

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

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

ListAllTags(sub { },ResourceId => Str, [MaxResults => Int, NextToken => Str])

ListAllTags(ResourceId => Str, [MaxResults => Int, NextToken => Str])

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

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

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

SEE ALSO

This service class forms part of Paws

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