Skip to main content

AWSOpenSearchDomain

No description

type AWSOpenSearchDomain {
  metadata: ResourceMetadata!
  arn: String!
  clusterConfiguration: AWSOpenSearchDomainClusterConfiguration
  id: String!
  name: String!
  accessPolicies: AWSOpenSearchDomainAccessPolicies
  advancedOptions: [AWSTag!]!
  advancedSecurityOptions: AWSOpenSearchDomainAdvancedSecurityOptions
  autoTuneOptions: AWSOpenSearchDomainAutoTuneOptions
  changeProgressDetails: AWSOpenSearchDomainChangeProgressDetails
  cognitoOptions: AWSOpenSearchDomainCognitoOptions
  created: Boolean!
  deleted: Boolean!
  domainEndpointOptions: AWSOpenSearchDomainEndpointOptions
  ebsOptions: AWSOpenSearchDomainEBSOptions
  encryptionAtRestOptions: AWSOpenSearchDomainEncryptionAtRestOptions
  endpoint: String!
  endpoints: [AWSTag!]!
  engineVersion: String!
  logPublishingOptions: [AWSOpenSearchDomainLogPublishingOption!]!
  nodeToNodeEncryptionOptions: AWSOpenSearchDomainNodeToNodeEncryptionOptions
  offPeakWindowOptions: AWSOpenSearchDomainOffPeakWindowOptions
  processing: Boolean!
  serviceSoftwareOptions: AWSOpenSearchDomainServiceSoftwareOptions
  softwareUpdateOptions: AWSOpenSearchDomainSoftwareUpdateOptions
  upgradeProcessing: Boolean!
  vpcOptions: AWSOpenSearchDomainVPCOptions
}

Fields​

AWSOpenSearchDomain.metadata ● ResourceMetadata! non-null object​

The metadata to identify this resource in Shisho Cloud

AWSOpenSearchDomain.arn ● String! non-null scalar​

The Amazon Resource Name (ARN) of the domain

AWSOpenSearchDomain.clusterConfiguration ● AWSOpenSearchDomainClusterConfiguration object​

The cluster configuration of the domain

AWSOpenSearchDomain.id ● String! non-null scalar​

The unique identifier for the domain

AWSOpenSearchDomain.name ● String! non-null scalar​

The name of the domain

AWSOpenSearchDomain.accessPolicies ● AWSOpenSearchDomainAccessPolicies object​

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

AWSOpenSearchDomain.advancedOptions ● [AWSTag!]! non-null object​

Key-value pairs that specify advanced configuration options

AWSOpenSearchDomain.advancedSecurityOptions ● AWSOpenSearchDomainAdvancedSecurityOptions object​

The current status of the Elasticsearch domain's advanced security options

AWSOpenSearchDomain.autoTuneOptions ● AWSOpenSearchDomainAutoTuneOptions object​

Auto-Tune settings for the domain

AWSOpenSearchDomain.changeProgressDetails ● AWSOpenSearchDomainChangeProgressDetails object​

Information about a configuration change happening on the domain

AWSOpenSearchDomain.cognitoOptions ● AWSOpenSearchDomainCognitoOptions object​

Key-value pairs to configure Amazon Cognito authentication for OpenSearch Dashboards

AWSOpenSearchDomain.created ● Boolean! non-null scalar​

Creation status of an OpenSearch Service domain

AWSOpenSearchDomain.deleted ● Boolean! non-null scalar​

Deletion status of an OpenSearch Service domain

AWSOpenSearchDomain.domainEndpointOptions ● AWSOpenSearchDomainEndpointOptions object​

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

AWSOpenSearchDomain.ebsOptions ● AWSOpenSearchDomainEBSOptions object​

Container for EBS-based storage settings for the domain

AWSOpenSearchDomain.encryptionAtRestOptions ● AWSOpenSearchDomainEncryptionAtRestOptions object​

Encryption at rest settings for the domain

AWSOpenSearchDomain.endpoint ● String! non-null scalar​

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

AWSOpenSearchDomain.endpoints ● [AWSTag!]! non-null object​

The key-value pair that exists if the OpenSearch Service domain uses VPC endpoints

AWSOpenSearchDomain.engineVersion ● String! non-null scalar​

Version of OpenSearch or Elasticsearch that the domain is running, in the format Elasticsearch_X.Y or OpenSearch_X.Y

AWSOpenSearchDomain.logPublishingOptions ● [AWSOpenSearchDomainLogPublishingOption!]! non-null object​

Log publishing options for the domain

AWSOpenSearchDomain.nodeToNodeEncryptionOptions ● AWSOpenSearchDomainNodeToNodeEncryptionOptions object​

Whether node-to-node encryption is enabled or disabled

AWSOpenSearchDomain.offPeakWindowOptions ● AWSOpenSearchDomainOffPeakWindowOptions object​

Options that specify a custom 10-hour window during which OpenSearch Service can perform configuration changes on the domain

AWSOpenSearchDomain.processing ● Boolean! non-null scalar​

The status of the domain configuration

AWSOpenSearchDomain.serviceSoftwareOptions ● AWSOpenSearchDomainServiceSoftwareOptions object​

The current status of the domain's service software

AWSOpenSearchDomain.softwareUpdateOptions ● AWSOpenSearchDomainSoftwareUpdateOptions object​

Service software update options for the domain

AWSOpenSearchDomain.upgradeProcessing ● Boolean! non-null scalar​

The status of a domain version upgrade

AWSOpenSearchDomain.vpcOptions ● AWSOpenSearchDomainVPCOptions object​

The VPC options for the specified domain

Member of​

AWSOpenSearch object