CfnDataSource¶
-
class
aws_cdk.aws_kendra.
CfnDataSource
(scope, id, *, index_id, name, type, data_source_configuration=None, description=None, role_arn=None, schedule=None, tags=None)¶ Bases:
aws_cdk.core.CfnResource
A CloudFormation
AWS::Kendra::DataSource
.- CloudformationResource
AWS::Kendra::DataSource
- Link
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kendra-datasource.html
Create a new
AWS::Kendra::DataSource
.- Parameters
scope (
Construct
) –scope in which this resource is defined.
id (
str
) –scoped id of the resource.
index_id (
str
) –AWS::Kendra::DataSource.IndexId
.name (
str
) –AWS::Kendra::DataSource.Name
.type (
str
) –AWS::Kendra::DataSource.Type
.data_source_configuration (
Union
[DataSourceConfigurationProperty
,IResolvable
,None
]) –AWS::Kendra::DataSource.DataSourceConfiguration
.description (
Optional
[str
]) –AWS::Kendra::DataSource.Description
.role_arn (
Optional
[str
]) –AWS::Kendra::DataSource.RoleArn
.schedule (
Optional
[str
]) –AWS::Kendra::DataSource.Schedule
.tags (
Optional
[Sequence
[CfnTag
]]) –AWS::Kendra::DataSource.Tags
.
Methods
-
add_deletion_override
(path)¶ Syntactic sugar for
addOverride(path, undefined)
.- Parameters
path (
str
) – The path of the value to delete.- Return type
None
-
add_depends_on
(target)¶ Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.
- Parameters
target (
CfnResource
) –- Return type
None
-
add_metadata
(key, value)¶ Add a value to the CloudFormation Resource Metadata.
- Parameters
key (
str
) –value (
Any
) –
- See
https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.
- Return type
None
-
add_override
(path, value)¶ Adds an override to the synthesized CloudFormation resource.
To add a property override, either use
addPropertyOverride
or prefixpath
with “Properties.” (i.e.Properties.TopicName
).If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.
To include a literal
.
in the property name, prefix with a\
. In most programming languages you will need to write this as"\\."
because the\
itself will need to be escaped.For example:
# Example automatically generated. See https://github.com/aws/jsii/issues/826 cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"]) cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")
would add the overrides Example:
"Properties": { "GlobalSecondaryIndexes": [ { "Projection": { "NonKeyAttributes": [ "myattribute" ] ... } ... }, { "ProjectionType": "INCLUDE" ... }, ] ... }
- Parameters
path (
str
) –The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
value (
Any
) –The value. Could be primitive or complex.
- Return type
None
-
add_property_deletion_override
(property_path)¶ Adds an override that deletes the value of a property from the resource definition.
- Parameters
property_path (
str
) – The path to the property.- Return type
None
-
add_property_override
(property_path, value)¶ Adds an override to a resource property.
Syntactic sugar for
addOverride("Properties.<...>", value)
.- Parameters
property_path (
str
) – The path of the property.value (
Any
) – The value.
- Return type
None
-
apply_removal_policy
(policy=None, *, apply_to_update_replace_policy=None, default=None)¶ Sets the deletion policy of the resource based on the removal policy specified.
- Parameters
policy (
Optional
[RemovalPolicy
]) –apply_to_update_replace_policy (
Optional
[bool
]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: truedefault (
Optional
[RemovalPolicy
]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resoure, please consult that specific resource’s documentation.
- Return type
None
-
get_att
(attribute_name)¶ Returns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g.
resource.arn
), but this can be used for future compatibility in case there is no generated attribute.- Parameters
attribute_name (
str
) – The name of the attribute.- Return type
-
get_metadata
(key)¶ Retrieve a value value from the CloudFormation Resource Metadata.
- Parameters
key (
str
) –- See
https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.
- Return type
Any
-
inspect
(inspector)¶ (experimental) Examines the CloudFormation resource and discloses attributes.
- Parameters
inspector (
TreeInspector
) –tree inspector to collect and process attributes.
- Stability
experimental
- Return type
None
-
override_logical_id
(new_logical_id)¶ Overrides the auto-generated logical ID with a specific ID.
- Parameters
new_logical_id (
str
) – The new logical ID to use for this stack element.- Return type
None
-
to_string
()¶ Returns a string representation of this construct.
- Return type
str
- Returns
a string representation of this resource
Attributes
-
CFN_RESOURCE_TYPE_NAME
= 'AWS::Kendra::DataSource'¶
-
attr_arn
¶ Arn
- Type
cloudformationAttribute
- Return type
str
-
attr_id
¶ Id
- Type
cloudformationAttribute
- Return type
str
-
cfn_options
¶ Options for this resource, such as condition, update policy etc.
- Return type
-
cfn_resource_type
¶ AWS resource type.
- Return type
str
-
creation_stack
¶ return:
the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.
- Return type
List
[str
]
-
data_source_configuration
¶ AWS::Kendra::DataSource.DataSourceConfiguration
.
-
description
¶ AWS::Kendra::DataSource.Description
.
-
index_id
¶ AWS::Kendra::DataSource.IndexId
.
-
logical_id
¶ The logical ID for this CloudFormation stack element.
The logical ID of the element is calculated from the path of the resource node in the construct tree.
To override this value, use
overrideLogicalId(newLogicalId)
.- Return type
str
- Returns
the logical ID as a stringified token. This value will only get resolved during synthesis.
-
name
¶ AWS::Kendra::DataSource.Name
.
-
node
¶ The construct tree node associated with this construct.
- Return type
-
ref
¶ Return a string that will be resolved to a CloudFormation
{ Ref }
for this element.If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through
Lazy.any({ produce: resource.ref })
.- Return type
str
-
role_arn
¶ AWS::Kendra::DataSource.RoleArn
.
-
schedule
¶ AWS::Kendra::DataSource.Schedule
.
-
stack
¶ The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
- Return type
AWS::Kendra::DataSource.Tags
.
-
type
¶ AWS::Kendra::DataSource.Type
.
Static Methods
-
classmethod
is_cfn_element
(x)¶ Returns
true
if a construct is a stack element (i.e. part of the synthesized cloudformation template).Uses duck-typing instead of
instanceof
to allow stack elements from different versions of this library to be included in the same stack.- Parameters
x (
Any
) –- Return type
bool
- Returns
The construct as a stack element or undefined if it is not a stack element.
-
classmethod
is_cfn_resource
(construct)¶ Check whether the given construct is a CfnResource.
- Parameters
construct (
IConstruct
) –- Return type
bool
-
classmethod
is_construct
(x)¶ Return whether the given object is a Construct.
- Parameters
x (
Any
) –- Return type
bool
AccessControlListConfigurationProperty¶
AclConfigurationProperty¶
-
class
CfnDataSource.
AclConfigurationProperty
(*, allowed_groups_column_name)¶ Bases:
object
- Parameters
allowed_groups_column_name (
str
) –CfnDataSource.AclConfigurationProperty.AllowedGroupsColumnName
.- Link
Attributes
-
allowed_groups_column_name
¶ CfnDataSource.AclConfigurationProperty.AllowedGroupsColumnName
.
ChangeDetectingColumnsProperty¶
-
class
CfnDataSource.
ChangeDetectingColumnsProperty
(*, change_detecting_columns=None)¶ Bases:
object
- Parameters
change_detecting_columns (
Optional
[Sequence
[str
]]) –CfnDataSource.ChangeDetectingColumnsProperty.ChangeDetectingColumns
.- Link
Attributes
-
change_detecting_columns
¶ CfnDataSource.ChangeDetectingColumnsProperty.ChangeDetectingColumns
.
ColumnConfigurationProperty¶
-
class
CfnDataSource.
ColumnConfigurationProperty
(*, change_detecting_columns, document_data_column_name, document_id_column_name, document_title_column_name=None, field_mappings=None)¶ Bases:
object
- Parameters
change_detecting_columns (
Union
[IResolvable
,ChangeDetectingColumnsProperty
]) –CfnDataSource.ColumnConfigurationProperty.ChangeDetectingColumns
.document_data_column_name (
str
) –CfnDataSource.ColumnConfigurationProperty.DocumentDataColumnName
.document_id_column_name (
str
) –CfnDataSource.ColumnConfigurationProperty.DocumentIdColumnName
.document_title_column_name (
Optional
[str
]) –CfnDataSource.ColumnConfigurationProperty.DocumentTitleColumnName
.field_mappings (
Union
[IResolvable
,DataSourceToIndexFieldMappingListProperty
,None
]) –CfnDataSource.ColumnConfigurationProperty.FieldMappings
.
- Link
Attributes
-
change_detecting_columns
¶ CfnDataSource.ColumnConfigurationProperty.ChangeDetectingColumns
.
-
document_data_column_name
¶ CfnDataSource.ColumnConfigurationProperty.DocumentDataColumnName
.
-
document_id_column_name
¶ CfnDataSource.ColumnConfigurationProperty.DocumentIdColumnName
.
-
document_title_column_name
¶ CfnDataSource.ColumnConfigurationProperty.DocumentTitleColumnName
.
-
field_mappings
¶ CfnDataSource.ColumnConfigurationProperty.FieldMappings
.
ConfluenceAttachmentConfigurationProperty¶
-
class
CfnDataSource.
ConfluenceAttachmentConfigurationProperty
(*, attachment_field_mappings=None, crawl_attachments=None)¶ Bases:
object
- Parameters
attachment_field_mappings (
Union
[IResolvable
,ConfluenceAttachmentFieldMappingsListProperty
,None
]) –CfnDataSource.ConfluenceAttachmentConfigurationProperty.AttachmentFieldMappings
.crawl_attachments (
Union
[bool
,IResolvable
,None
]) –CfnDataSource.ConfluenceAttachmentConfigurationProperty.CrawlAttachments
.
- Link
Attributes
-
attachment_field_mappings
¶ CfnDataSource.ConfluenceAttachmentConfigurationProperty.AttachmentFieldMappings
.- Link
- Return type
Union
[IResolvable
,ConfluenceAttachmentFieldMappingsListProperty
,None
]
-
crawl_attachments
¶ CfnDataSource.ConfluenceAttachmentConfigurationProperty.CrawlAttachments
.
ConfluenceAttachmentFieldMappingsListProperty¶
-
class
CfnDataSource.
ConfluenceAttachmentFieldMappingsListProperty
(*, confluence_attachment_field_mappings_list=None)¶ Bases:
object
- Parameters
confluence_attachment_field_mappings_list (
Union
[IResolvable
,Sequence
[Union
[IResolvable
,ConfluenceAttachmentToIndexFieldMappingProperty
]],None
]) –CfnDataSource.ConfluenceAttachmentFieldMappingsListProperty.ConfluenceAttachmentFieldMappingsList
.- Link
Attributes
-
confluence_attachment_field_mappings_list
¶ CfnDataSource.ConfluenceAttachmentFieldMappingsListProperty.ConfluenceAttachmentFieldMappingsList
.- Link
- Return type
Union
[IResolvable
,List
[Union
[IResolvable
,ConfluenceAttachmentToIndexFieldMappingProperty
]],None
]
ConfluenceAttachmentToIndexFieldMappingProperty¶
-
class
CfnDataSource.
ConfluenceAttachmentToIndexFieldMappingProperty
(*, data_source_field_name, index_field_name, date_field_format=None)¶ Bases:
object
- Parameters
data_source_field_name (
str
) –CfnDataSource.ConfluenceAttachmentToIndexFieldMappingProperty.DataSourceFieldName
.index_field_name (
str
) –CfnDataSource.ConfluenceAttachmentToIndexFieldMappingProperty.IndexFieldName
.date_field_format (
Optional
[str
]) –CfnDataSource.ConfluenceAttachmentToIndexFieldMappingProperty.DateFieldFormat
.
- Link
Attributes
-
data_source_field_name
¶ CfnDataSource.ConfluenceAttachmentToIndexFieldMappingProperty.DataSourceFieldName
.
-
date_field_format
¶ CfnDataSource.ConfluenceAttachmentToIndexFieldMappingProperty.DateFieldFormat
.
-
index_field_name
¶ CfnDataSource.ConfluenceAttachmentToIndexFieldMappingProperty.IndexFieldName
.
ConfluenceBlogConfigurationProperty¶
-
class
CfnDataSource.
ConfluenceBlogConfigurationProperty
(*, blog_field_mappings=None)¶ Bases:
object
- Parameters
blog_field_mappings (
Union
[IResolvable
,ConfluenceBlogFieldMappingsListProperty
,None
]) –CfnDataSource.ConfluenceBlogConfigurationProperty.BlogFieldMappings
.- Link
Attributes
-
blog_field_mappings
¶ CfnDataSource.ConfluenceBlogConfigurationProperty.BlogFieldMappings
.
ConfluenceBlogFieldMappingsListProperty¶
-
class
CfnDataSource.
ConfluenceBlogFieldMappingsListProperty
(*, confluence_blog_field_mappings_list=None)¶ Bases:
object
- Parameters
confluence_blog_field_mappings_list (
Union
[IResolvable
,Sequence
[Union
[IResolvable
,ConfluenceBlogToIndexFieldMappingProperty
]],None
]) –CfnDataSource.ConfluenceBlogFieldMappingsListProperty.ConfluenceBlogFieldMappingsList
.- Link
Attributes
-
confluence_blog_field_mappings_list
¶ CfnDataSource.ConfluenceBlogFieldMappingsListProperty.ConfluenceBlogFieldMappingsList
.- Link
- Return type
Union
[IResolvable
,List
[Union
[IResolvable
,ConfluenceBlogToIndexFieldMappingProperty
]],None
]
ConfluenceBlogToIndexFieldMappingProperty¶
-
class
CfnDataSource.
ConfluenceBlogToIndexFieldMappingProperty
(*, data_source_field_name, index_field_name, date_field_format=None)¶ Bases:
object
- Parameters
data_source_field_name (
str
) –CfnDataSource.ConfluenceBlogToIndexFieldMappingProperty.DataSourceFieldName
.index_field_name (
str
) –CfnDataSource.ConfluenceBlogToIndexFieldMappingProperty.IndexFieldName
.date_field_format (
Optional
[str
]) –CfnDataSource.ConfluenceBlogToIndexFieldMappingProperty.DateFieldFormat
.
- Link
Attributes
-
data_source_field_name
¶ CfnDataSource.ConfluenceBlogToIndexFieldMappingProperty.DataSourceFieldName
.
-
date_field_format
¶ CfnDataSource.ConfluenceBlogToIndexFieldMappingProperty.DateFieldFormat
.
-
index_field_name
¶ CfnDataSource.ConfluenceBlogToIndexFieldMappingProperty.IndexFieldName
.
ConfluenceConfigurationProperty¶
-
class
CfnDataSource.
ConfluenceConfigurationProperty
(*, secret_arn, server_url, version, attachment_configuration=None, blog_configuration=None, exclusion_patterns=None, inclusion_patterns=None, page_configuration=None, space_configuration=None, vpc_configuration=None)¶ Bases:
object
- Parameters
secret_arn (
str
) –CfnDataSource.ConfluenceConfigurationProperty.SecretArn
.server_url (
str
) –CfnDataSource.ConfluenceConfigurationProperty.ServerUrl
.version (
str
) –CfnDataSource.ConfluenceConfigurationProperty.Version
.attachment_configuration (
Union
[IResolvable
,ConfluenceAttachmentConfigurationProperty
,None
]) –CfnDataSource.ConfluenceConfigurationProperty.AttachmentConfiguration
.blog_configuration (
Union
[IResolvable
,ConfluenceBlogConfigurationProperty
,None
]) –CfnDataSource.ConfluenceConfigurationProperty.BlogConfiguration
.exclusion_patterns (
Union
[IResolvable
,DataSourceInclusionsExclusionsStringsProperty
,None
]) –CfnDataSource.ConfluenceConfigurationProperty.ExclusionPatterns
.inclusion_patterns (
Union
[IResolvable
,DataSourceInclusionsExclusionsStringsProperty
,None
]) –CfnDataSource.ConfluenceConfigurationProperty.InclusionPatterns
.page_configuration (
Union
[IResolvable
,ConfluencePageConfigurationProperty
,None
]) –CfnDataSource.ConfluenceConfigurationProperty.PageConfiguration
.space_configuration (
Union
[IResolvable
,ConfluenceSpaceConfigurationProperty
,None
]) –CfnDataSource.ConfluenceConfigurationProperty.SpaceConfiguration
.vpc_configuration (
Union
[IResolvable
,DataSourceVpcConfigurationProperty
,None
]) –CfnDataSource.ConfluenceConfigurationProperty.VpcConfiguration
.
- Link
Attributes
-
attachment_configuration
¶ CfnDataSource.ConfluenceConfigurationProperty.AttachmentConfiguration
.
-
blog_configuration
¶ CfnDataSource.ConfluenceConfigurationProperty.BlogConfiguration
.
-
exclusion_patterns
¶ CfnDataSource.ConfluenceConfigurationProperty.ExclusionPatterns
.
-
inclusion_patterns
¶ CfnDataSource.ConfluenceConfigurationProperty.InclusionPatterns
.
-
page_configuration
¶ CfnDataSource.ConfluenceConfigurationProperty.PageConfiguration
.
-
secret_arn
¶ CfnDataSource.ConfluenceConfigurationProperty.SecretArn
.
-
server_url
¶ CfnDataSource.ConfluenceConfigurationProperty.ServerUrl
.
-
space_configuration
¶ CfnDataSource.ConfluenceConfigurationProperty.SpaceConfiguration
.
-
version
¶ CfnDataSource.ConfluenceConfigurationProperty.Version
.
-
vpc_configuration
¶ CfnDataSource.ConfluenceConfigurationProperty.VpcConfiguration
.
ConfluencePageConfigurationProperty¶
-
class
CfnDataSource.
ConfluencePageConfigurationProperty
(*, page_field_mappings=None)¶ Bases:
object
- Parameters
page_field_mappings (
Union
[IResolvable
,ConfluencePageFieldMappingsListProperty
,None
]) –CfnDataSource.ConfluencePageConfigurationProperty.PageFieldMappings
.- Link
Attributes
-
page_field_mappings
¶ CfnDataSource.ConfluencePageConfigurationProperty.PageFieldMappings
.
ConfluencePageFieldMappingsListProperty¶
-
class
CfnDataSource.
ConfluencePageFieldMappingsListProperty
(*, confluence_page_field_mappings_list=None)¶ Bases:
object
- Parameters
confluence_page_field_mappings_list (
Union
[IResolvable
,Sequence
[Union
[IResolvable
,ConfluencePageToIndexFieldMappingProperty
]],None
]) –CfnDataSource.ConfluencePageFieldMappingsListProperty.ConfluencePageFieldMappingsList
.- Link
Attributes
-
confluence_page_field_mappings_list
¶ CfnDataSource.ConfluencePageFieldMappingsListProperty.ConfluencePageFieldMappingsList
.- Link
- Return type
Union
[IResolvable
,List
[Union
[IResolvable
,ConfluencePageToIndexFieldMappingProperty
]],None
]
ConfluencePageToIndexFieldMappingProperty¶
-
class
CfnDataSource.
ConfluencePageToIndexFieldMappingProperty
(*, data_source_field_name, index_field_name, date_field_format=None)¶ Bases:
object
- Parameters
data_source_field_name (
str
) –CfnDataSource.ConfluencePageToIndexFieldMappingProperty.DataSourceFieldName
.index_field_name (
str
) –CfnDataSource.ConfluencePageToIndexFieldMappingProperty.IndexFieldName
.date_field_format (
Optional
[str
]) –CfnDataSource.ConfluencePageToIndexFieldMappingProperty.DateFieldFormat
.
- Link
Attributes
-
data_source_field_name
¶ CfnDataSource.ConfluencePageToIndexFieldMappingProperty.DataSourceFieldName
.
-
date_field_format
¶ CfnDataSource.ConfluencePageToIndexFieldMappingProperty.DateFieldFormat
.
-
index_field_name
¶ CfnDataSource.ConfluencePageToIndexFieldMappingProperty.IndexFieldName
.
ConfluenceSpaceConfigurationProperty¶
-
class
CfnDataSource.
ConfluenceSpaceConfigurationProperty
(*, crawl_archived_spaces=None, crawl_personal_spaces=None, exclude_spaces=None, include_spaces=None, space_field_mappings=None)¶ Bases:
object
- Parameters
crawl_archived_spaces (
Union
[bool
,IResolvable
,None
]) –CfnDataSource.ConfluenceSpaceConfigurationProperty.CrawlArchivedSpaces
.crawl_personal_spaces (
Union
[bool
,IResolvable
,None
]) –CfnDataSource.ConfluenceSpaceConfigurationProperty.CrawlPersonalSpaces
.exclude_spaces (
Union
[IResolvable
,ConfluenceSpaceListProperty
,None
]) –CfnDataSource.ConfluenceSpaceConfigurationProperty.ExcludeSpaces
.include_spaces (
Union
[IResolvable
,ConfluenceSpaceListProperty
,None
]) –CfnDataSource.ConfluenceSpaceConfigurationProperty.IncludeSpaces
.space_field_mappings (
Union
[IResolvable
,ConfluenceSpaceFieldMappingsListProperty
,None
]) –CfnDataSource.ConfluenceSpaceConfigurationProperty.SpaceFieldMappings
.
- Link
Attributes
-
crawl_archived_spaces
¶ CfnDataSource.ConfluenceSpaceConfigurationProperty.CrawlArchivedSpaces
.
-
crawl_personal_spaces
¶ CfnDataSource.ConfluenceSpaceConfigurationProperty.CrawlPersonalSpaces
.
-
exclude_spaces
¶ CfnDataSource.ConfluenceSpaceConfigurationProperty.ExcludeSpaces
.
-
include_spaces
¶ CfnDataSource.ConfluenceSpaceConfigurationProperty.IncludeSpaces
.
-
space_field_mappings
¶ CfnDataSource.ConfluenceSpaceConfigurationProperty.SpaceFieldMappings
.
ConfluenceSpaceFieldMappingsListProperty¶
-
class
CfnDataSource.
ConfluenceSpaceFieldMappingsListProperty
(*, confluence_space_field_mappings_list=None)¶ Bases:
object
- Parameters
confluence_space_field_mappings_list (
Union
[IResolvable
,Sequence
[Union
[IResolvable
,ConfluenceSpaceToIndexFieldMappingProperty
]],None
]) –CfnDataSource.ConfluenceSpaceFieldMappingsListProperty.ConfluenceSpaceFieldMappingsList
.- Link
Attributes
-
confluence_space_field_mappings_list
¶ CfnDataSource.ConfluenceSpaceFieldMappingsListProperty.ConfluenceSpaceFieldMappingsList
.- Link
- Return type
Union
[IResolvable
,List
[Union
[IResolvable
,ConfluenceSpaceToIndexFieldMappingProperty
]],None
]
ConfluenceSpaceListProperty¶
-
class
CfnDataSource.
ConfluenceSpaceListProperty
(*, confluence_space_list=None)¶ Bases:
object
- Parameters
confluence_space_list (
Optional
[Sequence
[str
]]) –CfnDataSource.ConfluenceSpaceListProperty.ConfluenceSpaceList
.- Link
Attributes
-
confluence_space_list
¶ CfnDataSource.ConfluenceSpaceListProperty.ConfluenceSpaceList
.
ConfluenceSpaceToIndexFieldMappingProperty¶
-
class
CfnDataSource.
ConfluenceSpaceToIndexFieldMappingProperty
(*, data_source_field_name, index_field_name, date_field_format=None)¶ Bases:
object
- Parameters
data_source_field_name (
str
) –CfnDataSource.ConfluenceSpaceToIndexFieldMappingProperty.DataSourceFieldName
.index_field_name (
str
) –CfnDataSource.ConfluenceSpaceToIndexFieldMappingProperty.IndexFieldName
.date_field_format (
Optional
[str
]) –CfnDataSource.ConfluenceSpaceToIndexFieldMappingProperty.DateFieldFormat
.
- Link
Attributes
-
data_source_field_name
¶ CfnDataSource.ConfluenceSpaceToIndexFieldMappingProperty.DataSourceFieldName
.
-
date_field_format
¶ CfnDataSource.ConfluenceSpaceToIndexFieldMappingProperty.DateFieldFormat
.
-
index_field_name
¶ CfnDataSource.ConfluenceSpaceToIndexFieldMappingProperty.IndexFieldName
.
ConnectionConfigurationProperty¶
-
class
CfnDataSource.
ConnectionConfigurationProperty
(*, database_host, database_name, database_port, secret_arn, table_name)¶ Bases:
object
- Parameters
database_host (
str
) –CfnDataSource.ConnectionConfigurationProperty.DatabaseHost
.database_name (
str
) –CfnDataSource.ConnectionConfigurationProperty.DatabaseName
.database_port (
Union
[int
,float
]) –CfnDataSource.ConnectionConfigurationProperty.DatabasePort
.secret_arn (
str
) –CfnDataSource.ConnectionConfigurationProperty.SecretArn
.table_name (
str
) –CfnDataSource.ConnectionConfigurationProperty.TableName
.
- Link
Attributes
-
database_host
¶ CfnDataSource.ConnectionConfigurationProperty.DatabaseHost
.
-
database_name
¶ CfnDataSource.ConnectionConfigurationProperty.DatabaseName
.
-
database_port
¶ CfnDataSource.ConnectionConfigurationProperty.DatabasePort
.
-
secret_arn
¶ CfnDataSource.ConnectionConfigurationProperty.SecretArn
.
-
table_name
¶ CfnDataSource.ConnectionConfigurationProperty.TableName
.
DataSourceConfigurationProperty¶
-
class
CfnDataSource.
DataSourceConfigurationProperty
(*, confluence_configuration=None, database_configuration=None, google_drive_configuration=None, one_drive_configuration=None, s3_configuration=None, salesforce_configuration=None, service_now_configuration=None, share_point_configuration=None)¶ Bases:
object
- Parameters
confluence_configuration (
Union
[IResolvable
,ConfluenceConfigurationProperty
,None
]) –CfnDataSource.DataSourceConfigurationProperty.ConfluenceConfiguration
.database_configuration (
Union
[IResolvable
,DatabaseConfigurationProperty
,None
]) –CfnDataSource.DataSourceConfigurationProperty.DatabaseConfiguration
.google_drive_configuration (
Union
[IResolvable
,GoogleDriveConfigurationProperty
,None
]) –CfnDataSource.DataSourceConfigurationProperty.GoogleDriveConfiguration
.one_drive_configuration (
Union
[IResolvable
,OneDriveConfigurationProperty
,None
]) –CfnDataSource.DataSourceConfigurationProperty.OneDriveConfiguration
.s3_configuration (
Union
[IResolvable
,S3DataSourceConfigurationProperty
,None
]) –CfnDataSource.DataSourceConfigurationProperty.S3Configuration
.salesforce_configuration (
Union
[IResolvable
,SalesforceConfigurationProperty
,None
]) –CfnDataSource.DataSourceConfigurationProperty.SalesforceConfiguration
.service_now_configuration (
Union
[IResolvable
,ServiceNowConfigurationProperty
,None
]) –CfnDataSource.DataSourceConfigurationProperty.ServiceNowConfiguration
.share_point_configuration (
Union
[IResolvable
,SharePointConfigurationProperty
,None
]) –CfnDataSource.DataSourceConfigurationProperty.SharePointConfiguration
.
- Link
Attributes
-
confluence_configuration
¶ CfnDataSource.DataSourceConfigurationProperty.ConfluenceConfiguration
.
-
database_configuration
¶ CfnDataSource.DataSourceConfigurationProperty.DatabaseConfiguration
.
-
google_drive_configuration
¶ CfnDataSource.DataSourceConfigurationProperty.GoogleDriveConfiguration
.
-
one_drive_configuration
¶ CfnDataSource.DataSourceConfigurationProperty.OneDriveConfiguration
.
-
s3_configuration
¶ CfnDataSource.DataSourceConfigurationProperty.S3Configuration
.
-
salesforce_configuration
¶ CfnDataSource.DataSourceConfigurationProperty.SalesforceConfiguration
.
-
service_now_configuration
¶ CfnDataSource.DataSourceConfigurationProperty.ServiceNowConfiguration
.
CfnDataSource.DataSourceConfigurationProperty.SharePointConfiguration
.
DataSourceInclusionsExclusionsStringsProperty¶
-
class
CfnDataSource.
DataSourceInclusionsExclusionsStringsProperty
(*, data_source_inclusions_exclusions_strings=None)¶ Bases:
object
- Parameters
data_source_inclusions_exclusions_strings (
Optional
[Sequence
[str
]]) –CfnDataSource.DataSourceInclusionsExclusionsStringsProperty.DataSourceInclusionsExclusionsStrings
.- Link
Attributes
-
data_source_inclusions_exclusions_strings
¶ CfnDataSource.DataSourceInclusionsExclusionsStringsProperty.DataSourceInclusionsExclusionsStrings
.
DataSourceToIndexFieldMappingListProperty¶
-
class
CfnDataSource.
DataSourceToIndexFieldMappingListProperty
(*, data_source_to_index_field_mapping_list=None)¶ Bases:
object
- Parameters
data_source_to_index_field_mapping_list (
Union
[IResolvable
,Sequence
[Union
[IResolvable
,DataSourceToIndexFieldMappingProperty
]],None
]) –CfnDataSource.DataSourceToIndexFieldMappingListProperty.DataSourceToIndexFieldMappingList
.- Link
Attributes
-
data_source_to_index_field_mapping_list
¶ CfnDataSource.DataSourceToIndexFieldMappingListProperty.DataSourceToIndexFieldMappingList
.- Link
- Return type
Union
[IResolvable
,List
[Union
[IResolvable
,DataSourceToIndexFieldMappingProperty
]],None
]
DataSourceToIndexFieldMappingProperty¶
-
class
CfnDataSource.
DataSourceToIndexFieldMappingProperty
(*, data_source_field_name, index_field_name, date_field_format=None)¶ Bases:
object
- Parameters
data_source_field_name (
str
) –CfnDataSource.DataSourceToIndexFieldMappingProperty.DataSourceFieldName
.index_field_name (
str
) –CfnDataSource.DataSourceToIndexFieldMappingProperty.IndexFieldName
.date_field_format (
Optional
[str
]) –CfnDataSource.DataSourceToIndexFieldMappingProperty.DateFieldFormat
.
- Link
Attributes
-
data_source_field_name
¶ CfnDataSource.DataSourceToIndexFieldMappingProperty.DataSourceFieldName
.
-
date_field_format
¶ CfnDataSource.DataSourceToIndexFieldMappingProperty.DateFieldFormat
.
-
index_field_name
¶ CfnDataSource.DataSourceToIndexFieldMappingProperty.IndexFieldName
.
DataSourceVpcConfigurationProperty¶
-
class
CfnDataSource.
DataSourceVpcConfigurationProperty
(*, security_group_ids, subnet_ids)¶ Bases:
object
- Parameters
security_group_ids (
Sequence
[str
]) –CfnDataSource.DataSourceVpcConfigurationProperty.SecurityGroupIds
.subnet_ids (
Sequence
[str
]) –CfnDataSource.DataSourceVpcConfigurationProperty.SubnetIds
.
- Link
Attributes
-
security_group_ids
¶ CfnDataSource.DataSourceVpcConfigurationProperty.SecurityGroupIds
.
-
subnet_ids
¶ CfnDataSource.DataSourceVpcConfigurationProperty.SubnetIds
.
DatabaseConfigurationProperty¶
-
class
CfnDataSource.
DatabaseConfigurationProperty
(*, column_configuration, connection_configuration, database_engine_type, acl_configuration=None, sql_configuration=None, vpc_configuration=None)¶ Bases:
object
- Parameters
column_configuration (
Union
[IResolvable
,ColumnConfigurationProperty
]) –CfnDataSource.DatabaseConfigurationProperty.ColumnConfiguration
.connection_configuration (
Union
[IResolvable
,ConnectionConfigurationProperty
]) –CfnDataSource.DatabaseConfigurationProperty.ConnectionConfiguration
.database_engine_type (
str
) –CfnDataSource.DatabaseConfigurationProperty.DatabaseEngineType
.acl_configuration (
Union
[IResolvable
,AclConfigurationProperty
,None
]) –CfnDataSource.DatabaseConfigurationProperty.AclConfiguration
.sql_configuration (
Union
[IResolvable
,SqlConfigurationProperty
,None
]) –CfnDataSource.DatabaseConfigurationProperty.SqlConfiguration
.vpc_configuration (
Union
[IResolvable
,DataSourceVpcConfigurationProperty
,None
]) –CfnDataSource.DatabaseConfigurationProperty.VpcConfiguration
.
- Link
Attributes
-
acl_configuration
¶ CfnDataSource.DatabaseConfigurationProperty.AclConfiguration
.
-
column_configuration
¶ CfnDataSource.DatabaseConfigurationProperty.ColumnConfiguration
.
-
connection_configuration
¶ CfnDataSource.DatabaseConfigurationProperty.ConnectionConfiguration
.
-
database_engine_type
¶ CfnDataSource.DatabaseConfigurationProperty.DatabaseEngineType
.
-
sql_configuration
¶ CfnDataSource.DatabaseConfigurationProperty.SqlConfiguration
.
-
vpc_configuration
¶ CfnDataSource.DatabaseConfigurationProperty.VpcConfiguration
.
DocumentsMetadataConfigurationProperty¶
ExcludeMimeTypesListProperty¶
-
class
CfnDataSource.
ExcludeMimeTypesListProperty
(*, exclude_mime_types_list=None)¶ Bases:
object
- Parameters
exclude_mime_types_list (
Optional
[Sequence
[str
]]) –CfnDataSource.ExcludeMimeTypesListProperty.ExcludeMimeTypesList
.- Link
Attributes
-
exclude_mime_types_list
¶ CfnDataSource.ExcludeMimeTypesListProperty.ExcludeMimeTypesList
.
ExcludeUserAccountsListProperty¶
-
class
CfnDataSource.
ExcludeUserAccountsListProperty
(*, exclude_user_accounts_list=None)¶ Bases:
object
- Parameters
exclude_user_accounts_list (
Optional
[Sequence
[str
]]) –CfnDataSource.ExcludeUserAccountsListProperty.ExcludeUserAccountsList
.- Link
Attributes
-
exclude_user_accounts_list
¶ CfnDataSource.ExcludeUserAccountsListProperty.ExcludeUserAccountsList
.
GoogleDriveConfigurationProperty¶
-
class
CfnDataSource.
GoogleDriveConfigurationProperty
(*, secret_arn, exclude_mime_types=None, exclude_shared_drives=None, exclude_user_accounts=None, exclusion_patterns=None, field_mappings=None, inclusion_patterns=None)¶ Bases:
object
- Parameters
secret_arn (
str
) –CfnDataSource.GoogleDriveConfigurationProperty.SecretArn
.exclude_mime_types (
Union
[IResolvable
,ExcludeMimeTypesListProperty
,None
]) –CfnDataSource.GoogleDriveConfigurationProperty.ExcludeMimeTypes
.exclude_shared_drives (
Union
[IResolvable
,ExcludeSharedDrivesListProperty
,None
]) –CfnDataSource.GoogleDriveConfigurationProperty.ExcludeSharedDrives
.exclude_user_accounts (
Union
[IResolvable
,ExcludeUserAccountsListProperty
,None
]) –CfnDataSource.GoogleDriveConfigurationProperty.ExcludeUserAccounts
.exclusion_patterns (
Union
[IResolvable
,DataSourceInclusionsExclusionsStringsProperty
,None
]) –CfnDataSource.GoogleDriveConfigurationProperty.ExclusionPatterns
.field_mappings (
Union
[IResolvable
,DataSourceToIndexFieldMappingListProperty
,None
]) –CfnDataSource.GoogleDriveConfigurationProperty.FieldMappings
.inclusion_patterns (
Union
[IResolvable
,DataSourceInclusionsExclusionsStringsProperty
,None
]) –CfnDataSource.GoogleDriveConfigurationProperty.InclusionPatterns
.
- Link
Attributes
-
exclude_mime_types
¶ CfnDataSource.GoogleDriveConfigurationProperty.ExcludeMimeTypes
.
CfnDataSource.GoogleDriveConfigurationProperty.ExcludeSharedDrives
.
-
exclude_user_accounts
¶ CfnDataSource.GoogleDriveConfigurationProperty.ExcludeUserAccounts
.
-
exclusion_patterns
¶ CfnDataSource.GoogleDriveConfigurationProperty.ExclusionPatterns
.
-
field_mappings
¶ CfnDataSource.GoogleDriveConfigurationProperty.FieldMappings
.
-
inclusion_patterns
¶ CfnDataSource.GoogleDriveConfigurationProperty.InclusionPatterns
.
-
secret_arn
¶ CfnDataSource.GoogleDriveConfigurationProperty.SecretArn
.
OneDriveConfigurationProperty¶
-
class
CfnDataSource.
OneDriveConfigurationProperty
(*, one_drive_users, secret_arn, tenant_domain, disable_local_groups=None, exclusion_patterns=None, field_mappings=None, inclusion_patterns=None)¶ Bases:
object
- Parameters
one_drive_users (
Union
[IResolvable
,OneDriveUsersProperty
]) –CfnDataSource.OneDriveConfigurationProperty.OneDriveUsers
.secret_arn (
str
) –CfnDataSource.OneDriveConfigurationProperty.SecretArn
.tenant_domain (
str
) –CfnDataSource.OneDriveConfigurationProperty.TenantDomain
.disable_local_groups (
Union
[bool
,IResolvable
,None
]) –CfnDataSource.OneDriveConfigurationProperty.DisableLocalGroups
.exclusion_patterns (
Union
[IResolvable
,DataSourceInclusionsExclusionsStringsProperty
,None
]) –CfnDataSource.OneDriveConfigurationProperty.ExclusionPatterns
.field_mappings (
Union
[IResolvable
,DataSourceToIndexFieldMappingListProperty
,None
]) –CfnDataSource.OneDriveConfigurationProperty.FieldMappings
.inclusion_patterns (
Union
[IResolvable
,DataSourceInclusionsExclusionsStringsProperty
,None
]) –CfnDataSource.OneDriveConfigurationProperty.InclusionPatterns
.
- Link
Attributes
-
disable_local_groups
¶ CfnDataSource.OneDriveConfigurationProperty.DisableLocalGroups
.
-
exclusion_patterns
¶ CfnDataSource.OneDriveConfigurationProperty.ExclusionPatterns
.
-
field_mappings
¶ CfnDataSource.OneDriveConfigurationProperty.FieldMappings
.
-
inclusion_patterns
¶ CfnDataSource.OneDriveConfigurationProperty.InclusionPatterns
.
-
one_drive_users
¶ CfnDataSource.OneDriveConfigurationProperty.OneDriveUsers
.
-
secret_arn
¶ CfnDataSource.OneDriveConfigurationProperty.SecretArn
.
-
tenant_domain
¶ CfnDataSource.OneDriveConfigurationProperty.TenantDomain
.
OneDriveUserListProperty¶
OneDriveUsersProperty¶
-
class
CfnDataSource.
OneDriveUsersProperty
(*, one_drive_user_list=None, one_drive_user_s3_path=None)¶ Bases:
object
- Parameters
one_drive_user_list (
Union
[IResolvable
,OneDriveUserListProperty
,None
]) –CfnDataSource.OneDriveUsersProperty.OneDriveUserList
.one_drive_user_s3_path (
Union
[IResolvable
,S3PathProperty
,None
]) –CfnDataSource.OneDriveUsersProperty.OneDriveUserS3Path
.
- Link
Attributes
-
one_drive_user_list
¶ CfnDataSource.OneDriveUsersProperty.OneDriveUserList
.
-
one_drive_user_s3_path
¶ CfnDataSource.OneDriveUsersProperty.OneDriveUserS3Path
.
S3DataSourceConfigurationProperty¶
-
class
CfnDataSource.
S3DataSourceConfigurationProperty
(*, bucket_name, access_control_list_configuration=None, documents_metadata_configuration=None, exclusion_patterns=None, inclusion_patterns=None, inclusion_prefixes=None)¶ Bases:
object
- Parameters
bucket_name (
str
) –CfnDataSource.S3DataSourceConfigurationProperty.BucketName
.access_control_list_configuration (
Union
[IResolvable
,AccessControlListConfigurationProperty
,None
]) –CfnDataSource.S3DataSourceConfigurationProperty.AccessControlListConfiguration
.documents_metadata_configuration (
Union
[IResolvable
,DocumentsMetadataConfigurationProperty
,None
]) –CfnDataSource.S3DataSourceConfigurationProperty.DocumentsMetadataConfiguration
.exclusion_patterns (
Union
[IResolvable
,DataSourceInclusionsExclusionsStringsProperty
,None
]) –CfnDataSource.S3DataSourceConfigurationProperty.ExclusionPatterns
.inclusion_patterns (
Union
[IResolvable
,DataSourceInclusionsExclusionsStringsProperty
,None
]) –CfnDataSource.S3DataSourceConfigurationProperty.InclusionPatterns
.inclusion_prefixes (
Union
[IResolvable
,DataSourceInclusionsExclusionsStringsProperty
,None
]) –CfnDataSource.S3DataSourceConfigurationProperty.InclusionPrefixes
.
- Link
Attributes
-
access_control_list_configuration
¶ CfnDataSource.S3DataSourceConfigurationProperty.AccessControlListConfiguration
.
-
bucket_name
¶ CfnDataSource.S3DataSourceConfigurationProperty.BucketName
.
-
documents_metadata_configuration
¶ CfnDataSource.S3DataSourceConfigurationProperty.DocumentsMetadataConfiguration
.
-
exclusion_patterns
¶ CfnDataSource.S3DataSourceConfigurationProperty.ExclusionPatterns
.
-
inclusion_patterns
¶ CfnDataSource.S3DataSourceConfigurationProperty.InclusionPatterns
.
-
inclusion_prefixes
¶ CfnDataSource.S3DataSourceConfigurationProperty.InclusionPrefixes
.
S3PathProperty¶
SalesforceChatterFeedConfigurationProperty¶
-
class
CfnDataSource.
SalesforceChatterFeedConfigurationProperty
(*, document_data_field_name, document_title_field_name=None, field_mappings=None, include_filter_types=None)¶ Bases:
object
- Parameters
document_data_field_name (
str
) –CfnDataSource.SalesforceChatterFeedConfigurationProperty.DocumentDataFieldName
.document_title_field_name (
Optional
[str
]) –CfnDataSource.SalesforceChatterFeedConfigurationProperty.DocumentTitleFieldName
.field_mappings (
Union
[IResolvable
,DataSourceToIndexFieldMappingListProperty
,None
]) –CfnDataSource.SalesforceChatterFeedConfigurationProperty.FieldMappings
.include_filter_types (
Union
[IResolvable
,SalesforceChatterFeedIncludeFilterTypesProperty
,None
]) –CfnDataSource.SalesforceChatterFeedConfigurationProperty.IncludeFilterTypes
.
- Link
Attributes
-
document_data_field_name
¶ CfnDataSource.SalesforceChatterFeedConfigurationProperty.DocumentDataFieldName
.
-
document_title_field_name
¶ CfnDataSource.SalesforceChatterFeedConfigurationProperty.DocumentTitleFieldName
.
-
field_mappings
¶ CfnDataSource.SalesforceChatterFeedConfigurationProperty.FieldMappings
.
-
include_filter_types
¶ CfnDataSource.SalesforceChatterFeedConfigurationProperty.IncludeFilterTypes
.- Link
- Return type
Union
[IResolvable
,SalesforceChatterFeedIncludeFilterTypesProperty
,None
]
SalesforceChatterFeedIncludeFilterTypesProperty¶
-
class
CfnDataSource.
SalesforceChatterFeedIncludeFilterTypesProperty
(*, salesforce_chatter_feed_include_filter_types=None)¶ Bases:
object
- Parameters
salesforce_chatter_feed_include_filter_types (
Optional
[Sequence
[str
]]) –CfnDataSource.SalesforceChatterFeedIncludeFilterTypesProperty.SalesforceChatterFeedIncludeFilterTypes
.- Link
Attributes
-
salesforce_chatter_feed_include_filter_types
¶ CfnDataSource.SalesforceChatterFeedIncludeFilterTypesProperty.SalesforceChatterFeedIncludeFilterTypes
.
SalesforceConfigurationProperty¶
-
class
CfnDataSource.
SalesforceConfigurationProperty
(*, secret_arn, server_url, chatter_feed_configuration=None, crawl_attachments=None, exclude_attachment_file_patterns=None, include_attachment_file_patterns=None, knowledge_article_configuration=None, standard_object_attachment_configuration=None, standard_object_configurations=None)¶ Bases:
object
- Parameters
secret_arn (
str
) –CfnDataSource.SalesforceConfigurationProperty.SecretArn
.server_url (
str
) –CfnDataSource.SalesforceConfigurationProperty.ServerUrl
.chatter_feed_configuration (
Union
[IResolvable
,SalesforceChatterFeedConfigurationProperty
,None
]) –CfnDataSource.SalesforceConfigurationProperty.ChatterFeedConfiguration
.crawl_attachments (
Union
[bool
,IResolvable
,None
]) –CfnDataSource.SalesforceConfigurationProperty.CrawlAttachments
.exclude_attachment_file_patterns (
Union
[IResolvable
,DataSourceInclusionsExclusionsStringsProperty
,None
]) –CfnDataSource.SalesforceConfigurationProperty.ExcludeAttachmentFilePatterns
.include_attachment_file_patterns (
Union
[IResolvable
,DataSourceInclusionsExclusionsStringsProperty
,None
]) –CfnDataSource.SalesforceConfigurationProperty.IncludeAttachmentFilePatterns
.knowledge_article_configuration (
Union
[IResolvable
,SalesforceKnowledgeArticleConfigurationProperty
,None
]) –CfnDataSource.SalesforceConfigurationProperty.KnowledgeArticleConfiguration
.standard_object_attachment_configuration (
Union
[IResolvable
,SalesforceStandardObjectAttachmentConfigurationProperty
,None
]) –CfnDataSource.SalesforceConfigurationProperty.StandardObjectAttachmentConfiguration
.standard_object_configurations (
Union
[IResolvable
,SalesforceStandardObjectConfigurationListProperty
,None
]) –CfnDataSource.SalesforceConfigurationProperty.StandardObjectConfigurations
.
- Link
Attributes
-
chatter_feed_configuration
¶ CfnDataSource.SalesforceConfigurationProperty.ChatterFeedConfiguration
.
-
crawl_attachments
¶ CfnDataSource.SalesforceConfigurationProperty.CrawlAttachments
.
-
exclude_attachment_file_patterns
¶ CfnDataSource.SalesforceConfigurationProperty.ExcludeAttachmentFilePatterns
.
-
include_attachment_file_patterns
¶ CfnDataSource.SalesforceConfigurationProperty.IncludeAttachmentFilePatterns
.
-
knowledge_article_configuration
¶ CfnDataSource.SalesforceConfigurationProperty.KnowledgeArticleConfiguration
.
-
secret_arn
¶ CfnDataSource.SalesforceConfigurationProperty.SecretArn
.
-
server_url
¶ CfnDataSource.SalesforceConfigurationProperty.ServerUrl
.
-
standard_object_attachment_configuration
¶ CfnDataSource.SalesforceConfigurationProperty.StandardObjectAttachmentConfiguration
.- Link
- Return type
Union
[IResolvable
,SalesforceStandardObjectAttachmentConfigurationProperty
,None
]
-
standard_object_configurations
¶ CfnDataSource.SalesforceConfigurationProperty.StandardObjectConfigurations
.
SalesforceCustomKnowledgeArticleTypeConfigurationListProperty¶
-
class
CfnDataSource.
SalesforceCustomKnowledgeArticleTypeConfigurationListProperty
(*, salesforce_custom_knowledge_article_type_configuration_list=None)¶ Bases:
object
- Parameters
salesforce_custom_knowledge_article_type_configuration_list (
Union
[IResolvable
,Sequence
[Union
[IResolvable
,SalesforceCustomKnowledgeArticleTypeConfigurationProperty
]],None
]) –CfnDataSource.SalesforceCustomKnowledgeArticleTypeConfigurationListProperty.SalesforceCustomKnowledgeArticleTypeConfigurationList
.- Link
Attributes
-
salesforce_custom_knowledge_article_type_configuration_list
¶ CfnDataSource.SalesforceCustomKnowledgeArticleTypeConfigurationListProperty.SalesforceCustomKnowledgeArticleTypeConfigurationList
.- Link
- Return type
Union
[IResolvable
,List
[Union
[IResolvable
,SalesforceCustomKnowledgeArticleTypeConfigurationProperty
]],None
]
SalesforceCustomKnowledgeArticleTypeConfigurationProperty¶
-
class
CfnDataSource.
SalesforceCustomKnowledgeArticleTypeConfigurationProperty
(*, document_data_field_name, name, document_title_field_name=None, field_mappings=None)¶ Bases:
object
- Parameters
document_data_field_name (
str
) –CfnDataSource.SalesforceCustomKnowledgeArticleTypeConfigurationProperty.DocumentDataFieldName
.name (
str
) –CfnDataSource.SalesforceCustomKnowledgeArticleTypeConfigurationProperty.Name
.document_title_field_name (
Optional
[str
]) –CfnDataSource.SalesforceCustomKnowledgeArticleTypeConfigurationProperty.DocumentTitleFieldName
.field_mappings (
Union
[IResolvable
,DataSourceToIndexFieldMappingListProperty
,None
]) –CfnDataSource.SalesforceCustomKnowledgeArticleTypeConfigurationProperty.FieldMappings
.
- Link
Attributes
-
document_data_field_name
¶ CfnDataSource.SalesforceCustomKnowledgeArticleTypeConfigurationProperty.DocumentDataFieldName
.
-
document_title_field_name
¶ CfnDataSource.SalesforceCustomKnowledgeArticleTypeConfigurationProperty.DocumentTitleFieldName
.
-
field_mappings
¶ CfnDataSource.SalesforceCustomKnowledgeArticleTypeConfigurationProperty.FieldMappings
.- Link
- Return type
Union
[IResolvable
,DataSourceToIndexFieldMappingListProperty
,None
]
-
name
¶ CfnDataSource.SalesforceCustomKnowledgeArticleTypeConfigurationProperty.Name
.
SalesforceKnowledgeArticleConfigurationProperty¶
-
class
CfnDataSource.
SalesforceKnowledgeArticleConfigurationProperty
(*, included_states, custom_knowledge_article_type_configurations=None, standard_knowledge_article_type_configuration=None)¶ Bases:
object
- Parameters
included_states (
Union
[IResolvable
,SalesforceKnowledgeArticleStateListProperty
]) –CfnDataSource.SalesforceKnowledgeArticleConfigurationProperty.IncludedStates
.custom_knowledge_article_type_configurations (
Union
[IResolvable
,SalesforceCustomKnowledgeArticleTypeConfigurationListProperty
,None
]) –CfnDataSource.SalesforceKnowledgeArticleConfigurationProperty.CustomKnowledgeArticleTypeConfigurations
.standard_knowledge_article_type_configuration (
Union
[IResolvable
,SalesforceStandardKnowledgeArticleTypeConfigurationProperty
,None
]) –CfnDataSource.SalesforceKnowledgeArticleConfigurationProperty.StandardKnowledgeArticleTypeConfiguration
.
- Link
Attributes
-
custom_knowledge_article_type_configurations
¶ CfnDataSource.SalesforceKnowledgeArticleConfigurationProperty.CustomKnowledgeArticleTypeConfigurations
.- Link
- Return type
Union
[IResolvable
,SalesforceCustomKnowledgeArticleTypeConfigurationListProperty
,None
]
-
included_states
¶ CfnDataSource.SalesforceKnowledgeArticleConfigurationProperty.IncludedStates
.
-
standard_knowledge_article_type_configuration
¶ CfnDataSource.SalesforceKnowledgeArticleConfigurationProperty.StandardKnowledgeArticleTypeConfiguration
.- Link
- Return type
Union
[IResolvable
,SalesforceStandardKnowledgeArticleTypeConfigurationProperty
,None
]
SalesforceKnowledgeArticleStateListProperty¶
-
class
CfnDataSource.
SalesforceKnowledgeArticleStateListProperty
(*, salesforce_knowledge_article_state_list=None)¶ Bases:
object
- Parameters
salesforce_knowledge_article_state_list (
Optional
[Sequence
[str
]]) –CfnDataSource.SalesforceKnowledgeArticleStateListProperty.SalesforceKnowledgeArticleStateList
.- Link
Attributes
-
salesforce_knowledge_article_state_list
¶ CfnDataSource.SalesforceKnowledgeArticleStateListProperty.SalesforceKnowledgeArticleStateList
.
SalesforceStandardKnowledgeArticleTypeConfigurationProperty¶
-
class
CfnDataSource.
SalesforceStandardKnowledgeArticleTypeConfigurationProperty
(*, document_data_field_name, document_title_field_name=None, field_mappings=None)¶ Bases:
object
- Parameters
document_data_field_name (
str
) –CfnDataSource.SalesforceStandardKnowledgeArticleTypeConfigurationProperty.DocumentDataFieldName
.document_title_field_name (
Optional
[str
]) –CfnDataSource.SalesforceStandardKnowledgeArticleTypeConfigurationProperty.DocumentTitleFieldName
.field_mappings (
Union
[IResolvable
,DataSourceToIndexFieldMappingListProperty
,None
]) –CfnDataSource.SalesforceStandardKnowledgeArticleTypeConfigurationProperty.FieldMappings
.
- Link
Attributes
-
document_data_field_name
¶ CfnDataSource.SalesforceStandardKnowledgeArticleTypeConfigurationProperty.DocumentDataFieldName
.
-
document_title_field_name
¶ CfnDataSource.SalesforceStandardKnowledgeArticleTypeConfigurationProperty.DocumentTitleFieldName
.
-
field_mappings
¶ CfnDataSource.SalesforceStandardKnowledgeArticleTypeConfigurationProperty.FieldMappings
.- Link
- Return type
Union
[IResolvable
,DataSourceToIndexFieldMappingListProperty
,None
]
SalesforceStandardObjectAttachmentConfigurationProperty¶
-
class
CfnDataSource.
SalesforceStandardObjectAttachmentConfigurationProperty
(*, document_title_field_name=None, field_mappings=None)¶ Bases:
object
- Parameters
document_title_field_name (
Optional
[str
]) –CfnDataSource.SalesforceStandardObjectAttachmentConfigurationProperty.DocumentTitleFieldName
.field_mappings (
Union
[IResolvable
,DataSourceToIndexFieldMappingListProperty
,None
]) –CfnDataSource.SalesforceStandardObjectAttachmentConfigurationProperty.FieldMappings
.
- Link
Attributes
-
document_title_field_name
¶ CfnDataSource.SalesforceStandardObjectAttachmentConfigurationProperty.DocumentTitleFieldName
.
-
field_mappings
¶ CfnDataSource.SalesforceStandardObjectAttachmentConfigurationProperty.FieldMappings
.- Link
- Return type
Union
[IResolvable
,DataSourceToIndexFieldMappingListProperty
,None
]
SalesforceStandardObjectConfigurationListProperty¶
-
class
CfnDataSource.
SalesforceStandardObjectConfigurationListProperty
(*, salesforce_standard_object_configuration_list=None)¶ Bases:
object
- Parameters
salesforce_standard_object_configuration_list (
Union
[IResolvable
,Sequence
[Union
[IResolvable
,SalesforceStandardObjectConfigurationProperty
]],None
]) –CfnDataSource.SalesforceStandardObjectConfigurationListProperty.SalesforceStandardObjectConfigurationList
.- Link
Attributes
-
salesforce_standard_object_configuration_list
¶ CfnDataSource.SalesforceStandardObjectConfigurationListProperty.SalesforceStandardObjectConfigurationList
.- Link
- Return type
Union
[IResolvable
,List
[Union
[IResolvable
,SalesforceStandardObjectConfigurationProperty
]],None
]
SalesforceStandardObjectConfigurationProperty¶
-
class
CfnDataSource.
SalesforceStandardObjectConfigurationProperty
(*, document_data_field_name, name, document_title_field_name=None, field_mappings=None)¶ Bases:
object
- Parameters
document_data_field_name (
str
) –CfnDataSource.SalesforceStandardObjectConfigurationProperty.DocumentDataFieldName
.name (
str
) –CfnDataSource.SalesforceStandardObjectConfigurationProperty.Name
.document_title_field_name (
Optional
[str
]) –CfnDataSource.SalesforceStandardObjectConfigurationProperty.DocumentTitleFieldName
.field_mappings (
Union
[IResolvable
,DataSourceToIndexFieldMappingListProperty
,None
]) –CfnDataSource.SalesforceStandardObjectConfigurationProperty.FieldMappings
.
- Link
Attributes
-
document_data_field_name
¶ CfnDataSource.SalesforceStandardObjectConfigurationProperty.DocumentDataFieldName
.
-
document_title_field_name
¶ CfnDataSource.SalesforceStandardObjectConfigurationProperty.DocumentTitleFieldName
.
-
field_mappings
¶ CfnDataSource.SalesforceStandardObjectConfigurationProperty.FieldMappings
.
-
name
¶ CfnDataSource.SalesforceStandardObjectConfigurationProperty.Name
.
ServiceNowConfigurationProperty¶
-
class
CfnDataSource.
ServiceNowConfigurationProperty
(*, host_url, secret_arn, service_now_build_version, knowledge_article_configuration=None, service_catalog_configuration=None)¶ Bases:
object
- Parameters
host_url (
str
) –CfnDataSource.ServiceNowConfigurationProperty.HostUrl
.secret_arn (
str
) –CfnDataSource.ServiceNowConfigurationProperty.SecretArn
.service_now_build_version (
str
) –CfnDataSource.ServiceNowConfigurationProperty.ServiceNowBuildVersion
.knowledge_article_configuration (
Union
[IResolvable
,ServiceNowKnowledgeArticleConfigurationProperty
,None
]) –CfnDataSource.ServiceNowConfigurationProperty.KnowledgeArticleConfiguration
.service_catalog_configuration (
Union
[IResolvable
,ServiceNowServiceCatalogConfigurationProperty
,None
]) –CfnDataSource.ServiceNowConfigurationProperty.ServiceCatalogConfiguration
.
- Link
Attributes
-
host_url
¶ CfnDataSource.ServiceNowConfigurationProperty.HostUrl
.
-
knowledge_article_configuration
¶ CfnDataSource.ServiceNowConfigurationProperty.KnowledgeArticleConfiguration
.
-
secret_arn
¶ CfnDataSource.ServiceNowConfigurationProperty.SecretArn
.
-
service_catalog_configuration
¶ CfnDataSource.ServiceNowConfigurationProperty.ServiceCatalogConfiguration
.
-
service_now_build_version
¶ CfnDataSource.ServiceNowConfigurationProperty.ServiceNowBuildVersion
.
ServiceNowKnowledgeArticleConfigurationProperty¶
-
class
CfnDataSource.
ServiceNowKnowledgeArticleConfigurationProperty
(*, document_data_field_name, crawl_attachments=None, document_title_field_name=None, exclude_attachment_file_patterns=None, field_mappings=None, include_attachment_file_patterns=None)¶ Bases:
object
- Parameters
document_data_field_name (
str
) –CfnDataSource.ServiceNowKnowledgeArticleConfigurationProperty.DocumentDataFieldName
.crawl_attachments (
Union
[bool
,IResolvable
,None
]) –CfnDataSource.ServiceNowKnowledgeArticleConfigurationProperty.CrawlAttachments
.document_title_field_name (
Optional
[str
]) –CfnDataSource.ServiceNowKnowledgeArticleConfigurationProperty.DocumentTitleFieldName
.exclude_attachment_file_patterns (
Union
[IResolvable
,DataSourceInclusionsExclusionsStringsProperty
,None
]) –CfnDataSource.ServiceNowKnowledgeArticleConfigurationProperty.ExcludeAttachmentFilePatterns
.field_mappings (
Union
[IResolvable
,DataSourceToIndexFieldMappingListProperty
,None
]) –CfnDataSource.ServiceNowKnowledgeArticleConfigurationProperty.FieldMappings
.include_attachment_file_patterns (
Union
[IResolvable
,DataSourceInclusionsExclusionsStringsProperty
,None
]) –CfnDataSource.ServiceNowKnowledgeArticleConfigurationProperty.IncludeAttachmentFilePatterns
.
- Link
Attributes
-
crawl_attachments
¶ CfnDataSource.ServiceNowKnowledgeArticleConfigurationProperty.CrawlAttachments
.
-
document_data_field_name
¶ CfnDataSource.ServiceNowKnowledgeArticleConfigurationProperty.DocumentDataFieldName
.
-
document_title_field_name
¶ CfnDataSource.ServiceNowKnowledgeArticleConfigurationProperty.DocumentTitleFieldName
.
-
exclude_attachment_file_patterns
¶ CfnDataSource.ServiceNowKnowledgeArticleConfigurationProperty.ExcludeAttachmentFilePatterns
.- Link
- Return type
Union
[IResolvable
,DataSourceInclusionsExclusionsStringsProperty
,None
]
-
field_mappings
¶ CfnDataSource.ServiceNowKnowledgeArticleConfigurationProperty.FieldMappings
.- Link
- Return type
Union
[IResolvable
,DataSourceToIndexFieldMappingListProperty
,None
]
-
include_attachment_file_patterns
¶ CfnDataSource.ServiceNowKnowledgeArticleConfigurationProperty.IncludeAttachmentFilePatterns
.- Link
- Return type
Union
[IResolvable
,DataSourceInclusionsExclusionsStringsProperty
,None
]
ServiceNowServiceCatalogConfigurationProperty¶
-
class
CfnDataSource.
ServiceNowServiceCatalogConfigurationProperty
(*, document_data_field_name, crawl_attachments=None, document_title_field_name=None, exclude_attachment_file_patterns=None, field_mappings=None, include_attachment_file_patterns=None)¶ Bases:
object
- Parameters
document_data_field_name (
str
) –CfnDataSource.ServiceNowServiceCatalogConfigurationProperty.DocumentDataFieldName
.crawl_attachments (
Union
[bool
,IResolvable
,None
]) –CfnDataSource.ServiceNowServiceCatalogConfigurationProperty.CrawlAttachments
.document_title_field_name (
Optional
[str
]) –CfnDataSource.ServiceNowServiceCatalogConfigurationProperty.DocumentTitleFieldName
.exclude_attachment_file_patterns (
Union
[IResolvable
,DataSourceInclusionsExclusionsStringsProperty
,None
]) –CfnDataSource.ServiceNowServiceCatalogConfigurationProperty.ExcludeAttachmentFilePatterns
.field_mappings (
Union
[IResolvable
,DataSourceToIndexFieldMappingListProperty
,None
]) –CfnDataSource.ServiceNowServiceCatalogConfigurationProperty.FieldMappings
.include_attachment_file_patterns (
Union
[IResolvable
,DataSourceInclusionsExclusionsStringsProperty
,None
]) –CfnDataSource.ServiceNowServiceCatalogConfigurationProperty.IncludeAttachmentFilePatterns
.
- Link
Attributes
-
crawl_attachments
¶ CfnDataSource.ServiceNowServiceCatalogConfigurationProperty.CrawlAttachments
.
-
document_data_field_name
¶ CfnDataSource.ServiceNowServiceCatalogConfigurationProperty.DocumentDataFieldName
.
-
document_title_field_name
¶ CfnDataSource.ServiceNowServiceCatalogConfigurationProperty.DocumentTitleFieldName
.
-
exclude_attachment_file_patterns
¶ CfnDataSource.ServiceNowServiceCatalogConfigurationProperty.ExcludeAttachmentFilePatterns
.- Link
- Return type
Union
[IResolvable
,DataSourceInclusionsExclusionsStringsProperty
,None
]
-
field_mappings
¶ CfnDataSource.ServiceNowServiceCatalogConfigurationProperty.FieldMappings
.
-
include_attachment_file_patterns
¶ CfnDataSource.ServiceNowServiceCatalogConfigurationProperty.IncludeAttachmentFilePatterns
.- Link
- Return type
Union
[IResolvable
,DataSourceInclusionsExclusionsStringsProperty
,None
]
SqlConfigurationProperty¶
-
class
CfnDataSource.
SqlConfigurationProperty
(*, query_identifiers_enclosing_option=None)¶ Bases:
object
- Parameters
query_identifiers_enclosing_option (
Optional
[str
]) –CfnDataSource.SqlConfigurationProperty.QueryIdentifiersEnclosingOption
.- Link
Attributes
-
query_identifiers_enclosing_option
¶ CfnDataSource.SqlConfigurationProperty.QueryIdentifiersEnclosingOption
.