« blib/lib/Paws/CloudHSMv2/CopyBackupToRegionResponse.pm
↑ Summary
blib/lib/Paws/CloudHSMv2/CreateClusterResponse.pm »
| 1 | |||
| 2 | package Paws::CloudHSMv2::CreateCluster; | ||
| 3 | use Moose; | ||
| 4 | has BackupRetentionPolicy => (is => 'ro', isa => 'Paws::CloudHSMv2::BackupRetentionPolicy'); | ||
| 5 | has HsmType => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has SourceBackupId => (is => 'ro', isa => 'Str'); | ||
| 7 | has SubnetIds => (is => 'ro', isa => 'ArrayRef[Str|Undef]', required => 1); | ||
| 8 | has TagList => (is => 'ro', isa => 'ArrayRef[Paws::CloudHSMv2::Tag]'); | ||
| 9 | |||
| 10 | use MooseX::ClassAttribute; | ||
| 11 | |||
| 12 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateCluster'); | ||
| 13 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::CloudHSMv2::CreateClusterResponse'); | ||
| 14 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::CloudHSMv2::CreateCluster - Arguments for method CreateCluster on L<Paws::CloudHSMv2> | ||
| 22 | |||
| 23 | =head1 DESCRIPTION | ||
| 24 | |||
| 25 | This class represents the parameters used for calling the method CreateCluster on the | ||
| 26 | L<AWS CloudHSM V2|Paws::CloudHSMv2> service. Use the attributes of this class | ||
| 27 | as arguments to method CreateCluster. | ||
| 28 | |||
| 29 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateCluster. | ||
| 30 | |||
| 31 | =head1 SYNOPSIS | ||
| 32 | |||
| 33 | my $cloudhsmv2 = Paws->service('CloudHSMv2'); | ||
| 34 | my $CreateClusterResponse = $cloudhsmv2->CreateCluster( | ||
| 35 | HsmType => 'MyHsmType', | ||
| 36 | SubnetIds => [ 'MySubnetId', ... ], | ||
| 37 | BackupRetentionPolicy => { | ||
| 38 | Type => 'DAYS', # values: DAYS; OPTIONAL | ||
| 39 | Value => 'MyBackupRetentionValue', # min: 1, max: 3; OPTIONAL | ||
| 40 | }, # OPTIONAL | ||
| 41 | SourceBackupId => 'MyBackupId', # OPTIONAL | ||
| 42 | TagList => [ | ||
| 43 | { | ||
| 44 | Key => 'MyTagKey', # min: 1, max: 128 | ||
| 45 | Value => 'MyTagValue', # max: 256 | ||
| 46 | |||
| 47 | }, | ||
| 48 | ... | ||
| 49 | ], # OPTIONAL | ||
| 50 | ); | ||
| 51 | |||
| 52 | # Results: | ||
| 53 | my $Cluster = $CreateClusterResponse->Cluster; | ||
| 54 | |||
| 55 | # Returns a L<Paws::CloudHSMv2::CreateClusterResponse> object. | ||
| 56 | |||
| 57 | Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. | ||
| 58 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2/CreateCluster> | ||
| 59 | |||
| 60 | =head1 ATTRIBUTES | ||
| 61 | |||
| 62 | |||
| 63 | =head2 BackupRetentionPolicy => L<Paws::CloudHSMv2::BackupRetentionPolicy> | ||
| 64 | |||
| 65 | A policy that defines how the service retains backups. | ||
| 66 | |||
| 67 | |||
| 68 | |||
| 69 | =head2 B<REQUIRED> HsmType => Str | ||
| 70 | |||
| 71 | The type of HSM to use in the cluster. Currently the only allowed value | ||
| 72 | is C<hsm1.medium>. | ||
| 73 | |||
| 74 | |||
| 75 | |||
| 76 | =head2 SourceBackupId => Str | ||
| 77 | |||
| 78 | The identifier (ID) of the cluster backup to restore. Use this value to | ||
| 79 | restore the cluster from a backup instead of creating a new cluster. To | ||
| 80 | find the backup ID, use DescribeBackups. | ||
| 81 | |||
| 82 | |||
| 83 | |||
| 84 | =head2 B<REQUIRED> SubnetIds => ArrayRef[Str|Undef] | ||
| 85 | |||
| 86 | The identifiers (IDs) of the subnets where you are creating the | ||
| 87 | cluster. You must specify at least one subnet. If you specify multiple | ||
| 88 | subnets, they must meet the following criteria: | ||
| 89 | |||
| 90 | =over | ||
| 91 | |||
| 92 | =item * | ||
| 93 | |||
| 94 | All subnets must be in the same virtual private cloud (VPC). | ||
| 95 | |||
| 96 | =item * | ||
| 97 | |||
| 98 | You can specify only one subnet per Availability Zone. | ||
| 99 | |||
| 100 | =back | ||
| 101 | |||
| 102 | |||
| 103 | |||
| 104 | |||
| 105 | =head2 TagList => ArrayRef[L<Paws::CloudHSMv2::Tag>] | ||
| 106 | |||
| 107 | Tags to apply to the CloudHSM cluster during creation. | ||
| 108 | |||
| 109 | |||
| 110 | |||
| 111 | |||
| 112 | =head1 SEE ALSO | ||
| 113 | |||
| 114 | This class forms part of L<Paws>, documenting arguments for method CreateCluster in L<Paws::CloudHSMv2> | ||
| 115 | |||
| 116 | =head1 BUGS and CONTRIBUTIONS | ||
| 117 | |||
| 118 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 119 | |||
| 120 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 121 | |||
| 122 | =cut | ||
| 123 |