« blib/lib/Paws/Kendra/ConfluenceBlogToIndexFieldMapping.pm
↑ Summary
blib/lib/Paws/Kendra/ConfluencePageConfiguration.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Kendra::ConfluenceConfiguration; | ||
| 3 | use Moose; | ||
| 4 | has AttachmentConfiguration => (is => 'ro', isa => 'Paws::Kendra::ConfluenceAttachmentConfiguration'); | ||
| 5 | has BlogConfiguration => (is => 'ro', isa => 'Paws::Kendra::ConfluenceBlogConfiguration'); | ||
| 6 | has ExclusionPatterns => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 7 | has InclusionPatterns => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 8 | has PageConfiguration => (is => 'ro', isa => 'Paws::Kendra::ConfluencePageConfiguration'); | ||
| 9 | has SecretArn => (is => 'ro', isa => 'Str', required => 1); | ||
| 10 | has ServerUrl => (is => 'ro', isa => 'Str', required => 1); | ||
| 11 | has SpaceConfiguration => (is => 'ro', isa => 'Paws::Kendra::ConfluenceSpaceConfiguration'); | ||
| 12 | has Version => (is => 'ro', isa => 'Str', required => 1); | ||
| 13 | has VpcConfiguration => (is => 'ro', isa => 'Paws::Kendra::DataSourceVpcConfiguration'); | ||
| 14 | |||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::Kendra::ConfluenceConfiguration | ||
| 22 | |||
| 23 | =head1 USAGE | ||
| 24 | |||
| 25 | This class represents one of two things: | ||
| 26 | |||
| 27 | =head3 Arguments in a call to a service | ||
| 28 | |||
| 29 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 30 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 31 | |||
| 32 | As an example, if Att1 is expected to be a Paws::Kendra::ConfluenceConfiguration object: | ||
| 33 | |||
| 34 | $service_obj->Method(Att1 => { AttachmentConfiguration => $value, ..., VpcConfiguration => $value }); | ||
| 35 | |||
| 36 | =head3 Results returned from an API call | ||
| 37 | |||
| 38 | Use accessors for each attribute. If Att1 is expected to be an Paws::Kendra::ConfluenceConfiguration object: | ||
| 39 | |||
| 40 | $result = $service_obj->Method(...); | ||
| 41 | $result->Att1->AttachmentConfiguration | ||
| 42 | |||
| 43 | =head1 DESCRIPTION | ||
| 44 | |||
| 45 | Provides configuration information for data sources that connect to | ||
| 46 | Confluence. | ||
| 47 | |||
| 48 | =head1 ATTRIBUTES | ||
| 49 | |||
| 50 | |||
| 51 | =head2 AttachmentConfiguration => L<Paws::Kendra::ConfluenceAttachmentConfiguration> | ||
| 52 | |||
| 53 | Specifies configuration information for indexing attachments to | ||
| 54 | Confluence blogs and pages. | ||
| 55 | |||
| 56 | |||
| 57 | =head2 BlogConfiguration => L<Paws::Kendra::ConfluenceBlogConfiguration> | ||
| 58 | |||
| 59 | Specifies configuration information for indexing Confluence blogs. | ||
| 60 | |||
| 61 | |||
| 62 | =head2 ExclusionPatterns => ArrayRef[Str|Undef] | ||
| 63 | |||
| 64 | A list of regular expression patterns that apply to a URL on the | ||
| 65 | Confluence server. An exclusion pattern can apply to a blog post, a | ||
| 66 | page, a space, or an attachment. Items that match the pattern are | ||
| 67 | excluded from the index. Items that don't match the pattern are | ||
| 68 | included in the index. If a item matches both an exclusion pattern and | ||
| 69 | an inclusion pattern, the item isn't included in the index. | ||
| 70 | |||
| 71 | |||
| 72 | =head2 InclusionPatterns => ArrayRef[Str|Undef] | ||
| 73 | |||
| 74 | A list of regular expression patterns that apply to a URL on the | ||
| 75 | Confluence server. An inclusion pattern can apply to a blog post, a | ||
| 76 | page, a space, or an attachment. Items that match the patterns are | ||
| 77 | included in the index. Items that don't match the pattern are excluded | ||
| 78 | from the index. If an item matches both an inclusion pattern and an | ||
| 79 | exclusion pattern, the item isn't included in the index. | ||
| 80 | |||
| 81 | |||
| 82 | =head2 PageConfiguration => L<Paws::Kendra::ConfluencePageConfiguration> | ||
| 83 | |||
| 84 | Specifies configuration information for indexing Confluence pages. | ||
| 85 | |||
| 86 | |||
| 87 | =head2 B<REQUIRED> SecretArn => Str | ||
| 88 | |||
| 89 | The Amazon Resource Name (ARN) of an AWS Secrets Manager secret that | ||
| 90 | contains the key/value pairs required to connect to your Confluence | ||
| 91 | server. The secret must contain a JSON structure with the following | ||
| 92 | keys: | ||
| 93 | |||
| 94 | =over | ||
| 95 | |||
| 96 | =item * | ||
| 97 | |||
| 98 | username - The user name or email address of a user with administrative | ||
| 99 | privileges for the Confluence server. | ||
| 100 | |||
| 101 | =item * | ||
| 102 | |||
| 103 | password - The password associated with the user logging in to the | ||
| 104 | Confluence server. | ||
| 105 | |||
| 106 | =back | ||
| 107 | |||
| 108 | |||
| 109 | |||
| 110 | =head2 B<REQUIRED> ServerUrl => Str | ||
| 111 | |||
| 112 | The URL of your Confluence instance. Use the full URL of the server. | ||
| 113 | For example, C<https://server.example.com:port/>. You can also use an | ||
| 114 | IP address, for example, C<https://192.168.1.113/>. | ||
| 115 | |||
| 116 | |||
| 117 | =head2 SpaceConfiguration => L<Paws::Kendra::ConfluenceSpaceConfiguration> | ||
| 118 | |||
| 119 | Specifies configuration information for indexing Confluence spaces. | ||
| 120 | |||
| 121 | |||
| 122 | =head2 B<REQUIRED> Version => Str | ||
| 123 | |||
| 124 | Specifies the version of the Confluence installation that you are | ||
| 125 | connecting to. | ||
| 126 | |||
| 127 | |||
| 128 | =head2 VpcConfiguration => L<Paws::Kendra::DataSourceVpcConfiguration> | ||
| 129 | |||
| 130 | Specifies the information for connecting to an Amazon VPC. | ||
| 131 | |||
| 132 | |||
| 133 | |||
| 134 | =head1 SEE ALSO | ||
| 135 | |||
| 136 | This class forms part of L<Paws>, describing an object used in L<Paws::Kendra> | ||
| 137 | |||
| 138 | =head1 BUGS and CONTRIBUTIONS | ||
| 139 | |||
| 140 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 141 | |||
| 142 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 143 | |||
| 144 | =cut | ||
| 145 |