Domain

opensearchservice.services.k8s.aws/v1alpha1

TypeLink
GoDocopensearchservice-controller/apis/v1alpha1#Domain

Metadata

PropertyValue
ScopeNamespaced
KindDomain
ListKindDomainList
Pluraldomains
Singulardomain

Spec

accessPolicies: string
advancedOptions: {}
advancedSecurityOptions: 
  enabled: boolean
  internalUserDatabaseEnabled: boolean
  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
autoTuneOptions: 
  desiredState: string
  maintenanceSchedules:
  - cronExpressionForRecurrence: string
    duration: 
      unit: string
      value: integer
    startAt: string
clusterConfig: 
  coldStorageOptions: 
    enabled: boolean
  dedicatedMasterCount: integer
  dedicatedMasterEnabled: boolean
  dedicatedMasterType: string
  instanceCount: integer
  instanceType: string
  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
  volumeSize: integer
  volumeType: string
encryptionAtRestOptions: 
  enabled: boolean
  kmsKeyID: string
engineVersion: string
logPublishingOptions: {}
name: string
nodeToNodeEncryptionOptions: 
  enabled: boolean
tags:
- key: string
  value: string
vpcOptions: 
  securityGroupIDs:
  - string
  subnetIDs:
  - string
FieldDescription
accessPolicies
Optional
string
IAM access policy as a JSON-formatted string.
advancedOptions
Optional
object
Option to allow references to indices in an HTTP request body. Must be false when configuring access to individual sub-resources. By default, the value is true. See Advanced cluster parameters (http://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html#createdomain-configure-advanced-options) for more information.
advancedSecurityOptions
Optional
object
Specifies advanced security options.
advancedSecurityOptions.enabled
Optional
boolean
advancedSecurityOptions.internalUserDatabaseEnabled
Optional
boolean
advancedSecurityOptions.masterUserOptions
Optional
object
Credentials for the master user: username and password, ARN, or both.
advancedSecurityOptions.masterUserOptions.masterUserARN
Optional
string
The Amazon Resource Name (ARN) of the domain. See Identifiers for IAM Entities (http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html) in Using AWS Identity and Access Management for more information.
advancedSecurityOptions.masterUserOptions.masterUserName
Optional
string
advancedSecurityOptions.masterUserOptions.masterUserPassword
Optional
object
SecretKeyReference combines a k8s corev1.SecretReference with a specific key within the referred-to Secret
advancedSecurityOptions.masterUserOptions.masterUserPassword.key
Required
string
Key is the key within the secret
advancedSecurityOptions.masterUserOptions.masterUserPassword.name
Optional
string
Name is unique within a namespace to reference a secret resource.
advancedSecurityOptions.masterUserOptions.masterUserPassword.namespace
Optional
string
Namespace defines the space within which the secret name must be unique.
advancedSecurityOptions.sAMLOptions
Optional
object
The SAML application configuration for the domain.
advancedSecurityOptions.sAMLOptions.enabled
Optional
boolean
advancedSecurityOptions.sAMLOptions.idp
Optional
object
The SAML identity povider’s information.
advancedSecurityOptions.sAMLOptions.idp.entityID
Optional
string
advancedSecurityOptions.sAMLOptions.idp.metadataContent
Optional
string
advancedSecurityOptions.sAMLOptions.masterBackendRole
Optional
string
advancedSecurityOptions.sAMLOptions.masterUserName
Optional
string
advancedSecurityOptions.sAMLOptions.rolesKey
Optional
string
advancedSecurityOptions.sAMLOptions.sessionTimeoutMinutes
Optional
integer
advancedSecurityOptions.sAMLOptions.subjectKey
Optional
string
autoTuneOptions
Optional
object
Specifies Auto-Tune options.
autoTuneOptions.desiredState
Optional
string
The Auto-Tune desired state. Valid values are ENABLED and DISABLED.
autoTuneOptions.maintenanceSchedules
Optional
array
autoTuneOptions.maintenanceSchedules.[]
Required
object
Specifies the Auto-Tune maintenance schedule. See Auto-Tune for Amazon OpenSearch Service (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html) for more information.
autoTuneOptions.maintenanceSchedules.[].duration
Optional
object
The maintenance schedule duration: duration value and duration unit. See Auto-Tune for Amazon OpenSearch Service (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html) for more information.
autoTuneOptions.maintenanceSchedules.[].duration.unit
Optional
string
The unit of a maintenance schedule duration. Valid value is HOUR. See Auto-Tune for Amazon OpenSearch Service (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html) for more information.
autoTuneOptions.maintenanceSchedules.[].duration.value
Optional
integer
Integer to specify the value of a maintenance schedule duration. See Auto-Tune for Amazon OpenSearch Service (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html) for more information.
autoTuneOptions.maintenanceSchedules.[].startAt
Optional
string
clusterConfig
Optional
object
Configuration options for a domain. Specifies the instance type and number of instances in the domain.
clusterConfig.coldStorageOptions
Optional
object
Specifies the configuration for cold storage options such as enabled
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.warmCount
Optional
integer
clusterConfig.warmEnabled
Optional
boolean
clusterConfig.warmType
Optional
string
clusterConfig.zoneAwarenessConfig
Optional
object
The zone awareness configuration for the domain cluster, such as the number of availability zones.
clusterConfig.zoneAwarenessConfig.availabilityZoneCount
Optional
integer
clusterConfig.zoneAwarenessEnabled
Optional
boolean
cognitoOptions
Optional
object
Options to specify the Cognito user and identity pools for OpenSearch Dashboards authentication. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards (http://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
Options to specify configurations that will be applied to the domain endpoint.
domainEndpointOptions.customEndpoint
Optional
string
domainEndpointOptions.customEndpointCertificateARN
Optional
string
The Amazon Resource Name (ARN) of the domain. See Identifiers for IAM Entities (http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html) in Using AWS Identity and Access Management for more information.
domainEndpointOptions.customEndpointEnabled
Optional
boolean
domainEndpointOptions.enforceHTTPS
Optional
boolean
domainEndpointOptions.tlsSecurityPolicy
Optional
string
ebsOptions
Optional
object
Options to enable, disable, and specify the type and size of EBS storage volumes.
ebsOptions.ebsEnabled
Optional
boolean
ebsOptions.iops
Optional
integer
ebsOptions.volumeSize
Optional
integer
ebsOptions.volumeType
Optional
string
The type of EBS volume, standard, gp2, or io1. See Configuring EBS-based Storage (http://docs.aws.amazon.com/opensearch-service/latest/developerguide/opensearch-createupdatedomains.html#opensearch-createdomain-configure-ebs) for more information.
encryptionAtRestOptions
Optional
object
Options for encryption of data 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 Amazon OpenSearch Service domain. For example, “OpenSearch_1.0” or “Elasticsearch_7.9”. For more information, see Creating and managing Amazon OpenSearch Service domains (http://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html#createdomains).
logPublishingOptions
Optional
object
Map of LogType and LogPublishingOption, each containing options to publish a given type of OpenSearch log.
name
Required
string
The name of the Amazon OpenSearch Service domain you’re creating. Domain names are unique across the domains owned by an account within an AWS region. Domain names must start with a lowercase letter and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).
nodeToNodeEncryptionOptions
Optional
object
Node-to-node encryption options.
nodeToNodeEncryptionOptions.enabled
Optional
boolean
tags
Optional
array
A list of Tag added during domain creation.
tags.[]
Required
object
A key value pair for a resource tag.
tags.[].value
Optional
string
A string of length from 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
Options to specify the subnets and security groups for a VPC endpoint. For more information, see Launching your Amazon OpenSearch Service domains using a VPC (http://docs.aws.amazon.com/opensearch-service/latest/developerguide/vpc.html).
vpcOptions.securityGroupIDs
Optional
array
vpcOptions.securityGroupIDs.[]
Required
string
vpcOptions.subnetIDs.[]
Required
string

Status

ackResourceMetadata: 
  arn: string
  ownerAccountID: string
  region: string
conditions:
- lastTransitionTime: string
  message: string
  reason: string
  status: string
  type: string
created: boolean
deleted: boolean
domainID: string
endpoint: string
endpoints: {}
processing: boolean
serviceSoftwareOptions: 
  automatedUpdateDate: string
  cancellable: boolean
  currentVersion: string
  description: string
  newVersion: string
  optionalDeployment: boolean
  updateAvailable: boolean
  updateStatus: string
snapshotOptions: 
  automatedSnapshotStartHour: integer
upgradeProcessing: boolean
FieldDescription
ackResourceMetadata
Optional
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
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. TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse 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 that contains a collection of ackv1alpha1.Condition objects that describe the 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
created
Optional
boolean
The domain creation status. True if the creation of a domain is complete. False if domain creation is still in progress.
deleted
Optional
boolean
The domain deletion status. True if a delete request has been received for the domain but resource cleanup is still in progress. False if the domain has not been deleted. Once domain deletion is complete, the status of the domain is no longer returned.
domainID
Optional
string
The unique identifier for the specified domain.
endpoint
Optional
string
The domain endpoint that you use to submit index and search requests.
endpoints
Optional
object
Map containing the domain endpoints used to submit index and search requests. Example key, value: ‘vpc’,‘vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com’.
processing
Optional
boolean
The status of the domain configuration. True if Amazon OpenSearch Service is processing configuration changes. False if the configuration is active.
serviceSoftwareOptions
Optional
object
The current status of the domain’s service software.
serviceSoftwareOptions.automatedUpdateDate
Optional
string
serviceSoftwareOptions.cancellable
Optional
boolean
serviceSoftwareOptions.currentVersion
Optional
string
serviceSoftwareOptions.description
Optional
string
serviceSoftwareOptions.newVersion
Optional
string
serviceSoftwareOptions.optionalDeployment
Optional
boolean
serviceSoftwareOptions.updateAvailable
Optional
boolean
serviceSoftwareOptions.updateStatus
Optional
string
snapshotOptions
Optional
object
The status of the SnapshotOptions.
snapshotOptions.automatedSnapshotStartHour
Optional
integer
upgradeProcessing
Optional
boolean
The status of a domain version upgrade. True if Amazon OpenSearch Service is undergoing a version upgrade. False if the configuration is active.