| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::KMS::CustomKeyStoresListEntry; | ||
| 3 | use Moose; | ||
| 4 | has CloudHsmClusterId => (is => 'ro', isa => 'Str'); | ||
| 5 | has ConnectionErrorCode => (is => 'ro', isa => 'Str'); | ||
| 6 | has ConnectionState => (is => 'ro', isa => 'Str'); | ||
| 7 | has CreationDate => (is => 'ro', isa => 'Str'); | ||
| 8 | has CustomKeyStoreId => (is => 'ro', isa => 'Str'); | ||
| 9 | has CustomKeyStoreName => (is => 'ro', isa => 'Str'); | ||
| 10 | has TrustAnchorCertificate => (is => 'ro', isa => 'Str'); | ||
| 11 | |||
| 12 | 1; | ||
| 13 | |||
| 14 | ### main pod documentation begin ### | ||
| 15 | |||
| 16 | =head1 NAME | ||
| 17 | |||
| 18 | Paws::KMS::CustomKeyStoresListEntry | ||
| 19 | |||
| 20 | =head1 USAGE | ||
| 21 | |||
| 22 | This class represents one of two things: | ||
| 23 | |||
| 24 | =head3 Arguments in a call to a service | ||
| 25 | |||
| 26 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 27 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 28 | |||
| 29 | As an example, if Att1 is expected to be a Paws::KMS::CustomKeyStoresListEntry object: | ||
| 30 | |||
| 31 | $service_obj->Method(Att1 => { CloudHsmClusterId => $value, ..., TrustAnchorCertificate => $value }); | ||
| 32 | |||
| 33 | =head3 Results returned from an API call | ||
| 34 | |||
| 35 | Use accessors for each attribute. If Att1 is expected to be an Paws::KMS::CustomKeyStoresListEntry object: | ||
| 36 | |||
| 37 | $result = $service_obj->Method(...); | ||
| 38 | $result->Att1->CloudHsmClusterId | ||
| 39 | |||
| 40 | =head1 DESCRIPTION | ||
| 41 | |||
| 42 | Contains information about each custom key store in the custom key | ||
| 43 | store list. | ||
| 44 | |||
| 45 | =head1 ATTRIBUTES | ||
| 46 | |||
| 47 | |||
| 48 | =head2 CloudHsmClusterId => Str | ||
| 49 | |||
| 50 | A unique identifier for the AWS CloudHSM cluster that is associated | ||
| 51 | with the custom key store. | ||
| 52 | |||
| 53 | |||
| 54 | =head2 ConnectionErrorCode => Str | ||
| 55 | |||
| 56 | Describes the connection error. This field appears in the response only | ||
| 57 | when the C<ConnectionState> is C<FAILED>. For help resolving these | ||
| 58 | errors, see How to Fix a Connection Failure | ||
| 59 | (https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html#fix-keystore-failed) | ||
| 60 | in I<AWS Key Management Service Developer Guide>. | ||
| 61 | |||
| 62 | Valid values are: | ||
| 63 | |||
| 64 | =over | ||
| 65 | |||
| 66 | =item * | ||
| 67 | |||
| 68 | C<CLUSTER_NOT_FOUND> - AWS KMS cannot find the AWS CloudHSM cluster | ||
| 69 | with the specified cluster ID. | ||
| 70 | |||
| 71 | =item * | ||
| 72 | |||
| 73 | C<INSUFFICIENT_CLOUDHSM_HSMS> - The associated AWS CloudHSM cluster | ||
| 74 | does not contain any active HSMs. To connect a custom key store to its | ||
| 75 | AWS CloudHSM cluster, the cluster must contain at least one active HSM. | ||
| 76 | |||
| 77 | =item * | ||
| 78 | |||
| 79 | C<INTERNAL_ERROR> - AWS KMS could not complete the request due to an | ||
| 80 | internal error. Retry the request. For C<ConnectCustomKeyStore> | ||
| 81 | requests, disconnect the custom key store before trying to connect | ||
| 82 | again. | ||
| 83 | |||
| 84 | =item * | ||
| 85 | |||
| 86 | C<INVALID_CREDENTIALS> - AWS KMS does not have the correct password for | ||
| 87 | the C<kmsuser> crypto user in the AWS CloudHSM cluster. Before you can | ||
| 88 | connect your custom key store to its AWS CloudHSM cluster, you must | ||
| 89 | change the C<kmsuser> account password and update the key store | ||
| 90 | password value for the custom key store. | ||
| 91 | |||
| 92 | =item * | ||
| 93 | |||
| 94 | C<NETWORK_ERRORS> - Network errors are preventing AWS KMS from | ||
| 95 | connecting to the custom key store. | ||
| 96 | |||
| 97 | =item * | ||
| 98 | |||
| 99 | C<SUBNET_NOT_FOUND> - A subnet in the AWS CloudHSM cluster | ||
| 100 | configuration was deleted. If AWS KMS cannot find all of the subnets in | ||
| 101 | the cluster configuration, attempts to connect the custom key store to | ||
| 102 | the AWS CloudHSM cluster fail. To fix this error, create a cluster from | ||
| 103 | a recent backup and associate it with your custom key store. (This | ||
| 104 | process creates a new cluster configuration with a VPC and private | ||
| 105 | subnets.) For details, see How to Fix a Connection Failure | ||
| 106 | (https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html#fix-keystore-failed) | ||
| 107 | in the I<AWS Key Management Service Developer Guide>. | ||
| 108 | |||
| 109 | =item * | ||
| 110 | |||
| 111 | C<USER_LOCKED_OUT> - The C<kmsuser> CU account is locked out of the | ||
| 112 | associated AWS CloudHSM cluster due to too many failed password | ||
| 113 | attempts. Before you can connect your custom key store to its AWS | ||
| 114 | CloudHSM cluster, you must change the C<kmsuser> account password and | ||
| 115 | update the key store password value for the custom key store. | ||
| 116 | |||
| 117 | =item * | ||
| 118 | |||
| 119 | C<USER_LOGGED_IN> - The C<kmsuser> CU account is logged into the the | ||
| 120 | associated AWS CloudHSM cluster. This prevents AWS KMS from rotating | ||
| 121 | the C<kmsuser> account password and logging into the cluster. Before | ||
| 122 | you can connect your custom key store to its AWS CloudHSM cluster, you | ||
| 123 | must log the C<kmsuser> CU out of the cluster. If you changed the | ||
| 124 | C<kmsuser> password to log into the cluster, you must also and update | ||
| 125 | the key store password value for the custom key store. For help, see | ||
| 126 | How to Log Out and Reconnect | ||
| 127 | (https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html#login-kmsuser-2) | ||
| 128 | in the I<AWS Key Management Service Developer Guide>. | ||
| 129 | |||
| 130 | =item * | ||
| 131 | |||
| 132 | C<USER_NOT_FOUND> - AWS KMS cannot find a C<kmsuser> CU account in the | ||
| 133 | associated AWS CloudHSM cluster. Before you can connect your custom key | ||
| 134 | store to its AWS CloudHSM cluster, you must create a C<kmsuser> CU | ||
| 135 | account in the cluster, and then update the key store password value | ||
| 136 | for the custom key store. | ||
| 137 | |||
| 138 | =back | ||
| 139 | |||
| 140 | |||
| 141 | |||
| 142 | =head2 ConnectionState => Str | ||
| 143 | |||
| 144 | Indicates whether the custom key store is connected to its AWS CloudHSM | ||
| 145 | cluster. | ||
| 146 | |||
| 147 | You can create and use CMKs in your custom key stores only when its | ||
| 148 | connection state is C<CONNECTED>. | ||
| 149 | |||
| 150 | The value is C<DISCONNECTED> if the key store has never been connected | ||
| 151 | or you use the DisconnectCustomKeyStore operation to disconnect it. If | ||
| 152 | the value is C<CONNECTED> but you are having trouble using the custom | ||
| 153 | key store, make sure that its associated AWS CloudHSM cluster is active | ||
| 154 | and contains at least one active HSM. | ||
| 155 | |||
| 156 | A value of C<FAILED> indicates that an attempt to connect was | ||
| 157 | unsuccessful. The C<ConnectionErrorCode> field in the response | ||
| 158 | indicates the cause of the failure. For help resolving a connection | ||
| 159 | failure, see Troubleshooting a Custom Key Store | ||
| 160 | (https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html) | ||
| 161 | in the I<AWS Key Management Service Developer Guide>. | ||
| 162 | |||
| 163 | |||
| 164 | =head2 CreationDate => Str | ||
| 165 | |||
| 166 | The date and time when the custom key store was created. | ||
| 167 | |||
| 168 | |||
| 169 | =head2 CustomKeyStoreId => Str | ||
| 170 | |||
| 171 | A unique identifier for the custom key store. | ||
| 172 | |||
| 173 | |||
| 174 | =head2 CustomKeyStoreName => Str | ||
| 175 | |||
| 176 | The user-specified friendly name for the custom key store. | ||
| 177 | |||
| 178 | |||
| 179 | =head2 TrustAnchorCertificate => Str | ||
| 180 | |||
| 181 | The trust anchor certificate of the associated AWS CloudHSM cluster. | ||
| 182 | When you initialize the cluster | ||
| 183 | (https://docs.aws.amazon.com/cloudhsm/latest/userguide/initialize-cluster.html#sign-csr), | ||
| 184 | you create this certificate and save it in the C<customerCA.crt> file. | ||
| 185 | |||
| 186 | |||
| 187 | |||
| 188 | =head1 SEE ALSO | ||
| 189 | |||
| 190 | This class forms part of L<Paws>, describing an object used in L<Paws::KMS> | ||
| 191 | |||
| 192 | =head1 BUGS and CONTRIBUTIONS | ||
| 193 | |||
| 194 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 195 | |||
| 196 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 197 | |||
| 198 | =cut | ||
| 199 |