Represents a {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/data-sources/kendra_thesaurus aws_kendra_thesaurus}.
from cdktf_cdktf_provider_aws import data_aws_kendra_thesaurus
dataAwsKendraThesaurus.DataAwsKendraThesaurus(
scope: Construct,
id: str,
connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection] = None,
count: typing.Union[typing.Union[int, float], TerraformCount] = None,
depends_on: typing.List[ITerraformDependable] = None,
for_each: ITerraformIterator = None,
lifecycle: TerraformResourceLifecycle = None,
provider: TerraformProvider = None,
provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]] = None,
index_id: str,
thesaurus_id: str,
id: str = None,
tags: typing.Mapping[str] = None
)
Name | Type | Description |
---|---|---|
scope |
constructs.Construct |
The scope in which to define this construct. |
id |
str |
The scoped construct ID. |
connection |
typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection] |
No description. |
count |
typing.Union[typing.Union[int, float], cdktf.TerraformCount] |
No description. |
depends_on |
typing.List[cdktf.ITerraformDependable] |
No description. |
for_each |
cdktf.ITerraformIterator |
No description. |
lifecycle |
cdktf.TerraformResourceLifecycle |
No description. |
provider |
cdktf.TerraformProvider |
No description. |
provisioners |
typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]] |
No description. |
index_id |
str |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/data-sources/kendra_thesaurus#index_id DataAwsKendraThesaurus#index_id}. |
thesaurus_id |
str |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/data-sources/kendra_thesaurus#thesaurus_id DataAwsKendraThesaurus#thesaurus_id}. |
id |
str |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/data-sources/kendra_thesaurus#id DataAwsKendraThesaurus#id}. |
tags |
typing.Mapping[str] |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/data-sources/kendra_thesaurus#tags DataAwsKendraThesaurus#tags}. |
- Type: constructs.Construct
The scope in which to define this construct.
- Type: str
The scoped construct ID.
Must be unique amongst siblings in the same scope
- Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]
- Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]
- Type: typing.List[cdktf.ITerraformDependable]
- Type: cdktf.ITerraformIterator
- Type: cdktf.TerraformResourceLifecycle
- Type: cdktf.TerraformProvider
- Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]
- Type: str
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/data-sources/kendra_thesaurus#index_id DataAwsKendraThesaurus#index_id}.
- Type: str
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/data-sources/kendra_thesaurus#thesaurus_id DataAwsKendraThesaurus#thesaurus_id}.
- Type: str
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/data-sources/kendra_thesaurus#id DataAwsKendraThesaurus#id}.
Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.
- Type: typing.Mapping[str]
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/data-sources/kendra_thesaurus#tags DataAwsKendraThesaurus#tags}.
Name | Description |
---|---|
to_string |
Returns a string representation of this construct. |
add_override |
No description. |
override_logical_id |
Overrides the auto-generated logical ID with a specific ID. |
reset_override_logical_id |
Resets a previously passed logical Id to use the auto-generated logical id again. |
to_hcl_terraform |
Adds this resource to the terraform JSON output. |
to_metadata |
No description. |
to_terraform |
Adds this resource to the terraform JSON output. |
get_any_map_attribute |
No description. |
get_boolean_attribute |
No description. |
get_boolean_map_attribute |
No description. |
get_list_attribute |
No description. |
get_number_attribute |
No description. |
get_number_list_attribute |
No description. |
get_number_map_attribute |
No description. |
get_string_attribute |
No description. |
get_string_map_attribute |
No description. |
interpolation_for_attribute |
No description. |
reset_id |
No description. |
reset_tags |
No description. |
def to_string() -> str
Returns a string representation of this construct.
def add_override(
path: str,
value: typing.Any
) -> None
- Type: str
- Type: typing.Any
def override_logical_id(
new_logical_id: str
) -> None
Overrides the auto-generated logical ID with a specific ID.
- Type: str
The new logical ID to use for this stack element.
def reset_override_logical_id() -> None
Resets a previously passed logical Id to use the auto-generated logical id again.
def to_hcl_terraform() -> typing.Any
Adds this resource to the terraform JSON output.
def to_metadata() -> typing.Any
def to_terraform() -> typing.Any
Adds this resource to the terraform JSON output.
def get_any_map_attribute(
terraform_attribute: str
) -> typing.Mapping[typing.Any]
- Type: str
def get_boolean_attribute(
terraform_attribute: str
) -> IResolvable
- Type: str
def get_boolean_map_attribute(
terraform_attribute: str
) -> typing.Mapping[bool]
- Type: str
def get_list_attribute(
terraform_attribute: str
) -> typing.List[str]
- Type: str
def get_number_attribute(
terraform_attribute: str
) -> typing.Union[int, float]
- Type: str
def get_number_list_attribute(
terraform_attribute: str
) -> typing.List[typing.Union[int, float]]
- Type: str
def get_number_map_attribute(
terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]
- Type: str
def get_string_attribute(
terraform_attribute: str
) -> str
- Type: str
def get_string_map_attribute(
terraform_attribute: str
) -> typing.Mapping[str]
- Type: str
def interpolation_for_attribute(
terraform_attribute: str
) -> IResolvable
- Type: str
def reset_id() -> None
def reset_tags() -> None
Name | Description |
---|---|
is_construct |
Checks if x is a construct. |
is_terraform_element |
No description. |
is_terraform_data_source |
No description. |
generate_config_for_import |
Generates CDKTF code for importing a DataAwsKendraThesaurus resource upon running "cdktf plan ". |
from cdktf_cdktf_provider_aws import data_aws_kendra_thesaurus
dataAwsKendraThesaurus.DataAwsKendraThesaurus.is_construct(
x: typing.Any
)
Checks if x
is a construct.
Use this method instead of instanceof
to properly detect Construct
instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the constructs
library on
disk are seen as independent, completely different libraries. As a
consequence, the class Construct
in each copy of the constructs
library
is seen as a different class, and an instance of one class will not test as
instanceof
the other class. npm install
will not create installations
like this, but users may manually symlink construct libraries together or
use a monorepo tool: in those cases, multiple copies of the constructs
library can be accidentally installed, and instanceof
will behave
unpredictably. It is safest to avoid using instanceof
, and using
this type-testing method instead.
- Type: typing.Any
Any object.
from cdktf_cdktf_provider_aws import data_aws_kendra_thesaurus
dataAwsKendraThesaurus.DataAwsKendraThesaurus.is_terraform_element(
x: typing.Any
)
- Type: typing.Any
from cdktf_cdktf_provider_aws import data_aws_kendra_thesaurus
dataAwsKendraThesaurus.DataAwsKendraThesaurus.is_terraform_data_source(
x: typing.Any
)
- Type: typing.Any
from cdktf_cdktf_provider_aws import data_aws_kendra_thesaurus
dataAwsKendraThesaurus.DataAwsKendraThesaurus.generate_config_for_import(
scope: Construct,
import_to_id: str,
import_from_id: str,
provider: TerraformProvider = None
)
Generates CDKTF code for importing a DataAwsKendraThesaurus resource upon running "cdktf plan ".
- Type: constructs.Construct
The scope in which to define this construct.
- Type: str
The construct id used in the generated config for the DataAwsKendraThesaurus to import.
- Type: str
The id of the existing DataAwsKendraThesaurus that should be imported.
Refer to the {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/data-sources/kendra_thesaurus#import import section} in the documentation of this resource for the id to use
- Type: cdktf.TerraformProvider
? Optional instance of the provider where the DataAwsKendraThesaurus to import is found.
Name | Type | Description |
---|---|---|
node |
constructs.Node |
The tree node. |
cdktf_stack |
cdktf.TerraformStack |
No description. |
fqn |
str |
No description. |
friendly_unique_id |
str |
No description. |
terraform_meta_arguments |
typing.Mapping[typing.Any] |
No description. |
terraform_resource_type |
str |
No description. |
terraform_generator_metadata |
cdktf.TerraformProviderGeneratorMetadata |
No description. |
count |
typing.Union[typing.Union[int, float], cdktf.TerraformCount] |
No description. |
depends_on |
typing.List[str] |
No description. |
for_each |
cdktf.ITerraformIterator |
No description. |
lifecycle |
cdktf.TerraformResourceLifecycle |
No description. |
provider |
cdktf.TerraformProvider |
No description. |
arn |
str |
No description. |
created_at |
str |
No description. |
description |
str |
No description. |
error_message |
str |
No description. |
file_size_bytes |
typing.Union[int, float] |
No description. |
name |
str |
No description. |
role_arn |
str |
No description. |
source_s3_path |
DataAwsKendraThesaurusSourceS3PathList |
No description. |
status |
str |
No description. |
synonym_rule_count |
typing.Union[int, float] |
No description. |
term_count |
typing.Union[int, float] |
No description. |
updated_at |
str |
No description. |
id_input |
str |
No description. |
index_id_input |
str |
No description. |
tags_input |
typing.Mapping[str] |
No description. |
thesaurus_id_input |
str |
No description. |
id |
str |
No description. |
index_id |
str |
No description. |
tags |
typing.Mapping[str] |
No description. |
thesaurus_id |
str |
No description. |
node: Node
- Type: constructs.Node
The tree node.
cdktf_stack: TerraformStack
- Type: cdktf.TerraformStack
fqn: str
- Type: str
friendly_unique_id: str
- Type: str
terraform_meta_arguments: typing.Mapping[typing.Any]
- Type: typing.Mapping[typing.Any]
terraform_resource_type: str
- Type: str
terraform_generator_metadata: TerraformProviderGeneratorMetadata
- Type: cdktf.TerraformProviderGeneratorMetadata
count: typing.Union[typing.Union[int, float], TerraformCount]
- Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]
depends_on: typing.List[str]
- Type: typing.List[str]
for_each: ITerraformIterator
- Type: cdktf.ITerraformIterator
lifecycle: TerraformResourceLifecycle
- Type: cdktf.TerraformResourceLifecycle
provider: TerraformProvider
- Type: cdktf.TerraformProvider
arn: str
- Type: str
created_at: str
- Type: str
description: str
- Type: str
error_message: str
- Type: str
file_size_bytes: typing.Union[int, float]
- Type: typing.Union[int, float]
name: str
- Type: str
role_arn: str
- Type: str
source_s3_path: DataAwsKendraThesaurusSourceS3PathList
status: str
- Type: str
synonym_rule_count: typing.Union[int, float]
- Type: typing.Union[int, float]
term_count: typing.Union[int, float]
- Type: typing.Union[int, float]
updated_at: str
- Type: str
id_input: str
- Type: str
index_id_input: str
- Type: str
tags_input: typing.Mapping[str]
- Type: typing.Mapping[str]
thesaurus_id_input: str
- Type: str
id: str
- Type: str
index_id: str
- Type: str
tags: typing.Mapping[str]
- Type: typing.Mapping[str]
thesaurus_id: str
- Type: str
Name | Type | Description |
---|---|---|
tfResourceType |
str |
No description. |
tfResourceType: str
- Type: str
from cdktf_cdktf_provider_aws import data_aws_kendra_thesaurus
dataAwsKendraThesaurus.DataAwsKendraThesaurusConfig(
connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection] = None,
count: typing.Union[typing.Union[int, float], TerraformCount] = None,
depends_on: typing.List[ITerraformDependable] = None,
for_each: ITerraformIterator = None,
lifecycle: TerraformResourceLifecycle = None,
provider: TerraformProvider = None,
provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]] = None,
index_id: str,
thesaurus_id: str,
id: str = None,
tags: typing.Mapping[str] = None
)
Name | Type | Description |
---|---|---|
connection |
typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection] |
No description. |
count |
typing.Union[typing.Union[int, float], cdktf.TerraformCount] |
No description. |
depends_on |
typing.List[cdktf.ITerraformDependable] |
No description. |
for_each |
cdktf.ITerraformIterator |
No description. |
lifecycle |
cdktf.TerraformResourceLifecycle |
No description. |
provider |
cdktf.TerraformProvider |
No description. |
provisioners |
typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]] |
No description. |
index_id |
str |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/data-sources/kendra_thesaurus#index_id DataAwsKendraThesaurus#index_id}. |
thesaurus_id |
str |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/data-sources/kendra_thesaurus#thesaurus_id DataAwsKendraThesaurus#thesaurus_id}. |
id |
str |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/data-sources/kendra_thesaurus#id DataAwsKendraThesaurus#id}. |
tags |
typing.Mapping[str] |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/data-sources/kendra_thesaurus#tags DataAwsKendraThesaurus#tags}. |
connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection]
- Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]
count: typing.Union[typing.Union[int, float], TerraformCount]
- Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]
depends_on: typing.List[ITerraformDependable]
- Type: typing.List[cdktf.ITerraformDependable]
for_each: ITerraformIterator
- Type: cdktf.ITerraformIterator
lifecycle: TerraformResourceLifecycle
- Type: cdktf.TerraformResourceLifecycle
provider: TerraformProvider
- Type: cdktf.TerraformProvider
provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]]
- Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]
index_id: str
- Type: str
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/data-sources/kendra_thesaurus#index_id DataAwsKendraThesaurus#index_id}.
thesaurus_id: str
- Type: str
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/data-sources/kendra_thesaurus#thesaurus_id DataAwsKendraThesaurus#thesaurus_id}.
id: str
- Type: str
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/data-sources/kendra_thesaurus#id DataAwsKendraThesaurus#id}.
Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.
tags: typing.Mapping[str]
- Type: typing.Mapping[str]
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.78.0/docs/data-sources/kendra_thesaurus#tags DataAwsKendraThesaurus#tags}.
from cdktf_cdktf_provider_aws import data_aws_kendra_thesaurus
dataAwsKendraThesaurus.DataAwsKendraThesaurusSourceS3Path()
from cdktf_cdktf_provider_aws import data_aws_kendra_thesaurus
dataAwsKendraThesaurus.DataAwsKendraThesaurusSourceS3PathList(
terraform_resource: IInterpolatingParent,
terraform_attribute: str,
wraps_set: bool
)
Name | Type | Description |
---|---|---|
terraform_resource |
cdktf.IInterpolatingParent |
The parent resource. |
terraform_attribute |
str |
The attribute on the parent resource this class is referencing. |
wraps_set |
bool |
whether the list is wrapping a set (will add tolist() to be able to access an item via an index). |
- Type: cdktf.IInterpolatingParent
The parent resource.
- Type: str
The attribute on the parent resource this class is referencing.
- Type: bool
whether the list is wrapping a set (will add tolist() to be able to access an item via an index).
Name | Description |
---|---|
all_with_map_key |
Creating an iterator for this complex list. |
compute_fqn |
No description. |
resolve |
Produce the Token's value at resolution time. |
to_string |
Return a string representation of this resolvable object. |
get |
No description. |
def all_with_map_key(
map_key_attribute_name: str
) -> DynamicListTerraformIterator
Creating an iterator for this complex list.
The list will be converted into a map with the mapKeyAttributeName as the key.
- Type: str
def compute_fqn() -> str
def resolve(
_context: IResolveContext
) -> typing.Any
Produce the Token's value at resolution time.
- Type: cdktf.IResolveContext
def to_string() -> str
Return a string representation of this resolvable object.
Returns a reversible string representation.
def get(
index: typing.Union[int, float]
) -> DataAwsKendraThesaurusSourceS3PathOutputReference
- Type: typing.Union[int, float]
the index of the item to return.
Name | Type | Description |
---|---|---|
creation_stack |
typing.List[str] |
The creation stack of this resolvable which will be appended to errors thrown during resolution. |
fqn |
str |
No description. |
creation_stack: typing.List[str]
- Type: typing.List[str]
The creation stack of this resolvable which will be appended to errors thrown during resolution.
If this returns an empty array the stack will not be attached.
fqn: str
- Type: str
from cdktf_cdktf_provider_aws import data_aws_kendra_thesaurus
dataAwsKendraThesaurus.DataAwsKendraThesaurusSourceS3PathOutputReference(
terraform_resource: IInterpolatingParent,
terraform_attribute: str,
complex_object_index: typing.Union[int, float],
complex_object_is_from_set: bool
)
Name | Type | Description |
---|---|---|
terraform_resource |
cdktf.IInterpolatingParent |
The parent resource. |
terraform_attribute |
str |
The attribute on the parent resource this class is referencing. |
complex_object_index |
typing.Union[int, float] |
the index of this item in the list. |
complex_object_is_from_set |
bool |
whether the list is wrapping a set (will add tolist() to be able to access an item via an index). |
- Type: cdktf.IInterpolatingParent
The parent resource.
- Type: str
The attribute on the parent resource this class is referencing.
- Type: typing.Union[int, float]
the index of this item in the list.
- Type: bool
whether the list is wrapping a set (will add tolist() to be able to access an item via an index).
Name | Description |
---|---|
compute_fqn |
No description. |
get_any_map_attribute |
No description. |
get_boolean_attribute |
No description. |
get_boolean_map_attribute |
No description. |
get_list_attribute |
No description. |
get_number_attribute |
No description. |
get_number_list_attribute |
No description. |
get_number_map_attribute |
No description. |
get_string_attribute |
No description. |
get_string_map_attribute |
No description. |
interpolation_for_attribute |
No description. |
resolve |
Produce the Token's value at resolution time. |
to_string |
Return a string representation of this resolvable object. |
def compute_fqn() -> str
def get_any_map_attribute(
terraform_attribute: str
) -> typing.Mapping[typing.Any]
- Type: str
def get_boolean_attribute(
terraform_attribute: str
) -> IResolvable
- Type: str
def get_boolean_map_attribute(
terraform_attribute: str
) -> typing.Mapping[bool]
- Type: str
def get_list_attribute(
terraform_attribute: str
) -> typing.List[str]
- Type: str
def get_number_attribute(
terraform_attribute: str
) -> typing.Union[int, float]
- Type: str
def get_number_list_attribute(
terraform_attribute: str
) -> typing.List[typing.Union[int, float]]
- Type: str
def get_number_map_attribute(
terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]
- Type: str
def get_string_attribute(
terraform_attribute: str
) -> str
- Type: str
def get_string_map_attribute(
terraform_attribute: str
) -> typing.Mapping[str]
- Type: str
def interpolation_for_attribute(
property: str
) -> IResolvable
- Type: str
def resolve(
_context: IResolveContext
) -> typing.Any
Produce the Token's value at resolution time.
- Type: cdktf.IResolveContext
def to_string() -> str
Return a string representation of this resolvable object.
Returns a reversible string representation.
Name | Type | Description |
---|---|---|
creation_stack |
typing.List[str] |
The creation stack of this resolvable which will be appended to errors thrown during resolution. |
fqn |
str |
No description. |
bucket |
str |
No description. |
key |
str |
No description. |
internal_value |
DataAwsKendraThesaurusSourceS3Path |
No description. |
creation_stack: typing.List[str]
- Type: typing.List[str]
The creation stack of this resolvable which will be appended to errors thrown during resolution.
If this returns an empty array the stack will not be attached.
fqn: str
- Type: str
bucket: str
- Type: str
key: str
- Type: str
internal_value: DataAwsKendraThesaurusSourceS3Path