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
IndexSpec defines the desired state of Index
No description provided.
A block that sets the number of additional document storage and query capacity units that should be used by the index. Detailed below.
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.
Reference to a Role in iam to populate roleArn.
Policies for referencing.
Selector for a Role in iam to populate roleArn.
Policies for selection.
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.
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.
A block that specifies the user token configuration. Detailed below.
A block that specifies the information about the JSON token type configuration. Detailed below.
A block that specifies the information about the JWT token type configuration. Detailed below.
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.
A block that sets the number of additional document storage and query capacity units that should be used by the index. Detailed below.
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.
Reference to a Role in iam to populate roleArn.
Policies for referencing.
Selector for a Role in iam to populate roleArn.
Policies for selection.
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.
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.
A block that specifies the user token configuration. Detailed below.
A block that specifies the information about the JSON token type configuration. Detailed below.
A block that specifies the information about the JWT token type configuration. Detailed below.
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
ProviderConfigReference specifies how the provider that will be used to create, observe, update, and delete this managed resource should be configured.
Policies for referencing.
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.
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.
IndexStatus defines the observed state of Index.
No description provided.
A block that sets the number of additional document storage and query capacity units that should be used by the index. Detailed below.
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.
A block that provides information about the number of FAQ questions and answers and the number of text documents indexed. Detailed below.
A block that specifies the number of question and answer topics in the index. Detailed below.
A block that specifies the number of text documents indexed. Detailed below.
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.
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.
A block that specifies the user token configuration. Detailed below.
A block that specifies the information about the JSON token type configuration. Detailed below.
A block that specifies the information about the JWT token type configuration. Detailed below.
Conditions of the resource.
index-5
apiVersion: kendra.aws.upbound.io/v1beta1
kind: Index
metadata:
annotations:
meta.upbound.io/example-id: kendra/v1beta1/thesaurus
uptest.upbound.io/timeout: "7200"
labels:
testing.upbound.io/example-name: example
name: index-5
spec:
forProvider:
name: index-5
region: us-east-1
roleArn: arn:aws:iam::153891904029:role/kendra-index-role
index-2
apiVersion: kendra.aws.upbound.io/v1beta1
kind: Index
metadata:
annotations:
meta.upbound.io/example-id: kendra/v1beta1/index
upjet.upbound.io/manual-intervention: Uptest doesn't pick up successful resource status
uptest.upbound.io/timeout: "7200"
labels:
testing.upbound.io/example-name: example
name: index-2
spec:
forProvider:
name: index-2
region: us-west-2
roleArn: arn:aws:iam::153891904029:role/kendra-index-role
index-3
apiVersion: kendra.aws.upbound.io/v1beta1
kind: Index
metadata:
annotations:
meta.upbound.io/example-id: kendra/v1beta1/experience
uptest.upbound.io/timeout: "7200"
labels:
testing.upbound.io/example-name: example
name: index-3
spec:
forProvider:
name: index-3
region: us-east-1
roleArn: arn:aws:iam::153891904029:role/kendra-index-role
index-4
apiVersion: kendra.aws.upbound.io/v1beta1
kind: Index
metadata:
annotations:
meta.upbound.io/example-id: kendra/v1beta1/querysuggestionsblocklist
uptest.upbound.io/timeout: "7200"
labels:
testing.upbound.io/example-name: example
name: index-4
spec:
forProvider:
name: index-4
region: us-east-1
roleArn: arn:aws:iam::153891904029:role/kendra-index-role
index-1
apiVersion: kendra.aws.upbound.io/v1beta1
kind: Index
metadata:
annotations:
meta.upbound.io/example-id: kendra/v1beta1/datasource
uptest.upbound.io/timeout: "7200"
labels:
testing.upbound.io/example-name: example
name: index-1
spec:
forProvider:
name: index-1
region: us-east-1
roleArn: arn:aws:iam::153891904029:role/kendra-index-role
© 2022 Upbound, Inc.
Discover the building blocksfor your internal cloud platform.