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 prefix path 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: true

  • default (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

Reference

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)

Examines the CloudFormation resource and discloses attributes.

Parameters

inspector (TreeInspector) –

  • tree inspector to collect and process attributes.

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

ICfnResourceOptions

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.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kendra-datasource.html#cfn-kendra-datasource-datasourceconfiguration

Return type

Union[DataSourceConfigurationProperty, IResolvable, None]

description

AWS::Kendra::DataSource.Description.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kendra-datasource.html#cfn-kendra-datasource-description

Return type

Optional[str]

index_id

AWS::Kendra::DataSource.IndexId.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kendra-datasource.html#cfn-kendra-datasource-indexid

Return type

str

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.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kendra-datasource.html#cfn-kendra-datasource-name

Return type

str

node

The construct tree node associated with this construct.

Return type

ConstructNode

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.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kendra-datasource.html#cfn-kendra-datasource-rolearn

Return type

Optional[str]

schedule

AWS::Kendra::DataSource.Schedule.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kendra-datasource.html#cfn-kendra-datasource-schedule

Return type

Optional[str]

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Return type

Stack

tags

AWS::Kendra::DataSource.Tags.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kendra-datasource.html#cfn-kendra-datasource-tags

Return type

TagManager

type

AWS::Kendra::DataSource.Type.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kendra-datasource.html#cfn-kendra-datasource-type

Return type

str

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

class CfnDataSource.AccessControlListConfigurationProperty(*, key_path=None)

Bases: object

Parameters

key_path (Optional[str]) – CfnDataSource.AccessControlListConfigurationProperty.KeyPath.

Link

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

Attributes

key_path

CfnDataSource.AccessControlListConfigurationProperty.KeyPath.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-accesscontrollistconfiguration.html#cfn-kendra-datasource-accesscontrollistconfiguration-keypath

Return type

Optional[str]

AclConfigurationProperty

class CfnDataSource.AclConfigurationProperty(*, allowed_groups_column_name)

Bases: object

Parameters

allowed_groups_column_name (str) – CfnDataSource.AclConfigurationProperty.AllowedGroupsColumnName.

Link

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

Attributes

allowed_groups_column_name

CfnDataSource.AclConfigurationProperty.AllowedGroupsColumnName.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-aclconfiguration.html#cfn-kendra-datasource-aclconfiguration-allowedgroupscolumnname

Return type

str

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 (Sequence[str]) – 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, Sequence[Union[IResolvable, DataSourceToIndexFieldMappingProperty]], None]) – CfnDataSource.ColumnConfigurationProperty.FieldMappings.

Link

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

Attributes

change_detecting_columns

CfnDataSource.ColumnConfigurationProperty.ChangeDetectingColumns.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-columnconfiguration.html#cfn-kendra-datasource-columnconfiguration-changedetectingcolumns

Return type

List[str]

document_data_column_name

CfnDataSource.ColumnConfigurationProperty.DocumentDataColumnName.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-columnconfiguration.html#cfn-kendra-datasource-columnconfiguration-documentdatacolumnname

Return type

str

document_id_column_name

CfnDataSource.ColumnConfigurationProperty.DocumentIdColumnName.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-columnconfiguration.html#cfn-kendra-datasource-columnconfiguration-documentidcolumnname

Return type

str

document_title_column_name

CfnDataSource.ColumnConfigurationProperty.DocumentTitleColumnName.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-columnconfiguration.html#cfn-kendra-datasource-columnconfiguration-documenttitlecolumnname

Return type

Optional[str]

field_mappings

CfnDataSource.ColumnConfigurationProperty.FieldMappings.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-columnconfiguration.html#cfn-kendra-datasource-columnconfiguration-fieldmappings

Return type

Union[IResolvable, List[Union[IResolvable, DataSourceToIndexFieldMappingProperty]], None]

ConfluenceAttachmentConfigurationProperty

class CfnDataSource.ConfluenceAttachmentConfigurationProperty(*, attachment_field_mappings=None, crawl_attachments=None)

Bases: object

Parameters
Link

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

Attributes

attachment_field_mappings

CfnDataSource.ConfluenceAttachmentConfigurationProperty.AttachmentFieldMappings.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-confluenceattachmentconfiguration.html#cfn-kendra-datasource-confluenceattachmentconfiguration-attachmentfieldmappings

Return type

Union[IResolvable, List[Union[IResolvable, ConfluenceAttachmentToIndexFieldMappingProperty]], None]

crawl_attachments

CfnDataSource.ConfluenceAttachmentConfigurationProperty.CrawlAttachments.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-confluenceattachmentconfiguration.html#cfn-kendra-datasource-confluenceattachmentconfiguration-crawlattachments

Return type

Union[bool, IResolvable, 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

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

Attributes

data_source_field_name

CfnDataSource.ConfluenceAttachmentToIndexFieldMappingProperty.DataSourceFieldName.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-confluenceattachmenttoindexfieldmapping.html#cfn-kendra-datasource-confluenceattachmenttoindexfieldmapping-datasourcefieldname

Return type

str

date_field_format

CfnDataSource.ConfluenceAttachmentToIndexFieldMappingProperty.DateFieldFormat.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-confluenceattachmenttoindexfieldmapping.html#cfn-kendra-datasource-confluenceattachmenttoindexfieldmapping-datefieldformat

Return type

Optional[str]

index_field_name

CfnDataSource.ConfluenceAttachmentToIndexFieldMappingProperty.IndexFieldName.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-confluenceattachmenttoindexfieldmapping.html#cfn-kendra-datasource-confluenceattachmenttoindexfieldmapping-indexfieldname

Return type

str

ConfluenceBlogConfigurationProperty

class CfnDataSource.ConfluenceBlogConfigurationProperty(*, blog_field_mappings=None)

Bases: object

Parameters

blog_field_mappings (Union[IResolvable, Sequence[Union[IResolvable, ConfluenceBlogToIndexFieldMappingProperty]], None]) – CfnDataSource.ConfluenceBlogConfigurationProperty.BlogFieldMappings.

Link

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

Attributes

blog_field_mappings

CfnDataSource.ConfluenceBlogConfigurationProperty.BlogFieldMappings.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-confluenceblogconfiguration.html#cfn-kendra-datasource-confluenceblogconfiguration-blogfieldmappings

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

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

Attributes

data_source_field_name

CfnDataSource.ConfluenceBlogToIndexFieldMappingProperty.DataSourceFieldName.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-confluenceblogtoindexfieldmapping.html#cfn-kendra-datasource-confluenceblogtoindexfieldmapping-datasourcefieldname

Return type

str

date_field_format

CfnDataSource.ConfluenceBlogToIndexFieldMappingProperty.DateFieldFormat.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-confluenceblogtoindexfieldmapping.html#cfn-kendra-datasource-confluenceblogtoindexfieldmapping-datefieldformat

Return type

Optional[str]

index_field_name

CfnDataSource.ConfluenceBlogToIndexFieldMappingProperty.IndexFieldName.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-confluenceblogtoindexfieldmapping.html#cfn-kendra-datasource-confluenceblogtoindexfieldmapping-indexfieldname

Return type

str

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 (Optional[Sequence[str]]) – CfnDataSource.ConfluenceConfigurationProperty.ExclusionPatterns.

  • inclusion_patterns (Optional[Sequence[str]]) – 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

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

Attributes

attachment_configuration

CfnDataSource.ConfluenceConfigurationProperty.AttachmentConfiguration.

Link

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

Return type

Union[IResolvable, ConfluenceAttachmentConfigurationProperty, None]

blog_configuration

CfnDataSource.ConfluenceConfigurationProperty.BlogConfiguration.

Link

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

Return type

Union[IResolvable, ConfluenceBlogConfigurationProperty, None]

exclusion_patterns

CfnDataSource.ConfluenceConfigurationProperty.ExclusionPatterns.

Link

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

Return type

Optional[List[str]]

inclusion_patterns

CfnDataSource.ConfluenceConfigurationProperty.InclusionPatterns.

Link

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

Return type

Optional[List[str]]

page_configuration

CfnDataSource.ConfluenceConfigurationProperty.PageConfiguration.

Link

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

Return type

Union[IResolvable, ConfluencePageConfigurationProperty, None]

secret_arn

CfnDataSource.ConfluenceConfigurationProperty.SecretArn.

Link

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

Return type

str

server_url

CfnDataSource.ConfluenceConfigurationProperty.ServerUrl.

Link

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

Return type

str

space_configuration

CfnDataSource.ConfluenceConfigurationProperty.SpaceConfiguration.

Link

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

Return type

Union[IResolvable, ConfluenceSpaceConfigurationProperty, None]

version

CfnDataSource.ConfluenceConfigurationProperty.Version.

Link

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

Return type

str

vpc_configuration

CfnDataSource.ConfluenceConfigurationProperty.VpcConfiguration.

Link

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

Return type

Union[IResolvable, DataSourceVpcConfigurationProperty, None]

ConfluencePageConfigurationProperty

class CfnDataSource.ConfluencePageConfigurationProperty(*, page_field_mappings=None)

Bases: object

Parameters

page_field_mappings (Union[IResolvable, Sequence[Union[IResolvable, ConfluencePageToIndexFieldMappingProperty]], None]) – CfnDataSource.ConfluencePageConfigurationProperty.PageFieldMappings.

Link

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

Attributes

page_field_mappings

CfnDataSource.ConfluencePageConfigurationProperty.PageFieldMappings.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-confluencepageconfiguration.html#cfn-kendra-datasource-confluencepageconfiguration-pagefieldmappings

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

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

Attributes

data_source_field_name

CfnDataSource.ConfluencePageToIndexFieldMappingProperty.DataSourceFieldName.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-confluencepagetoindexfieldmapping.html#cfn-kendra-datasource-confluencepagetoindexfieldmapping-datasourcefieldname

Return type

str

date_field_format

CfnDataSource.ConfluencePageToIndexFieldMappingProperty.DateFieldFormat.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-confluencepagetoindexfieldmapping.html#cfn-kendra-datasource-confluencepagetoindexfieldmapping-datefieldformat

Return type

Optional[str]

index_field_name

CfnDataSource.ConfluencePageToIndexFieldMappingProperty.IndexFieldName.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-confluencepagetoindexfieldmapping.html#cfn-kendra-datasource-confluencepagetoindexfieldmapping-indexfieldname

Return type

str

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 (Optional[Sequence[str]]) – CfnDataSource.ConfluenceSpaceConfigurationProperty.ExcludeSpaces.

  • include_spaces (Optional[Sequence[str]]) – CfnDataSource.ConfluenceSpaceConfigurationProperty.IncludeSpaces.

  • space_field_mappings (Union[IResolvable, Sequence[Union[IResolvable, ConfluenceSpaceToIndexFieldMappingProperty]], None]) – CfnDataSource.ConfluenceSpaceConfigurationProperty.SpaceFieldMappings.

Link

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

Attributes

crawl_archived_spaces

CfnDataSource.ConfluenceSpaceConfigurationProperty.CrawlArchivedSpaces.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-confluencespaceconfiguration.html#cfn-kendra-datasource-confluencespaceconfiguration-crawlarchivedspaces

Return type

Union[bool, IResolvable, None]

crawl_personal_spaces

CfnDataSource.ConfluenceSpaceConfigurationProperty.CrawlPersonalSpaces.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-confluencespaceconfiguration.html#cfn-kendra-datasource-confluencespaceconfiguration-crawlpersonalspaces

Return type

Union[bool, IResolvable, None]

exclude_spaces

CfnDataSource.ConfluenceSpaceConfigurationProperty.ExcludeSpaces.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-confluencespaceconfiguration.html#cfn-kendra-datasource-confluencespaceconfiguration-excludespaces

Return type

Optional[List[str]]

include_spaces

CfnDataSource.ConfluenceSpaceConfigurationProperty.IncludeSpaces.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-confluencespaceconfiguration.html#cfn-kendra-datasource-confluencespaceconfiguration-includespaces

Return type

Optional[List[str]]

space_field_mappings

CfnDataSource.ConfluenceSpaceConfigurationProperty.SpaceFieldMappings.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-confluencespaceconfiguration.html#cfn-kendra-datasource-confluencespaceconfiguration-spacefieldmappings

Return type

Union[IResolvable, List[Union[IResolvable, ConfluenceSpaceToIndexFieldMappingProperty]], None]

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

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

Attributes

data_source_field_name

CfnDataSource.ConfluenceSpaceToIndexFieldMappingProperty.DataSourceFieldName.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-confluencespacetoindexfieldmapping.html#cfn-kendra-datasource-confluencespacetoindexfieldmapping-datasourcefieldname

Return type

str

date_field_format

CfnDataSource.ConfluenceSpaceToIndexFieldMappingProperty.DateFieldFormat.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-confluencespacetoindexfieldmapping.html#cfn-kendra-datasource-confluencespacetoindexfieldmapping-datefieldformat

Return type

Optional[str]

index_field_name

CfnDataSource.ConfluenceSpaceToIndexFieldMappingProperty.IndexFieldName.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-confluencespacetoindexfieldmapping.html#cfn-kendra-datasource-confluencespacetoindexfieldmapping-indexfieldname

Return type

str

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

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

Attributes

database_host

CfnDataSource.ConnectionConfigurationProperty.DatabaseHost.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-connectionconfiguration.html#cfn-kendra-datasource-connectionconfiguration-databasehost

Return type

str

database_name

CfnDataSource.ConnectionConfigurationProperty.DatabaseName.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-connectionconfiguration.html#cfn-kendra-datasource-connectionconfiguration-databasename

Return type

str

database_port

CfnDataSource.ConnectionConfigurationProperty.DatabasePort.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-connectionconfiguration.html#cfn-kendra-datasource-connectionconfiguration-databaseport

Return type

Union[int, float]

secret_arn

CfnDataSource.ConnectionConfigurationProperty.SecretArn.

Link

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

Return type

str

table_name

CfnDataSource.ConnectionConfigurationProperty.TableName.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-connectionconfiguration.html#cfn-kendra-datasource-connectionconfiguration-tablename

Return type

str

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
Link

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

Attributes

confluence_configuration

CfnDataSource.DataSourceConfigurationProperty.ConfluenceConfiguration.

Link

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

Return type

Union[IResolvable, ConfluenceConfigurationProperty, None]

database_configuration

CfnDataSource.DataSourceConfigurationProperty.DatabaseConfiguration.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-datasourceconfiguration.html#cfn-kendra-datasource-datasourceconfiguration-databaseconfiguration

Return type

Union[IResolvable, DatabaseConfigurationProperty, None]

google_drive_configuration

CfnDataSource.DataSourceConfigurationProperty.GoogleDriveConfiguration.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-datasourceconfiguration.html#cfn-kendra-datasource-datasourceconfiguration-googledriveconfiguration

Return type

Union[IResolvable, GoogleDriveConfigurationProperty, None]

one_drive_configuration

CfnDataSource.DataSourceConfigurationProperty.OneDriveConfiguration.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-datasourceconfiguration.html#cfn-kendra-datasource-datasourceconfiguration-onedriveconfiguration

Return type

Union[IResolvable, OneDriveConfigurationProperty, None]

s3_configuration

CfnDataSource.DataSourceConfigurationProperty.S3Configuration.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-datasourceconfiguration.html#cfn-kendra-datasource-datasourceconfiguration-s3configuration

Return type

Union[IResolvable, S3DataSourceConfigurationProperty, None]

salesforce_configuration

CfnDataSource.DataSourceConfigurationProperty.SalesforceConfiguration.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-datasourceconfiguration.html#cfn-kendra-datasource-datasourceconfiguration-salesforceconfiguration

Return type

Union[IResolvable, SalesforceConfigurationProperty, None]

service_now_configuration

CfnDataSource.DataSourceConfigurationProperty.ServiceNowConfiguration.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-datasourceconfiguration.html#cfn-kendra-datasource-datasourceconfiguration-servicenowconfiguration

Return type

Union[IResolvable, ServiceNowConfigurationProperty, None]

share_point_configuration

CfnDataSource.DataSourceConfigurationProperty.SharePointConfiguration.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-datasourceconfiguration.html#cfn-kendra-datasource-datasourceconfiguration-sharepointconfiguration

Return type

Union[IResolvable, SharePointConfigurationProperty, 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

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

Attributes

data_source_field_name

CfnDataSource.DataSourceToIndexFieldMappingProperty.DataSourceFieldName.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-datasourcetoindexfieldmapping.html#cfn-kendra-datasource-datasourcetoindexfieldmapping-datasourcefieldname

Return type

str

date_field_format

CfnDataSource.DataSourceToIndexFieldMappingProperty.DateFieldFormat.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-datasourcetoindexfieldmapping.html#cfn-kendra-datasource-datasourcetoindexfieldmapping-datefieldformat

Return type

Optional[str]

index_field_name

CfnDataSource.DataSourceToIndexFieldMappingProperty.IndexFieldName.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-datasourcetoindexfieldmapping.html#cfn-kendra-datasource-datasourcetoindexfieldmapping-indexfieldname

Return type

str

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

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

Attributes

security_group_ids

CfnDataSource.DataSourceVpcConfigurationProperty.SecurityGroupIds.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-datasourcevpcconfiguration.html#cfn-kendra-datasource-datasourcevpcconfiguration-securitygroupids

Return type

List[str]

subnet_ids

CfnDataSource.DataSourceVpcConfigurationProperty.SubnetIds.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-datasourcevpcconfiguration.html#cfn-kendra-datasource-datasourcevpcconfiguration-subnetids

Return type

List[str]

DatabaseConfigurationProperty

class CfnDataSource.DatabaseConfigurationProperty(*, column_configuration, connection_configuration, database_engine_type, acl_configuration=None, sql_configuration=None, vpc_configuration=None)

Bases: object

Parameters
Link

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

Attributes

acl_configuration

CfnDataSource.DatabaseConfigurationProperty.AclConfiguration.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-databaseconfiguration.html#cfn-kendra-datasource-databaseconfiguration-aclconfiguration

Return type

Union[IResolvable, AclConfigurationProperty, None]

column_configuration

CfnDataSource.DatabaseConfigurationProperty.ColumnConfiguration.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-databaseconfiguration.html#cfn-kendra-datasource-databaseconfiguration-columnconfiguration

Return type

Union[IResolvable, ColumnConfigurationProperty]

connection_configuration

CfnDataSource.DatabaseConfigurationProperty.ConnectionConfiguration.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-databaseconfiguration.html#cfn-kendra-datasource-databaseconfiguration-connectionconfiguration

Return type

Union[IResolvable, ConnectionConfigurationProperty]

database_engine_type

CfnDataSource.DatabaseConfigurationProperty.DatabaseEngineType.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-databaseconfiguration.html#cfn-kendra-datasource-databaseconfiguration-databaseenginetype

Return type

str

sql_configuration

CfnDataSource.DatabaseConfigurationProperty.SqlConfiguration.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-databaseconfiguration.html#cfn-kendra-datasource-databaseconfiguration-sqlconfiguration

Return type

Union[IResolvable, SqlConfigurationProperty, None]

vpc_configuration

CfnDataSource.DatabaseConfigurationProperty.VpcConfiguration.

Link

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

Return type

Union[IResolvable, DataSourceVpcConfigurationProperty, None]

DocumentsMetadataConfigurationProperty

class CfnDataSource.DocumentsMetadataConfigurationProperty(*, s3_prefix=None)

Bases: object

Parameters

s3_prefix (Optional[str]) – CfnDataSource.DocumentsMetadataConfigurationProperty.S3Prefix.

Link

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

Attributes

s3_prefix

CfnDataSource.DocumentsMetadataConfigurationProperty.S3Prefix.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-documentsmetadataconfiguration.html#cfn-kendra-datasource-documentsmetadataconfiguration-s3prefix

Return type

Optional[str]

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 (Optional[Sequence[str]]) – CfnDataSource.GoogleDriveConfigurationProperty.ExcludeMimeTypes.

  • exclude_shared_drives (Optional[Sequence[str]]) – CfnDataSource.GoogleDriveConfigurationProperty.ExcludeSharedDrives.

  • exclude_user_accounts (Optional[Sequence[str]]) – CfnDataSource.GoogleDriveConfigurationProperty.ExcludeUserAccounts.

  • exclusion_patterns (Optional[Sequence[str]]) – CfnDataSource.GoogleDriveConfigurationProperty.ExclusionPatterns.

  • field_mappings (Union[IResolvable, Sequence[Union[IResolvable, DataSourceToIndexFieldMappingProperty]], None]) – CfnDataSource.GoogleDriveConfigurationProperty.FieldMappings.

  • inclusion_patterns (Optional[Sequence[str]]) – CfnDataSource.GoogleDriveConfigurationProperty.InclusionPatterns.

Link

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

Attributes

exclude_mime_types

CfnDataSource.GoogleDriveConfigurationProperty.ExcludeMimeTypes.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-googledriveconfiguration.html#cfn-kendra-datasource-googledriveconfiguration-excludemimetypes

Return type

Optional[List[str]]

exclude_shared_drives

CfnDataSource.GoogleDriveConfigurationProperty.ExcludeSharedDrives.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-googledriveconfiguration.html#cfn-kendra-datasource-googledriveconfiguration-excludeshareddrives

Return type

Optional[List[str]]

exclude_user_accounts

CfnDataSource.GoogleDriveConfigurationProperty.ExcludeUserAccounts.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-googledriveconfiguration.html#cfn-kendra-datasource-googledriveconfiguration-excludeuseraccounts

Return type

Optional[List[str]]

exclusion_patterns

CfnDataSource.GoogleDriveConfigurationProperty.ExclusionPatterns.

Link

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

Return type

Optional[List[str]]

field_mappings

CfnDataSource.GoogleDriveConfigurationProperty.FieldMappings.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-googledriveconfiguration.html#cfn-kendra-datasource-googledriveconfiguration-fieldmappings

Return type

Union[IResolvable, List[Union[IResolvable, DataSourceToIndexFieldMappingProperty]], None]

inclusion_patterns

CfnDataSource.GoogleDriveConfigurationProperty.InclusionPatterns.

Link

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

Return type

Optional[List[str]]

secret_arn

CfnDataSource.GoogleDriveConfigurationProperty.SecretArn.

Link

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

Return type

str

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 (Optional[Sequence[str]]) – CfnDataSource.OneDriveConfigurationProperty.ExclusionPatterns.

  • field_mappings (Union[IResolvable, Sequence[Union[IResolvable, DataSourceToIndexFieldMappingProperty]], None]) – CfnDataSource.OneDriveConfigurationProperty.FieldMappings.

  • inclusion_patterns (Optional[Sequence[str]]) – CfnDataSource.OneDriveConfigurationProperty.InclusionPatterns.

Link

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

Attributes

disable_local_groups

CfnDataSource.OneDriveConfigurationProperty.DisableLocalGroups.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-onedriveconfiguration.html#cfn-kendra-datasource-onedriveconfiguration-disablelocalgroups

Return type

Union[bool, IResolvable, None]

exclusion_patterns

CfnDataSource.OneDriveConfigurationProperty.ExclusionPatterns.

Link

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

Return type

Optional[List[str]]

field_mappings

CfnDataSource.OneDriveConfigurationProperty.FieldMappings.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-onedriveconfiguration.html#cfn-kendra-datasource-onedriveconfiguration-fieldmappings

Return type

Union[IResolvable, List[Union[IResolvable, DataSourceToIndexFieldMappingProperty]], None]

inclusion_patterns

CfnDataSource.OneDriveConfigurationProperty.InclusionPatterns.

Link

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

Return type

Optional[List[str]]

one_drive_users

CfnDataSource.OneDriveConfigurationProperty.OneDriveUsers.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-onedriveconfiguration.html#cfn-kendra-datasource-onedriveconfiguration-onedriveusers

Return type

Union[IResolvable, OneDriveUsersProperty]

secret_arn

CfnDataSource.OneDriveConfigurationProperty.SecretArn.

Link

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

Return type

str

tenant_domain

CfnDataSource.OneDriveConfigurationProperty.TenantDomain.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-onedriveconfiguration.html#cfn-kendra-datasource-onedriveconfiguration-tenantdomain

Return type

str

OneDriveUsersProperty

class CfnDataSource.OneDriveUsersProperty(*, one_drive_user_list=None, one_drive_user_s3_path=None)

Bases: object

Parameters

  • one_drive_user_list (Optional[Sequence[str]]) – CfnDataSource.OneDriveUsersProperty.OneDriveUserList.

  • one_drive_user_s3_path (Union[IResolvable, S3PathProperty, None]) – CfnDataSource.OneDriveUsersProperty.OneDriveUserS3Path.

Link

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

Attributes

one_drive_user_list

CfnDataSource.OneDriveUsersProperty.OneDriveUserList.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-onedriveusers.html#cfn-kendra-datasource-onedriveusers-onedriveuserlist

Return type

Optional[List[str]]

one_drive_user_s3_path

CfnDataSource.OneDriveUsersProperty.OneDriveUserS3Path.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-onedriveusers.html#cfn-kendra-datasource-onedriveusers-onedriveusers3path

Return type

Union[IResolvable, S3PathProperty, None]

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 (Optional[Sequence[str]]) – CfnDataSource.S3DataSourceConfigurationProperty.ExclusionPatterns.

  • inclusion_patterns (Optional[Sequence[str]]) – CfnDataSource.S3DataSourceConfigurationProperty.InclusionPatterns.

  • inclusion_prefixes (Optional[Sequence[str]]) – CfnDataSource.S3DataSourceConfigurationProperty.InclusionPrefixes.

Link

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

Attributes

access_control_list_configuration

CfnDataSource.S3DataSourceConfigurationProperty.AccessControlListConfiguration.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-s3datasourceconfiguration.html#cfn-kendra-datasource-s3datasourceconfiguration-accesscontrollistconfiguration

Return type

Union[IResolvable, AccessControlListConfigurationProperty, None]

bucket_name

CfnDataSource.S3DataSourceConfigurationProperty.BucketName.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-s3datasourceconfiguration.html#cfn-kendra-datasource-s3datasourceconfiguration-bucketname

Return type

str

documents_metadata_configuration

CfnDataSource.S3DataSourceConfigurationProperty.DocumentsMetadataConfiguration.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-s3datasourceconfiguration.html#cfn-kendra-datasource-s3datasourceconfiguration-documentsmetadataconfiguration

Return type

Union[IResolvable, DocumentsMetadataConfigurationProperty, None]

exclusion_patterns

CfnDataSource.S3DataSourceConfigurationProperty.ExclusionPatterns.

Link

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

Return type

Optional[List[str]]

inclusion_patterns

CfnDataSource.S3DataSourceConfigurationProperty.InclusionPatterns.

Link

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

Return type

Optional[List[str]]

inclusion_prefixes

CfnDataSource.S3DataSourceConfigurationProperty.InclusionPrefixes.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-s3datasourceconfiguration.html#cfn-kendra-datasource-s3datasourceconfiguration-inclusionprefixes

Return type

Optional[List[str]]

S3PathProperty

class CfnDataSource.S3PathProperty(*, bucket, key)

Bases: object

Parameters

  • bucket (str) – CfnDataSource.S3PathProperty.Bucket.

  • key (str) – CfnDataSource.S3PathProperty.Key.

Link

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

Attributes

bucket

CfnDataSource.S3PathProperty.Bucket.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-s3path.html#cfn-kendra-datasource-s3path-bucket

Return type

str

key

CfnDataSource.S3PathProperty.Key.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-s3path.html#cfn-kendra-datasource-s3path-key

Return type

str

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, Sequence[Union[IResolvable, DataSourceToIndexFieldMappingProperty]], None]) – CfnDataSource.SalesforceChatterFeedConfigurationProperty.FieldMappings.

  • include_filter_types (Optional[Sequence[str]]) – CfnDataSource.SalesforceChatterFeedConfigurationProperty.IncludeFilterTypes.

Link

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

Attributes

document_data_field_name

CfnDataSource.SalesforceChatterFeedConfigurationProperty.DocumentDataFieldName.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-salesforcechatterfeedconfiguration.html#cfn-kendra-datasource-salesforcechatterfeedconfiguration-documentdatafieldname

Return type

str

document_title_field_name

CfnDataSource.SalesforceChatterFeedConfigurationProperty.DocumentTitleFieldName.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-salesforcechatterfeedconfiguration.html#cfn-kendra-datasource-salesforcechatterfeedconfiguration-documenttitlefieldname

Return type

Optional[str]

field_mappings

CfnDataSource.SalesforceChatterFeedConfigurationProperty.FieldMappings.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-salesforcechatterfeedconfiguration.html#cfn-kendra-datasource-salesforcechatterfeedconfiguration-fieldmappings

Return type

Union[IResolvable, List[Union[IResolvable, DataSourceToIndexFieldMappingProperty]], None]

include_filter_types

CfnDataSource.SalesforceChatterFeedConfigurationProperty.IncludeFilterTypes.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-salesforcechatterfeedconfiguration.html#cfn-kendra-datasource-salesforcechatterfeedconfiguration-includefiltertypes

Return type

Optional[List[str]]

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 (Optional[Sequence[str]]) – CfnDataSource.SalesforceConfigurationProperty.ExcludeAttachmentFilePatterns.

  • include_attachment_file_patterns (Optional[Sequence[str]]) – 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, Sequence[Union[IResolvable, SalesforceStandardObjectConfigurationProperty]], None]) – CfnDataSource.SalesforceConfigurationProperty.StandardObjectConfigurations.

Link

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

Attributes

chatter_feed_configuration

CfnDataSource.SalesforceConfigurationProperty.ChatterFeedConfiguration.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-salesforceconfiguration.html#cfn-kendra-datasource-salesforceconfiguration-chatterfeedconfiguration

Return type

Union[IResolvable, SalesforceChatterFeedConfigurationProperty, None]

crawl_attachments

CfnDataSource.SalesforceConfigurationProperty.CrawlAttachments.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-salesforceconfiguration.html#cfn-kendra-datasource-salesforceconfiguration-crawlattachments

Return type

Union[bool, IResolvable, None]

exclude_attachment_file_patterns

CfnDataSource.SalesforceConfigurationProperty.ExcludeAttachmentFilePatterns.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-salesforceconfiguration.html#cfn-kendra-datasource-salesforceconfiguration-excludeattachmentfilepatterns

Return type

Optional[List[str]]

include_attachment_file_patterns

CfnDataSource.SalesforceConfigurationProperty.IncludeAttachmentFilePatterns.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-salesforceconfiguration.html#cfn-kendra-datasource-salesforceconfiguration-includeattachmentfilepatterns

Return type

Optional[List[str]]

knowledge_article_configuration

CfnDataSource.SalesforceConfigurationProperty.KnowledgeArticleConfiguration.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-salesforceconfiguration.html#cfn-kendra-datasource-salesforceconfiguration-knowledgearticleconfiguration

Return type

Union[IResolvable, SalesforceKnowledgeArticleConfigurationProperty, None]

secret_arn

CfnDataSource.SalesforceConfigurationProperty.SecretArn.

Link

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

Return type

str

server_url

CfnDataSource.SalesforceConfigurationProperty.ServerUrl.

Link

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

Return type

str

standard_object_attachment_configuration

CfnDataSource.SalesforceConfigurationProperty.StandardObjectAttachmentConfiguration.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-salesforceconfiguration.html#cfn-kendra-datasource-salesforceconfiguration-standardobjectattachmentconfiguration

Return type

Union[IResolvable, SalesforceStandardObjectAttachmentConfigurationProperty, None]

standard_object_configurations

CfnDataSource.SalesforceConfigurationProperty.StandardObjectConfigurations.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-salesforceconfiguration.html#cfn-kendra-datasource-salesforceconfiguration-standardobjectconfigurations

Return type

Union[IResolvable, List[Union[IResolvable, SalesforceStandardObjectConfigurationProperty]], 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, Sequence[Union[IResolvable, DataSourceToIndexFieldMappingProperty]], None]) – CfnDataSource.SalesforceCustomKnowledgeArticleTypeConfigurationProperty.FieldMappings.

Link

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

Attributes

document_data_field_name

CfnDataSource.SalesforceCustomKnowledgeArticleTypeConfigurationProperty.DocumentDataFieldName.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-salesforcecustomknowledgearticletypeconfiguration.html#cfn-kendra-datasource-salesforcecustomknowledgearticletypeconfiguration-documentdatafieldname

Return type

str

document_title_field_name

CfnDataSource.SalesforceCustomKnowledgeArticleTypeConfigurationProperty.DocumentTitleFieldName.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-salesforcecustomknowledgearticletypeconfiguration.html#cfn-kendra-datasource-salesforcecustomknowledgearticletypeconfiguration-documenttitlefieldname

Return type

Optional[str]

field_mappings

CfnDataSource.SalesforceCustomKnowledgeArticleTypeConfigurationProperty.FieldMappings.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-salesforcecustomknowledgearticletypeconfiguration.html#cfn-kendra-datasource-salesforcecustomknowledgearticletypeconfiguration-fieldmappings

Return type

Union[IResolvable, List[Union[IResolvable, DataSourceToIndexFieldMappingProperty]], None]

name

CfnDataSource.SalesforceCustomKnowledgeArticleTypeConfigurationProperty.Name.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-salesforcecustomknowledgearticletypeconfiguration.html#cfn-kendra-datasource-salesforcecustomknowledgearticletypeconfiguration-name

Return type

str

SalesforceKnowledgeArticleConfigurationProperty

class CfnDataSource.SalesforceKnowledgeArticleConfigurationProperty(*, included_states, custom_knowledge_article_type_configurations=None, standard_knowledge_article_type_configuration=None)

Bases: object

Parameters
Link

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

Attributes

custom_knowledge_article_type_configurations

CfnDataSource.SalesforceKnowledgeArticleConfigurationProperty.CustomKnowledgeArticleTypeConfigurations.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-salesforceknowledgearticleconfiguration.html#cfn-kendra-datasource-salesforceknowledgearticleconfiguration-customknowledgearticletypeconfigurations

Return type

Union[IResolvable, List[Union[IResolvable, SalesforceCustomKnowledgeArticleTypeConfigurationProperty]], None]

included_states

CfnDataSource.SalesforceKnowledgeArticleConfigurationProperty.IncludedStates.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-salesforceknowledgearticleconfiguration.html#cfn-kendra-datasource-salesforceknowledgearticleconfiguration-includedstates

Return type

List[str]

standard_knowledge_article_type_configuration

CfnDataSource.SalesforceKnowledgeArticleConfigurationProperty.StandardKnowledgeArticleTypeConfiguration.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-salesforceknowledgearticleconfiguration.html#cfn-kendra-datasource-salesforceknowledgearticleconfiguration-standardknowledgearticletypeconfiguration

Return type

Union[IResolvable, SalesforceStandardKnowledgeArticleTypeConfigurationProperty, None]

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, Sequence[Union[IResolvable, DataSourceToIndexFieldMappingProperty]], None]) – CfnDataSource.SalesforceStandardKnowledgeArticleTypeConfigurationProperty.FieldMappings.

Link

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

Attributes

document_data_field_name

CfnDataSource.SalesforceStandardKnowledgeArticleTypeConfigurationProperty.DocumentDataFieldName.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-salesforcestandardknowledgearticletypeconfiguration.html#cfn-kendra-datasource-salesforcestandardknowledgearticletypeconfiguration-documentdatafieldname

Return type

str

document_title_field_name

CfnDataSource.SalesforceStandardKnowledgeArticleTypeConfigurationProperty.DocumentTitleFieldName.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-salesforcestandardknowledgearticletypeconfiguration.html#cfn-kendra-datasource-salesforcestandardknowledgearticletypeconfiguration-documenttitlefieldname

Return type

Optional[str]

field_mappings

CfnDataSource.SalesforceStandardKnowledgeArticleTypeConfigurationProperty.FieldMappings.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-salesforcestandardknowledgearticletypeconfiguration.html#cfn-kendra-datasource-salesforcestandardknowledgearticletypeconfiguration-fieldmappings

Return type

Union[IResolvable, List[Union[IResolvable, DataSourceToIndexFieldMappingProperty]], 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, Sequence[Union[IResolvable, DataSourceToIndexFieldMappingProperty]], None]) – CfnDataSource.SalesforceStandardObjectAttachmentConfigurationProperty.FieldMappings.

Link

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

Attributes

document_title_field_name

CfnDataSource.SalesforceStandardObjectAttachmentConfigurationProperty.DocumentTitleFieldName.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-salesforcestandardobjectattachmentconfiguration.html#cfn-kendra-datasource-salesforcestandardobjectattachmentconfiguration-documenttitlefieldname

Return type

Optional[str]

field_mappings

CfnDataSource.SalesforceStandardObjectAttachmentConfigurationProperty.FieldMappings.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-salesforcestandardobjectattachmentconfiguration.html#cfn-kendra-datasource-salesforcestandardobjectattachmentconfiguration-fieldmappings

Return type

Union[IResolvable, List[Union[IResolvable, DataSourceToIndexFieldMappingProperty]], 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, Sequence[Union[IResolvable, DataSourceToIndexFieldMappingProperty]], None]) – CfnDataSource.SalesforceStandardObjectConfigurationProperty.FieldMappings.

Link

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

Attributes

document_data_field_name

CfnDataSource.SalesforceStandardObjectConfigurationProperty.DocumentDataFieldName.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-salesforcestandardobjectconfiguration.html#cfn-kendra-datasource-salesforcestandardobjectconfiguration-documentdatafieldname

Return type

str

document_title_field_name

CfnDataSource.SalesforceStandardObjectConfigurationProperty.DocumentTitleFieldName.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-salesforcestandardobjectconfiguration.html#cfn-kendra-datasource-salesforcestandardobjectconfiguration-documenttitlefieldname

Return type

Optional[str]

field_mappings

CfnDataSource.SalesforceStandardObjectConfigurationProperty.FieldMappings.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-salesforcestandardobjectconfiguration.html#cfn-kendra-datasource-salesforcestandardobjectconfiguration-fieldmappings

Return type

Union[IResolvable, List[Union[IResolvable, DataSourceToIndexFieldMappingProperty]], None]

name

CfnDataSource.SalesforceStandardObjectConfigurationProperty.Name.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-salesforcestandardobjectconfiguration.html#cfn-kendra-datasource-salesforcestandardobjectconfiguration-name

Return type

str

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

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

Attributes

host_url

CfnDataSource.ServiceNowConfigurationProperty.HostUrl.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-servicenowconfiguration.html#cfn-kendra-datasource-servicenowconfiguration-hosturl

Return type

str

knowledge_article_configuration

CfnDataSource.ServiceNowConfigurationProperty.KnowledgeArticleConfiguration.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-servicenowconfiguration.html#cfn-kendra-datasource-servicenowconfiguration-knowledgearticleconfiguration

Return type

Union[IResolvable, ServiceNowKnowledgeArticleConfigurationProperty, None]

secret_arn

CfnDataSource.ServiceNowConfigurationProperty.SecretArn.

Link

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

Return type

str

service_catalog_configuration

CfnDataSource.ServiceNowConfigurationProperty.ServiceCatalogConfiguration.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-servicenowconfiguration.html#cfn-kendra-datasource-servicenowconfiguration-servicecatalogconfiguration

Return type

Union[IResolvable, ServiceNowServiceCatalogConfigurationProperty, None]

service_now_build_version

CfnDataSource.ServiceNowConfigurationProperty.ServiceNowBuildVersion.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-servicenowconfiguration.html#cfn-kendra-datasource-servicenowconfiguration-servicenowbuildversion

Return type

str

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 (Optional[Sequence[str]]) – CfnDataSource.ServiceNowKnowledgeArticleConfigurationProperty.ExcludeAttachmentFilePatterns.

  • field_mappings (Union[IResolvable, Sequence[Union[IResolvable, DataSourceToIndexFieldMappingProperty]], None]) – CfnDataSource.ServiceNowKnowledgeArticleConfigurationProperty.FieldMappings.

  • include_attachment_file_patterns (Optional[Sequence[str]]) – CfnDataSource.ServiceNowKnowledgeArticleConfigurationProperty.IncludeAttachmentFilePatterns.

Link

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

Attributes

crawl_attachments

CfnDataSource.ServiceNowKnowledgeArticleConfigurationProperty.CrawlAttachments.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-servicenowknowledgearticleconfiguration.html#cfn-kendra-datasource-servicenowknowledgearticleconfiguration-crawlattachments

Return type

Union[bool, IResolvable, None]

document_data_field_name

CfnDataSource.ServiceNowKnowledgeArticleConfigurationProperty.DocumentDataFieldName.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-servicenowknowledgearticleconfiguration.html#cfn-kendra-datasource-servicenowknowledgearticleconfiguration-documentdatafieldname

Return type

str

document_title_field_name

CfnDataSource.ServiceNowKnowledgeArticleConfigurationProperty.DocumentTitleFieldName.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-servicenowknowledgearticleconfiguration.html#cfn-kendra-datasource-servicenowknowledgearticleconfiguration-documenttitlefieldname

Return type

Optional[str]

exclude_attachment_file_patterns

CfnDataSource.ServiceNowKnowledgeArticleConfigurationProperty.ExcludeAttachmentFilePatterns.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-servicenowknowledgearticleconfiguration.html#cfn-kendra-datasource-servicenowknowledgearticleconfiguration-excludeattachmentfilepatterns

Return type

Optional[List[str]]

field_mappings

CfnDataSource.ServiceNowKnowledgeArticleConfigurationProperty.FieldMappings.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-servicenowknowledgearticleconfiguration.html#cfn-kendra-datasource-servicenowknowledgearticleconfiguration-fieldmappings

Return type

Union[IResolvable, List[Union[IResolvable, DataSourceToIndexFieldMappingProperty]], None]

include_attachment_file_patterns

CfnDataSource.ServiceNowKnowledgeArticleConfigurationProperty.IncludeAttachmentFilePatterns.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-servicenowknowledgearticleconfiguration.html#cfn-kendra-datasource-servicenowknowledgearticleconfiguration-includeattachmentfilepatterns

Return type

Optional[List[str]]

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 (Optional[Sequence[str]]) – CfnDataSource.ServiceNowServiceCatalogConfigurationProperty.ExcludeAttachmentFilePatterns.

  • field_mappings (Union[IResolvable, Sequence[Union[IResolvable, DataSourceToIndexFieldMappingProperty]], None]) – CfnDataSource.ServiceNowServiceCatalogConfigurationProperty.FieldMappings.

  • include_attachment_file_patterns (Optional[Sequence[str]]) – CfnDataSource.ServiceNowServiceCatalogConfigurationProperty.IncludeAttachmentFilePatterns.

Link

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

Attributes

crawl_attachments

CfnDataSource.ServiceNowServiceCatalogConfigurationProperty.CrawlAttachments.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-servicenowservicecatalogconfiguration.html#cfn-kendra-datasource-servicenowservicecatalogconfiguration-crawlattachments

Return type

Union[bool, IResolvable, None]

document_data_field_name

CfnDataSource.ServiceNowServiceCatalogConfigurationProperty.DocumentDataFieldName.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-servicenowservicecatalogconfiguration.html#cfn-kendra-datasource-servicenowservicecatalogconfiguration-documentdatafieldname

Return type

str

document_title_field_name

CfnDataSource.ServiceNowServiceCatalogConfigurationProperty.DocumentTitleFieldName.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-servicenowservicecatalogconfiguration.html#cfn-kendra-datasource-servicenowservicecatalogconfiguration-documenttitlefieldname

Return type

Optional[str]

exclude_attachment_file_patterns

CfnDataSource.ServiceNowServiceCatalogConfigurationProperty.ExcludeAttachmentFilePatterns.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-servicenowservicecatalogconfiguration.html#cfn-kendra-datasource-servicenowservicecatalogconfiguration-excludeattachmentfilepatterns

Return type

Optional[List[str]]

field_mappings

CfnDataSource.ServiceNowServiceCatalogConfigurationProperty.FieldMappings.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-servicenowservicecatalogconfiguration.html#cfn-kendra-datasource-servicenowservicecatalogconfiguration-fieldmappings

Return type

Union[IResolvable, List[Union[IResolvable, DataSourceToIndexFieldMappingProperty]], None]

include_attachment_file_patterns

CfnDataSource.ServiceNowServiceCatalogConfigurationProperty.IncludeAttachmentFilePatterns.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-servicenowservicecatalogconfiguration.html#cfn-kendra-datasource-servicenowservicecatalogconfiguration-includeattachmentfilepatterns

Return type

Optional[List[str]]

SharePointConfigurationProperty

class CfnDataSource.SharePointConfigurationProperty(*, secret_arn, share_point_version, urls, crawl_attachments=None, disable_local_groups=None, document_title_field_name=None, exclusion_patterns=None, field_mappings=None, inclusion_patterns=None, use_change_log=None, vpc_configuration=None)

Bases: object

Parameters

  • secret_arn (str) – CfnDataSource.SharePointConfigurationProperty.SecretArn.

  • share_point_version (str) – CfnDataSource.SharePointConfigurationProperty.SharePointVersion.

  • urls (Sequence[str]) – CfnDataSource.SharePointConfigurationProperty.Urls.

  • crawl_attachments (Union[bool, IResolvable, None]) – CfnDataSource.SharePointConfigurationProperty.CrawlAttachments.

  • disable_local_groups (Union[bool, IResolvable, None]) – CfnDataSource.SharePointConfigurationProperty.DisableLocalGroups.

  • document_title_field_name (Optional[str]) – CfnDataSource.SharePointConfigurationProperty.DocumentTitleFieldName.

  • exclusion_patterns (Optional[Sequence[str]]) – CfnDataSource.SharePointConfigurationProperty.ExclusionPatterns.

  • field_mappings (Union[IResolvable, Sequence[Union[IResolvable, DataSourceToIndexFieldMappingProperty]], None]) – CfnDataSource.SharePointConfigurationProperty.FieldMappings.

  • inclusion_patterns (Optional[Sequence[str]]) – CfnDataSource.SharePointConfigurationProperty.InclusionPatterns.

  • use_change_log (Union[bool, IResolvable, None]) – CfnDataSource.SharePointConfigurationProperty.UseChangeLog.

  • vpc_configuration (Union[IResolvable, DataSourceVpcConfigurationProperty, None]) – CfnDataSource.SharePointConfigurationProperty.VpcConfiguration.

Link

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

Attributes

crawl_attachments

CfnDataSource.SharePointConfigurationProperty.CrawlAttachments.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-sharepointconfiguration.html#cfn-kendra-datasource-sharepointconfiguration-crawlattachments

Return type

Union[bool, IResolvable, None]

disable_local_groups

CfnDataSource.SharePointConfigurationProperty.DisableLocalGroups.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-sharepointconfiguration.html#cfn-kendra-datasource-sharepointconfiguration-disablelocalgroups

Return type

Union[bool, IResolvable, None]

document_title_field_name

CfnDataSource.SharePointConfigurationProperty.DocumentTitleFieldName.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-sharepointconfiguration.html#cfn-kendra-datasource-sharepointconfiguration-documenttitlefieldname

Return type

Optional[str]

exclusion_patterns

CfnDataSource.SharePointConfigurationProperty.ExclusionPatterns.

Link

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

Return type

Optional[List[str]]

field_mappings

CfnDataSource.SharePointConfigurationProperty.FieldMappings.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-sharepointconfiguration.html#cfn-kendra-datasource-sharepointconfiguration-fieldmappings

Return type

Union[IResolvable, List[Union[IResolvable, DataSourceToIndexFieldMappingProperty]], None]

inclusion_patterns

CfnDataSource.SharePointConfigurationProperty.InclusionPatterns.

Link

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

Return type

Optional[List[str]]

secret_arn

CfnDataSource.SharePointConfigurationProperty.SecretArn.

Link

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

Return type

str

share_point_version

CfnDataSource.SharePointConfigurationProperty.SharePointVersion.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-sharepointconfiguration.html#cfn-kendra-datasource-sharepointconfiguration-sharepointversion

Return type

str

urls

CfnDataSource.SharePointConfigurationProperty.Urls.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-sharepointconfiguration.html#cfn-kendra-datasource-sharepointconfiguration-urls

Return type

List[str]

use_change_log

CfnDataSource.SharePointConfigurationProperty.UseChangeLog.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-sharepointconfiguration.html#cfn-kendra-datasource-sharepointconfiguration-usechangelog

Return type

Union[bool, IResolvable, None]

vpc_configuration

CfnDataSource.SharePointConfigurationProperty.VpcConfiguration.

Link

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

Return type

Union[IResolvable, DataSourceVpcConfigurationProperty, None]

SqlConfigurationProperty

class CfnDataSource.SqlConfigurationProperty(*, query_identifiers_enclosing_option=None)

Bases: object

Parameters

query_identifiers_enclosing_option (Optional[str]) – CfnDataSource.SqlConfigurationProperty.QueryIdentifiersEnclosingOption.

Link

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

Attributes

query_identifiers_enclosing_option

CfnDataSource.SqlConfigurationProperty.QueryIdentifiersEnclosingOption.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-sqlconfiguration.html#cfn-kendra-datasource-sqlconfiguration-queryidentifiersenclosingoption

Return type

Optional[str]