« blib/lib/Paws/Kendra/ConfluenceSpaceToIndexFieldMapping.pm
↑ Summary
blib/lib/Paws/Kendra/CreateDataSource.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Kendra::ConnectionConfiguration; | ||
| 3 | use Moose; | ||
| 4 | has DatabaseHost => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has DatabaseName => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has DatabasePort => (is => 'ro', isa => 'Int', required => 1); | ||
| 7 | has SecretArn => (is => 'ro', isa => 'Str', required => 1); | ||
| 8 | has TableName => (is => 'ro', isa => 'Str', required => 1); | ||
| 9 | |||
| 10 | 1; | ||
| 11 | |||
| 12 | ### main pod documentation begin ### | ||
| 13 | |||
| 14 | =head1 NAME | ||
| 15 | |||
| 16 | Paws::Kendra::ConnectionConfiguration | ||
| 17 | |||
| 18 | =head1 USAGE | ||
| 19 | |||
| 20 | This class represents one of two things: | ||
| 21 | |||
| 22 | =head3 Arguments in a call to a service | ||
| 23 | |||
| 24 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 25 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 26 | |||
| 27 | As an example, if Att1 is expected to be a Paws::Kendra::ConnectionConfiguration object: | ||
| 28 | |||
| 29 | $service_obj->Method(Att1 => { DatabaseHost => $value, ..., TableName => $value }); | ||
| 30 | |||
| 31 | =head3 Results returned from an API call | ||
| 32 | |||
| 33 | Use accessors for each attribute. If Att1 is expected to be an Paws::Kendra::ConnectionConfiguration object: | ||
| 34 | |||
| 35 | $result = $service_obj->Method(...); | ||
| 36 | $result->Att1->DatabaseHost | ||
| 37 | |||
| 38 | =head1 DESCRIPTION | ||
| 39 | |||
| 40 | Provides the information necessary to connect to a database. | ||
| 41 | |||
| 42 | =head1 ATTRIBUTES | ||
| 43 | |||
| 44 | |||
| 45 | =head2 B<REQUIRED> DatabaseHost => Str | ||
| 46 | |||
| 47 | The name of the host for the database. Can be either a string | ||
| 48 | (host.subdomain.domain.tld) or an IPv4 or IPv6 address. | ||
| 49 | |||
| 50 | |||
| 51 | =head2 B<REQUIRED> DatabaseName => Str | ||
| 52 | |||
| 53 | The name of the database containing the document data. | ||
| 54 | |||
| 55 | |||
| 56 | =head2 B<REQUIRED> DatabasePort => Int | ||
| 57 | |||
| 58 | The port that the database uses for connections. | ||
| 59 | |||
| 60 | |||
| 61 | =head2 B<REQUIRED> SecretArn => Str | ||
| 62 | |||
| 63 | The Amazon Resource Name (ARN) of credentials stored in AWS Secrets | ||
| 64 | Manager. The credentials should be a user/password pair. For more | ||
| 65 | information, see Using a Database Data Source | ||
| 66 | (https://docs.aws.amazon.com/kendra/latest/dg/data-source-database.html). | ||
| 67 | For more information about AWS Secrets Manager, see What Is AWS Secrets | ||
| 68 | Manager | ||
| 69 | (https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html) | ||
| 70 | in the I<AWS Secrets Manager> user guide. | ||
| 71 | |||
| 72 | |||
| 73 | =head2 B<REQUIRED> TableName => Str | ||
| 74 | |||
| 75 | The name of the table that contains the document data. | ||
| 76 | |||
| 77 | |||
| 78 | |||
| 79 | =head1 SEE ALSO | ||
| 80 | |||
| 81 | This class forms part of L<Paws>, describing an object used in L<Paws::Kendra> | ||
| 82 | |||
| 83 | =head1 BUGS and CONTRIBUTIONS | ||
| 84 | |||
| 85 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 86 | |||
| 87 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 88 | |||
| 89 | =cut | ||
| 90 |