Class CfnDataSource.ConfluenceConfigurationProperty

Provides the configuration information to connect to Confluence as your data source.

Inheritance

object

CfnDataSource.ConfluenceConfigurationProperty

Implements

CfnDataSource.IConfluenceConfigurationProperty

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.Kendra

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnDataSource.ConfluenceConfigurationProperty : CfnDataSource.IConfluenceConfigurationProperty

Syntax (vb)

Public Class CfnDataSource.ConfluenceConfigurationProperty Implements CfnDataSource.IConfluenceConfigurationProperty

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-confluenceconfiguration.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.Kendra;

             var confluenceConfigurationProperty = new ConfluenceConfigurationProperty {
                 SecretArn = "secretArn",
                 ServerUrl = "serverUrl",
                 Version = "version",

                 // the properties below are optional
                 AttachmentConfiguration = new ConfluenceAttachmentConfigurationProperty {
                     AttachmentFieldMappings = new [] { new ConfluenceAttachmentToIndexFieldMappingProperty {
                         DataSourceFieldName = "dataSourceFieldName",
                         IndexFieldName = "indexFieldName",

                         // the properties below are optional
                         DateFieldFormat = "dateFieldFormat"
                     } },
                     CrawlAttachments = false
                 },
                 BlogConfiguration = new ConfluenceBlogConfigurationProperty {
                     BlogFieldMappings = new [] { new ConfluenceBlogToIndexFieldMappingProperty {
                         DataSourceFieldName = "dataSourceFieldName",
                         IndexFieldName = "indexFieldName",

                         // the properties below are optional
                         DateFieldFormat = "dateFieldFormat"
                     } }
                 },
                 ExclusionPatterns = new [] { "exclusionPatterns" },
                 InclusionPatterns = new [] { "inclusionPatterns" },
                 PageConfiguration = new ConfluencePageConfigurationProperty {
                     PageFieldMappings = new [] { new ConfluencePageToIndexFieldMappingProperty {
                         DataSourceFieldName = "dataSourceFieldName",
                         IndexFieldName = "indexFieldName",

                         // the properties below are optional
                         DateFieldFormat = "dateFieldFormat"
                     } }
                 },
                 SpaceConfiguration = new ConfluenceSpaceConfigurationProperty {
                     CrawlArchivedSpaces = false,
                     CrawlPersonalSpaces = false,
                     ExcludeSpaces = new [] { "excludeSpaces" },
                     IncludeSpaces = new [] { "includeSpaces" },
                     SpaceFieldMappings = new [] { new ConfluenceSpaceToIndexFieldMappingProperty {
                         DataSourceFieldName = "dataSourceFieldName",
                         IndexFieldName = "indexFieldName",

                         // the properties below are optional
                         DateFieldFormat = "dateFieldFormat"
                     } }
                 },
                 VpcConfiguration = new DataSourceVpcConfigurationProperty {
                     SecurityGroupIds = new [] { "securityGroupIds" },
                     SubnetIds = new [] { "subnetIds" }
                 }
             };

Synopsis

Constructors

ConfluenceConfigurationProperty()

Provides the configuration information to connect to Confluence as your data source.

Properties

AttachmentConfiguration	Configuration information for indexing attachments to Confluence blogs and pages.
BlogConfiguration	Configuration information for indexing Confluence blogs.
ExclusionPatterns	A list of regular expression patterns to exclude certain blog posts, pages, spaces, or attachments in your Confluence.
InclusionPatterns	A list of regular expression patterns to include certain blog posts, pages, spaces, or attachments in your Confluence.
PageConfiguration	Configuration information for indexing Confluence pages.
SecretArn	The Amazon Resource Name (ARN) of an AWS Secrets Manager secret that contains the user name and password required to connect to the Confluence instance.
ServerUrl	The URL of your Confluence instance.
SpaceConfiguration	Configuration information for indexing Confluence spaces.
Version	The version or the type of Confluence installation to connect to.
VpcConfiguration	Configuration information for an Amazon Virtual Private Cloud to connect to your Confluence.

Constructors

ConfluenceConfigurationProperty()

Provides the configuration information to connect to Confluence as your data source.

public ConfluenceConfigurationProperty()

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-confluenceconfiguration.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.Kendra;

             var confluenceConfigurationProperty = new ConfluenceConfigurationProperty {
                 SecretArn = "secretArn",
                 ServerUrl = "serverUrl",
                 Version = "version",

                 // the properties below are optional
                 AttachmentConfiguration = new ConfluenceAttachmentConfigurationProperty {
                     AttachmentFieldMappings = new [] { new ConfluenceAttachmentToIndexFieldMappingProperty {
                         DataSourceFieldName = "dataSourceFieldName",
                         IndexFieldName = "indexFieldName",

                         // the properties below are optional
                         DateFieldFormat = "dateFieldFormat"
                     } },
                     CrawlAttachments = false
                 },
                 BlogConfiguration = new ConfluenceBlogConfigurationProperty {
                     BlogFieldMappings = new [] { new ConfluenceBlogToIndexFieldMappingProperty {
                         DataSourceFieldName = "dataSourceFieldName",
                         IndexFieldName = "indexFieldName",

                         // the properties below are optional
                         DateFieldFormat = "dateFieldFormat"
                     } }
                 },
                 ExclusionPatterns = new [] { "exclusionPatterns" },
                 InclusionPatterns = new [] { "inclusionPatterns" },
                 PageConfiguration = new ConfluencePageConfigurationProperty {
                     PageFieldMappings = new [] { new ConfluencePageToIndexFieldMappingProperty {
                         DataSourceFieldName = "dataSourceFieldName",
                         IndexFieldName = "indexFieldName",

                         // the properties below are optional
                         DateFieldFormat = "dateFieldFormat"
                     } }
                 },
                 SpaceConfiguration = new ConfluenceSpaceConfigurationProperty {
                     CrawlArchivedSpaces = false,
                     CrawlPersonalSpaces = false,
                     ExcludeSpaces = new [] { "excludeSpaces" },
                     IncludeSpaces = new [] { "includeSpaces" },
                     SpaceFieldMappings = new [] { new ConfluenceSpaceToIndexFieldMappingProperty {
                         DataSourceFieldName = "dataSourceFieldName",
                         IndexFieldName = "indexFieldName",

                         // the properties below are optional
                         DateFieldFormat = "dateFieldFormat"
                     } }
                 },
                 VpcConfiguration = new DataSourceVpcConfigurationProperty {
                     SecurityGroupIds = new [] { "securityGroupIds" },
                     SubnetIds = new [] { "subnetIds" }
                 }
             };

Properties

AttachmentConfiguration

Configuration information for indexing attachments to Confluence blogs and pages.

public object? AttachmentConfiguration { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-confluenceconfiguration.html#cfn-kendra-datasource-confluenceconfiguration-attachmentconfiguration

BlogConfiguration

Configuration information for indexing Confluence blogs.

public object? BlogConfiguration { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-confluenceconfiguration.html#cfn-kendra-datasource-confluenceconfiguration-blogconfiguration

ExclusionPatterns

A list of regular expression patterns to exclude certain blog posts, pages, spaces, or attachments in your Confluence.

public string[]? ExclusionPatterns { get; set; }

Property Value

string[]

Remarks

Content that matches the patterns are excluded from the index. Content that doesn't match the patterns is included in the index. If content matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the content isn't included in the index.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-confluenceconfiguration.html#cfn-kendra-datasource-confluenceconfiguration-exclusionpatterns

InclusionPatterns

A list of regular expression patterns to include certain blog posts, pages, spaces, or attachments in your Confluence.

public string[]? InclusionPatterns { get; set; }

Property Value

string[]

Remarks

Content that matches the patterns are included in the index. Content that doesn't match the patterns is excluded from the index. If content matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the content isn't included in the index.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-confluenceconfiguration.html#cfn-kendra-datasource-confluenceconfiguration-inclusionpatterns

PageConfiguration

Configuration information for indexing Confluence pages.

public object? PageConfiguration { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-confluenceconfiguration.html#cfn-kendra-datasource-confluenceconfiguration-pageconfiguration

SecretArn

The Amazon Resource Name (ARN) of an AWS Secrets Manager secret that contains the user name and password required to connect to the Confluence instance.

public string SecretArn { get; set; }

Property Value

string

Remarks

If you use Confluence Cloud, you use a generated API token as the password.

You can also provide authentication credentials in the form of a personal access token. For more information, see Using a Confluence data source .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-confluenceconfiguration.html#cfn-kendra-datasource-confluenceconfiguration-secretarn

ServerUrl

The URL of your Confluence instance.

public string ServerUrl { get; set; }

Property Value

string

Remarks

Use the full URL of the server. For example, https://server.example.com:port/ . You can also use an IP address, for example, https://192.168.1.113/ .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-confluenceconfiguration.html#cfn-kendra-datasource-confluenceconfiguration-serverurl

SpaceConfiguration

Configuration information for indexing Confluence spaces.

public object? SpaceConfiguration { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-confluenceconfiguration.html#cfn-kendra-datasource-confluenceconfiguration-spaceconfiguration

Version

The version or the type of Confluence installation to connect to.

public string Version { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-confluenceconfiguration.html#cfn-kendra-datasource-confluenceconfiguration-version

VpcConfiguration

Configuration information for an Amazon Virtual Private Cloud to connect to your Confluence.

public object? VpcConfiguration { get; set; }

Property Value

object

Remarks

For more information, see Configuring a VPC .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-confluenceconfiguration.html#cfn-kendra-datasource-confluenceconfiguration-vpcconfiguration

Implements

CfnDataSource.IConfluenceConfigurationProperty