ServerlessCollectionState class

Input properties used for looking up and filtering ServerlessCollection resources.

Constructors

ServerlessCollectionState({Input<String?>? arn, Input<String?>? collectionEndpoint, Input<String?>? collectionGroupName, Input<String?>? dashboardEndpoint, Input<String?>? description, Input<List<ServerlessCollectionEncryptionConfig>?>? encryptionConfigs, Input<String?>? kmsKeyArn, Input<String?>? name, Input<String?>? region, Input<String?>? standbyReplicas, Input<Map<String, String>?>? tags, Input<Map<String, String>?>? tagsAll, Input<ServerlessCollectionTimeouts?>? timeouts, Input<String?>? type, Input<List<ServerlessCollectionVectorOption>?>? vectorOptions})
Creates a new ServerlessCollectionState. arn ARN of the collection. collectionEndpoint Collection-specific endpoint used to submit index, search, and data upload requests to an OpenSearch Serverless collection. collectionGroupName Name of the collection group to associate with this collection. dashboardEndpoint Collection-specific endpoint used to access OpenSearch Dashboards. description Description of the collection. encryptionConfigs Configuration block for direct collection encryption settings. See encryptionConfig below for details. kmsKeyArn ARN of the Amazon Web Services KMS key used to encrypt the collection. name Name of the collection. region Region where this resource will be managed. Defaults to the Region set in the provider configuration. standbyReplicas Whether standby replicas should be used for a collection. One of ENABLED or DISABLED. Defaults to ENABLED. tags Map of tags assigned to the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level. tagsAll Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block. timeouts Optional. type Type of collection. One of SEARCH, TIMESERIES, or VECTORSEARCH. Defaults to TIMESERIES. vectorOptions Configuration block for vector search options. Only valid when type is VECTORSEARCH. See vectorOptions below for details.
const
ServerlessCollectionState.fromMap(Map<String, dynamic> map)
factory

Properties

arn → Input<String?>?
ARN of the collection.
final
collectionEndpoint → Input<String?>?
Collection-specific endpoint used to submit index, search, and data upload requests to an OpenSearch Serverless collection.
final
collectionGroupName → Input<String?>?
Name of the collection group to associate with this collection.
final
dashboardEndpoint → Input<String?>?
Collection-specific endpoint used to access OpenSearch Dashboards.
final
description → Input<String?>?
Description of the collection.
final
encryptionConfigs → Input<List<ServerlessCollectionEncryptionConfig>?>?
Configuration block for direct collection encryption settings. See encryptionConfig below for details.
final
hashCode → int
The hash code for this object.
no setterinherited
kmsKeyArn → Input<String?>?
ARN of the Amazon Web Services KMS key used to encrypt the collection.
final
name → Input<String?>?
Name of the collection.
final
region → Input<String?>?
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
standbyReplicas → Input<String?>?
Whether standby replicas should be used for a collection. One of ENABLED or DISABLED. Defaults to ENABLED.
final
tags → Input<Map<String, String>?>?
Map of tags assigned to the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
final
tagsAll → Input<Map<String, String>?>?
Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
final
timeouts → Input<ServerlessCollectionTimeouts?>?
final
type → Input<String?>?
Type of collection. One of SEARCH, TIMESERIES, or VECTORSEARCH. Defaults to TIMESERIES.
final
vectorOptions → Input<List<ServerlessCollectionVectorOption>?>?
Configuration block for vector search options. Only valid when type is VECTORSEARCH. See vectorOptions below for details.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited