AWS Native

v0.43.0 published on Thursday, Dec 1, 2022 by Pulumi

Index

A Kendra index

Create Index Resource

new Index(name: string, args: IndexArgs, opts?: CustomResourceOptions);
@overload
def Index(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          capacity_units: Optional[IndexCapacityUnitsConfigurationArgs] = None,
          description: Optional[str] = None,
          document_metadata_configurations: Optional[Sequence[IndexDocumentMetadataConfigurationArgs]] = None,
          edition: Optional[IndexEdition] = None,
          name: Optional[str] = None,
          role_arn: Optional[str] = None,
          server_side_encryption_configuration: Optional[IndexServerSideEncryptionConfigurationArgs] = None,
          tags: Optional[Sequence[IndexTagArgs]] = None,
          user_context_policy: Optional[IndexUserContextPolicy] = None,
          user_token_configurations: Optional[Sequence[IndexUserTokenConfigurationArgs]] = None)
@overload
def Index(resource_name: str,
          args: IndexArgs,
          opts: Optional[ResourceOptions] = None)
func NewIndex(ctx *Context, name string, args IndexArgs, opts ...ResourceOption) (*Index, error)
public Index(string name, IndexArgs args, CustomResourceOptions? opts = null)
public Index(String name, IndexArgs args)
public Index(String name, IndexArgs args, CustomResourceOptions options)
type: aws-native:kendra:Index
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args IndexArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args IndexArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args IndexArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args IndexArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args IndexArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Index Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The Index resource accepts the following input properties:

Outputs

All input properties are implicitly available as output properties. Additionally, the Index resource produces the following output properties:

Arn string
Id string

The provider-assigned unique ID for this managed resource.

Arn string
Id string

The provider-assigned unique ID for this managed resource.

arn String
id String

The provider-assigned unique ID for this managed resource.

arn string
id string

The provider-assigned unique ID for this managed resource.

arn str
id str

The provider-assigned unique ID for this managed resource.

arn String
id String

The provider-assigned unique ID for this managed resource.

Supporting Types

IndexCapacityUnitsConfiguration

IndexDocumentAttributeValueType

StringValue
STRING_VALUE
StringListValue
STRING_LIST_VALUE
LongValue
LONG_VALUE
DateValue
DATE_VALUE
IndexDocumentAttributeValueTypeStringValue
STRING_VALUE
IndexDocumentAttributeValueTypeStringListValue
STRING_LIST_VALUE
IndexDocumentAttributeValueTypeLongValue
LONG_VALUE
IndexDocumentAttributeValueTypeDateValue
DATE_VALUE
StringValue
STRING_VALUE
StringListValue
STRING_LIST_VALUE
LongValue
LONG_VALUE
DateValue
DATE_VALUE
StringValue
STRING_VALUE
StringListValue
STRING_LIST_VALUE
LongValue
LONG_VALUE
DateValue
DATE_VALUE
STRING_VALUE
STRING_VALUE
STRING_LIST_VALUE
STRING_LIST_VALUE
LONG_VALUE
LONG_VALUE
DATE_VALUE
DATE_VALUE
"STRING_VALUE"
STRING_VALUE
"STRING_LIST_VALUE"
STRING_LIST_VALUE
"LONG_VALUE"
LONG_VALUE
"DATE_VALUE"
DATE_VALUE

IndexDocumentMetadataConfiguration

IndexEdition

DeveloperEdition
DEVELOPER_EDITION
EnterpriseEdition
ENTERPRISE_EDITION
IndexEditionDeveloperEdition
DEVELOPER_EDITION
IndexEditionEnterpriseEdition
ENTERPRISE_EDITION
DeveloperEdition
DEVELOPER_EDITION
EnterpriseEdition
ENTERPRISE_EDITION
DeveloperEdition
DEVELOPER_EDITION
EnterpriseEdition
ENTERPRISE_EDITION
DEVELOPER_EDITION
DEVELOPER_EDITION
ENTERPRISE_EDITION
ENTERPRISE_EDITION
"DEVELOPER_EDITION"
DEVELOPER_EDITION
"ENTERPRISE_EDITION"
ENTERPRISE_EDITION

IndexJsonTokenTypeConfiguration

IndexJwtTokenTypeConfiguration

IndexKeyLocation

Url
URL
SecretManager
SECRET_MANAGER
IndexKeyLocationUrl
URL
IndexKeyLocationSecretManager
SECRET_MANAGER
Url
URL
SecretManager
SECRET_MANAGER
Url
URL
SecretManager
SECRET_MANAGER
URL
URL
SECRET_MANAGER
SECRET_MANAGER
"URL"
URL
"SECRET_MANAGER"
SECRET_MANAGER

IndexOrder

Ascending
ASCENDING
Descending
DESCENDING
IndexOrderAscending
ASCENDING
IndexOrderDescending
DESCENDING
Ascending
ASCENDING
Descending
DESCENDING
Ascending
ASCENDING
Descending
DESCENDING
ASCENDING
ASCENDING
DESCENDING
DESCENDING
"ASCENDING"
ASCENDING
"DESCENDING"
DESCENDING

IndexRelevance

IndexSearch

displayable Boolean
facetable Boolean
searchable Boolean
sortable Boolean
displayable boolean
facetable boolean
searchable boolean
sortable boolean
displayable Boolean
facetable Boolean
searchable Boolean
sortable Boolean

IndexServerSideEncryptionConfiguration

KmsKeyId string
KmsKeyId string
kmsKeyId String
kmsKeyId string
kmsKeyId String

IndexTag

Key string

A string used to identify this tag

Value string

A string containing the value for the tag

Key string

A string used to identify this tag

Value string

A string containing the value for the tag

key String

A string used to identify this tag

value String

A string containing the value for the tag

key string

A string used to identify this tag

value string

A string containing the value for the tag

key str

A string used to identify this tag

value str

A string containing the value for the tag

key String

A string used to identify this tag

value String

A string containing the value for the tag

IndexUserContextPolicy

AttributeFilter
ATTRIBUTE_FILTER
UserToken
USER_TOKEN
IndexUserContextPolicyAttributeFilter
ATTRIBUTE_FILTER
IndexUserContextPolicyUserToken
USER_TOKEN
AttributeFilter
ATTRIBUTE_FILTER
UserToken
USER_TOKEN
AttributeFilter
ATTRIBUTE_FILTER
UserToken
USER_TOKEN
ATTRIBUTE_FILTER
ATTRIBUTE_FILTER
USER_TOKEN
USER_TOKEN
"ATTRIBUTE_FILTER"
ATTRIBUTE_FILTER
"USER_TOKEN"
USER_TOKEN

IndexUserTokenConfiguration

IndexValueImportanceItem

Key string
Value int
Key string
Value int
key String
value Integer
key string
value number
key str
value int
key String
value Number

Package Details

Repository
https://github.com/pulumi/pulumi-aws-native
License
Apache-2.0