Skip to content

Commit

Permalink
Merge pull request #32294 from hashicorp/d-calliope-test
Browse files Browse the repository at this point in the history
kendra: Calliope first docs edit
  • Loading branch information
YakDriver authored Jun 30, 2023
2 parents 67f39ff + 55c3812 commit 1d064eb
Show file tree
Hide file tree
Showing 6 changed files with 21 additions and 21 deletions.
2 changes: 1 addition & 1 deletion .ci/tools/go.mod
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ module github.com/hashicorp/terraform-provider-aws/tools
go 1.20

require (
github.com/bflad/tfproviderdocs v0.11.0
github.com/YakDriver/tfproviderdocs v0.3.0
github.com/client9/misspell v0.3.4
github.com/golangci/golangci-lint v1.53.3
github.com/hashicorp/go-changelog v0.0.0-20201005170154-56335215ce3a
Expand Down
4 changes: 2 additions & 2 deletions .ci/tools/go.sum
Original file line number Diff line number Diff line change
Expand Up @@ -226,6 +226,8 @@ github.com/OpenPeeDeeP/depguard/v2 v2.1.0 h1:aQl70G173h/GZYhWf36aE5H0KaujXfVMnn/
github.com/OpenPeeDeeP/depguard/v2 v2.1.0/go.mod h1:PUBgk35fX4i7JDmwzlJwJ+GMe6NfO1723wmJMgPThNQ=
github.com/ProtonMail/go-crypto v0.0.0-20210428141323-04723f9f07d7 h1:YoJbenK9C67SkzkDfmQuVln04ygHj3vjZfd9FL+GmQQ=
github.com/ProtonMail/go-crypto v0.0.0-20210428141323-04723f9f07d7/go.mod h1:z4/9nQmJSSwwds7ejkxaJwO37dru3geImFUdJlaLzQo=
github.com/YakDriver/tfproviderdocs v0.3.0 h1:qH6IK3OE8KQMmwy83w9Muys5rmdxjMuE6bxs3Eqv1Tc=
github.com/YakDriver/tfproviderdocs v0.3.0/go.mod h1:exzn3DQfLxdiJwVM344Ob7OgL1wJFYa0prAbdaqPA+8=
github.com/acomagu/bufpipe v1.0.3 h1:fxAGrHZTgQ9w5QqVItgzwj235/uYZYgbXitB+dLupOk=
github.com/acomagu/bufpipe v1.0.3/go.mod h1:mxdxdup/WdsKVreO5GpW4+M/1CE2sMG4jeGJ2sYmHc4=
github.com/agext/levenshtein v1.2.3 h1:YB2fHEn0UJagG8T1rrWknE3ZQzWM06O8AMAatNn7lmo=
Expand Down Expand Up @@ -266,8 +268,6 @@ github.com/beorn7/perks v0.0.0-20180321164747-3a771d992973/go.mod h1:Dwedo/Wpr24
github.com/beorn7/perks v1.0.0/go.mod h1:KWe93zE9D1o94FZ5RNwFwVgaQK1VOXiVxmqh+CedLV8=
github.com/beorn7/perks v1.0.1 h1:VlbKKnNfV8bJzeqoa4cOKqO6bYr3WgKZxO8Z16+hsOM=
github.com/beorn7/perks v1.0.1/go.mod h1:G2ZrVWU2WbWT9wwq4/hrbKbnv/1ERSJQ0ibhJ6rlkpw=
github.com/bflad/tfproviderdocs v0.11.0 h1:Ckoplhi2vBiSOsmB7P+qiaWhMnr388bbNdg4HN+jDJk=
github.com/bflad/tfproviderdocs v0.11.0/go.mod h1:RhPZXM7mBDiZCAquDReEeHy5aEdH938rZHpkrz9Qoac=
github.com/bgentry/go-netrc v0.0.0-20140422174119-9fd32a8b3d3d h1:xDfNPAt8lFiC1UJrqV3uuy861HCTo708pDMbjHHdCas=
github.com/bgentry/go-netrc v0.0.0-20140422174119-9fd32a8b3d3d/go.mod h1:6QX/PXZ00z/TKoufEY6K/a0k6AhaJrQKdFe6OfVXsa4=
github.com/bgentry/speakeasy v0.1.0 h1:ByYyxL9InA1OWqxJqqp2A5pYHUrCiAL6K3J+LKSsQkY=
Expand Down
2 changes: 1 addition & 1 deletion .ci/tools/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
package main

import (
_ "github.com/bflad/tfproviderdocs"
_ "github.com/YakDriver/tfproviderdocs"
_ "github.com/client9/misspell/cmd/misspell"
_ "github.com/golangci/golangci-lint/cmd/golangci-lint"
_ "github.com/hashicorp/go-changelog/cmd/changelog-build"
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/terraform_provider.yml
Original file line number Diff line number Diff line change
Expand Up @@ -250,7 +250,7 @@ jobs:
with:
path: ~/go/pkg/mod
key: ${{ runner.os }}-go-pkg-mod-${{ hashFiles('go.sum') }}
- run: cd .ci/tools && go install github.com/bflad/tfproviderdocs
- run: cd .ci/tools && go install github.com/YakDriver/tfproviderdocs
- uses: actions/cache@88522ab9f39a2ea568f7027eddc7d8d8bc9d59c8
timeout-minutes: 2
with:
Expand Down
2 changes: 1 addition & 1 deletion GNUmakefile
Original file line number Diff line number Diff line change
Expand Up @@ -365,7 +365,7 @@ tfsdk2fw:

tools:
cd .ci/providerlint && $(GO_VER) install .
cd .ci/tools && $(GO_VER) install github.com/bflad/tfproviderdocs
cd .ci/tools && $(GO_VER) install github.com/YakDriver/tfproviderdocs
cd .ci/tools && $(GO_VER) install github.com/client9/misspell/cmd/misspell
cd .ci/tools && $(GO_VER) install github.com/golangci/golangci-lint/cmd/golangci-lint
cd .ci/tools && $(GO_VER) install github.com/katbyte/terrafmt
Expand Down
30 changes: 15 additions & 15 deletions website/docs/r/kendra_query_suggestions_block_list.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ description: |-

# Resource: aws_kendra_query_suggestions_block_list

Terraform resource for managing an AWS Kendra block list used for query suggestions for an index.
Use the `aws_kendra_index_block_list` resource to manage an AWS Kendra block list used for query suggestions for an index.

## Example Usage

Expand All @@ -35,40 +35,40 @@ resource "aws_kendra_query_suggestions_block_list" "example" {

The following arguments are required:

* `index_id`- (Required, Forces new resource) The identifier of the index for a block list.
* `name` - (Required) The name for the block list.
* `role_arn` - (Required) The IAM (Identity and Access Management) role used to access the block list text file in S3.
* `source_s3_path` - (Required) The S3 path where your block list text file sits in S3. Detailed below.
* `index_id` - (Required, Forces New Resource) Identifier of the index for a block list.
* `name` - (Required) Name for the block list.
* `role_arn` - (Required) IAM (Identity and Access Management) role used to access the block list text file in S3.
* `source_s3_path` - (Required) S3 path where your block list text file is located. See details below.

The `source_s3_path` configuration block supports the following arguments:

* `bucket` - (Required) The name of the S3 bucket that contains the file.
* `key` - (Required) The name of the file.
* `bucket` - (Required) Name of the S3 bucket that contains the file.
* `key` - (Required) Name of the file.

The following arguments are optional:

* `description` - (Optional) The description for a block list.
* `tags` - (Optional) Key-value map of resource tags. If configured with a provider [`default_tags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level.
* `description` - (Optional) Description for a block list.
* `tags` - (Optional) Key-value map of resource tags. If configured with a provider [`default_tags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block), tags with matching keys will overwrite those defined at the provider-level.

## Attributes Reference
## Attribute Reference

In addition to all arguments above, the following attributes are exported:
This resource exports the following attributes in addition to the arguments above:

* `arn` - ARN of the block list.
* `query_suggestions_block_list_id` - The unique indentifier of the block list.
* `tags_all` - A map of tags assigned to the resource, including those inherited from the provider [`default_tags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block).
* `query_suggestions_block_list_id` - Unique identifier of the block list.
* `tags_all` - Map of tags assigned to the resource, including those inherited from the provider's [default_tags configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block).

## Timeouts

[Configuration options](https://developer.hashicorp.com/terraform/language/resources/syntax#operation-timeouts):
Configuration options for operation timeouts can be found [here](https://developer.hashicorp.com/terraform/language/resources/syntax#operation-timeouts).

* `create` - (Default `30m`)
* `update` - (Default `30m`)
* `delete` - (Default `30m`)

## Import

`aws_kendra_query_suggestions_block_list` can be imported using the unique identifiers of the block list and index separated by a slash (`/`), e.g.,
The `aws_kendra_query_suggestions_block_list` resource can be imported using the unique identifiers of the block list and index separated by a slash (`/`), for example:

```
$ terraform import aws_kendra_query_suggestions_block_list.example blocklist-123456780/idx-8012925589
Expand Down

0 comments on commit 1d064eb

Please sign in to comment.