DomainList (opensearchservice.services.k8s.aws/v1alpha1)

Type: object

DomainList is a list of Domain

Type: string

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

Type: array

List of domains. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md

No Additional Items

Each item of this array must be:

aws.k8s.services.opensearchservice.v1alpha1.Domain

Type: object

Domain is the Schema for the Domains API

Type: string

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

Type: string

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta

Type: object

Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

Type: object

Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations

Each additional property must conform to the following schema

Type: string

io.k8s.apimachinery.pkg.apis.meta.v1.Time

Type: string

CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.

Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

Type: integerFormat: int64

Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.

io.k8s.apimachinery.pkg.apis.meta.v1.Time

Type: string

DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.

Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

Same definition as creationTimestamp

Type: array of string

Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list.

No Additional Items

Each item of this array must be:

Type: string

GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.

If this field is specified and the generated name exists, the server will return a 409.

Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency

Type: integerFormat: int64

A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.

Type: object

Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels

Each additional property must conform to the following schema

Type: string

Type: array

ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object.

No Additional Items

Each item of this array must be:

io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry

Type: object

ManagedFieldsEntry is a workflow-id, a FieldSet and the group version of the resource that the fieldset applies to.

Type: string

APIVersion defines the version of this resource that this field set applies to. The format is "group/version" just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted.

Type: string

FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1"

io.k8s.apimachinery.pkg.apis.meta.v1.FieldsV1

Type: object

FieldsV1 holds the first JSON version format as described in the "FieldsV1" type.

Type: string

Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'.

Type: string

Subresource is the name of the subresource used to update that object, or empty string if the object was updated through the main resource. The value of this field is used to distinguish between managers, even if they share the same name. For example, a status update will be distinct from a regular update using the same manager name. Note that the APIVersion field is not related to the Subresource field and it always corresponds to the version of the main resource.

io.k8s.apimachinery.pkg.apis.meta.v1.Time

Type: string

Time is the timestamp of when the ManagedFields entry was added. The timestamp will also be updated if a field is added, the manager changes any of the owned fields value or removes a field. The timestamp does not update when a field is removed from the entry because another manager took it over.

Same definition as creationTimestamp

Type: string

Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names

Type: string

Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.

Must be a DNS_LABEL. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces

Type: array

List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.

No Additional Items

Each item of this array must be:

io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference

Type: object

OwnerReference contains enough information to let you identify an owning object. An owning object must be in the same namespace as the dependent, or be cluster-scoped, so there is no namespace field.

Type: boolean

If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. See https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion for how the garbage collector interacts with this field and enforces the foreground deletion. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.

Type: string

Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

Type: string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names

Type: string

UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids

Type: string

An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.

Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

Type: string

UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.

Populated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids

Type: object

DomainSpec defines the desired state of Domain.

Type: string

Identity and Access Management (IAM) policy document specifying the access
policies for the new domain.

Regex Pattern: .*

Type: object

Key-value pairs to specify advanced configuration options. The following
key-value pairs are supported:

  • "rest.action.multi.allowexplicitindex": "true" | "false" - Note the
    use of a string rather than a boolean. Specifies whether explicit references
    to indexes are allowed inside the body of HTTP requests. If you want to
    configure access policies for domain sub-resources, such as specific indexes
    and domain APIs, you must disable this property. Default is true.

  • "indices.fielddata.cache.size": "80" - Note the use of a string rather
    than a boolean. Specifies the percentage of heap space allocated to field
    data. Default is unbounded.

  • "indices.query.bool.maxclausecount": "1024" - Note the use of a string
    rather than a boolean. Specifies the maximum number of clauses allowed
    in a Lucene boolean query. Default is 1,024. Queries with more than the
    permitted number of clauses result in a TooManyClauses error.

  • "overridemainresponse_version": "true" | "false" - Note the use of
    a string rather than a boolean. Specifies whether the domain reports its
    version as 7.10 to allow Elasticsearch OSS clients and plugins to continue
    working with it. Default is false when creating a domain and true when
    upgrading a domain.

For more information, see Advanced cluster parameters (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html#createdomain-configure-advanced-options).

Each additional property must conform to the following schema

Type: string

Type: object

Options for fine-grained access control.

Type: object

Credentials for the master user for a domain.

Type: string

The Amazon Resource Name (ARN) of the domain. See Identifiers for IAM Entities
(https://docs.aws.amazon.com/IAM/latest/UserGuide/index.html) in Using Amazon
Web Services Identity and Access Management for more information.

Type: object

SecretKeyReference combines a k8s corev1.SecretReference with a
specific key within the referred-to Secret

Type: string

name is unique within a namespace to reference a secret resource.

Type: string

namespace defines the space within which the secret name must be unique.

Type: object

The SAML authentication configuration for an Amazon OpenSearch Service domain.

Type: object

Options for all machine learning features for the specified domain.

Type: object

Options for Auto-Tune.

Type: string

The Auto-Tune desired state. Valid values are ENABLED and DISABLED.

Type: array of object
No Additional Items

Each item of this array must be:

Type: object

This object is deprecated. Use the domain's off-peak window (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/off-peak.html)
to schedule Auto-Tune optimizations. For migration instructions, see Migrating
from Auto-Tune maintenance windows (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/off-peak.html#off-peak-migrate).

The Auto-Tune maintenance schedule. For more information, see Auto-Tune for
Amazon OpenSearch Service (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html).

Type: object

The duration of a maintenance schedule. For more information, see Auto-Tune
for Amazon OpenSearch Service (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html).

Type: string

The unit of a maintenance schedule duration. Valid value is HOUR.

Type: integerFormat: int64

Integer that specifies the value of a maintenance schedule duration.

Type: object

Container for the cluster configuration of a domain.

Type: object

Container for the parameters required to enable cold storage for an OpenSearch
Service domain. For more information, see Cold storage for Amazon OpenSearch
Service (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/cold-storage.html).

Type: object

The zone awareness configuration for an Amazon OpenSearch Service domain.

Type: object

Key-value pairs to configure Amazon Cognito authentication. For more information,
see Configuring Amazon Cognito authentication for OpenSearch Dashboards (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/cognito-auth.html).

Type: object

Additional options for the domain endpoint, such as whether to require HTTPS
for all traffic.

Type: string

The Amazon Resource Name (ARN) of the domain. See Identifiers for IAM Entities
(https://docs.aws.amazon.com/IAM/latest/UserGuide/index.html) in Using Amazon
Web Services Identity and Access Management for more information.

Type: object

Container for the parameters required to enable EBS-based storage for an
OpenSearch Service domain.

Type: string

The type of EBS volume that a domain uses. For more information, see Configuring
EBS-based storage (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/opensearch-createupdatedomains.html#opensearch-createdomain-configure-ebs).

Type: string

String of format ElasticsearchX.Y or OpenSearchX.Y to specify the engine
version for the OpenSearch Service domain. For example, OpenSearch1.0 or
Elasticsearch
7.9. For more information, see Creating and managing Amazon
OpenSearch Service domains (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html#createdomains).

Regex Pattern: ^Elasticsearch_[0-9]{1}\.[0-9]{1,2}$|^OpenSearch_[0-9]{1,2}\.[0-9]{1,2}$

Type: string

Specify either dual stack or IPv4 as your IP address type. Dual stack allows
you to share domain resources across IPv4 and IPv6 address types, and is
the recommended option. If you set your IP address type to dual stack, you
can't change your address type later.

Type: object

Key-value pairs to configure log publishing.

Each additional property must conform to the following schema

Type: object

Specifies whether the Amazon OpenSearch Service domain publishes the OpenSearch
application and slow logs to Amazon CloudWatch. For more information, see
Monitoring OpenSearch logs with Amazon CloudWatch Logs (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/createdomain-configure-slow-logs.html).

After you enable log publishing, you still have to enable the collection
of slow logs using the OpenSearch REST API.

Type: string

Name of the OpenSearch Service domain to create. Domain names are unique
across the domains owned by an account within an Amazon Web Services Region.

Regex Pattern: ^[a-z][a-z0-9\-]+$

Type: object

Specifies a daily 10-hour time block during which OpenSearch Service can
perform configuration changes on the domain, including service software updates
and Auto-Tune enhancements that require a blue/green deployment. If no options
are specified, the default start time of 10:00 P.M. local time (for the Region
that the domain is created in) is used.

Type: object

A custom 10-hour, low-traffic window during which OpenSearch Service can
perform mandatory configuration changes on the domain. These actions can
include scheduled service software updates and blue/green Auto-Tune enhancements.
OpenSearch Service will schedule these actions during the window that you
specify.

If you don't specify a window start time, it defaults to 10:00 P.M. local
time.

For more information, see Defining off-peak maintenance windows for Amazon
OpenSearch Service (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/off-peak.html).

Type: object

The desired start time for an off-peak maintenance window (https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_OffPeakWindow.html).

Type: array of object

List of tags to add to the domain upon creation.

No Additional Items

Each item of this array must be:

Type: object

A tag (key-value pair) for an Amazon OpenSearch Service resource.

Type: string

A string between 1 to 128 characters that specifies the key for a tag. Tag
keys must be unique for the domain to which they're attached.

Type: string

A string between 0 to 256 characters that specifies the value for a tag.
Tag values can be null and don't have to be unique in a tag set.

Type: object

Container for the values required to configure VPC access domains. If you
don't specify these values, OpenSearch Service creates the domain with a
public endpoint. For more information, see Launching your Amazon OpenSearch
Service domains using a VPC (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/vpc.html).

Type: array of object

Reference field for SecurityGroupIDs

No Additional Items

Each item of this array must be:

Type: object

AWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference
type to provide more user friendly syntax for references using 'from' field
Ex:
APIIDRef:

from:
  name: my-api

Type: array of object

Reference field for SubnetIDs

No Additional Items

Each item of this array must be:

Type: object

AWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference
type to provide more user friendly syntax for references using 'from' field
Ex:
APIIDRef:

from:
  name: my-api

Type: object

AWSResourceReference provides all the values necessary to reference another
k8s resource for finding the identifier(Id/ARN/Name)

Type: object

DomainStatus defines the observed state of Domain

Type: object

All CRs managed by ACK have a common Status.ACKResourceMetadata member
that is used to contain resource sync state, account ownership,
constructed ARN for the resource

Type: 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

Type: string

OwnerAccountID is the AWS Account ID of the account that owns the
backend AWS service API resource.

Type: string

Partition is the AWS partition in which the resource exists or will exist

Type: string

Region is the AWS region in which the resource exists or will exist.

Type: array of object

All CRs managed by ACK have a common Status.Conditions member that
contains a collection of ackv1alpha1.Condition objects that describe
the various terminal states of the CR and its backend AWS service API
resource

No Additional Items

Each item of this array must be:

Type: 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

Type: stringFormat: date-time

Last time the condition transitioned from one status to another.

Type: string

A human readable message indicating details about the transition.

Type: string

The reason for the condition's last transition.

Type: string

Status of the condition, one of True, False, Unknown.

Type: boolean

Creation status of an OpenSearch Service domain. True if domain creation
is complete. False if domain creation is still in progress.

Type: boolean

Deletion status of an OpenSearch Service domain. True if domain deletion
is complete. False if domain deletion is still in progress. Once deletion
is complete, the status of the domain is no longer returned.

Type: string

The dual stack hosted zone ID for the domain.

Type: string

Unique identifier for the domain.

Type: string

The status of any changes that are currently in progress for the domain.

Type: string

Domain-specific endpoint used to submit index, search, and data upload requests
to the domain.

Type: string

If IPAddressType to set to dualstack, a version 2 domain endpoint is provisioned.
This endpoint functions like a normal endpoint, except that it works with
both IPv4 and IPv6 IP addresses. Normal endpoints work only with IPv4 IP
addresses.

Type: object

The key-value pair that exists if the OpenSearch Service domain uses VPC
endpoints. For example:

  • IPv4 IP addresses - 'vpc','vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com'

  • Dual stack IP addresses - 'vpcv2':'vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.aos.us-east-1.on.aws'

Each additional property must conform to the following schema

Type: string

Type: boolean

The status of the domain configuration. True if OpenSearch Service is processing
configuration changes. False if the configuration is active.

Type: object

DEPRECATED. Container for parameters required to configure automated snapshots
of domain indexes.

Type: boolean

The status of a domain version upgrade to a new version of OpenSearch or
Elasticsearch. True if OpenSearch Service is in the process of a version
upgrade. False if the configuration is active.

Type: string

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta

Type: object

Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

Type: string

continue may be set if the user set a limit on the number of items returned, and indicates that the server has more data available. The value is opaque and may be used to issue another request to the endpoint that served this list to retrieve the next set of available objects. Continuing a consistent list may not be possible if the server configuration has changed or more than a few minutes have passed. The resourceVersion field returned when using this continue value will be identical to the value in the first response, unless you have received this token from an error message.

Type: integerFormat: int64

remainingItemCount is the number of subsequent items in the list which are not included in this list response. If the list request contained label or field selectors, then the number of remaining items is unknown and the field will be left unset and omitted during serialization. If the list is complete (either because it is not chunking or because this is the last chunk), then there are no more remaining items and this field will be left unset and omitted during serialization. Servers older than v1.15 do not set this field. The intended use of the remainingItemCount is estimating the size of a collection. Clients should not rely on the remainingItemCount to be set or to be exact.

Type: string

String that identifies the server's internal version of this object that can be used by clients to determine when objects have changed. Value must be treated as opaque by clients and passed unmodified back to the server. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency