« blib/lib/Paws/CloudHSM/CreateHapgResponse.pm
↑ Summary
blib/lib/Paws/CloudHSM/CreateHsmResponse.pm »
| 1 | |||
| 2 | package Paws::CloudHSM::CreateHsm; | ||
| 3 | use Moose; | ||
| 4 | has ClientToken => (is => 'ro', isa => 'Str'); | ||
| 5 | has EniIp => (is => 'ro', isa => 'Str'); | ||
| 6 | has ExternalId => (is => 'ro', isa => 'Str'); | ||
| 7 | has IamRoleArn => (is => 'ro', isa => 'Str', required => 1); | ||
| 8 | has SshKey => (is => 'ro', isa => 'Str', required => 1); | ||
| 9 | has SubnetId => (is => 'ro', isa => 'Str', required => 1); | ||
| 10 | has SubscriptionType => (is => 'ro', isa => 'Str', required => 1); | ||
| 11 | has SyslogIp => (is => 'ro', isa => 'Str'); | ||
| 12 | |||
| 13 | use MooseX::ClassAttribute; | ||
| 14 | |||
| 15 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateHsm'); | ||
| 16 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::CloudHSM::CreateHsmResponse'); | ||
| 17 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 18 | 1; | ||
| 19 | |||
| 20 | ### main pod documentation begin ### | ||
| 21 | |||
| 22 | =head1 NAME | ||
| 23 | |||
| 24 | Paws::CloudHSM::CreateHsm - Arguments for method CreateHsm on L<Paws::CloudHSM> | ||
| 25 | |||
| 26 | =head1 DESCRIPTION | ||
| 27 | |||
| 28 | This class represents the parameters used for calling the method CreateHsm on the | ||
| 29 | L<Amazon CloudHSM|Paws::CloudHSM> service. Use the attributes of this class | ||
| 30 | as arguments to method CreateHsm. | ||
| 31 | |||
| 32 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateHsm. | ||
| 33 | |||
| 34 | =head1 SYNOPSIS | ||
| 35 | |||
| 36 | my $cloudhsm = Paws->service('CloudHSM'); | ||
| 37 | my $CreateHsmResponse = $cloudhsm->CreateHsm( | ||
| 38 | IamRoleArn => 'MyIamRoleArn', | ||
| 39 | SshKey => 'MySshKey', | ||
| 40 | SubnetId => 'MySubnetId', | ||
| 41 | SubscriptionType => 'PRODUCTION', | ||
| 42 | ClientToken => 'MyClientToken', # OPTIONAL | ||
| 43 | EniIp => 'MyIpAddress', # OPTIONAL | ||
| 44 | ExternalId => 'MyExternalId', # OPTIONAL | ||
| 45 | SyslogIp => 'MyIpAddress', # OPTIONAL | ||
| 46 | ); | ||
| 47 | |||
| 48 | # Results: | ||
| 49 | my $HsmArn = $CreateHsmResponse->HsmArn; | ||
| 50 | |||
| 51 | # Returns a L<Paws::CloudHSM::CreateHsmResponse> object. | ||
| 52 | |||
| 53 | 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. | ||
| 54 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/cloudhsm/CreateHsm> | ||
| 55 | |||
| 56 | =head1 ATTRIBUTES | ||
| 57 | |||
| 58 | |||
| 59 | =head2 ClientToken => Str | ||
| 60 | |||
| 61 | A user-defined token to ensure idempotence. Subsequent calls to this | ||
| 62 | operation with the same token will be ignored. | ||
| 63 | |||
| 64 | |||
| 65 | |||
| 66 | =head2 EniIp => Str | ||
| 67 | |||
| 68 | The IP address to assign to the HSM's ENI. | ||
| 69 | |||
| 70 | If an IP address is not specified, an IP address will be randomly | ||
| 71 | chosen from the CIDR range of the subnet. | ||
| 72 | |||
| 73 | |||
| 74 | |||
| 75 | =head2 ExternalId => Str | ||
| 76 | |||
| 77 | The external ID from C<IamRoleArn>, if present. | ||
| 78 | |||
| 79 | |||
| 80 | |||
| 81 | =head2 B<REQUIRED> IamRoleArn => Str | ||
| 82 | |||
| 83 | The ARN of an IAM role to enable the AWS CloudHSM service to allocate | ||
| 84 | an ENI on your behalf. | ||
| 85 | |||
| 86 | |||
| 87 | |||
| 88 | =head2 B<REQUIRED> SshKey => Str | ||
| 89 | |||
| 90 | The SSH public key to install on the HSM. | ||
| 91 | |||
| 92 | |||
| 93 | |||
| 94 | =head2 B<REQUIRED> SubnetId => Str | ||
| 95 | |||
| 96 | The identifier of the subnet in your VPC in which to place the HSM. | ||
| 97 | |||
| 98 | |||
| 99 | |||
| 100 | =head2 B<REQUIRED> SubscriptionType => Str | ||
| 101 | |||
| 102 | |||
| 103 | |||
| 104 | Valid values are: C<"PRODUCTION"> | ||
| 105 | |||
| 106 | =head2 SyslogIp => Str | ||
| 107 | |||
| 108 | The IP address for the syslog monitoring server. The AWS CloudHSM | ||
| 109 | service only supports one syslog monitoring server. | ||
| 110 | |||
| 111 | |||
| 112 | |||
| 113 | |||
| 114 | =head1 SEE ALSO | ||
| 115 | |||
| 116 | This class forms part of L<Paws>, documenting arguments for method CreateHsm in L<Paws::CloudHSM> | ||
| 117 | |||
| 118 | =head1 BUGS and CONTRIBUTIONS | ||
| 119 | |||
| 120 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 121 | |||
| 122 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 123 | |||
| 124 | =cut | ||
| 125 |