`opensearchserverlessCollection` Submodule

Constructs

OpensearchserverlessCollection

Represents a {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/opensearchserverless_collection aws_opensearchserverless_collection}.

Initializers

from cdktn_provider_aws import opensearchserverless_collection

opensearchserverlessCollection.OpensearchserverlessCollection(
  scope: Construct,
  id: str,
  connection: SSHProvisionerConnection | WinrmProvisionerConnection = None,
  count: 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[FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner] = None,
  name: str,
  collection_group_name: str = None,
  description: str = None,
  encryption_config: IResolvable | typing.List[OpensearchserverlessCollectionEncryptionConfig] = None,
  region: str = None,
  standby_replicas: str = None,
  tags: typing.Mapping[str] = None,
  timeouts: OpensearchserverlessCollectionTimeouts = None,
  type: str = None
)

Name	Type	Description
`scope`	`constructs.Construct`	The scope in which to define this construct.
`id`	`str`	The scoped construct ID.
`connection`	`cdktn.SSHProvisionerConnection \| cdktn.WinrmProvisionerConnection`	No description.
`count`	`typing.Union[int, float] \| cdktn.TerraformCount`	No description.
`depends_on`	`typing.List[cdktn.ITerraformDependable]`	No description.
`for_each`	`cdktn.ITerraformIterator`	No description.
`lifecycle`	`cdktn.TerraformResourceLifecycle`	No description.
`provider`	`cdktn.TerraformProvider`	No description.
`provisioners`	`typing.List[cdktn.FileProvisioner \| cdktn.LocalExecProvisioner \| cdktn.RemoteExecProvisioner]`	No description.
`name`	`str`	Name of the collection.
`collection_group_name`	`str`	Name of the collection group to associate with this collection.
`description`	`str`	Description of the collection.
`encryption_config`	`cdktn.IResolvable \| typing.List[OpensearchserverlessCollectionEncryptionConfig]`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/opensearchserverless_collection#encryption_config OpensearchserverlessCollection#encryption_config}.
`region`	`str`	Region where this resource will be managed. Defaults to the Region set in the provider configuration.
`standby_replicas`	`str`	Indicates whether standby replicas should be used for a collection. One of `ENABLED` or `DISABLED`. Defaults to `ENABLED`.
`tags`	`typing.Mapping[str]`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/opensearchserverless_collection#tags OpensearchserverlessCollection#tags}.
`timeouts`	`OpensearchserverlessCollectionTimeouts`	timeouts block.
`type`	`str`	Type of collection. One of `SEARCH`, `TIMESERIES`, or `VECTORSEARCH`. Defaults to `TIMESERIES`.

`scope`^Required

Type: constructs.Construct

The scope in which to define this construct.

`id`^Required

Type: str

The scoped construct ID.

Must be unique amongst siblings in the same scope

`connection`^Optional

Type: cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection

`count`^Optional

Type: typing.Union[int, float] | cdktn.TerraformCount

`depends_on`^Optional

Type: typing.List[cdktn.ITerraformDependable]

`for_each`^Optional

Type: cdktn.ITerraformIterator

`lifecycle`^Optional

Type: cdktn.TerraformResourceLifecycle

`provider`^Optional

Type: cdktn.TerraformProvider

`provisioners`^Optional

Type: typing.List[cdktn.FileProvisioner | cdktn.LocalExecProvisioner | cdktn.RemoteExecProvisioner]

`name`^Required

Type: str

Name of the collection.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/opensearchserverless_collection#name OpensearchserverlessCollection#name}

`collection_group_name`^Optional

Type: str

Name of the collection group to associate with this collection.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/opensearchserverless_collection#collection_group_name OpensearchserverlessCollection#collection_group_name}

`description`^Optional

Type: str

Description of the collection.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/opensearchserverless_collection#description OpensearchserverlessCollection#description}

`encryption_config`^Optional

Type: cdktn.IResolvable | typing.List[OpensearchserverlessCollectionEncryptionConfig]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/opensearchserverless_collection#encryption_config OpensearchserverlessCollection#encryption_config}.

`region`^Optional

Type: str

Region where this resource will be managed. Defaults to the Region set in the provider configuration.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/opensearchserverless_collection#region OpensearchserverlessCollection#region}

`standby_replicas`^Optional

Type: str

Indicates whether standby replicas should be used for a collection. One of ENABLED or DISABLED. Defaults to ENABLED.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/opensearchserverless_collection#standby_replicas OpensearchserverlessCollection#standby_replicas}

`tags`^Optional

Type: typing.Mapping[str]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/opensearchserverless_collection#tags OpensearchserverlessCollection#tags}.

`timeouts`^Optional

Type: OpensearchserverlessCollectionTimeouts

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/opensearchserverless_collection#timeouts OpensearchserverlessCollection#timeouts}

`type`^Optional

Type: str

Type of collection. One of SEARCH, TIMESERIES, or VECTORSEARCH. Defaults to TIMESERIES.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/opensearchserverless_collection#type OpensearchserverlessCollection#type}

Methods

Name	Description
`to_string`	Returns a string representation of this construct.
`with`	Applies one or more mixins to 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`	No description.
`to_metadata`	No description.
`to_terraform`	Adds this resource to the terraform JSON output.
`add_move_target`	Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
`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.
`has_resource_move`	No description.
`import_from`	No description.
`interpolation_for_attribute`	No description.
`move_from_id`	Move the resource corresponding to "id" to this resource.
`move_to`	Moves this resource to the target resource given by moveTarget.
`move_to_id`	Moves this resource to the resource corresponding to "id".
`put_encryption_config`	No description.
`put_timeouts`	No description.
`reset_collection_group_name`	No description.
`reset_description`	No description.
`reset_encryption_config`	No description.
`reset_region`	No description.
`reset_standby_replicas`	No description.
`reset_tags`	No description.
`reset_timeouts`	No description.
`reset_type`	No description.

`to_string`

def to_string() -> str

Returns a string representation of this construct.

`with`

def with(
  mixins: *IMixin
) -> IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

`mixins`^Required

Type: *constructs.IMixin

The mixins to apply.

`add_override`

def add_override(
  path: str,
  value: typing.Any
) -> None

`path`^Required

Type: str

`value`^Required

Type: typing.Any

`override_logical_id`

def override_logical_id(
  new_logical_id: str
) -> None

Overrides the auto-generated logical ID with a specific ID.

`new_logical_id`^Required

Type: str

The new logical ID to use for this stack element.

`reset_override_logical_id`

def reset_override_logical_id() -> None

Resets a previously passed logical Id to use the auto-generated logical id again.

`to_hcl_terraform`

def to_hcl_terraform() -> typing.Any

`to_metadata`

def to_metadata() -> typing.Any

`to_terraform`

def to_terraform() -> typing.Any

Adds this resource to the terraform JSON output.

`add_move_target`

def add_move_target(
  move_target: str
) -> None

Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.

`move_target`^Required

Type: str

The string move target that will correspond to this resource.

`get_any_map_attribute`

def get_any_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Any]

`terraform_attribute`^Required

Type: str

`get_boolean_attribute`

def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable

`terraform_attribute`^Required

Type: str

`get_boolean_map_attribute`

def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]

`terraform_attribute`^Required

Type: str

`get_list_attribute`

def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]

`terraform_attribute`^Required

Type: str

`get_number_attribute`

def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]

`terraform_attribute`^Required

Type: str

`get_number_list_attribute`

def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]

`terraform_attribute`^Required

Type: str

`get_number_map_attribute`

def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]

`terraform_attribute`^Required

Type: str

`get_string_attribute`

def get_string_attribute(
  terraform_attribute: str
) -> str

`terraform_attribute`^Required

Type: str

`get_string_map_attribute`

def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]

`terraform_attribute`^Required

Type: str

`has_resource_move`

def has_resource_move() -> TerraformResourceMoveByTarget | TerraformResourceMoveById

`import_from`

def import_from(
  id: str,
  provider: TerraformProvider = None
) -> None

`id`^Required

Type: str

`provider`^Optional

Type: cdktn.TerraformProvider

`interpolation_for_attribute`

def interpolation_for_attribute(
  terraform_attribute: str
) -> IResolvable

`terraform_attribute`^Required

Type: str

`move_from_id`

def move_from_id(
  id: str
) -> None

Move the resource corresponding to "id" to this resource.

Note that the resource being moved from must be marked as moved using it's instance function.

`id`^Required

Type: str

Full id of resource being moved from, e.g. "aws_s3_bucket.example".

`move_to`

def move_to(
  move_target: str,
  index: str | typing.Union[int, float] = None
) -> None

Moves this resource to the target resource given by moveTarget.

`move_target`^Required

Type: str

The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.

`index`^Optional

Type: str | typing.Union[int, float]

Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.

`move_to_id`

def move_to_id(
  id: str
) -> None

Moves this resource to the resource corresponding to "id".

`id`^Required

Type: str

Full id of resource to move to, e.g. "aws_s3_bucket.example".

`put_encryption_config`

def put_encryption_config(
  value: IResolvable | typing.List[OpensearchserverlessCollectionEncryptionConfig]
) -> None

`value`^Required

Type: cdktn.IResolvable | typing.List[OpensearchserverlessCollectionEncryptionConfig]

`put_timeouts`

def put_timeouts(
  create: str = None,
  delete: str = None
) -> None

`create`^Optional

Type: str

A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/opensearchserverless_collection#create OpensearchserverlessCollection#create}

`delete`^Optional

Type: str

A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/opensearchserverless_collection#delete OpensearchserverlessCollection#delete}

`reset_collection_group_name`

def reset_collection_group_name() -> None

`reset_description`

def reset_description() -> None

`reset_encryption_config`

def reset_encryption_config() -> None

`reset_region`

def reset_region() -> None

`reset_standby_replicas`

def reset_standby_replicas() -> None

`reset_tags`

def reset_tags() -> None

`reset_timeouts`

def reset_timeouts() -> None

`reset_type`

def reset_type() -> None

Static Functions

Name	Description
`is_construct`	Checks if `x` is a construct.
`is_terraform_element`	No description.
`is_terraform_resource`	No description.
`generate_config_for_import`	Generates CDKTN code for importing a OpensearchserverlessCollection resource upon running "cdktn plan ".

`is_construct`

from cdktn_provider_aws import opensearchserverless_collection

opensearchserverlessCollection.OpensearchserverlessCollection.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.

`x`^Required

Type: typing.Any

Any object.

`is_terraform_element`

from cdktn_provider_aws import opensearchserverless_collection

opensearchserverlessCollection.OpensearchserverlessCollection.is_terraform_element(
  x: typing.Any
)

`x`^Required

Type: typing.Any

`is_terraform_resource`

from cdktn_provider_aws import opensearchserverless_collection

opensearchserverlessCollection.OpensearchserverlessCollection.is_terraform_resource(
  x: typing.Any
)

`x`^Required

Type: typing.Any

`generate_config_for_import`

from cdktn_provider_aws import opensearchserverless_collection

opensearchserverlessCollection.OpensearchserverlessCollection.generate_config_for_import(
  scope: Construct,
  import_to_id: str,
  import_from_id: str,
  provider: TerraformProvider = None
)

Generates CDKTN code for importing a OpensearchserverlessCollection resource upon running "cdktn plan ".

`scope`^Required

Type: constructs.Construct

The scope in which to define this construct.

`import_to_id`^Required

Type: str

The construct id used in the generated config for the OpensearchserverlessCollection to import.

`import_from_id`^Required

Type: str

The id of the existing OpensearchserverlessCollection that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/opensearchserverless_collection#import import section} in the documentation of this resource for the id to use

`provider`^Optional

Type: cdktn.TerraformProvider

? Optional instance of the provider where the OpensearchserverlessCollection to import is found.

Properties

Name	Type	Description
`node`	`constructs.Node`	The tree node.
`cdktf_stack`	`cdktn.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`	`cdktn.TerraformProviderGeneratorMetadata`	No description.
`connection`	`cdktn.SSHProvisionerConnection \| cdktn.WinrmProvisionerConnection`	No description.
`count`	`typing.Union[int, float] \| cdktn.TerraformCount`	No description.
`depends_on`	`typing.List[str]`	No description.
`for_each`	`cdktn.ITerraformIterator`	No description.
`lifecycle`	`cdktn.TerraformResourceLifecycle`	No description.
`provider`	`cdktn.TerraformProvider`	No description.
`provisioners`	`typing.List[cdktn.FileProvisioner \| cdktn.LocalExecProvisioner \| cdktn.RemoteExecProvisioner]`	No description.
`arn`	`str`	No description.
`collection_endpoint`	`str`	No description.
`dashboard_endpoint`	`str`	No description.
`encryption_config`	`OpensearchserverlessCollectionEncryptionConfigList`	No description.
`id`	`str`	No description.
`kms_key_arn`	`str`	No description.
`tags_all`	`cdktn.StringMap`	No description.
`timeouts`	`OpensearchserverlessCollectionTimeoutsOutputReference`	No description.
`collection_group_name_input`	`str`	No description.
`description_input`	`str`	No description.
`encryption_config_input`	`cdktn.IResolvable \| typing.List[OpensearchserverlessCollectionEncryptionConfig]`	No description.
`name_input`	`str`	No description.
`region_input`	`str`	No description.
`standby_replicas_input`	`str`	No description.
`tags_input`	`typing.Mapping[str]`	No description.
`timeouts_input`	`cdktn.IResolvable \| OpensearchserverlessCollectionTimeouts`	No description.
`type_input`	`str`	No description.
`collection_group_name`	`str`	No description.
`description`	`str`	No description.
`name`	`str`	No description.
`region`	`str`	No description.
`standby_replicas`	`str`	No description.
`tags`	`typing.Mapping[str]`	No description.
`type`	`str`	No description.

`node`^Required

node: Node

Type: constructs.Node

The tree node.

`cdktf_stack`^Required

cdktf_stack: TerraformStack

Type: cdktn.TerraformStack

`fqn`^Required

fqn: str

Type: str

`friendly_unique_id`^Required

friendly_unique_id: str

Type: str

`terraform_meta_arguments`^Required

terraform_meta_arguments: typing.Mapping[typing.Any]

Type: typing.Mapping[typing.Any]

`terraform_resource_type`^Required

terraform_resource_type: str

Type: str

`terraform_generator_metadata`^Optional

terraform_generator_metadata: TerraformProviderGeneratorMetadata

Type: cdktn.TerraformProviderGeneratorMetadata

`connection`^Optional

connection: SSHProvisionerConnection | WinrmProvisionerConnection

Type: cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection

`count`^Optional

count: typing.Union[int, float] | TerraformCount

Type: typing.Union[int, float] | cdktn.TerraformCount

`depends_on`^Optional

depends_on: typing.List[str]

Type: typing.List[str]

`for_each`^Optional

for_each: ITerraformIterator

Type: cdktn.ITerraformIterator

`lifecycle`^Optional

lifecycle: TerraformResourceLifecycle

Type: cdktn.TerraformResourceLifecycle

`provider`^Optional

provider: TerraformProvider

Type: cdktn.TerraformProvider

`provisioners`^Optional

provisioners: typing.List[FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner]

Type: typing.List[cdktn.FileProvisioner | cdktn.LocalExecProvisioner | cdktn.RemoteExecProvisioner]

`arn`^Required

arn: str

Type: str

`collection_endpoint`^Required

collection_endpoint: str

Type: str

`dashboard_endpoint`^Required

dashboard_endpoint: str

Type: str

`encryption_config`^Required

encryption_config: OpensearchserverlessCollectionEncryptionConfigList

Type: OpensearchserverlessCollectionEncryptionConfigList

`id`^Required

id: str

Type: str

`kms_key_arn`^Required

kms_key_arn: str

Type: str

`tags_all`^Required

tags_all: StringMap

Type: cdktn.StringMap

`timeouts`^Required

timeouts: OpensearchserverlessCollectionTimeoutsOutputReference

Type: OpensearchserverlessCollectionTimeoutsOutputReference

`collection_group_name_input`^Optional

collection_group_name_input: str

Type: str

`description_input`^Optional

description_input: str

Type: str

`encryption_config_input`^Optional

encryption_config_input: IResolvable | typing.List[OpensearchserverlessCollectionEncryptionConfig]

Type: cdktn.IResolvable | typing.List[OpensearchserverlessCollectionEncryptionConfig]

`name_input`^Optional

name_input: str

Type: str

`region_input`^Optional

region_input: str

Type: str

`standby_replicas_input`^Optional

standby_replicas_input: str

Type: str

`tags_input`^Optional

tags_input: typing.Mapping[str]

Type: typing.Mapping[str]

`timeouts_input`^Optional

timeouts_input: IResolvable | OpensearchserverlessCollectionTimeouts

Type: cdktn.IResolvable | OpensearchserverlessCollectionTimeouts

`type_input`^Optional

type_input: str

Type: str

`collection_group_name`^Required

collection_group_name: str

Type: str

`description`^Required

description: str

Type: str

`name`^Required

name: str

Type: str

`region`^Required

region: str

Type: str

`standby_replicas`^Required

standby_replicas: str

Type: str

`tags`^Required

tags: typing.Mapping[str]

Type: typing.Mapping[str]

`type`^Required

type: str

Type: str

Constants

Name	Type	Description
`tfResourceType`	`str`	No description.

`tfResourceType`^Required

tfResourceType: str

Type: str

Structs

OpensearchserverlessCollectionConfig

Initializer

from cdktn_provider_aws import opensearchserverless_collection

opensearchserverlessCollection.OpensearchserverlessCollectionConfig(
  connection: SSHProvisionerConnection | WinrmProvisionerConnection = None,
  count: 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[FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner] = None,
  name: str,
  collection_group_name: str = None,
  description: str = None,
  encryption_config: IResolvable | typing.List[OpensearchserverlessCollectionEncryptionConfig] = None,
  region: str = None,
  standby_replicas: str = None,
  tags: typing.Mapping[str] = None,
  timeouts: OpensearchserverlessCollectionTimeouts = None,
  type: str = None
)

Properties

Name	Type	Description
`connection`	`cdktn.SSHProvisionerConnection \| cdktn.WinrmProvisionerConnection`	No description.
`count`	`typing.Union[int, float] \| cdktn.TerraformCount`	No description.
`depends_on`	`typing.List[cdktn.ITerraformDependable]`	No description.
`for_each`	`cdktn.ITerraformIterator`	No description.
`lifecycle`	`cdktn.TerraformResourceLifecycle`	No description.
`provider`	`cdktn.TerraformProvider`	No description.
`provisioners`	`typing.List[cdktn.FileProvisioner \| cdktn.LocalExecProvisioner \| cdktn.RemoteExecProvisioner]`	No description.
`name`	`str`	Name of the collection.
`collection_group_name`	`str`	Name of the collection group to associate with this collection.
`description`	`str`	Description of the collection.
`encryption_config`	`cdktn.IResolvable \| typing.List[OpensearchserverlessCollectionEncryptionConfig]`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/opensearchserverless_collection#encryption_config OpensearchserverlessCollection#encryption_config}.
`region`	`str`	Region where this resource will be managed. Defaults to the Region set in the provider configuration.
`standby_replicas`	`str`	Indicates whether standby replicas should be used for a collection. One of `ENABLED` or `DISABLED`. Defaults to `ENABLED`.
`tags`	`typing.Mapping[str]`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/opensearchserverless_collection#tags OpensearchserverlessCollection#tags}.
`timeouts`	`OpensearchserverlessCollectionTimeouts`	timeouts block.
`type`	`str`	Type of collection. One of `SEARCH`, `TIMESERIES`, or `VECTORSEARCH`. Defaults to `TIMESERIES`.

`connection`^Optional

connection: SSHProvisionerConnection | WinrmProvisionerConnection

Type: cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection

`count`^Optional

count: typing.Union[int, float] | TerraformCount

Type: typing.Union[int, float] | cdktn.TerraformCount

`depends_on`^Optional

depends_on: typing.List[ITerraformDependable]

Type: typing.List[cdktn.ITerraformDependable]

`for_each`^Optional

for_each: ITerraformIterator

Type: cdktn.ITerraformIterator

`lifecycle`^Optional

lifecycle: TerraformResourceLifecycle

Type: cdktn.TerraformResourceLifecycle

`provider`^Optional

provider: TerraformProvider

Type: cdktn.TerraformProvider

`provisioners`^Optional

provisioners: typing.List[FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner]

Type: typing.List[cdktn.FileProvisioner | cdktn.LocalExecProvisioner | cdktn.RemoteExecProvisioner]

`name`^Required

name: str

Type: str

Name of the collection.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/opensearchserverless_collection#name OpensearchserverlessCollection#name}

`collection_group_name`^Optional

collection_group_name: str

Type: str

Name of the collection group to associate with this collection.

`description`^Optional

description: str

Type: str

Description of the collection.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/opensearchserverless_collection#description OpensearchserverlessCollection#description}

`encryption_config`^Optional

encryption_config: IResolvable | typing.List[OpensearchserverlessCollectionEncryptionConfig]

Type: cdktn.IResolvable | typing.List[OpensearchserverlessCollectionEncryptionConfig]

`region`^Optional

region: str

Type: str

Region where this resource will be managed. Defaults to the Region set in the provider configuration.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/opensearchserverless_collection#region OpensearchserverlessCollection#region}

`standby_replicas`^Optional

standby_replicas: str

Type: str

Indicates whether standby replicas should be used for a collection. One of ENABLED or DISABLED. Defaults to ENABLED.

`tags`^Optional

tags: typing.Mapping[str]

Type: typing.Mapping[str]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/opensearchserverless_collection#tags OpensearchserverlessCollection#tags}.

`timeouts`^Optional

timeouts: OpensearchserverlessCollectionTimeouts

Type: OpensearchserverlessCollectionTimeouts

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/opensearchserverless_collection#timeouts OpensearchserverlessCollection#timeouts}

`type`^Optional

type: str

Type: str

Type of collection. One of SEARCH, TIMESERIES, or VECTORSEARCH. Defaults to TIMESERIES.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/opensearchserverless_collection#type OpensearchserverlessCollection#type}

OpensearchserverlessCollectionEncryptionConfig

Initializer

from cdktn_provider_aws import opensearchserverless_collection

opensearchserverlessCollection.OpensearchserverlessCollectionEncryptionConfig(
  aws_owned_key: bool | IResolvable = None,
  kms_key_arn: str = None
)

Properties

Name	Type	Description
`aws_owned_key`	`bool \| cdktn.IResolvable`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/opensearchserverless_collection#aws_owned_key OpensearchserverlessCollection#aws_owned_key}.
`kms_key_arn`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/opensearchserverless_collection#kms_key_arn OpensearchserverlessCollection#kms_key_arn}.

`aws_owned_key`^Optional

aws_owned_key: bool | IResolvable

Type: bool | cdktn.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/opensearchserverless_collection#aws_owned_key OpensearchserverlessCollection#aws_owned_key}.

`kms_key_arn`^Optional

kms_key_arn: str

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/opensearchserverless_collection#kms_key_arn OpensearchserverlessCollection#kms_key_arn}.

OpensearchserverlessCollectionTimeouts

Initializer

from cdktn_provider_aws import opensearchserverless_collection

opensearchserverlessCollection.OpensearchserverlessCollectionTimeouts(
  create: str = None,
  delete: str = None
)

Properties

Name	Type	Description
`create`	`str`	A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
`delete`	`str`	A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.

`create`^Optional

create: str

Type: str

A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/opensearchserverless_collection#create OpensearchserverlessCollection#create}

`delete`^Optional

delete: str

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/opensearchserverless_collection#delete OpensearchserverlessCollection#delete}

Classes

OpensearchserverlessCollectionEncryptionConfigList

Initializers

from cdktn_provider_aws import opensearchserverless_collection

opensearchserverlessCollection.OpensearchserverlessCollectionEncryptionConfigList(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str,
  wraps_set: bool
)

Name	Type	Description
`terraform_resource`	`cdktn.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).

`terraform_resource`^Required

Type: cdktn.IInterpolatingParent

The parent resource.

`terraform_attribute`^Required

Type: str

The attribute on the parent resource this class is referencing.

`wraps_set`^Required

Type: bool

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

Methods

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.

`all_with_map_key`

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.

`map_key_attribute_name`^Required

Type: str

`compute_fqn`

def compute_fqn() -> str

`resolve`

def resolve(
  _context: IResolveContext
) -> typing.Any

Produce the Token's value at resolution time.

`_context`^Required

Type: cdktn.IResolveContext

`to_string`

def to_string() -> str

Return a string representation of this resolvable object.

Returns a reversible string representation.

`get`

def get(
  index: typing.Union[int, float]
) -> OpensearchserverlessCollectionEncryptionConfigOutputReference

`index`^Required

Type: typing.Union[int, float]

the index of the item to return.

Properties

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.
`internal_value`	`cdktn.IResolvable \| typing.List[OpensearchserverlessCollectionEncryptionConfig]`	No description.

`creation_stack`^Required

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`^Required

fqn: str

Type: str

`internal_value`^Optional

internal_value: IResolvable | typing.List[OpensearchserverlessCollectionEncryptionConfig]

Type: cdktn.IResolvable | typing.List[OpensearchserverlessCollectionEncryptionConfig]

OpensearchserverlessCollectionEncryptionConfigOutputReference

Initializers

from cdktn_provider_aws import opensearchserverless_collection

opensearchserverlessCollection.OpensearchserverlessCollectionEncryptionConfigOutputReference(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str,
  complex_object_index: typing.Union[int, float],
  complex_object_is_from_set: bool
)

Name	Type	Description
`terraform_resource`	`cdktn.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).

`terraform_resource`^Required

Type: cdktn.IInterpolatingParent

The parent resource.

`terraform_attribute`^Required

Type: str

The attribute on the parent resource this class is referencing.

`complex_object_index`^Required

Type: typing.Union[int, float]

the index of this item in the list.

`complex_object_is_from_set`^Required

Type: bool

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

Methods

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.
`reset_aws_owned_key`	No description.
`reset_kms_key_arn`	No description.

`compute_fqn`

def compute_fqn() -> str

`get_any_map_attribute`

def get_any_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Any]

`terraform_attribute`^Required

Type: str

`get_boolean_attribute`

def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable

`terraform_attribute`^Required

Type: str

`get_boolean_map_attribute`

def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]

`terraform_attribute`^Required

Type: str

`get_list_attribute`

def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]

`terraform_attribute`^Required

Type: str

`get_number_attribute`

def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]

`terraform_attribute`^Required

Type: str

`get_number_list_attribute`

def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]

`terraform_attribute`^Required

Type: str

`get_number_map_attribute`

def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]

`terraform_attribute`^Required

Type: str

`get_string_attribute`

def get_string_attribute(
  terraform_attribute: str
) -> str

`terraform_attribute`^Required

Type: str

`get_string_map_attribute`

def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]

`terraform_attribute`^Required

Type: str

`interpolation_for_attribute`

def interpolation_for_attribute(
  property: str
) -> IResolvable

`property`^Required

Type: str

`resolve`

def resolve(
  _context: IResolveContext
) -> typing.Any

Produce the Token's value at resolution time.

`_context`^Required

Type: cdktn.IResolveContext

`to_string`

def to_string() -> str

Return a string representation of this resolvable object.

Returns a reversible string representation.

`reset_aws_owned_key`

def reset_aws_owned_key() -> None

`reset_kms_key_arn`

def reset_kms_key_arn() -> None

Properties

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.
`aws_owned_key_input`	`bool \| cdktn.IResolvable`	No description.
`kms_key_arn_input`	`str`	No description.
`aws_owned_key`	`bool \| cdktn.IResolvable`	No description.
`kms_key_arn`	`str`	No description.
`internal_value`	`cdktn.IResolvable \| OpensearchserverlessCollectionEncryptionConfig`	No description.

`creation_stack`^Required

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`^Required

fqn: str

Type: str

`aws_owned_key_input`^Optional

aws_owned_key_input: bool | IResolvable

Type: bool | cdktn.IResolvable

`kms_key_arn_input`^Optional

kms_key_arn_input: str

Type: str

`aws_owned_key`^Required

aws_owned_key: bool | IResolvable

Type: bool | cdktn.IResolvable

`kms_key_arn`^Required

kms_key_arn: str

Type: str

`internal_value`^Optional

internal_value: IResolvable | OpensearchserverlessCollectionEncryptionConfig

Type: cdktn.IResolvable | OpensearchserverlessCollectionEncryptionConfig

OpensearchserverlessCollectionTimeoutsOutputReference

Initializers

from cdktn_provider_aws import opensearchserverless_collection

opensearchserverlessCollection.OpensearchserverlessCollectionTimeoutsOutputReference(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str
)

Name	Type	Description
`terraform_resource`	`cdktn.IInterpolatingParent`	The parent resource.
`terraform_attribute`	`str`	The attribute on the parent resource this class is referencing.

`terraform_resource`^Required

Type: cdktn.IInterpolatingParent

The parent resource.

`terraform_attribute`^Required

Type: str

The attribute on the parent resource this class is referencing.

Methods

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.
`reset_create`	No description.
`reset_delete`	No description.

`compute_fqn`

def compute_fqn() -> str

`get_any_map_attribute`

def get_any_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Any]

`terraform_attribute`^Required

Type: str

`get_boolean_attribute`

def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable

`terraform_attribute`^Required

Type: str

`get_boolean_map_attribute`

def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]

`terraform_attribute`^Required

Type: str

`get_list_attribute`

def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]

`terraform_attribute`^Required

Type: str

`get_number_attribute`

def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]

`terraform_attribute`^Required

Type: str

`get_number_list_attribute`

def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]

`terraform_attribute`^Required

Type: str

`get_number_map_attribute`

def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]

`terraform_attribute`^Required

Type: str

`get_string_attribute`

def get_string_attribute(
  terraform_attribute: str
) -> str

`terraform_attribute`^Required

Type: str

`get_string_map_attribute`

def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]

`terraform_attribute`^Required

Type: str

`interpolation_for_attribute`

def interpolation_for_attribute(
  property: str
) -> IResolvable

`property`^Required

Type: str

`resolve`

def resolve(
  _context: IResolveContext
) -> typing.Any

Produce the Token's value at resolution time.

`_context`^Required

Type: cdktn.IResolveContext

`to_string`

def to_string() -> str

Return a string representation of this resolvable object.

Returns a reversible string representation.

`reset_create`

def reset_create() -> None

`reset_delete`

def reset_delete() -> None

Properties

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.
`create_input`	`str`	No description.
`delete_input`	`str`	No description.
`create`	`str`	No description.
`delete`	`str`	No description.
`internal_value`	`cdktn.IResolvable \| OpensearchserverlessCollectionTimeouts`	No description.

`creation_stack`^Required

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`^Required

fqn: str

Type: str

`create_input`^Optional

create_input: str

Type: str

`delete_input`^Optional

delete_input: str

Type: str

`create`^Required

create: str

Type: str

`delete`^Required

delete: str

Type: str

`internal_value`^Optional

internal_value: IResolvable | OpensearchserverlessCollectionTimeouts

Type: cdktn.IResolvable | OpensearchserverlessCollectionTimeouts

FilesExpand file tree

opensearchserverlessCollection.python.md

Latest commit

History

opensearchserverlessCollection.python.md

File metadata and controls

opensearchserverlessCollection Submodule

Constructs