| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Kendra::ProxyConfiguration; | ||
| 3 | use Moose; | ||
| 4 | has Credentials => (is => 'ro', isa => 'Str'); | ||
| 5 | has Host => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has Port => (is => 'ro', isa => 'Int', required => 1); | ||
| 7 | |||
| 8 | 1; | ||
| 9 | |||
| 10 | ### main pod documentation begin ### | ||
| 11 | |||
| 12 | =head1 NAME | ||
| 13 | |||
| 14 | Paws::Kendra::ProxyConfiguration | ||
| 15 | |||
| 16 | =head1 USAGE | ||
| 17 | |||
| 18 | This class represents one of two things: | ||
| 19 | |||
| 20 | =head3 Arguments in a call to a service | ||
| 21 | |||
| 22 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 23 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 24 | |||
| 25 | As an example, if Att1 is expected to be a Paws::Kendra::ProxyConfiguration object: | ||
| 26 | |||
| 27 | $service_obj->Method(Att1 => { Credentials => $value, ..., Port => $value }); | ||
| 28 | |||
| 29 | =head3 Results returned from an API call | ||
| 30 | |||
| 31 | Use accessors for each attribute. If Att1 is expected to be an Paws::Kendra::ProxyConfiguration object: | ||
| 32 | |||
| 33 | $result = $service_obj->Method(...); | ||
| 34 | $result->Att1->Credentials | ||
| 35 | |||
| 36 | =head1 DESCRIPTION | ||
| 37 | |||
| 38 | Provides the configuration information for a web proxy to connect to | ||
| 39 | website hosts. | ||
| 40 | |||
| 41 | =head1 ATTRIBUTES | ||
| 42 | |||
| 43 | |||
| 44 | =head2 Credentials => Str | ||
| 45 | |||
| 46 | Your secret ARN, which you can create in AWS Secrets Manager | ||
| 47 | (https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html) | ||
| 48 | |||
| 49 | The credentials are optional. You use a secret if web proxy credentials | ||
| 50 | are required to connect to a website host. Amazon Kendra currently | ||
| 51 | support basic authentication to connect to a web proxy server. The | ||
| 52 | secret stores your credentials. | ||
| 53 | |||
| 54 | |||
| 55 | =head2 B<REQUIRED> Host => Str | ||
| 56 | |||
| 57 | The name of the website host you want to connect to via a web proxy | ||
| 58 | server. | ||
| 59 | |||
| 60 | For example, the host name of https://a.example.com/page1.html is | ||
| 61 | "a.example.com". | ||
| 62 | |||
| 63 | |||
| 64 | =head2 B<REQUIRED> Port => Int | ||
| 65 | |||
| 66 | The port number of the website host you want to connect to via a web | ||
| 67 | proxy server. | ||
| 68 | |||
| 69 | For example, the port for https://a.example.com/page1.html is 443, the | ||
| 70 | standard port for HTTPS. | ||
| 71 | |||
| 72 | |||
| 73 | |||
| 74 | =head1 SEE ALSO | ||
| 75 | |||
| 76 | This class forms part of L<Paws>, describing an object used in L<Paws::Kendra> | ||
| 77 | |||
| 78 | =head1 BUGS and CONTRIBUTIONS | ||
| 79 | |||
| 80 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 81 | |||
| 82 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 83 | |||
| 84 | =cut | ||
| 85 |