| 1 | |||
| 2 | package Paws::KMS::UpdateCustomKeyStore; | ||
| 3 | use Moose; | ||
| 4 | has CloudHsmClusterId => (is => 'ro', isa => 'Str'); | ||
| 5 | has CustomKeyStoreId => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has KeyStorePassword => (is => 'ro', isa => 'Str'); | ||
| 7 | has NewCustomKeyStoreName => (is => 'ro', isa => 'Str'); | ||
| 8 | |||
| 9 | use MooseX::ClassAttribute; | ||
| 10 | |||
| 11 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'UpdateCustomKeyStore'); | ||
| 12 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::KMS::UpdateCustomKeyStoreResponse'); | ||
| 13 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 14 | 1; | ||
| 15 | |||
| 16 | ### main pod documentation begin ### | ||
| 17 | |||
| 18 | =head1 NAME | ||
| 19 | |||
| 20 | Paws::KMS::UpdateCustomKeyStore - Arguments for method UpdateCustomKeyStore on L<Paws::KMS> | ||
| 21 | |||
| 22 | =head1 DESCRIPTION | ||
| 23 | |||
| 24 | This class represents the parameters used for calling the method UpdateCustomKeyStore on the | ||
| 25 | L<AWS Key Management Service|Paws::KMS> service. Use the attributes of this class | ||
| 26 | as arguments to method UpdateCustomKeyStore. | ||
| 27 | |||
| 28 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to UpdateCustomKeyStore. | ||
| 29 | |||
| 30 | =head1 SYNOPSIS | ||
| 31 | |||
| 32 | my $kms = Paws->service('KMS'); | ||
| 33 | my $UpdateCustomKeyStoreResponse = $kms->UpdateCustomKeyStore( | ||
| 34 | CustomKeyStoreId => 'MyCustomKeyStoreIdType', | ||
| 35 | CloudHsmClusterId => 'MyCloudHsmClusterIdType', # OPTIONAL | ||
| 36 | KeyStorePassword => 'MyKeyStorePasswordType', # OPTIONAL | ||
| 37 | NewCustomKeyStoreName => 'MyCustomKeyStoreNameType', # OPTIONAL | ||
| 38 | ); | ||
| 39 | |||
| 40 | 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. | ||
| 41 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/kms/UpdateCustomKeyStore> | ||
| 42 | |||
| 43 | =head1 ATTRIBUTES | ||
| 44 | |||
| 45 | |||
| 46 | =head2 CloudHsmClusterId => Str | ||
| 47 | |||
| 48 | Associates the custom key store with a related AWS CloudHSM cluster. | ||
| 49 | |||
| 50 | Enter the cluster ID of the cluster that you used to create the custom | ||
| 51 | key store or a cluster that shares a backup history and has the same | ||
| 52 | cluster certificate as the original cluster. You cannot use this | ||
| 53 | parameter to associate a custom key store with an unrelated cluster. In | ||
| 54 | addition, the replacement cluster must fulfill the requirements | ||
| 55 | (https://docs.aws.amazon.com/kms/latest/developerguide/create-keystore.html#before-keystore) | ||
| 56 | for a cluster associated with a custom key store. To view the cluster | ||
| 57 | certificate of a cluster, use the DescribeClusters | ||
| 58 | (https://docs.aws.amazon.com/cloudhsm/latest/APIReference/API_DescribeClusters.html) | ||
| 59 | operation. | ||
| 60 | |||
| 61 | |||
| 62 | |||
| 63 | =head2 B<REQUIRED> CustomKeyStoreId => Str | ||
| 64 | |||
| 65 | Identifies the custom key store that you want to update. Enter the ID | ||
| 66 | of the custom key store. To find the ID of a custom key store, use the | ||
| 67 | DescribeCustomKeyStores operation. | ||
| 68 | |||
| 69 | |||
| 70 | |||
| 71 | =head2 KeyStorePassword => Str | ||
| 72 | |||
| 73 | Enter the current password of the C<kmsuser> crypto user (CU) in the | ||
| 74 | AWS CloudHSM cluster that is associated with the custom key store. | ||
| 75 | |||
| 76 | This parameter tells AWS KMS the current password of the C<kmsuser> | ||
| 77 | crypto user (CU). It does not set or change the password of any users | ||
| 78 | in the AWS CloudHSM cluster. | ||
| 79 | |||
| 80 | |||
| 81 | |||
| 82 | =head2 NewCustomKeyStoreName => Str | ||
| 83 | |||
| 84 | Changes the friendly name of the custom key store to the value that you | ||
| 85 | specify. The custom key store name must be unique in the AWS account. | ||
| 86 | |||
| 87 | |||
| 88 | |||
| 89 | |||
| 90 | =head1 SEE ALSO | ||
| 91 | |||
| 92 | This class forms part of L<Paws>, documenting arguments for method UpdateCustomKeyStore in L<Paws::KMS> | ||
| 93 | |||
| 94 | =head1 BUGS and CONTRIBUTIONS | ||
| 95 | |||
| 96 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 97 | |||
| 98 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 99 | |||
| 100 | =cut | ||
| 101 |