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< ? encryptionConfigs, Input<ServerlessCollectionEncryptionConfig> ?>String?> ? kmsKeyArn, Input<String?> ? name, Input<String?> ? region, Input<String?> ? standbyReplicas, Input<Map< ? tags, Input<String, String> ?>Map< ? tagsAll, Input<String, String> ?>ServerlessCollectionTimeouts?> ? timeouts, Input<String?> ? type, Input<List< ? vectorOptions})ServerlessCollectionVectorOption> ?> -
Creates a new ServerlessCollectionState.
arnARN of the collection.collectionEndpointCollection-specific endpoint used to submit index, search, and data upload requests to an OpenSearch Serverless collection.collectionGroupNameName of the collection group to associate with this collection.dashboardEndpointCollection-specific endpoint used to access OpenSearch Dashboards.descriptionDescription of the collection.encryptionConfigsConfiguration block for direct collection encryption settings. SeeencryptionConfigbelow for details.kmsKeyArnARN of the Amazon Web Services KMS key used to encrypt the collection.nameName of the collection.regionRegion where this resource will be managed. Defaults to the Region set in the provider configuration.standbyReplicasWhether standby replicas should be used for a collection. One ofENABLEDorDISABLED. Defaults toENABLED.tagsMap of tags assigned to the resource. If configured with a providerdefaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.tagsAllMap of tags assigned to the resource, including those inherited from the providerdefaultTagsconfiguration block.timeoutsOptional.typeType of collection. One ofSEARCH,TIMESERIES, orVECTORSEARCH. Defaults toTIMESERIES.vectorOptionsConfiguration block for vector search options. Only valid whentypeisVECTORSEARCH. SeevectorOptionsbelow 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
encryptionConfigbelow 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
ENABLEDorDISABLED. Defaults toENABLED.final -
Map of tags assigned to the resource. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.final -
Map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration block.final -
timeouts
→ Input<
ServerlessCollectionTimeouts?> ? -
final
-
type
→ Input<
String?> ? -
Type of collection. One of
SEARCH,TIMESERIES, orVECTORSEARCH. Defaults toTIMESERIES.final -
vectorOptions
→ Input<
List< ?ServerlessCollectionVectorOption> ?> -
Configuration block for vector search options. Only valid when
typeisVECTORSEARCH. SeevectorOptionsbelow 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