Marketplace
BrowsePublish
Marketplace
You are viewing an outdated version of provider-aws.Go to Latest
upbound/provider-aws@v0.44.0
Index
kendra.aws.upbound.io
Index
upbound/provider-aws@v0.44.0kendra.aws.upbound.io

Index is the Schema for the Indexs API. Provides an Amazon Kendra Index resource.

Type

CRD

Group

kendra.aws.upbound.io

Version

v1beta1

apiVersion: kendra.aws.upbound.io/v1beta1

kind: Index

API Documentation
apiVersion
string
kind
string
metadata
object
spec
object
object

IndexSpec defines the desired state of Index

forProvider
requiredobject
requiredobject

No description provided.

array

A block that sets the number of additional document storage and query capacity units that should be used by the index. Detailed below.

array

One or more blocks that specify the configuration settings for any metadata applied to the documents in the index. Minimum number of 0 items. Maximum number of 500 items. If specified, you must define all elements, including those that are provided by default. These index fields are documented at Amazon Kendra Index documentation. For an example resource that defines these default index fields, refer to the default example above. For an example resource that appends additional index fields, refer to the append example above. All arguments for each block must be specified. Note that blocks cannot be removed since index fields cannot be deleted. This argument is detailed below.

name
string
array

A block that provides manual tuning parameters to determine how the field affects the search results. Detailed below

search
array
array

A block that provides information about how the field is used during a search. Documented below. Detailed below

facetable
boolean
searchable
boolean
sortable
boolean
type
string
edition
string
name
string
region
requiredstring
roleArn
string
object

Reference to a Role in iam to populate roleArn.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

Selector for a Role in iam to populate roleArn.

policy
object
object

Policies for selection.

resolve
string
array

A block that specifies the identifier of the AWS KMS customer managed key (CMK) that's used to encrypt data indexed by Amazon Kendra. Amazon Kendra doesn't support asymmetric CMKs. Detailed below.

kmsKeyId
string
tags
object
array

A block that enables fetching access levels of groups and users from an AWS Single Sign-On identity source. To configure this, see UserGroupResolutionConfiguration. Detailed below.

array

A block that specifies the user token configuration. Detailed below.

array

A block that specifies the information about the JSON token type configuration. Detailed below.

array

A block that specifies the information about the JWT token type configuration. Detailed below.

object

THIS IS A BETA FIELD. It will be honored unless the Management Policies feature flag is disabled. InitProvider holds the same fields as ForProvider, with the exception of Identifier and other resource reference fields. The fields that are in InitProvider are merged into ForProvider when the resource is created. The same fields are also added to the terraform ignore_changes hook, to avoid updating them after creation. This is useful for fields that are required on creation, but we do not desire to update them after creation, for example because of an external controller is managing them, like an autoscaler.

array

A block that sets the number of additional document storage and query capacity units that should be used by the index. Detailed below.

array

One or more blocks that specify the configuration settings for any metadata applied to the documents in the index. Minimum number of 0 items. Maximum number of 500 items. If specified, you must define all elements, including those that are provided by default. These index fields are documented at Amazon Kendra Index documentation. For an example resource that defines these default index fields, refer to the default example above. For an example resource that appends additional index fields, refer to the append example above. All arguments for each block must be specified. Note that blocks cannot be removed since index fields cannot be deleted. This argument is detailed below.

name
string
array

A block that provides manual tuning parameters to determine how the field affects the search results. Detailed below

search
array
array

A block that provides information about how the field is used during a search. Documented below. Detailed below

facetable
boolean
searchable
boolean
sortable
boolean
type
string
edition
string
name
string
array

A block that specifies the identifier of the AWS KMS customer managed key (CMK) that's used to encrypt data indexed by Amazon Kendra. Amazon Kendra doesn't support asymmetric CMKs. Detailed below.

kmsKeyId
string
tags
object
array

A block that enables fetching access levels of groups and users from an AWS Single Sign-On identity source. To configure this, see UserGroupResolutionConfiguration. Detailed below.

array

A block that specifies the user token configuration. Detailed below.

array

A block that specifies the information about the JSON token type configuration. Detailed below.

array

A block that specifies the information about the JWT token type configuration. Detailed below.

array

THIS IS A BETA FIELD. It is on by default but can be opted out through a Crossplane feature flag. ManagementPolicies specify the array of actions Crossplane is allowed to take on the managed and external resources. This field is planned to replace the DeletionPolicy field in a future release. Currently, both could be set independently and non-default values would be honored if the feature flag is enabled. If both are custom, the DeletionPolicy field will be ignored. See the design doc for more information: https://github.com/crossplane/crossplane/blob/499895a25d1a1a0ba1604944ef98ac7a1a71f197/design/design-doc-observe-only-resources.md?plain=1#L223 and this one: https://github.com/crossplane/crossplane/blob/444267e84783136daa93568b364a5f01228cacbe/design/one-pager-ignore-changes.md

object

ProviderConfigReference specifies how the provider that will be used to create, observe, update, and delete this managed resource should be configured.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

PublishConnectionDetailsTo specifies the connection secret config which contains a name, metadata and a reference to secret store config to which any connection details for this managed resource should be written. Connection details frequently include the endpoint, username, and password required to connect to the managed resource.

configRef
object
object

SecretStoreConfigRef specifies which secret store config should be used for this ConnectionSecret.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
metadata
object
object

Metadata is the metadata for connection secret.

labels
object
type
string
name
requiredstring
object

WriteConnectionSecretToReference specifies the namespace and name of a Secret to which any connection details for this managed resource should be written. Connection details frequently include the endpoint, username, and password required to connect to the managed resource. This field is planned to be replaced in a future release in favor of PublishConnectionDetailsTo. Currently, both could be set independently and connection details would be published to both without affecting each other.

name
requiredstring
namespace
requiredstring
status
object
object

IndexStatus defines the observed state of Index.

object

No description provided.

arn
string
array

A block that sets the number of additional document storage and query capacity units that should be used by the index. Detailed below.

createdAt
string
array

One or more blocks that specify the configuration settings for any metadata applied to the documents in the index. Minimum number of 0 items. Maximum number of 500 items. If specified, you must define all elements, including those that are provided by default. These index fields are documented at Amazon Kendra Index documentation. For an example resource that defines these default index fields, refer to the default example above. For an example resource that appends additional index fields, refer to the append example above. All arguments for each block must be specified. Note that blocks cannot be removed since index fields cannot be deleted. This argument is detailed below.

name
string
array

A block that provides manual tuning parameters to determine how the field affects the search results. Detailed below

search
array
array

A block that provides information about how the field is used during a search. Documented below. Detailed below

facetable
boolean
searchable
boolean
sortable
boolean
type
string
edition
string
id
string
array

A block that provides information about the number of FAQ questions and answers and the number of text documents indexed. Detailed below.

array

A block that specifies the number of question and answer topics in the index. Detailed below.

array

A block that specifies the number of text documents indexed. Detailed below.

name
string
roleArn
string
array

A block that specifies the identifier of the AWS KMS customer managed key (CMK) that's used to encrypt data indexed by Amazon Kendra. Amazon Kendra doesn't support asymmetric CMKs. Detailed below.

kmsKeyId
string
status
string
tags
object
tagsAll
object
updatedAt
string
array

A block that enables fetching access levels of groups and users from an AWS Single Sign-On identity source. To configure this, see UserGroupResolutionConfiguration. Detailed below.

array

A block that specifies the user token configuration. Detailed below.

array

A block that specifies the information about the JSON token type configuration. Detailed below.

array

A block that specifies the information about the JWT token type configuration. Detailed below.

array

Conditions of the resource.

lastTransitionTime
requiredstring
message
string
reason
requiredstring
status
requiredstring
type
requiredstring
Marketplace

Discover the building blocks for your internal cloud platform.

© 2022 Upbound, Inc.

SolutionsProvidersConfigurations
LearnDocumentationTry for Free
MorePrivacy PolicyTerms & Conditions
Marketplace

© 2022 Upbound, Inc.

Marketplace

Discover the building blocksfor your internal cloud platform.