« blib/lib/Paws/IoT/RateIncreaseCriteria.pm
↑ Summary
blib/lib/Paws/IoT/RegisterCACertificateResponse.pm »
| 1 | |||
| 2 | package Paws::IoT::RegisterCACertificate; | ||
| 3 | use Moose; | ||
| 4 | has AllowAutoRegistration => (is => 'ro', isa => 'Bool', traits => ['ParamInQuery'], query_name => 'allowAutoRegistration'); | ||
| 5 | has CaCertificate => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'caCertificate', required => 1); | ||
| 6 | has RegistrationConfig => (is => 'ro', isa => 'Paws::IoT::RegistrationConfig', traits => ['NameInRequest'], request_name => 'registrationConfig'); | ||
| 7 | has SetAsActive => (is => 'ro', isa => 'Bool', traits => ['ParamInQuery'], query_name => 'setAsActive'); | ||
| 8 | has Tags => (is => 'ro', isa => 'ArrayRef[Paws::IoT::Tag]', traits => ['NameInRequest'], request_name => 'tags'); | ||
| 9 | has VerificationCertificate => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'verificationCertificate', required => 1); | ||
| 10 | |||
| 11 | use MooseX::ClassAttribute; | ||
| 12 | |||
| 13 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'RegisterCACertificate'); | ||
| 14 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/cacertificate'); | ||
| 15 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 16 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::IoT::RegisterCACertificateResponse'); | ||
| 17 | 1; | ||
| 18 | |||
| 19 | ### main pod documentation begin ### | ||
| 20 | |||
| 21 | =head1 NAME | ||
| 22 | |||
| 23 | Paws::IoT::RegisterCACertificate - Arguments for method RegisterCACertificate on L<Paws::IoT> | ||
| 24 | |||
| 25 | =head1 DESCRIPTION | ||
| 26 | |||
| 27 | This class represents the parameters used for calling the method RegisterCACertificate on the | ||
| 28 | L<AWS IoT|Paws::IoT> service. Use the attributes of this class | ||
| 29 | as arguments to method RegisterCACertificate. | ||
| 30 | |||
| 31 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to RegisterCACertificate. | ||
| 32 | |||
| 33 | =head1 SYNOPSIS | ||
| 34 | |||
| 35 | my $iot = Paws->service('IoT'); | ||
| 36 | my $RegisterCACertificateResponse = $iot->RegisterCACertificate( | ||
| 37 | CaCertificate => 'MyCertificatePem', | ||
| 38 | VerificationCertificate => 'MyCertificatePem', | ||
| 39 | AllowAutoRegistration => 1, # OPTIONAL | ||
| 40 | RegistrationConfig => { | ||
| 41 | RoleArn => 'MyRoleArn', # min: 20, max: 2048; OPTIONAL | ||
| 42 | TemplateBody => 'MyTemplateBody', # OPTIONAL | ||
| 43 | }, # OPTIONAL | ||
| 44 | SetAsActive => 1, # OPTIONAL | ||
| 45 | Tags => [ | ||
| 46 | { | ||
| 47 | Key => 'MyTagKey', # min: 1, max: 128 | ||
| 48 | Value => 'MyTagValue', # min: 1, max: 256; OPTIONAL | ||
| 49 | }, | ||
| 50 | ... | ||
| 51 | ], # OPTIONAL | ||
| 52 | ); | ||
| 53 | |||
| 54 | # Results: | ||
| 55 | my $CertificateArn = $RegisterCACertificateResponse->CertificateArn; | ||
| 56 | my $CertificateId = $RegisterCACertificateResponse->CertificateId; | ||
| 57 | |||
| 58 | # Returns a L<Paws::IoT::RegisterCACertificateResponse> object. | ||
| 59 | |||
| 60 | 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. | ||
| 61 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/iot/RegisterCACertificate> | ||
| 62 | |||
| 63 | =head1 ATTRIBUTES | ||
| 64 | |||
| 65 | |||
| 66 | =head2 AllowAutoRegistration => Bool | ||
| 67 | |||
| 68 | Allows this CA certificate to be used for auto registration of device | ||
| 69 | certificates. | ||
| 70 | |||
| 71 | |||
| 72 | |||
| 73 | =head2 B<REQUIRED> CaCertificate => Str | ||
| 74 | |||
| 75 | The CA certificate. | ||
| 76 | |||
| 77 | |||
| 78 | |||
| 79 | =head2 RegistrationConfig => L<Paws::IoT::RegistrationConfig> | ||
| 80 | |||
| 81 | Information about the registration configuration. | ||
| 82 | |||
| 83 | |||
| 84 | |||
| 85 | =head2 SetAsActive => Bool | ||
| 86 | |||
| 87 | A boolean value that specifies if the CA certificate is set to active. | ||
| 88 | |||
| 89 | |||
| 90 | |||
| 91 | =head2 Tags => ArrayRef[L<Paws::IoT::Tag>] | ||
| 92 | |||
| 93 | Metadata which can be used to manage the CA certificate. | ||
| 94 | |||
| 95 | For URI Request parameters use format: ...key1=value1&key2=value2... | ||
| 96 | |||
| 97 | For the CLI command-line parameter use format: &&tags | ||
| 98 | "key1=value1&key2=value2..." | ||
| 99 | |||
| 100 | For the cli-input-json file use format: "tags": | ||
| 101 | "key1=value1&key2=value2..." | ||
| 102 | |||
| 103 | |||
| 104 | |||
| 105 | =head2 B<REQUIRED> VerificationCertificate => Str | ||
| 106 | |||
| 107 | The private key verification certificate. | ||
| 108 | |||
| 109 | |||
| 110 | |||
| 111 | |||
| 112 | =head1 SEE ALSO | ||
| 113 | |||
| 114 | This class forms part of L<Paws>, documenting arguments for method RegisterCACertificate in L<Paws::IoT> | ||
| 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 |