Domain

opensearchservice.services.k8s.aws/v1alpha1

Metadata#

Spec#

accessPolicies: string
advancedOptions: {}
advancedSecurityOptions: 
  anonymousAuthEnabled: boolean
  enabled: boolean
  internalUserDatabaseEnabled: boolean
  jwtOptions: 
    enabled: boolean
    publicKey: string
    rolesKey: string
    subjectKey: string
  masterUserOptions: 
    masterUserARN: string
    masterUserName: string
    masterUserPassword: 
      key: string
      name: string
      namespace: string
  sAMLOptions: 
    enabled: boolean
    idp: 
      entityID: string
      metadataContent: string
    masterBackendRole: string
    masterUserName: string
    rolesKey: string
    sessionTimeoutMinutes: integer
    subjectKey: string
aimlOptions: 
  naturalLanguageQueryGenerationOptions: 
    desiredState: string
autoTuneOptions: 
  desiredState: string
  maintenanceSchedules:
  - cronExpressionForRecurrence: string
    duration: 
      unit: string
      value: integer
    startAt: string
  useOffPeakWindow: boolean
clusterConfig: 
  coldStorageOptions: 
    enabled: boolean
  dedicatedMasterCount: integer
  dedicatedMasterEnabled: boolean
  dedicatedMasterType: string
  instanceCount: integer
  instanceType: string
  multiAZWithStandbyEnabled: boolean
  warmCount: integer
  warmEnabled: boolean
  warmType: string
  zoneAwarenessConfig: 
    availabilityZoneCount: integer
  zoneAwarenessEnabled: boolean
cognitoOptions: 
  enabled: boolean
  identityPoolID: string
  roleARN: string
  userPoolID: string
domainEndpointOptions: 
  customEndpoint: string
  customEndpointCertificateARN: string
  customEndpointEnabled: boolean
  enforceHTTPS: boolean
  tlsSecurityPolicy: string
ebsOptions: 
  ebsEnabled: boolean
  iops: integer
  throughput: integer
  volumeSize: integer
  volumeType: string
encryptionAtRestOptions: 
  enabled: boolean
  kmsKeyID: string
engineVersion: string
ipAddressType: string
logPublishingOptions: {}
name: string
nodeToNodeEncryptionOptions: 
  enabled: boolean
offPeakWindowOptions: 
  enabled: boolean
  offPeakWindow: 
    windowStartTime: 
      hours: integer
      minutes: integer
softwareUpdateOptions: 
  autoSoftwareUpdateEnabled: boolean
tags:
- key: string
  value: string
vpcOptions: 
  securityGroupIDs:
  - string
  subnetIDs:
  - string

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). || autoTuneOptions.maintenanceSchedules.[].cronExpressionForRecurrence
Optional | string
| | autoTuneOptions.maintenanceSchedules.[].duration
Optional | 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). | | autoTuneOptions.maintenanceSchedules.[].duration.unit
Optional | string
The unit of a maintenance schedule duration. Valid value is HOUR. | | autoTuneOptions.maintenanceSchedules.[].duration.value
Optional | integer
Integer that specifies the value of a maintenance schedule duration. | | autoTuneOptions.maintenanceSchedules.[].startAt
Optional | string
| | autoTuneOptions.useOffPeakWindow
Optional | boolean
| | clusterConfig
Optional | object
Container for the cluster configuration of a domain. | | clusterConfig.coldStorageOptions
Optional | 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). | | clusterConfig.coldStorageOptions.enabled
Optional | boolean
| | clusterConfig.dedicatedMasterCount
Optional | integer
| | clusterConfig.dedicatedMasterEnabled
Optional | boolean
| | clusterConfig.dedicatedMasterType
Optional | string
| | clusterConfig.instanceCount
Optional | integer
| | clusterConfig.instanceType
Optional | string
| | clusterConfig.multiAZWithStandbyEnabled
Optional | boolean
| | clusterConfig.warmCount
Optional | integer
| | clusterConfig.warmEnabled
Optional | boolean
| | clusterConfig.warmType
Optional | string
| | clusterConfig.zoneAwarenessConfig
Optional | object
The zone awareness configuration for an Amazon OpenSearch Service domain. | | clusterConfig.zoneAwarenessConfig.availabilityZoneCount
Optional | integer
| | clusterConfig.zoneAwarenessEnabled
Optional | boolean
| | cognitoOptions
Optional | 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). | | cognitoOptions.enabled
Optional | boolean
| | cognitoOptions.identityPoolID
Optional | string
| | cognitoOptions.roleARN
Optional | string
| | cognitoOptions.userPoolID
Optional | string
| | domainEndpointOptions
Optional | object
Additional options for the domain endpoint, such as whether to require HTTPS
for all traffic. | | domainEndpointOptions.customEndpoint
Optional | string
| | domainEndpointOptions.customEndpointCertificateARN
Optional | 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. | | domainEndpointOptions.customEndpointEnabled
Optional | boolean
| | domainEndpointOptions.enforceHTTPS
Optional | boolean
| | domainEndpointOptions.tlsSecurityPolicy
Optional | string
| | ebsOptions
Optional | object
Container for the parameters required to enable EBS-based storage for an
OpenSearch Service domain. | | ebsOptions.ebsEnabled
Optional | boolean
| | ebsOptions.iops
Optional | integer
| | ebsOptions.throughput
Optional | integer
| | ebsOptions.volumeSize
Optional | integer
| | ebsOptions.volumeType
Optional | 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). | | encryptionAtRestOptions
Optional | object
Key-value pairs to enable encryption at rest. | | encryptionAtRestOptions.enabled
Optional | boolean
| | encryptionAtRestOptions.kmsKeyID
Optional | string
| | engineVersion
Optional | string
String of format Elasticsearch_X.Y or OpenSearch_X.Y to specify the engine
version for the OpenSearch Service domain. For example, OpenSearch_1.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). | | ipAddressType
Optional | 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. | | logPublishingOptions
Optional | object
Key-value pairs to configure log publishing. | | name
Required | 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. | | nodeToNodeEncryptionOptions
Optional | object
Enables node-to-node encryption. | | nodeToNodeEncryptionOptions.enabled
Optional | boolean
| | offPeakWindowOptions
Optional | 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. | | offPeakWindowOptions.enabled
Optional | boolean
| | offPeakWindowOptions.offPeakWindow
Optional | 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). | | offPeakWindowOptions.offPeakWindow.windowStartTime
Optional | object
The desired start time for an off-peak maintenance window (https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_OffPeakWindow.html). | | offPeakWindowOptions.offPeakWindow.windowStartTime.hours
Optional | integer
| | offPeakWindowOptions.offPeakWindow.windowStartTime.minutes
Optional | integer
| | softwareUpdateOptions
Optional | object
Software update options for the domain. | | softwareUpdateOptions.autoSoftwareUpdateEnabled
Optional | boolean
| | tags
Optional | array
List of tags to add to the domain upon creation. | | tags.[]
Required | object
A tag (key-value pair) for an Amazon OpenSearch Service resource. || tags.[].key
Optional | 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. | | tags.[].value
Optional | 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. | | vpcOptions
Optional | 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). | | vpcOptions.securityGroupIDs
Optional | array
| | vpcOptions.securityGroupIDs.[]
Required | string
|| vpcOptions.subnetIDs
Optional | array
| | vpcOptions.subnetIDs.[]
Required | string
|

Status#

ackResourceMetadata: 
  arn: string
  ownerAccountID: string
  region: string
changeProgressDetails: 
  changeID: string
  configChangeStatus: string
  initiatedBy: string
  lastUpdatedTime: string
  message: string
  startTime: string
conditions:
- lastTransitionTime: string
  message: string
  reason: string
  status: string
  type: string
created: boolean
deleted: boolean
domainEndpointV2HostedZoneID: string
domainID: string
domainProcessingStatus: string
endpoint: string
endpointV2: string
endpoints: {}
modifyingProperties:
- activeValue: string
  name: string
  pendingValue: string
  valueType: string
processing: boolean
serviceSoftwareOptions: 
  automatedUpdateDate: string
  cancellable: boolean
  currentVersion: string
  description: string
  newVersion: string
  optionalDeployment: boolean
  updateAvailable: boolean
  updateStatus: string
snapshotOptions: 
  automatedSnapshotStartHour: integer
upgradeProcessing: boolean