CfnIndex

class aws_cdk.aws_kendra.CfnIndex(scope, id, *, edition, name, role_arn, capacity_units=None, description=None, document_metadata_configurations=None, server_side_encryption_configuration=None, tags=None, user_context_policy=None, user_token_configurations=None)

Bases: aws_cdk.core.CfnResource

A CloudFormation AWS::Kendra::Index.

CloudformationResource

AWS::Kendra::Index

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kendra-index.html

Create a new AWS::Kendra::Index.

Parameters

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::Index'
attr_arn

Arn

Type

cloudformationAttribute

Return type

str

attr_id

Id

Type

cloudformationAttribute

Return type

str

capacity_units

AWS::Kendra::Index.CapacityUnits.

Link

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

Return type

Union[IResolvable, CapacityUnitsConfigurationProperty, None]

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]

description

AWS::Kendra::Index.Description.

Link

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

Return type

Optional[str]

document_metadata_configurations

AWS::Kendra::Index.DocumentMetadataConfigurations.

Link

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

Return type

Union[IResolvable, List[Union[IResolvable, DocumentMetadataConfigurationProperty]], None]

edition

AWS::Kendra::Index.Edition.

Link

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

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::Index.Name.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kendra-index.html#cfn-kendra-index-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::Index.RoleArn.

Link

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

Return type

str

server_side_encryption_configuration

AWS::Kendra::Index.ServerSideEncryptionConfiguration.

Link

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

Return type

Union[IResolvable, ServerSideEncryptionConfigurationProperty, None]

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::Index.Tags.

Link

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

Return type

TagManager

user_context_policy

AWS::Kendra::Index.UserContextPolicy.

Link

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

Return type

Optional[str]

user_token_configurations

AWS::Kendra::Index.UserTokenConfigurations.

Link

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

Return type

Union[IResolvable, List[Union[IResolvable, UserTokenConfigurationProperty]], None]

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

CapacityUnitsConfigurationProperty

class CfnIndex.CapacityUnitsConfigurationProperty(*, query_capacity_units, storage_capacity_units)

Bases: object

Parameters
  • query_capacity_units (Union[int, float]) – CfnIndex.CapacityUnitsConfigurationProperty.QueryCapacityUnits.

  • storage_capacity_units (Union[int, float]) – CfnIndex.CapacityUnitsConfigurationProperty.StorageCapacityUnits.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-capacityunitsconfiguration.html

Attributes

query_capacity_units

CfnIndex.CapacityUnitsConfigurationProperty.QueryCapacityUnits.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-capacityunitsconfiguration.html#cfn-kendra-index-capacityunitsconfiguration-querycapacityunits

Return type

Union[int, float]

storage_capacity_units

CfnIndex.CapacityUnitsConfigurationProperty.StorageCapacityUnits.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-capacityunitsconfiguration.html#cfn-kendra-index-capacityunitsconfiguration-storagecapacityunits

Return type

Union[int, float]

DocumentMetadataConfigurationProperty

class CfnIndex.DocumentMetadataConfigurationProperty(*, name, type, relevance=None, search=None)

Bases: object

Parameters
  • name (str) – CfnIndex.DocumentMetadataConfigurationProperty.Name.

  • type (str) – CfnIndex.DocumentMetadataConfigurationProperty.Type.

  • relevance (Union[IResolvable, RelevanceProperty, None]) – CfnIndex.DocumentMetadataConfigurationProperty.Relevance.

  • search (Union[IResolvable, SearchProperty, None]) – CfnIndex.DocumentMetadataConfigurationProperty.Search.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-documentmetadataconfiguration.html

Attributes

name

CfnIndex.DocumentMetadataConfigurationProperty.Name.

Link

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

Return type

str

relevance

CfnIndex.DocumentMetadataConfigurationProperty.Relevance.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-documentmetadataconfiguration.html#cfn-kendra-index-documentmetadataconfiguration-relevance

Return type

Union[IResolvable, RelevanceProperty, None]

search

CfnIndex.DocumentMetadataConfigurationProperty.Search.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-documentmetadataconfiguration.html#cfn-kendra-index-documentmetadataconfiguration-search

Return type

Union[IResolvable, SearchProperty, None]

type

CfnIndex.DocumentMetadataConfigurationProperty.Type.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-documentmetadataconfiguration.html#cfn-kendra-index-documentmetadataconfiguration-type

Return type

str

JsonTokenTypeConfigurationProperty

class CfnIndex.JsonTokenTypeConfigurationProperty(*, group_attribute_field, user_name_attribute_field)

Bases: object

Parameters
  • group_attribute_field (str) – CfnIndex.JsonTokenTypeConfigurationProperty.GroupAttributeField.

  • user_name_attribute_field (str) – CfnIndex.JsonTokenTypeConfigurationProperty.UserNameAttributeField.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-jsontokentypeconfiguration.html

Attributes

group_attribute_field

CfnIndex.JsonTokenTypeConfigurationProperty.GroupAttributeField.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-jsontokentypeconfiguration.html#cfn-kendra-index-jsontokentypeconfiguration-groupattributefield

Return type

str

user_name_attribute_field

CfnIndex.JsonTokenTypeConfigurationProperty.UserNameAttributeField.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-jsontokentypeconfiguration.html#cfn-kendra-index-jsontokentypeconfiguration-usernameattributefield

Return type

str

JwtTokenTypeConfigurationProperty

class CfnIndex.JwtTokenTypeConfigurationProperty(*, key_location, claim_regex=None, group_attribute_field=None, issuer=None, secret_manager_arn=None, url=None, user_name_attribute_field=None)

Bases: object

Parameters
  • key_location (str) – CfnIndex.JwtTokenTypeConfigurationProperty.KeyLocation.

  • claim_regex (Optional[str]) – CfnIndex.JwtTokenTypeConfigurationProperty.ClaimRegex.

  • group_attribute_field (Optional[str]) – CfnIndex.JwtTokenTypeConfigurationProperty.GroupAttributeField.

  • issuer (Optional[str]) – CfnIndex.JwtTokenTypeConfigurationProperty.Issuer.

  • secret_manager_arn (Optional[str]) – CfnIndex.JwtTokenTypeConfigurationProperty.SecretManagerArn.

  • url (Optional[str]) – CfnIndex.JwtTokenTypeConfigurationProperty.URL.

  • user_name_attribute_field (Optional[str]) – CfnIndex.JwtTokenTypeConfigurationProperty.UserNameAttributeField.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-jwttokentypeconfiguration.html

Attributes

claim_regex

CfnIndex.JwtTokenTypeConfigurationProperty.ClaimRegex.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-jwttokentypeconfiguration.html#cfn-kendra-index-jwttokentypeconfiguration-claimregex

Return type

Optional[str]

group_attribute_field

CfnIndex.JwtTokenTypeConfigurationProperty.GroupAttributeField.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-jwttokentypeconfiguration.html#cfn-kendra-index-jwttokentypeconfiguration-groupattributefield

Return type

Optional[str]

issuer

CfnIndex.JwtTokenTypeConfigurationProperty.Issuer.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-jwttokentypeconfiguration.html#cfn-kendra-index-jwttokentypeconfiguration-issuer

Return type

Optional[str]

key_location

CfnIndex.JwtTokenTypeConfigurationProperty.KeyLocation.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-jwttokentypeconfiguration.html#cfn-kendra-index-jwttokentypeconfiguration-keylocation

Return type

str

secret_manager_arn

CfnIndex.JwtTokenTypeConfigurationProperty.SecretManagerArn.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-jwttokentypeconfiguration.html#cfn-kendra-index-jwttokentypeconfiguration-secretmanagerarn

Return type

Optional[str]

url

CfnIndex.JwtTokenTypeConfigurationProperty.URL.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-jwttokentypeconfiguration.html#cfn-kendra-index-jwttokentypeconfiguration-url

Return type

Optional[str]

user_name_attribute_field

CfnIndex.JwtTokenTypeConfigurationProperty.UserNameAttributeField.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-jwttokentypeconfiguration.html#cfn-kendra-index-jwttokentypeconfiguration-usernameattributefield

Return type

Optional[str]

RelevanceProperty

class CfnIndex.RelevanceProperty(*, duration=None, freshness=None, importance=None, rank_order=None, value_importance_items=None)

Bases: object

Parameters
  • duration (Optional[str]) – CfnIndex.RelevanceProperty.Duration.

  • freshness (Union[bool, IResolvable, None]) – CfnIndex.RelevanceProperty.Freshness.

  • importance (Union[int, float, None]) – CfnIndex.RelevanceProperty.Importance.

  • rank_order (Optional[str]) – CfnIndex.RelevanceProperty.RankOrder.

  • value_importance_items (Union[IResolvable, Sequence[Union[IResolvable, ValueImportanceItemProperty]], None]) – CfnIndex.RelevanceProperty.ValueImportanceItems.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-relevance.html

Attributes

duration

CfnIndex.RelevanceProperty.Duration.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-relevance.html#cfn-kendra-index-relevance-duration

Return type

Optional[str]

freshness

CfnIndex.RelevanceProperty.Freshness.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-relevance.html#cfn-kendra-index-relevance-freshness

Return type

Union[bool, IResolvable, None]

importance

CfnIndex.RelevanceProperty.Importance.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-relevance.html#cfn-kendra-index-relevance-importance

Return type

Union[int, float, None]

rank_order

CfnIndex.RelevanceProperty.RankOrder.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-relevance.html#cfn-kendra-index-relevance-rankorder

Return type

Optional[str]

value_importance_items

CfnIndex.RelevanceProperty.ValueImportanceItems.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-relevance.html#cfn-kendra-index-relevance-valueimportanceitems

Return type

Union[IResolvable, List[Union[IResolvable, ValueImportanceItemProperty]], None]

SearchProperty

class CfnIndex.SearchProperty(*, displayable=None, facetable=None, searchable=None, sortable=None)

Bases: object

Parameters
  • displayable (Union[bool, IResolvable, None]) – CfnIndex.SearchProperty.Displayable.

  • facetable (Union[bool, IResolvable, None]) – CfnIndex.SearchProperty.Facetable.

  • searchable (Union[bool, IResolvable, None]) – CfnIndex.SearchProperty.Searchable.

  • sortable (Union[bool, IResolvable, None]) – CfnIndex.SearchProperty.Sortable.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-search.html

Attributes

displayable

CfnIndex.SearchProperty.Displayable.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-search.html#cfn-kendra-index-search-displayable

Return type

Union[bool, IResolvable, None]

facetable

CfnIndex.SearchProperty.Facetable.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-search.html#cfn-kendra-index-search-facetable

Return type

Union[bool, IResolvable, None]

searchable

CfnIndex.SearchProperty.Searchable.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-search.html#cfn-kendra-index-search-searchable

Return type

Union[bool, IResolvable, None]

sortable

CfnIndex.SearchProperty.Sortable.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-search.html#cfn-kendra-index-search-sortable

Return type

Union[bool, IResolvable, None]

ServerSideEncryptionConfigurationProperty

class CfnIndex.ServerSideEncryptionConfigurationProperty(*, kms_key_id=None)

Bases: object

Parameters

kms_key_id (Optional[str]) – CfnIndex.ServerSideEncryptionConfigurationProperty.KmsKeyId.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-serversideencryptionconfiguration.html

Attributes

kms_key_id

CfnIndex.ServerSideEncryptionConfigurationProperty.KmsKeyId.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-serversideencryptionconfiguration.html#cfn-kendra-index-serversideencryptionconfiguration-kmskeyid

Return type

Optional[str]

UserTokenConfigurationProperty

class CfnIndex.UserTokenConfigurationProperty(*, json_token_type_configuration=None, jwt_token_type_configuration=None)

Bases: object

Parameters
Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-usertokenconfiguration.html

Attributes

json_token_type_configuration

CfnIndex.UserTokenConfigurationProperty.JsonTokenTypeConfiguration.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-usertokenconfiguration.html#cfn-kendra-index-usertokenconfiguration-jsontokentypeconfiguration

Return type

Union[IResolvable, JsonTokenTypeConfigurationProperty, None]

jwt_token_type_configuration

CfnIndex.UserTokenConfigurationProperty.JwtTokenTypeConfiguration.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-usertokenconfiguration.html#cfn-kendra-index-usertokenconfiguration-jwttokentypeconfiguration

Return type

Union[IResolvable, JwtTokenTypeConfigurationProperty, None]

ValueImportanceItemProperty

class CfnIndex.ValueImportanceItemProperty(*, key=None, value=None)

Bases: object

Parameters
  • key (Optional[str]) – CfnIndex.ValueImportanceItemProperty.Key.

  • value (Union[int, float, None]) – CfnIndex.ValueImportanceItemProperty.Value.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-valueimportanceitem.html

Attributes

key

CfnIndex.ValueImportanceItemProperty.Key.

Link

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

Return type

Optional[str]

value

CfnIndex.ValueImportanceItemProperty.Value.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-valueimportanceitem.html#cfn-kendra-index-valueimportanceitem-value

Return type

Union[int, float, None]