blib/lib/Paws/Kendra/ServiceNowConfiguration.pm untested

filter: Statementstmt 0.0% 0 / 9 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 1 Podpod n/a totaltotal 0.0% 0 / 10 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
CRAP 2.0
1 # Generated by default/object.tt
2 package Paws::Kendra::ServiceNowConfiguration;
3 use Moose;
4 has AuthenticationType => (is => 'ro', isa => 'Str');
5 has HostUrl => (is => 'ro', isa => 'Str', required => 1);
6 has KnowledgeArticleConfiguration => (is => 'ro', isa => 'Paws::Kendra::ServiceNowKnowledgeArticleConfiguration');
7 has SecretArn => (is => 'ro', isa => 'Str', required => 1);
8 has ServiceCatalogConfiguration => (is => 'ro', isa => 'Paws::Kendra::ServiceNowServiceCatalogConfiguration');
9 has ServiceNowBuildVersion => (is => 'ro', isa => 'Str', required => 1);
10  
11 1;
12  
13 ### main pod documentation begin ###
14  
15 =head1 NAME
16  
17 Paws::Kendra::ServiceNowConfiguration
18  
19 =head1 USAGE
20  
21 This class represents one of two things:
22  
23 =head3 Arguments in a call to a service
24  
25 Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
26 Each attribute should be used as a named argument in the calls that expect this type of object.
27  
28 As an example, if Att1 is expected to be a Paws::Kendra::ServiceNowConfiguration object:
29  
30 $service_obj->Method(Att1 => { AuthenticationType => $value, ..., ServiceNowBuildVersion => $value });
31  
32 =head3 Results returned from an API call
33  
34 Use accessors for each attribute. If Att1 is expected to be an Paws::Kendra::ServiceNowConfiguration object:
35  
36 $result = $service_obj->Method(...);
37 $result->Att1->AuthenticationType
38  
39 =head1 DESCRIPTION
40  
41 Provides configuration information required to connect to a ServiceNow
42 data source.
43  
44 =head1 ATTRIBUTES
45  
46  
47 =head2 AuthenticationType => Str
48  
49 Determines the type of authentication used to connect to the ServiceNow
50 instance. If you choose C<HTTP_BASIC>, Amazon Kendra is authenticated
51 using the user name and password provided in the AWS Secrets Manager
52 secret in the C<SecretArn> field. When you choose C<OAUTH2>, Amazon
53 Kendra is authenticated using the OAuth token and secret provided in
54 the Secrets Manager secret, and the user name and password are used to
55 determine which information Amazon Kendra has access to.
56  
57 When you use C<OAUTH2> authentication, you must generate a token and a
58 client secret using the ServiceNow console. For more information, see
59 Using a ServiceNow data source
60 (https://docs.aws.amazon.com/kendra/latest/dg/data-source-servicenow.html).
61  
62  
63 =head2 B<REQUIRED> HostUrl => Str
64  
65 The ServiceNow instance that the data source connects to. The host
66 endpoint should look like the following: C<{instance}.service-now.com.>
67  
68  
69 =head2 KnowledgeArticleConfiguration => L<Paws::Kendra::ServiceNowKnowledgeArticleConfiguration>
70  
71 Provides configuration information for crawling knowledge articles in
72 the ServiceNow site.
73  
74  
75 =head2 B<REQUIRED> SecretArn => Str
76  
77 The Amazon Resource Name (ARN) of the AWS Secret Manager secret that
78 contains the user name and password required to connect to the
79 ServiceNow instance.
80  
81  
82 =head2 ServiceCatalogConfiguration => L<Paws::Kendra::ServiceNowServiceCatalogConfiguration>
83  
84 Provides configuration information for crawling service catalogs in the
85 ServiceNow site.
86  
87  
88 =head2 B<REQUIRED> ServiceNowBuildVersion => Str
89  
90 The identifier of the release that the ServiceNow host is running. If
91 the host is not running the C<LONDON> release, use C<OTHERS>.
92  
93  
94  
95 =head1 SEE ALSO
96  
97 This class forms part of L<Paws>, describing an object used in L<Paws::Kendra>
98  
99 =head1 BUGS and CONTRIBUTIONS
100  
101 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
102  
103 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
104  
105 =cut
106