Class: AWSCDK::Kendra::CfnDataSource::ConfluenceConfigurationProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
kendra/cfn_data_source.rb

Overview

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

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(secret_arn:, server_url:, version:, attachment_configuration: nil, blog_configuration: nil, exclusion_patterns: nil, inclusion_patterns: nil, page_configuration: nil, space_configuration: nil, vpc_configuration: nil) ⇒ ConfluenceConfigurationProperty

Returns a new instance of ConfluenceConfigurationProperty.

Parameters:



1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
 
# File 'kendra/cfn_data_source.rb', line 1012

def initialize(secret_arn:, server_url:, version:, attachment_configuration: nil, blog_configuration: nil, exclusion_patterns: nil, inclusion_patterns: nil, page_configuration: nil, space_configuration: nil, vpc_configuration: nil)
  @secret_arn = secret_arn
  Jsii::Type.check_type(@secret_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "secretArn")
  @server_url = server_url
  Jsii::Type.check_type(@server_url, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "serverUrl")
  @version = version
  Jsii::Type.check_type(@version, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "version")
  @attachment_configuration = attachment_configuration.is_a?(Hash) ? ::AWSCDK::Kendra::CfnDataSource::ConfluenceAttachmentConfigurationProperty.new(**attachment_configuration.transform_keys(&:to_sym)) : attachment_configuration
  Jsii::Type.check_type(@attachment_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19rZW5kcmEuQ2ZuRGF0YVNvdXJjZS5Db25mbHVlbmNlQXR0YWNobWVudENvbmZpZ3VyYXRpb25Qcm9wZXJ0eSJ9XX19")), "attachmentConfiguration") unless @attachment_configuration.nil?
  @blog_configuration = blog_configuration.is_a?(Hash) ? ::AWSCDK::Kendra::CfnDataSource::ConfluenceBlogConfigurationProperty.new(**blog_configuration.transform_keys(&:to_sym)) : blog_configuration
  Jsii::Type.check_type(@blog_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19rZW5kcmEuQ2ZuRGF0YVNvdXJjZS5Db25mbHVlbmNlQmxvZ0NvbmZpZ3VyYXRpb25Qcm9wZXJ0eSJ9XX19")), "blogConfiguration") unless @blog_configuration.nil?
  @exclusion_patterns = exclusion_patterns
  Jsii::Type.check_type(@exclusion_patterns, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "exclusionPatterns") unless @exclusion_patterns.nil?
  @inclusion_patterns = inclusion_patterns
  Jsii::Type.check_type(@inclusion_patterns, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "inclusionPatterns") unless @inclusion_patterns.nil?
  @page_configuration = page_configuration.is_a?(Hash) ? ::AWSCDK::Kendra::CfnDataSource::ConfluencePageConfigurationProperty.new(**page_configuration.transform_keys(&:to_sym)) : page_configuration
  Jsii::Type.check_type(@page_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19rZW5kcmEuQ2ZuRGF0YVNvdXJjZS5Db25mbHVlbmNlUGFnZUNvbmZpZ3VyYXRpb25Qcm9wZXJ0eSJ9XX19")), "pageConfiguration") unless @page_configuration.nil?
  @space_configuration = space_configuration.is_a?(Hash) ? ::AWSCDK::Kendra::CfnDataSource::ConfluenceSpaceConfigurationProperty.new(**space_configuration.transform_keys(&:to_sym)) : space_configuration
  Jsii::Type.check_type(@space_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19rZW5kcmEuQ2ZuRGF0YVNvdXJjZS5Db25mbHVlbmNlU3BhY2VDb25maWd1cmF0aW9uUHJvcGVydHkifV19fQ==")), "spaceConfiguration") unless @space_configuration.nil?
  @vpc_configuration = vpc_configuration.is_a?(Hash) ? ::AWSCDK::Kendra::CfnDataSource::DataSourceVPCConfigurationProperty.new(**vpc_configuration.transform_keys(&:to_sym)) : vpc_configuration
  Jsii::Type.check_type(@vpc_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19rZW5kcmEuQ2ZuRGF0YVNvdXJjZS5EYXRhU291cmNlVnBjQ29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "vpcConfiguration") unless @vpc_configuration.nil?
end

Instance Attribute Details

#attachment_configuration ⇒ AWSCDK::IResolvable, ... (readonly)

Configuration information for indexing attachments to Confluence blogs and pages.

Returns:

See Also:



1060
1061
1062
 
# File 'kendra/cfn_data_source.rb', line 1060

def attachment_configuration
  @attachment_configuration
end

#blog_configuration ⇒ AWSCDK::IResolvable, ... (readonly)

Configuration information for indexing Confluence blogs.

Returns:

See Also:



1065
1066
1067
 
# File 'kendra/cfn_data_source.rb', line 1065

def blog_configuration
  @blog_configuration
end

#exclusion_patterns ⇒ Array<String>? (readonly)

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

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.

Returns:

  • (Array<String>, nil)

See Also:



1072
1073
1074
 
# File 'kendra/cfn_data_source.rb', line 1072

def exclusion_patterns
  @exclusion_patterns
end

#inclusion_patterns ⇒ Array<String>? (readonly)

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

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.

Returns:

  • (Array<String>, nil)

See Also:



1079
1080
1081
 
# File 'kendra/cfn_data_source.rb', line 1079

def inclusion_patterns
  @inclusion_patterns
end

#page_configuration ⇒ AWSCDK::IResolvable, ... (readonly)

Configuration information for indexing Confluence pages.

Returns:

See Also:



1084
1085
1086
 
# File 'kendra/cfn_data_source.rb', line 1084

def page_configuration
  @page_configuration
end

#secret_arn ⇒ String (readonly)

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.

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 .

Returns:

  • (String)

See Also:



1043
1044
1045
 
# File 'kendra/cfn_data_source.rb', line 1043

def secret_arn
  @secret_arn
end

#server_url ⇒ String (readonly)

The URL of your Confluence instance.

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/ .

Returns:

  • (String)

See Also:



1050
1051
1052
 
# File 'kendra/cfn_data_source.rb', line 1050

def server_url
  @server_url
end

#space_configuration ⇒ AWSCDK::IResolvable, ... (readonly)

Configuration information for indexing Confluence spaces.

Returns:

See Also:



1089
1090
1091
 
# File 'kendra/cfn_data_source.rb', line 1089

def space_configuration
  @space_configuration
end

#version ⇒ String (readonly)

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

Returns:

  • (String)

See Also:



1055
1056
1057
 
# File 'kendra/cfn_data_source.rb', line 1055

def version
  @version
end

#vpc_configuration ⇒ AWSCDK::IResolvable, ... (readonly)

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

For more information, see Configuring a VPC .

Returns:

See Also:



1096
1097
1098
 
# File 'kendra/cfn_data_source.rb', line 1096

def vpc_configuration
  @vpc_configuration
end

Class Method Details

.jsii_properties ⇒ Object 



1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
 
# File 'kendra/cfn_data_source.rb', line 1098

def self.jsii_properties
  {
    :secret_arn => "secretArn",
    :server_url => "serverUrl",
    :version => "version",
    :attachment_configuration => "attachmentConfiguration",
    :blog_configuration => "blogConfiguration",
    :exclusion_patterns => "exclusionPatterns",
    :inclusion_patterns => "inclusionPatterns",
    :page_configuration => "pageConfiguration",
    :space_configuration => "spaceConfiguration",
    :vpc_configuration => "vpcConfiguration",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
 
# File 'kendra/cfn_data_source.rb', line 1113

def to_jsii
  result = {}
  result.merge!({
    "secretArn" => @secret_arn,
    "serverUrl" => @server_url,
    "version" => @version,
    "attachmentConfiguration" => @attachment_configuration,
    "blogConfiguration" => @blog_configuration,
    "exclusionPatterns" => @exclusion_patterns,
    "inclusionPatterns" => @inclusion_patterns,
    "pageConfiguration" => @page_configuration,
    "spaceConfiguration" => @space_configuration,
    "vpcConfiguration" => @vpc_configuration,
  })
  result.compact
end