Collection
opensearchserverless.services.k8s.aws/v1alpha1
| Type | Link |
|---|---|
| GoDoc | opensearchserverless-controller/apis/v1alpha1#Collection |
Metadata
| Property | Value |
|---|---|
| Scope | Namespaced |
| Kind | Collection |
| ListKind | CollectionList |
| Plural | collections |
| Singular | collection |
Spec
description: string
name: string
standbyReplicas: string
tags:
- key: string
value: string
type: string
| Field | Description |
|---|---|
| description Optional | string Description of the collection. |
| name Required | string Name of the collection. Regex Pattern: ^[a-z][a-z0-9-]+$ |
| standbyReplicas Optional | string Indicates whether standby replicas should be used for a collection. |
| tags Optional | array An arbitrary set of tags (key–value pairs) to associate with the OpenSearch Serverless collection. |
| tags.[] Required | object A map of key-value pairs associated to an OpenSearch Serverless resource. |
| tags.[].value Optional | string |
| type Optional | string The type of collection. |
Status
ackResourceMetadata:
arn: string
ownerAccountID: string
region: string
conditions:
- lastTransitionTime: string
message: string
reason: string
status: string
type: string
createdDate: integer
id: string
kmsKeyARN: string
lastModifiedDate: integer
status: string
| Field | Description |
|---|---|
| ackResourceMetadata Optional | object All CRs managed by ACK have a common Status.ACKResourceMetadata memberthat is used to contain resource sync state, account ownership, constructed ARN for the resource |
| ackResourceMetadata.arn Optional | string ARN is the Amazon Resource Name for the resource. This is a globally-unique identifier and is set only by the ACK service controller once the controller has orchestrated the creation of the resource OR when it has verified that an “adopted” resource (a resource where the ARN annotation was set by the Kubernetes user on the CR) exists and matches the supplied CR’s Spec field values. https://github.com/aws/aws-controllers-k8s/issues/270 |
| ackResourceMetadata.ownerAccountID Required | string OwnerAccountID is the AWS Account ID of the account that owns the backend AWS service API resource. |
| ackResourceMetadata.region Required | string Region is the AWS region in which the resource exists or will exist. |
| conditions Optional | array All CRs managed by ACK have a common Status.Conditions member thatcontains a collection of ackv1alpha1.Condition objects that describethe various terminal states of the CR and its backend AWS service API resource |
| conditions.[] Required | object Condition is the common struct used by all CRDs managed by ACK service |
| controllers to indicate terminal states of the CR and its backend AWS | |
| service API resource | |
| conditions.[].message Optional | string A human readable message indicating details about the transition. |
| conditions.[].reason Optional | string The reason for the condition’s last transition. |
| conditions.[].status Optional | string Status of the condition, one of True, False, Unknown. |
| conditions.[].type Optional | string Type is the type of the Condition |
| createdDate Optional | integer The Epoch time when the collection was created. |
| id Optional | string The unique identifier of the collection. Regex Pattern: ^[a-z0-9]{3,40}$ |
| kmsKeyARN Optional | string The Amazon Resource Name (ARN) of the KMS key with which to encrypt the collection. |
| lastModifiedDate Optional | integer The date and time when the collection was last modified. |
| status Optional | string The current status of the collection. |