OpenSearch

3 resource kinds. Generated from the operator's CRD schemas.

API Group: aws.konfig.io/v1alpha1

OpenSearchApplication # CLOUD CONTROL · AWS::OpenSearchService::Application

OpenSearchApplication manages AWS::OpenSearchService::Application through the AWS Cloud Control API.

kubectl get opensearchapplications · example on GitHub

Example

# OpenSearchApplication — OpenSearch
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/opensearch.html#opensearchapplication
apiVersion: aws.konfig.io/v1alpha1
kind: OpenSearchApplication
metadata:
  name: example-opensearchapplication
  namespace: default
spec:
  appConfigs:
  - key: opensearchDashboards.dashboardAdmin.users
    value: example
  dataSources:
  - dataSourceDescription: Managed by konfig-konector
  endpoint: example
  iamIdentityCenterOptions:
    enabled: true
    iamRoleForIdentityCenterApplicationArn: arn:aws:iam::123456789012:role/example-role
  kmsKeyArn: arn:aws:iam::123456789012:role/example-role
  name: example-opensearchapplication
  providerRef:
    name: example-opensearchapplication
    region: us-east-1
  tags:
  - key: example
    value: example

Spec

Field	Type	Required	Description
`appConfigs`	array<object>	—	List of application configurations.
`appConfigs[].key`	enum	yes	The configuration key Allowed: `opensearchDashboards.dashboardAdmin.users, opensearchDashboards.dashboardAdmin.groups`
`appConfigs[].value`	string	yes	The configuration value.
`dataSources`	array<object>	—	List of data sources.
`dataSources[].dataSourceArn`	object	yes	The ARN of the data source.
`dataSources[].dataSourceDescription`	string	—	Description of the data source.
`endpoint`	string	—	The endpoint for the application.
`iamIdentityCenterOptions`	object	—	Options for configuring IAM Identity Center
`iamIdentityCenterOptions.enabled`	boolean	—	Whether IAM Identity Center is enabled.
`iamIdentityCenterOptions.iamIdentityCenterInstanceArn`	object	—	The ARN of the IAM Identity Center instance.
`iamIdentityCenterOptions.iamRoleForIdentityCenterApplicationArn`	string	—	The ARN of the IAM role for Identity Center application.
`kmsKeyArn`	string	—	The ARN of the KMS key used to encrypt the application.
`name`	string	yes	The name of the application.
`providerRef`	object	—	ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
`providerRef.name`	string	yes	Name of a cluster-scoped AWSProvider.
`providerRef.region`	string	—	Region overrides the provider's region for this resource only.
`tags`	array<object>	—	An arbitrary set of tags (key-value pairs) for this application.
`tags[].key`	string	yes
`tags[].value`	string	yes

Status

Field	Type	Required	Description
`arn`	string	—	Amazon Resource Name (ARN) format.
`attempt`	integer	—	Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure.
`awsProvider`	object	—	AWSProvider confirms the account and region this resource was reconciled against.
`awsProvider.accountId`	string	—	AccountID the resource lives in.
`awsProvider.name`	string	—	Name of the AWSProvider used; empty when the operator's own credentials were used.
`awsProvider.region`	string	—	Region the resource lives in (empty for global services).
`conditions`	array<object>	—	Conditions describe the current state of the resource.
`conditions[].lastTransitionTime`	string	yes	lastTransitionTime is the last time the condition transitioned from one status to another.
`conditions[].message`	string	yes	message is a human readable message indicating details about the transition.
`conditions[].observedGeneration`	integer	—	observedGeneration represents the .metadata.generation that the condition was set based upon.
`conditions[].reason`	string	yes	reason contains a programmatic identifier indicating the reason for the condition's last transition.
`conditions[].status`	enum	yes	status of the condition, one of True, False, Unknown. Allowed: `True, False, Unknown`
`conditions[].type`	string	yes	type of condition in CamelCase or in foo.example.com/CamelCase.
`id`	string	—	The identifier of the application.
`identifier`	string	—	Identifier is the Cloud Control primary identifier of the resource.
`lastSyncTime`	string	—
`observedGeneration`	integer	—
`operation`	string	—	Operation is the in-flight operation (CREATE, UPDATE, DELETE).
`operationStatus`	string	—	OperationStatus is the last reported operation status.
`requestToken`	string	—	RequestToken tracks an in-flight asynchronous operation.

OpenSearchDataSource # CLOUD CONTROL · AWS::OpenSearch::DataSource

OpenSearchDataSource manages AWS::OpenSearch::DataSource through the AWS Cloud Control API.

kubectl get opensearchdatasources · example on GitHub

Example

# OpenSearchDataSource — OpenSearch
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/opensearch.html#opensearchdatasource
apiVersion: aws.konfig.io/v1alpha1
kind: OpenSearchDataSource
metadata:
  name: example-opensearchdatasource
  namespace: default
spec:
  dataSourceType:
    s3GlueDataCatalog:
      roleArn: arn:aws:iam::123456789012:role/example-role
  description: Managed by konfig-konector
  domainName: example-opensearchdatasource
  name: example-opensearchdatasource
  providerRef:
    name: example-opensearchdatasource
    region: us-east-1

Spec

Field	Type	Required	Description
`dataSourceType`	object	yes	OpenSearchDataSourceDataSourceType is a nested property type of AWS::OpenSearch::DataSource.
`dataSourceType.s3GlueDataCatalog`	object	—	OpenSearchDataSourceS3GlueDataCatalog is a nested property type of AWS::OpenSearch::DataSource.
`dataSourceType.s3GlueDataCatalog.roleArn`	string	yes	The ARN of the IAM role that grants OpenSearch Service permission to access the Glue Data Catalog.
`description`	string	—	A description of the data source.
`domainName`	string	yes	The name of the OpenSearch Service domain.
`name`	string	yes	The name of the data source.
`providerRef`	object	—	ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
`providerRef.name`	string	yes	Name of a cluster-scoped AWSProvider.
`providerRef.region`	string	—	Region overrides the provider's region for this resource only.

Status

Field	Type	Required	Description
`arn`	string	—	The Amazon Resource Name (ARN) of the data source.
`attempt`	integer	—	Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure.
`awsProvider`	object	—	AWSProvider confirms the account and region this resource was reconciled against.
`awsProvider.accountId`	string	—	AccountID the resource lives in.
`awsProvider.name`	string	—	Name of the AWSProvider used; empty when the operator's own credentials were used.
`awsProvider.region`	string	—	Region the resource lives in (empty for global services).
`conditions`	array<object>	—	Conditions describe the current state of the resource.
`conditions[].lastTransitionTime`	string	yes	lastTransitionTime is the last time the condition transitioned from one status to another.
`conditions[].message`	string	yes	message is a human readable message indicating details about the transition.
`conditions[].observedGeneration`	integer	—	observedGeneration represents the .metadata.generation that the condition was set based upon.
`conditions[].reason`	string	yes	reason contains a programmatic identifier indicating the reason for the condition's last transition.
`conditions[].status`	enum	yes	status of the condition, one of True, False, Unknown. Allowed: `True, False, Unknown`
`conditions[].type`	string	yes	type of condition in CamelCase or in foo.example.com/CamelCase.
`identifier`	string	—	Identifier is the Cloud Control primary identifier of the resource.
`lastSyncTime`	string	—
`observedGeneration`	integer	—
`operation`	string	—	Operation is the in-flight operation (CREATE, UPDATE, DELETE).
`operationStatus`	string	—	OperationStatus is the last reported operation status.
`requestToken`	string	—	RequestToken tracks an in-flight asynchronous operation.
`status`	enum	—	The status of the data source. Allowed: `ACTIVE, DISABLED`

OpenSearchDomain # GA

OpenSearchDomain is the Schema for managing AWS OpenSearch Service domains.

kubectl get opensearchdomains · example on GitHub

Example

# OpenSearchDomain — OpenSearch
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/opensearch.html#opensearchdomain
apiVersion: aws.konfig.io/v1alpha1
kind: OpenSearchDomain
metadata:
  name: example-opensearchdomain
  namespace: default
spec:
  clusterConfig:
    dedicatedMasterEnabled: true
    instanceCount: 2
    instanceType: example
  domainName: example-opensearchdomain
  engineVersion: example
  providerRef:
    name: example-opensearchdomain
    region: us-east-1
  tags:
    environment: dev
    team: platform

Spec

Field	Type	Required	Description
`clusterConfig`	object	—	ClusterConfig defines the cluster configuration.
`clusterConfig.dedicatedMasterEnabled`	boolean	—	DedicatedMasterEnabled enables dedicated master nodes.
`clusterConfig.instanceCount`	integer	—	InstanceCount is the number of data nodes.
`clusterConfig.instanceType`	string	—	InstanceType is the instance type for data nodes (e.g.
`domainName`	string	yes	DomainName is the name of the domain.
`engineVersion`	string	—	EngineVersion specifies the OpenSearch or Elasticsearch version (e.g.
`providerRef`	object	—	ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
`providerRef.name`	string	yes	Name of a cluster-scoped AWSProvider.
`providerRef.region`	string	—	Region overrides the provider's region for this resource only.
`tags`	map<string>	—	Tags are metadata tags for the domain.

Status

Field	Type	Required	Description
`awsProvider`	object	—	AWSProvider confirms the account and region this resource was reconciled against.
`awsProvider.accountId`	string	—	AccountID the resource lives in.
`awsProvider.name`	string	—	Name of the AWSProvider used; empty when the operator's own credentials were used.
`awsProvider.region`	string	—	Region the resource lives in (empty for global services).
`conditions`	array<object>	—	Conditions describe the current state of the resource.
`conditions[].lastTransitionTime`	string	yes	lastTransitionTime is the last time the condition transitioned from one status to another.
`conditions[].message`	string	yes	message is a human readable message indicating details about the transition.
`conditions[].observedGeneration`	integer	—	observedGeneration represents the .metadata.generation that the condition was set based upon.
`conditions[].reason`	string	yes	reason contains a programmatic identifier indicating the reason for the condition's last transition.
`conditions[].status`	enum	yes	status of the condition, one of True, False, Unknown. Allowed: `True, False, Unknown`
`conditions[].type`	string	yes	type of condition in CamelCase or in foo.example.com/CamelCase.
`domainARN`	string	—	DomainARN is the ARN of the OpenSearch domain.
`domainID`	string	—	DomainID is the unique identifier of the domain.
`endpoint`	string	—	Endpoint is the domain endpoint URL.
`lastSyncTime`	string	—	LastSyncTime is when the resource was last successfully reconciled.
`observedGeneration`	integer	—	ObservedGeneration is the most recent .metadata.generation reconciled.
`processing`	boolean	—	Processing is true when the domain is being created or updated.