aiven.getOpenSearch

func LookupOpenSearch(ctx *Context, args *LookupOpenSearchArgs, opts ...InvokeOption) (*LookupOpenSearchResult, error)
func LookupOpenSearchOutput(ctx *Context, args *LookupOpenSearchOutputArgs, opts ...InvokeOption) LookupOpenSearchResultOutput

> Note: This function is named LookupOpenSearch in the Go SDK.

Project string

The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.

ServiceName string

Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.

Project string

The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.

ServiceName string

Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.

project String

The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.

serviceName String

Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.

project string

The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.

serviceName string

Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.

project str

The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.

service_name str

Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.

project String

The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.

serviceName String

Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.

AdditionalDiskSpace string

Add disk storage in increments of 30 GiB to scale your service. The maximum value depends on the service type and cloud provider. Removing additional storage causes the service nodes to go through a rolling restart and there might be a short downtime for services with no HA capabilities.

CloudName string

Defines where the cloud provider and region where the service is hosted in. This can be changed freely after service is created. Changing the value will trigger a potentially lengthy migration process for the service. Format is cloud provider name (aws, azure, do google, upcloud, etc.), dash, and the cloud provider specific region name. These are documented on each Cloud provider's own support articles, like here for Google and here for AWS.

Components List<GetOpenSearchComponent>

Service component information objects

DiskSpace string

Service disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.

DiskSpaceCap string

The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.

DiskSpaceDefault string

The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for disk_space

DiskSpaceStep string

The default disk space step of the service, possible values depend on the service type, the cloud provider and the project. disk_space needs to increment from disk_space_default by increments of this size.

DiskSpaceUsed string

Disk space that service is currently using

Id string

The provider-assigned unique ID for this managed resource.

MaintenanceWindowDow string

Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.

MaintenanceWindowTime string

Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.

OpensearchUserConfigs List<GetOpenSearchOpensearchUserConfig>

Opensearch user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later

Opensearches List<GetOpenSearchOpensearch>

OpenSearch server provided values

Plan string

Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are hobbyist, startup-x, business-x and premium-x where x is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be seen from the Aiven pricing page.

Project string

The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.

ProjectVpcId string

Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.

ServiceHost string

The hostname of the service.

ServiceIntegrations List<GetOpenSearchServiceIntegration>

Service integrations to specify when creating a service. Not applied after initial service creation

ServiceName string

Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.

ServicePassword string

Password used for connecting to the service, if applicable

ServicePort int

The port of the service

ServiceType string

Aiven internal service type code

ServiceUri string

URI for connecting to the service. Service specific info is under "kafka", "pg", etc.

ServiceUsername string

Username used for connecting to the service, if applicable

State string

Service state. One of POWEROFF, REBALANCING, REBUILDING or RUNNING

StaticIps List<string>

Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again

Tags List<GetOpenSearchTag>

Tags are key-value pairs that allow you to categorize services.

TechEmails List<GetOpenSearchTechEmail>

The email addresses for service contacts, who will receive important alerts and updates about this service. You can also set email contacts at the project level.

TerminationProtection bool

Prevents the service from being deleted. It is recommended to set this to true for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.

AdditionalDiskSpace string

Add disk storage in increments of 30 GiB to scale your service. The maximum value depends on the service type and cloud provider. Removing additional storage causes the service nodes to go through a rolling restart and there might be a short downtime for services with no HA capabilities.

CloudName string

Defines where the cloud provider and region where the service is hosted in. This can be changed freely after service is created. Changing the value will trigger a potentially lengthy migration process for the service. Format is cloud provider name (aws, azure, do google, upcloud, etc.), dash, and the cloud provider specific region name. These are documented on each Cloud provider's own support articles, like here for Google and here for AWS.

Components []GetOpenSearchComponent

Service component information objects

DiskSpace string

Service disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.

DiskSpaceCap string

The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.

DiskSpaceDefault string

The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for disk_space

DiskSpaceStep string

The default disk space step of the service, possible values depend on the service type, the cloud provider and the project. disk_space needs to increment from disk_space_default by increments of this size.

DiskSpaceUsed string

Disk space that service is currently using

Id string

The provider-assigned unique ID for this managed resource.

MaintenanceWindowDow string

Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.

MaintenanceWindowTime string

Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.

OpensearchUserConfigs []GetOpenSearchOpensearchUserConfig

Opensearch user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later

Opensearches []GetOpenSearchOpensearch

OpenSearch server provided values

Plan string

Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are hobbyist, startup-x, business-x and premium-x where x is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be seen from the Aiven pricing page.

Project string

The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.

ProjectVpcId string

Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.

ServiceHost string

The hostname of the service.

ServiceIntegrations []GetOpenSearchServiceIntegration

Service integrations to specify when creating a service. Not applied after initial service creation

ServiceName string

Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.

ServicePassword string

Password used for connecting to the service, if applicable

ServicePort int

The port of the service

ServiceType string

Aiven internal service type code

ServiceUri string

URI for connecting to the service. Service specific info is under "kafka", "pg", etc.

ServiceUsername string

Username used for connecting to the service, if applicable

State string

Service state. One of POWEROFF, REBALANCING, REBUILDING or RUNNING

StaticIps []string

Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again

Tags []GetOpenSearchTag

Tags are key-value pairs that allow you to categorize services.

TechEmails []GetOpenSearchTechEmail

The email addresses for service contacts, who will receive important alerts and updates about this service. You can also set email contacts at the project level.

TerminationProtection bool

Prevents the service from being deleted. It is recommended to set this to true for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.

additionalDiskSpace String

Add disk storage in increments of 30 GiB to scale your service. The maximum value depends on the service type and cloud provider. Removing additional storage causes the service nodes to go through a rolling restart and there might be a short downtime for services with no HA capabilities.

cloudName String

Defines where the cloud provider and region where the service is hosted in. This can be changed freely after service is created. Changing the value will trigger a potentially lengthy migration process for the service. Format is cloud provider name (aws, azure, do google, upcloud, etc.), dash, and the cloud provider specific region name. These are documented on each Cloud provider's own support articles, like here for Google and here for AWS.

components List<GetOpenSearchComponent>

Service component information objects

diskSpace String

Service disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.

diskSpaceCap String

The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.

diskSpaceDefault String

The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for disk_space

diskSpaceStep String

The default disk space step of the service, possible values depend on the service type, the cloud provider and the project. disk_space needs to increment from disk_space_default by increments of this size.

diskSpaceUsed String

Disk space that service is currently using

id String

The provider-assigned unique ID for this managed resource.

maintenanceWindowDow String

Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.

maintenanceWindowTime String

Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.

opensearchUserConfigs List<GetOpenSearchOpensearchUserConfig>

Opensearch user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later

opensearches List<GetOpenSearchOpensearch>

OpenSearch server provided values

plan String

Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are hobbyist, startup-x, business-x and premium-x where x is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be seen from the Aiven pricing page.

project String

The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.

projectVpcId String

Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.

serviceHost String

The hostname of the service.

serviceIntegrations List<GetOpenSearchServiceIntegration>

Service integrations to specify when creating a service. Not applied after initial service creation

serviceName String

Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.

servicePassword String

Password used for connecting to the service, if applicable

servicePort Integer

The port of the service

serviceType String

Aiven internal service type code

serviceUri String

URI for connecting to the service. Service specific info is under "kafka", "pg", etc.

serviceUsername String

Username used for connecting to the service, if applicable

state String

Service state. One of POWEROFF, REBALANCING, REBUILDING or RUNNING

staticIps List<String>

Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again

tags List<GetOpenSearchTag>

Tags are key-value pairs that allow you to categorize services.

techEmails List<GetOpenSearchTechEmail>

The email addresses for service contacts, who will receive important alerts and updates about this service. You can also set email contacts at the project level.

terminationProtection Boolean

Prevents the service from being deleted. It is recommended to set this to true for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.

additionalDiskSpace string

Add disk storage in increments of 30 GiB to scale your service. The maximum value depends on the service type and cloud provider. Removing additional storage causes the service nodes to go through a rolling restart and there might be a short downtime for services with no HA capabilities.

cloudName string

Defines where the cloud provider and region where the service is hosted in. This can be changed freely after service is created. Changing the value will trigger a potentially lengthy migration process for the service. Format is cloud provider name (aws, azure, do google, upcloud, etc.), dash, and the cloud provider specific region name. These are documented on each Cloud provider's own support articles, like here for Google and here for AWS.

components GetOpenSearchComponent[]

Service component information objects

diskSpace string

Service disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.

diskSpaceCap string

The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.

diskSpaceDefault string

The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for disk_space

diskSpaceStep string

The default disk space step of the service, possible values depend on the service type, the cloud provider and the project. disk_space needs to increment from disk_space_default by increments of this size.

diskSpaceUsed string

Disk space that service is currently using

id string

The provider-assigned unique ID for this managed resource.

maintenanceWindowDow string

Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.

maintenanceWindowTime string

Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.

opensearchUserConfigs GetOpenSearchOpensearchUserConfig[]

Opensearch user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later

opensearches GetOpenSearchOpensearch[]

OpenSearch server provided values

plan string

Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are hobbyist, startup-x, business-x and premium-x where x is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be seen from the Aiven pricing page.

project string

The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.

projectVpcId string

Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.

serviceHost string

The hostname of the service.

serviceIntegrations GetOpenSearchServiceIntegration[]

Service integrations to specify when creating a service. Not applied after initial service creation

serviceName string

Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.

servicePassword string

Password used for connecting to the service, if applicable

servicePort number

The port of the service

serviceType string

Aiven internal service type code

serviceUri string

URI for connecting to the service. Service specific info is under "kafka", "pg", etc.

serviceUsername string

Username used for connecting to the service, if applicable

state string

Service state. One of POWEROFF, REBALANCING, REBUILDING or RUNNING

staticIps string[]

Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again

tags GetOpenSearchTag[]

Tags are key-value pairs that allow you to categorize services.

techEmails GetOpenSearchTechEmail[]

The email addresses for service contacts, who will receive important alerts and updates about this service. You can also set email contacts at the project level.

terminationProtection boolean

Prevents the service from being deleted. It is recommended to set this to true for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.

additional_disk_space str

Add disk storage in increments of 30 GiB to scale your service. The maximum value depends on the service type and cloud provider. Removing additional storage causes the service nodes to go through a rolling restart and there might be a short downtime for services with no HA capabilities.

cloud_name str

Defines where the cloud provider and region where the service is hosted in. This can be changed freely after service is created. Changing the value will trigger a potentially lengthy migration process for the service. Format is cloud provider name (aws, azure, do google, upcloud, etc.), dash, and the cloud provider specific region name. These are documented on each Cloud provider's own support articles, like here for Google and here for AWS.

components Sequence[GetOpenSearchComponent]

Service component information objects

disk_space str

Service disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.

disk_space_cap str

The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.

disk_space_default str

The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for disk_space

disk_space_step str

The default disk space step of the service, possible values depend on the service type, the cloud provider and the project. disk_space needs to increment from disk_space_default by increments of this size.

disk_space_used str

Disk space that service is currently using

id str

The provider-assigned unique ID for this managed resource.

maintenance_window_dow str

Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.

maintenance_window_time str

Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.

opensearch_user_configs Sequence[GetOpenSearchOpensearchUserConfig]

Opensearch user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later

opensearches Sequence[GetOpenSearchOpensearch]

OpenSearch server provided values

plan str

Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are hobbyist, startup-x, business-x and premium-x where x is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be seen from the Aiven pricing page.

project str

The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.

project_vpc_id str

Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.

service_host str

The hostname of the service.

service_integrations Sequence[GetOpenSearchServiceIntegration]

Service integrations to specify when creating a service. Not applied after initial service creation

service_name str

Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.

service_password str

Password used for connecting to the service, if applicable

service_port int

The port of the service

service_type str

Aiven internal service type code

service_uri str

URI for connecting to the service. Service specific info is under "kafka", "pg", etc.

service_username str

Username used for connecting to the service, if applicable

state str

Service state. One of POWEROFF, REBALANCING, REBUILDING or RUNNING

static_ips Sequence[str]

Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again

tags Sequence[GetOpenSearchTag]

Tags are key-value pairs that allow you to categorize services.

tech_emails Sequence[GetOpenSearchTechEmail]

The email addresses for service contacts, who will receive important alerts and updates about this service. You can also set email contacts at the project level.

termination_protection bool

Prevents the service from being deleted. It is recommended to set this to true for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.

additionalDiskSpace String

Add disk storage in increments of 30 GiB to scale your service. The maximum value depends on the service type and cloud provider. Removing additional storage causes the service nodes to go through a rolling restart and there might be a short downtime for services with no HA capabilities.

cloudName String

Defines where the cloud provider and region where the service is hosted in. This can be changed freely after service is created. Changing the value will trigger a potentially lengthy migration process for the service. Format is cloud provider name (aws, azure, do google, upcloud, etc.), dash, and the cloud provider specific region name. These are documented on each Cloud provider's own support articles, like here for Google and here for AWS.

components List<Property Map>

Service component information objects

diskSpace String

Service disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.

diskSpaceCap String

The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.

diskSpaceDefault String

The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for disk_space

diskSpaceStep String

The default disk space step of the service, possible values depend on the service type, the cloud provider and the project. disk_space needs to increment from disk_space_default by increments of this size.

diskSpaceUsed String

Disk space that service is currently using

id String

The provider-assigned unique ID for this managed resource.

maintenanceWindowDow String

Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.

maintenanceWindowTime String

Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.

opensearchUserConfigs List<Property Map>

Opensearch user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later

opensearches List<Property Map>

OpenSearch server provided values

plan String

Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are hobbyist, startup-x, business-x and premium-x where x is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be seen from the Aiven pricing page.

project String

The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.

projectVpcId String

Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.

serviceHost String

The hostname of the service.

serviceIntegrations List<Property Map>

Service integrations to specify when creating a service. Not applied after initial service creation

serviceName String

Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.

servicePassword String

Password used for connecting to the service, if applicable

servicePort Number

The port of the service

serviceType String

Aiven internal service type code

serviceUri String

URI for connecting to the service. Service specific info is under "kafka", "pg", etc.

serviceUsername String

Username used for connecting to the service, if applicable

state String

Service state. One of POWEROFF, REBALANCING, REBUILDING or RUNNING

staticIps List<String>

Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again

tags List<Property Map>

Tags are key-value pairs that allow you to categorize services.

techEmails List<Property Map>

The email addresses for service contacts, who will receive important alerts and updates about this service. You can also set email contacts at the project level.

terminationProtection Boolean

Prevents the service from being deleted. It is recommended to set this to true for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.

Component string

Service component name

ConnectionUri string

Connection info for connecting to the service component. This is a combination of host and port.

Host string

Host name for connecting to the service component

KafkaAuthenticationMethod string

Kafka authentication method. This is a value specific to the 'kafka' service component

Port int

Port number for connecting to the service component

Route string

Network access route

Ssl bool

Whether the endpoint is encrypted or accepts plaintext. By default endpoints are always encrypted and this property is only included for service components they may disable encryption

Usage string

DNS usage name

Component string

Service component name

ConnectionUri string

Connection info for connecting to the service component. This is a combination of host and port.

Host string

Host name for connecting to the service component

KafkaAuthenticationMethod string

Kafka authentication method. This is a value specific to the 'kafka' service component

Port int

Port number for connecting to the service component

Route string

Network access route

Ssl bool

Whether the endpoint is encrypted or accepts plaintext. By default endpoints are always encrypted and this property is only included for service components they may disable encryption

Usage string

DNS usage name

component String

Service component name

connectionUri String

Connection info for connecting to the service component. This is a combination of host and port.

host String

Host name for connecting to the service component

kafkaAuthenticationMethod String

Kafka authentication method. This is a value specific to the 'kafka' service component

port Integer

Port number for connecting to the service component

route String

Network access route

ssl Boolean

Whether the endpoint is encrypted or accepts plaintext. By default endpoints are always encrypted and this property is only included for service components they may disable encryption

usage String

DNS usage name

component string

Service component name

connectionUri string

Connection info for connecting to the service component. This is a combination of host and port.

host string

Host name for connecting to the service component

kafkaAuthenticationMethod string

Kafka authentication method. This is a value specific to the 'kafka' service component

port number

Port number for connecting to the service component

route string

Network access route

ssl boolean

Whether the endpoint is encrypted or accepts plaintext. By default endpoints are always encrypted and this property is only included for service components they may disable encryption

usage string

DNS usage name

component str

Service component name

connection_uri str

Connection info for connecting to the service component. This is a combination of host and port.

host str

Host name for connecting to the service component

kafka_authentication_method str

Kafka authentication method. This is a value specific to the 'kafka' service component

port int

Port number for connecting to the service component

route str

Network access route

ssl bool

Whether the endpoint is encrypted or accepts plaintext. By default endpoints are always encrypted and this property is only included for service components they may disable encryption

usage str

DNS usage name

component String

Service component name

connectionUri String

Connection info for connecting to the service component. This is a combination of host and port.

host String

Host name for connecting to the service component

kafkaAuthenticationMethod String

Kafka authentication method. This is a value specific to the 'kafka' service component

port Number

Port number for connecting to the service component

route String

Network access route

ssl Boolean

Whether the endpoint is encrypted or accepts plaintext. By default endpoints are always encrypted and this property is only included for service components they may disable encryption

usage String

DNS usage name

KibanaUri string

URI for Kibana dashboard frontend

Deprecated: This field was added by mistake and has never worked. It will be removed in future versions.

OpensearchDashboardsUri string

URI for OpenSearch dashboard frontend

Password string

OpenSearch password

Uris List<string>

OpenSearch server URIs.

Username string

OpenSearch username

KibanaUri string

URI for Kibana dashboard frontend

Deprecated: This field was added by mistake and has never worked. It will be removed in future versions.

OpensearchDashboardsUri string

URI for OpenSearch dashboard frontend

Password string

OpenSearch password

Uris []string

OpenSearch server URIs.

Username string

OpenSearch username

kibanaUri String

URI for Kibana dashboard frontend

Deprecated: This field was added by mistake and has never worked. It will be removed in future versions.

opensearchDashboardsUri String

URI for OpenSearch dashboard frontend

password String

OpenSearch password

uris List<String>

OpenSearch server URIs.

username String

OpenSearch username

kibanaUri string

URI for Kibana dashboard frontend

Deprecated: This field was added by mistake and has never worked. It will be removed in future versions.

opensearchDashboardsUri string

URI for OpenSearch dashboard frontend

password string

OpenSearch password

uris string[]

OpenSearch server URIs.

username string

OpenSearch username

kibana_uri str

URI for Kibana dashboard frontend

Deprecated: This field was added by mistake and has never worked. It will be removed in future versions.

opensearch_dashboards_uri str

URI for OpenSearch dashboard frontend

password str

OpenSearch password

uris Sequence[str]

OpenSearch server URIs.

username str

OpenSearch username

kibanaUri String

URI for Kibana dashboard frontend

Deprecated: This field was added by mistake and has never worked. It will be removed in future versions.

opensearchDashboardsUri String

URI for OpenSearch dashboard frontend

password String

OpenSearch password

uris List<String>

OpenSearch server URIs.

username String

OpenSearch username

AdditionalBackupRegions string

Additional Cloud Regions for Backup Replication.

AzureMigration GetOpenSearchOpensearchUserConfigAzureMigration

Azure migration settings

CustomDomain string

Serve the web frontend using a custom CNAME pointing to the Aiven DNS name. Example: grafana.example.org.

DisableReplicationFactorAdjustment bool

Disable automatic replication factor adjustment for multi-node services. By default, Aiven ensures all indexes are replicated at least to two nodes. Note: Due to potential data loss in case of losing a service node, this setting can not be activated unless specifically allowed for the project.

GcsMigration GetOpenSearchOpensearchUserConfigGcsMigration

Google Cloud Storage migration settings

IndexPatterns List<GetOpenSearchOpensearchUserConfigIndexPattern>

Index patterns

IndexRollup GetOpenSearchOpensearchUserConfigIndexRollup

Index rollup settings

IndexTemplate GetOpenSearchOpensearchUserConfigIndexTemplate

Template settings for all new indexes

IpFilterObjects List<GetOpenSearchOpensearchUserConfigIpFilterObject>

Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16

IpFilterStrings List<string>

Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.

IpFilters List<string>

Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.

Deprecated: Deprecated. Use ip_filter_string instead.

KeepIndexRefreshInterval bool

Aiven automation resets index.refresh_interval to default value for every index to be sure that indices are always visible to search. If it doesn't fit your case, you can disable this by setting up this flag to true.

MaxIndexCount int

Use index_patterns instead. Default: 0.

Openid GetOpenSearchOpensearchUserConfigOpenid

OpenSearch OpenID Connect Configuration

Opensearch GetOpenSearchOpensearchUserConfigOpensearch

OpenSearch settings

OpensearchDashboards GetOpenSearchOpensearchUserConfigOpensearchDashboards

OpenSearch Dashboards settings

OpensearchVersion string

Enum: 1, 2, and newer. OpenSearch major version.

PrivateAccess GetOpenSearchOpensearchUserConfigPrivateAccess

Allow access to selected service ports from private networks

PrivatelinkAccess GetOpenSearchOpensearchUserConfigPrivatelinkAccess

Allow access to selected service components through Privatelink

ProjectToForkFrom string

Name of another project to fork a service from. This has effect only when a new service is being created. Example: anotherprojectname.

PublicAccess GetOpenSearchOpensearchUserConfigPublicAccess

Allow access to selected service ports from the public Internet

RecoveryBasebackupName string

Name of the basebackup to restore in forked service. Example: backup-20191112t091354293891z.

S3Migration GetOpenSearchOpensearchUserConfigS3Migration

AWS S3 / AWS S3 compatible migration settings

Saml GetOpenSearchOpensearchUserConfigSaml

OpenSearch SAML configuration

ServiceLog bool

Store logs for the service so that they are available in the HTTP API and console.

ServiceToForkFrom string

Name of another service to fork from. This has effect only when a new service is being created. Example: anotherservicename.

StaticIps bool

Use static public IP addresses.

AdditionalBackupRegions string

Additional Cloud Regions for Backup Replication.

AzureMigration GetOpenSearchOpensearchUserConfigAzureMigration

Azure migration settings

CustomDomain string

Serve the web frontend using a custom CNAME pointing to the Aiven DNS name. Example: grafana.example.org.

DisableReplicationFactorAdjustment bool

Disable automatic replication factor adjustment for multi-node services. By default, Aiven ensures all indexes are replicated at least to two nodes. Note: Due to potential data loss in case of losing a service node, this setting can not be activated unless specifically allowed for the project.

GcsMigration GetOpenSearchOpensearchUserConfigGcsMigration

Google Cloud Storage migration settings

IndexPatterns []GetOpenSearchOpensearchUserConfigIndexPattern

Index patterns

IndexRollup GetOpenSearchOpensearchUserConfigIndexRollup

Index rollup settings

IndexTemplate GetOpenSearchOpensearchUserConfigIndexTemplate

Template settings for all new indexes

IpFilterObjects []GetOpenSearchOpensearchUserConfigIpFilterObject

Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16

IpFilterStrings []string

Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.

IpFilters []string

Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.

Deprecated: Deprecated. Use ip_filter_string instead.

KeepIndexRefreshInterval bool

Aiven automation resets index.refresh_interval to default value for every index to be sure that indices are always visible to search. If it doesn't fit your case, you can disable this by setting up this flag to true.

MaxIndexCount int

Use index_patterns instead. Default: 0.

Openid GetOpenSearchOpensearchUserConfigOpenid

OpenSearch OpenID Connect Configuration

Opensearch GetOpenSearchOpensearchUserConfigOpensearch

OpenSearch settings

OpensearchDashboards GetOpenSearchOpensearchUserConfigOpensearchDashboards

OpenSearch Dashboards settings

OpensearchVersion string

Enum: 1, 2, and newer. OpenSearch major version.

PrivateAccess GetOpenSearchOpensearchUserConfigPrivateAccess

Allow access to selected service ports from private networks

PrivatelinkAccess GetOpenSearchOpensearchUserConfigPrivatelinkAccess

Allow access to selected service components through Privatelink

ProjectToForkFrom string

Name of another project to fork a service from. This has effect only when a new service is being created. Example: anotherprojectname.

PublicAccess GetOpenSearchOpensearchUserConfigPublicAccess

Allow access to selected service ports from the public Internet

RecoveryBasebackupName string

Name of the basebackup to restore in forked service. Example: backup-20191112t091354293891z.

S3Migration GetOpenSearchOpensearchUserConfigS3Migration

AWS S3 / AWS S3 compatible migration settings

Saml GetOpenSearchOpensearchUserConfigSaml

OpenSearch SAML configuration

ServiceLog bool

Store logs for the service so that they are available in the HTTP API and console.

ServiceToForkFrom string

Name of another service to fork from. This has effect only when a new service is being created. Example: anotherservicename.

StaticIps bool

Use static public IP addresses.

additionalBackupRegions String

Additional Cloud Regions for Backup Replication.

azureMigration GetOpenSearchOpensearchUserConfigAzureMigration

Azure migration settings

customDomain String

Serve the web frontend using a custom CNAME pointing to the Aiven DNS name. Example: grafana.example.org.

disableReplicationFactorAdjustment Boolean

Disable automatic replication factor adjustment for multi-node services. By default, Aiven ensures all indexes are replicated at least to two nodes. Note: Due to potential data loss in case of losing a service node, this setting can not be activated unless specifically allowed for the project.

gcsMigration GetOpenSearchOpensearchUserConfigGcsMigration

Google Cloud Storage migration settings

indexPatterns List<GetOpenSearchOpensearchUserConfigIndexPattern>

Index patterns

indexRollup GetOpenSearchOpensearchUserConfigIndexRollup

Index rollup settings

indexTemplate GetOpenSearchOpensearchUserConfigIndexTemplate

Template settings for all new indexes

ipFilterObjects List<GetOpenSearchOpensearchUserConfigIpFilterObject>

Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16

ipFilterStrings List<String>

Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.

ipFilters List<String>

Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.

Deprecated: Deprecated. Use ip_filter_string instead.

keepIndexRefreshInterval Boolean

Aiven automation resets index.refresh_interval to default value for every index to be sure that indices are always visible to search. If it doesn't fit your case, you can disable this by setting up this flag to true.

maxIndexCount Integer

Use index_patterns instead. Default: 0.

openid GetOpenSearchOpensearchUserConfigOpenid

OpenSearch OpenID Connect Configuration

opensearch GetOpenSearchOpensearchUserConfigOpensearch

OpenSearch settings

opensearchDashboards GetOpenSearchOpensearchUserConfigOpensearchDashboards

OpenSearch Dashboards settings

opensearchVersion String

Enum: 1, 2, and newer. OpenSearch major version.

privateAccess GetOpenSearchOpensearchUserConfigPrivateAccess

Allow access to selected service ports from private networks

privatelinkAccess GetOpenSearchOpensearchUserConfigPrivatelinkAccess

Allow access to selected service components through Privatelink

projectToForkFrom String

Name of another project to fork a service from. This has effect only when a new service is being created. Example: anotherprojectname.

publicAccess GetOpenSearchOpensearchUserConfigPublicAccess

Allow access to selected service ports from the public Internet

recoveryBasebackupName String

Name of the basebackup to restore in forked service. Example: backup-20191112t091354293891z.

s3Migration GetOpenSearchOpensearchUserConfigS3Migration

AWS S3 / AWS S3 compatible migration settings

saml GetOpenSearchOpensearchUserConfigSaml

OpenSearch SAML configuration

serviceLog Boolean

Store logs for the service so that they are available in the HTTP API and console.

serviceToForkFrom String

Name of another service to fork from. This has effect only when a new service is being created. Example: anotherservicename.

staticIps Boolean

Use static public IP addresses.

additionalBackupRegions string

Additional Cloud Regions for Backup Replication.

azureMigration GetOpenSearchOpensearchUserConfigAzureMigration

Azure migration settings

customDomain string

Serve the web frontend using a custom CNAME pointing to the Aiven DNS name. Example: grafana.example.org.

disableReplicationFactorAdjustment boolean

Disable automatic replication factor adjustment for multi-node services. By default, Aiven ensures all indexes are replicated at least to two nodes. Note: Due to potential data loss in case of losing a service node, this setting can not be activated unless specifically allowed for the project.

gcsMigration GetOpenSearchOpensearchUserConfigGcsMigration

Google Cloud Storage migration settings

indexPatterns GetOpenSearchOpensearchUserConfigIndexPattern[]

Index patterns

indexRollup GetOpenSearchOpensearchUserConfigIndexRollup

Index rollup settings

indexTemplate GetOpenSearchOpensearchUserConfigIndexTemplate

Template settings for all new indexes

ipFilterObjects GetOpenSearchOpensearchUserConfigIpFilterObject[]

Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16

ipFilterStrings string[]

Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.

ipFilters string[]

Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.

Deprecated: Deprecated. Use ip_filter_string instead.

keepIndexRefreshInterval boolean

Aiven automation resets index.refresh_interval to default value for every index to be sure that indices are always visible to search. If it doesn't fit your case, you can disable this by setting up this flag to true.

maxIndexCount number

Use index_patterns instead. Default: 0.

openid GetOpenSearchOpensearchUserConfigOpenid

OpenSearch OpenID Connect Configuration

opensearch GetOpenSearchOpensearchUserConfigOpensearch

OpenSearch settings

opensearchDashboards GetOpenSearchOpensearchUserConfigOpensearchDashboards

OpenSearch Dashboards settings

opensearchVersion string

Enum: 1, 2, and newer. OpenSearch major version.

privateAccess GetOpenSearchOpensearchUserConfigPrivateAccess

Allow access to selected service ports from private networks

privatelinkAccess GetOpenSearchOpensearchUserConfigPrivatelinkAccess

Allow access to selected service components through Privatelink

projectToForkFrom string

Name of another project to fork a service from. This has effect only when a new service is being created. Example: anotherprojectname.

publicAccess GetOpenSearchOpensearchUserConfigPublicAccess

Allow access to selected service ports from the public Internet

recoveryBasebackupName string

Name of the basebackup to restore in forked service. Example: backup-20191112t091354293891z.

s3Migration GetOpenSearchOpensearchUserConfigS3Migration

AWS S3 / AWS S3 compatible migration settings

saml GetOpenSearchOpensearchUserConfigSaml

OpenSearch SAML configuration

serviceLog boolean

Store logs for the service so that they are available in the HTTP API and console.

serviceToForkFrom string

Name of another service to fork from. This has effect only when a new service is being created. Example: anotherservicename.

staticIps boolean

Use static public IP addresses.

additional_backup_regions str

Additional Cloud Regions for Backup Replication.

azure_migration GetOpenSearchOpensearchUserConfigAzureMigration

Azure migration settings

custom_domain str

Serve the web frontend using a custom CNAME pointing to the Aiven DNS name. Example: grafana.example.org.

disable_replication_factor_adjustment bool

Disable automatic replication factor adjustment for multi-node services. By default, Aiven ensures all indexes are replicated at least to two nodes. Note: Due to potential data loss in case of losing a service node, this setting can not be activated unless specifically allowed for the project.

gcs_migration GetOpenSearchOpensearchUserConfigGcsMigration

Google Cloud Storage migration settings

index_patterns Sequence[GetOpenSearchOpensearchUserConfigIndexPattern]

Index patterns

index_rollup GetOpenSearchOpensearchUserConfigIndexRollup

Index rollup settings

index_template GetOpenSearchOpensearchUserConfigIndexTemplate

Template settings for all new indexes

ip_filter_objects Sequence[GetOpenSearchOpensearchUserConfigIpFilterObject]

Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16

ip_filter_strings Sequence[str]

Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.

ip_filters Sequence[str]

Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.

Deprecated: Deprecated. Use ip_filter_string instead.

keep_index_refresh_interval bool

Aiven automation resets index.refresh_interval to default value for every index to be sure that indices are always visible to search. If it doesn't fit your case, you can disable this by setting up this flag to true.

max_index_count int

Use index_patterns instead. Default: 0.

openid GetOpenSearchOpensearchUserConfigOpenid

OpenSearch OpenID Connect Configuration

opensearch GetOpenSearchOpensearchUserConfigOpensearch

OpenSearch settings

opensearch_dashboards GetOpenSearchOpensearchUserConfigOpensearchDashboards

OpenSearch Dashboards settings

opensearch_version str

Enum: 1, 2, and newer. OpenSearch major version.

private_access GetOpenSearchOpensearchUserConfigPrivateAccess

Allow access to selected service ports from private networks

privatelink_access GetOpenSearchOpensearchUserConfigPrivatelinkAccess

Allow access to selected service components through Privatelink

project_to_fork_from str

Name of another project to fork a service from. This has effect only when a new service is being created. Example: anotherprojectname.

public_access GetOpenSearchOpensearchUserConfigPublicAccess

Allow access to selected service ports from the public Internet

recovery_basebackup_name str

Name of the basebackup to restore in forked service. Example: backup-20191112t091354293891z.

s3_migration GetOpenSearchOpensearchUserConfigS3Migration

AWS S3 / AWS S3 compatible migration settings

saml GetOpenSearchOpensearchUserConfigSaml

OpenSearch SAML configuration

service_log bool

Store logs for the service so that they are available in the HTTP API and console.

service_to_fork_from str

Name of another service to fork from. This has effect only when a new service is being created. Example: anotherservicename.

static_ips bool

Use static public IP addresses.

additionalBackupRegions String

Additional Cloud Regions for Backup Replication.

azureMigration Property Map

Azure migration settings

customDomain String

Serve the web frontend using a custom CNAME pointing to the Aiven DNS name. Example: grafana.example.org.

disableReplicationFactorAdjustment Boolean

Disable automatic replication factor adjustment for multi-node services. By default, Aiven ensures all indexes are replicated at least to two nodes. Note: Due to potential data loss in case of losing a service node, this setting can not be activated unless specifically allowed for the project.

gcsMigration Property Map

Google Cloud Storage migration settings

indexPatterns List<Property Map>

Index patterns

indexRollup Property Map

Index rollup settings

indexTemplate Property Map

Template settings for all new indexes

ipFilterObjects List<Property Map>

Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16

ipFilterStrings List<String>

Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.

ipFilters List<String>

Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.

Deprecated: Deprecated. Use ip_filter_string instead.

keepIndexRefreshInterval Boolean

Aiven automation resets index.refresh_interval to default value for every index to be sure that indices are always visible to search. If it doesn't fit your case, you can disable this by setting up this flag to true.

maxIndexCount Number

Use index_patterns instead. Default: 0.

openid Property Map

OpenSearch OpenID Connect Configuration

opensearch Property Map

OpenSearch settings

opensearchDashboards Property Map

OpenSearch Dashboards settings

opensearchVersion String

Enum: 1, 2, and newer. OpenSearch major version.

privateAccess Property Map

Allow access to selected service ports from private networks

privatelinkAccess Property Map

Allow access to selected service components through Privatelink

projectToForkFrom String

Name of another project to fork a service from. This has effect only when a new service is being created. Example: anotherprojectname.

publicAccess Property Map

Allow access to selected service ports from the public Internet

recoveryBasebackupName String

Name of the basebackup to restore in forked service. Example: backup-20191112t091354293891z.

s3Migration Property Map

AWS S3 / AWS S3 compatible migration settings

saml Property Map

OpenSearch SAML configuration

serviceLog Boolean

Store logs for the service so that they are available in the HTTP API and console.

serviceToForkFrom String

Name of another service to fork from. This has effect only when a new service is being created. Example: anotherservicename.

staticIps Boolean

Use static public IP addresses.

Account string

Azure account name.

BasePath string

The path to the repository data within its container. The value of this setting should not start or end with a /.

Container string

Azure container name.

Indices string

A comma-delimited list of indices to restore from the snapshot. Multi-index syntax is supported. Example: metrics*,logs*,data-20240823.

SnapshotName string

The snapshot name to restore from.

ChunkSize string

Big files can be broken down into chunks during snapshotting if needed. Should be the same as for the 3rd party repository.

Compress bool

When set to true metadata files are stored in compressed format.

EndpointSuffix string

Defines the DNS suffix for Azure Storage endpoints.

IncludeAliases bool

Whether to restore aliases alongside their associated indexes. Default is true.

Key string

Azure account secret key. One of key or sas_token should be specified.

RestoreGlobalState bool

If true, restore the cluster state. Defaults to false.

SasToken string

A shared access signatures (SAS) token. One of key or sas_token should be specified.

Account string

Azure account name.

BasePath string

The path to the repository data within its container. The value of this setting should not start or end with a /.

Container string

Azure container name.

Indices string

A comma-delimited list of indices to restore from the snapshot. Multi-index syntax is supported. Example: metrics*,logs*,data-20240823.

SnapshotName string

The snapshot name to restore from.

ChunkSize string

Big files can be broken down into chunks during snapshotting if needed. Should be the same as for the 3rd party repository.

Compress bool

When set to true metadata files are stored in compressed format.

EndpointSuffix string

Defines the DNS suffix for Azure Storage endpoints.

IncludeAliases bool

Whether to restore aliases alongside their associated indexes. Default is true.

Key string

Azure account secret key. One of key or sas_token should be specified.

RestoreGlobalState bool

If true, restore the cluster state. Defaults to false.

SasToken string

A shared access signatures (SAS) token. One of key or sas_token should be specified.

account String

Azure account name.

basePath String

The path to the repository data within its container. The value of this setting should not start or end with a /.

container String

Azure container name.

indices String

A comma-delimited list of indices to restore from the snapshot. Multi-index syntax is supported. Example: metrics*,logs*,data-20240823.

snapshotName String

The snapshot name to restore from.

chunkSize String

Big files can be broken down into chunks during snapshotting if needed. Should be the same as for the 3rd party repository.

compress Boolean

When set to true metadata files are stored in compressed format.

endpointSuffix String

Defines the DNS suffix for Azure Storage endpoints.

includeAliases Boolean

Whether to restore aliases alongside their associated indexes. Default is true.

key String

Azure account secret key. One of key or sas_token should be specified.

restoreGlobalState Boolean

If true, restore the cluster state. Defaults to false.

sasToken String

A shared access signatures (SAS) token. One of key or sas_token should be specified.

account string

Azure account name.

basePath string

The path to the repository data within its container. The value of this setting should not start or end with a /.

container string

Azure container name.

indices string

A comma-delimited list of indices to restore from the snapshot. Multi-index syntax is supported. Example: metrics*,logs*,data-20240823.

snapshotName string

The snapshot name to restore from.

chunkSize string

Big files can be broken down into chunks during snapshotting if needed. Should be the same as for the 3rd party repository.

compress boolean

When set to true metadata files are stored in compressed format.

endpointSuffix string

Defines the DNS suffix for Azure Storage endpoints.

includeAliases boolean

Whether to restore aliases alongside their associated indexes. Default is true.

key string

Azure account secret key. One of key or sas_token should be specified.

restoreGlobalState boolean

If true, restore the cluster state. Defaults to false.

sasToken string

A shared access signatures (SAS) token. One of key or sas_token should be specified.

account str

Azure account name.

base_path str

The path to the repository data within its container. The value of this setting should not start or end with a /.

container str

Azure container name.

indices str

A comma-delimited list of indices to restore from the snapshot. Multi-index syntax is supported. Example: metrics*,logs*,data-20240823.

snapshot_name str

The snapshot name to restore from.

chunk_size str

Big files can be broken down into chunks during snapshotting if needed. Should be the same as for the 3rd party repository.

compress bool

When set to true metadata files are stored in compressed format.

endpoint_suffix str

Defines the DNS suffix for Azure Storage endpoints.

include_aliases bool

Whether to restore aliases alongside their associated indexes. Default is true.

key str

Azure account secret key. One of key or sas_token should be specified.

restore_global_state bool

If true, restore the cluster state. Defaults to false.

sas_token str

A shared access signatures (SAS) token. One of key or sas_token should be specified.

account String

Azure account name.

basePath String

The path to the repository data within its container. The value of this setting should not start or end with a /.

container String

Azure container name.

indices String

A comma-delimited list of indices to restore from the snapshot. Multi-index syntax is supported. Example: metrics*,logs*,data-20240823.

snapshotName String

The snapshot name to restore from.

chunkSize String

Big files can be broken down into chunks during snapshotting if needed. Should be the same as for the 3rd party repository.

compress Boolean

When set to true metadata files are stored in compressed format.

endpointSuffix String

Defines the DNS suffix for Azure Storage endpoints.

includeAliases Boolean

Whether to restore aliases alongside their associated indexes. Default is true.

key String

Azure account secret key. One of key or sas_token should be specified.

restoreGlobalState Boolean

If true, restore the cluster state. Defaults to false.

sasToken String

A shared access signatures (SAS) token. One of key or sas_token should be specified.

BasePath string

The path to the repository data within its container. The value of this setting should not start or end with a /.

Bucket string

The path to the repository data within its container.

Credentials string

Google Cloud Storage credentials file content.

Indices string

A comma-delimited list of indices to restore from the snapshot. Multi-index syntax is supported. Example: metrics*,logs*,data-20240823.

SnapshotName string

The snapshot name to restore from.

ChunkSize string

Big files can be broken down into chunks during snapshotting if needed. Should be the same as for the 3rd party repository.

Compress bool

When set to true metadata files are stored in compressed format.

IncludeAliases bool

Whether to restore aliases alongside their associated indexes. Default is true.

RestoreGlobalState bool

If true, restore the cluster state. Defaults to false.

BasePath string

The path to the repository data within its container. The value of this setting should not start or end with a /.

Bucket string

The path to the repository data within its container.

Credentials string

Google Cloud Storage credentials file content.

Indices string

A comma-delimited list of indices to restore from the snapshot. Multi-index syntax is supported. Example: metrics*,logs*,data-20240823.

SnapshotName string

The snapshot name to restore from.

ChunkSize string

Big files can be broken down into chunks during snapshotting if needed. Should be the same as for the 3rd party repository.

Compress bool

When set to true metadata files are stored in compressed format.

IncludeAliases bool

Whether to restore aliases alongside their associated indexes. Default is true.

RestoreGlobalState bool

If true, restore the cluster state. Defaults to false.

basePath String

The path to the repository data within its container. The value of this setting should not start or end with a /.

bucket String

The path to the repository data within its container.

credentials String

Google Cloud Storage credentials file content.

indices String

A comma-delimited list of indices to restore from the snapshot. Multi-index syntax is supported. Example: metrics*,logs*,data-20240823.

snapshotName String

The snapshot name to restore from.

chunkSize String

Big files can be broken down into chunks during snapshotting if needed. Should be the same as for the 3rd party repository.

compress Boolean

When set to true metadata files are stored in compressed format.

includeAliases Boolean

Whether to restore aliases alongside their associated indexes. Default is true.

restoreGlobalState Boolean

If true, restore the cluster state. Defaults to false.

basePath string

The path to the repository data within its container. The value of this setting should not start or end with a /.

bucket string

The path to the repository data within its container.

credentials string

Google Cloud Storage credentials file content.

indices string

A comma-delimited list of indices to restore from the snapshot. Multi-index syntax is supported. Example: metrics*,logs*,data-20240823.

snapshotName string

The snapshot name to restore from.

chunkSize string

Big files can be broken down into chunks during snapshotting if needed. Should be the same as for the 3rd party repository.

compress boolean

When set to true metadata files are stored in compressed format.

includeAliases boolean

Whether to restore aliases alongside their associated indexes. Default is true.

restoreGlobalState boolean

If true, restore the cluster state. Defaults to false.

base_path str

The path to the repository data within its container. The value of this setting should not start or end with a /.

bucket str

The path to the repository data within its container.

credentials str

Google Cloud Storage credentials file content.

indices str

A comma-delimited list of indices to restore from the snapshot. Multi-index syntax is supported. Example: metrics*,logs*,data-20240823.

snapshot_name str

The snapshot name to restore from.

chunk_size str

Big files can be broken down into chunks during snapshotting if needed. Should be the same as for the 3rd party repository.

compress bool

When set to true metadata files are stored in compressed format.

include_aliases bool

Whether to restore aliases alongside their associated indexes. Default is true.

restore_global_state bool

If true, restore the cluster state. Defaults to false.

basePath String

The path to the repository data within its container. The value of this setting should not start or end with a /.

bucket String

The path to the repository data within its container.

credentials String

Google Cloud Storage credentials file content.

indices String

A comma-delimited list of indices to restore from the snapshot. Multi-index syntax is supported. Example: metrics*,logs*,data-20240823.

snapshotName String

The snapshot name to restore from.

chunkSize String

Big files can be broken down into chunks during snapshotting if needed. Should be the same as for the 3rd party repository.

compress Boolean

When set to true metadata files are stored in compressed format.

includeAliases Boolean

Whether to restore aliases alongside their associated indexes. Default is true.

restoreGlobalState Boolean

If true, restore the cluster state. Defaults to false.

MaxIndexCount int

Maximum number of indexes to keep. Example: 3.

Pattern string

fnmatch pattern. Example: logs_*_foo_*.

SortingAlgorithm string

Enum: alphabetical, creation_date. Deletion sorting algorithm. Default: creation_date.

MaxIndexCount int

Maximum number of indexes to keep. Example: 3.

Pattern string

fnmatch pattern. Example: logs_*_foo_*.

SortingAlgorithm string

Enum: alphabetical, creation_date. Deletion sorting algorithm. Default: creation_date.

maxIndexCount Integer

Maximum number of indexes to keep. Example: 3.

pattern String

fnmatch pattern. Example: logs_*_foo_*.

sortingAlgorithm String

Enum: alphabetical, creation_date. Deletion sorting algorithm. Default: creation_date.

maxIndexCount number

Maximum number of indexes to keep. Example: 3.

pattern string

fnmatch pattern. Example: logs_*_foo_*.

sortingAlgorithm string

Enum: alphabetical, creation_date. Deletion sorting algorithm. Default: creation_date.

max_index_count int

Maximum number of indexes to keep. Example: 3.

pattern str

fnmatch pattern. Example: logs_*_foo_*.

sorting_algorithm str

Enum: alphabetical, creation_date. Deletion sorting algorithm. Default: creation_date.

maxIndexCount Number

Maximum number of indexes to keep. Example: 3.

pattern String

fnmatch pattern. Example: logs_*_foo_*.

sortingAlgorithm String

Enum: alphabetical, creation_date. Deletion sorting algorithm. Default: creation_date.

RollupDashboardsEnabled bool

Whether rollups are enabled in OpenSearch Dashboards. Defaults to true.

RollupEnabled bool

Whether the rollup plugin is enabled. Defaults to true.

RollupSearchBackoffCount int

How many retries the plugin should attempt for failed rollup jobs. Defaults to 5.

RollupSearchBackoffMillis int

The backoff time between retries for failed rollup jobs. Defaults to 1000ms.

RollupSearchSearchAllJobs bool

Whether OpenSearch should return all jobs that match all specified search terms. If disabled, OpenSearch returns just one, as opposed to all, of the jobs that matches the search terms. Defaults to false.

RollupDashboardsEnabled bool

Whether rollups are enabled in OpenSearch Dashboards. Defaults to true.

RollupEnabled bool

Whether the rollup plugin is enabled. Defaults to true.

RollupSearchBackoffCount int

How many retries the plugin should attempt for failed rollup jobs. Defaults to 5.

RollupSearchBackoffMillis int

The backoff time between retries for failed rollup jobs. Defaults to 1000ms.

RollupSearchSearchAllJobs bool

Whether OpenSearch should return all jobs that match all specified search terms. If disabled, OpenSearch returns just one, as opposed to all, of the jobs that matches the search terms. Defaults to false.

rollupDashboardsEnabled Boolean

Whether rollups are enabled in OpenSearch Dashboards. Defaults to true.

rollupEnabled Boolean

Whether the rollup plugin is enabled. Defaults to true.

rollupSearchBackoffCount Integer

How many retries the plugin should attempt for failed rollup jobs. Defaults to 5.

rollupSearchBackoffMillis Integer

The backoff time between retries for failed rollup jobs. Defaults to 1000ms.

rollupSearchSearchAllJobs Boolean

Whether OpenSearch should return all jobs that match all specified search terms. If disabled, OpenSearch returns just one, as opposed to all, of the jobs that matches the search terms. Defaults to false.

rollupDashboardsEnabled boolean

Whether rollups are enabled in OpenSearch Dashboards. Defaults to true.

rollupEnabled boolean

Whether the rollup plugin is enabled. Defaults to true.

rollupSearchBackoffCount number

How many retries the plugin should attempt for failed rollup jobs. Defaults to 5.

rollupSearchBackoffMillis number

The backoff time between retries for failed rollup jobs. Defaults to 1000ms.

rollupSearchSearchAllJobs boolean

Whether OpenSearch should return all jobs that match all specified search terms. If disabled, OpenSearch returns just one, as opposed to all, of the jobs that matches the search terms. Defaults to false.

rollup_dashboards_enabled bool

Whether rollups are enabled in OpenSearch Dashboards. Defaults to true.

rollup_enabled bool

Whether the rollup plugin is enabled. Defaults to true.

rollup_search_backoff_count int

How many retries the plugin should attempt for failed rollup jobs. Defaults to 5.

rollup_search_backoff_millis int

The backoff time between retries for failed rollup jobs. Defaults to 1000ms.

rollup_search_search_all_jobs bool

Whether OpenSearch should return all jobs that match all specified search terms. If disabled, OpenSearch returns just one, as opposed to all, of the jobs that matches the search terms. Defaults to false.

rollupDashboardsEnabled Boolean

Whether rollups are enabled in OpenSearch Dashboards. Defaults to true.

rollupEnabled Boolean

Whether the rollup plugin is enabled. Defaults to true.

rollupSearchBackoffCount Number

How many retries the plugin should attempt for failed rollup jobs. Defaults to 5.

rollupSearchBackoffMillis Number

The backoff time between retries for failed rollup jobs. Defaults to 1000ms.

rollupSearchSearchAllJobs Boolean

Whether OpenSearch should return all jobs that match all specified search terms. If disabled, OpenSearch returns just one, as opposed to all, of the jobs that matches the search terms. Defaults to false.

MappingNestedObjectsLimit int

The maximum number of nested JSON objects that a single document can contain across all nested types. This limit helps to prevent out of memory errors when a document contains too many nested objects. Default is 10000. Example: 10000.

NumberOfReplicas int

The number of replicas each primary shard has. Example: 1.

NumberOfShards int

The number of primary shards that an index should have. Example: 1.

MappingNestedObjectsLimit int

The maximum number of nested JSON objects that a single document can contain across all nested types. This limit helps to prevent out of memory errors when a document contains too many nested objects. Default is 10000. Example: 10000.

NumberOfReplicas int

The number of replicas each primary shard has. Example: 1.

NumberOfShards int

The number of primary shards that an index should have. Example: 1.

mappingNestedObjectsLimit Integer

The maximum number of nested JSON objects that a single document can contain across all nested types. This limit helps to prevent out of memory errors when a document contains too many nested objects. Default is 10000. Example: 10000.

numberOfReplicas Integer

The number of replicas each primary shard has. Example: 1.

numberOfShards Integer

The number of primary shards that an index should have. Example: 1.

mappingNestedObjectsLimit number

The maximum number of nested JSON objects that a single document can contain across all nested types. This limit helps to prevent out of memory errors when a document contains too many nested objects. Default is 10000. Example: 10000.

numberOfReplicas number

The number of replicas each primary shard has. Example: 1.

numberOfShards number

The number of primary shards that an index should have. Example: 1.

mapping_nested_objects_limit int

The maximum number of nested JSON objects that a single document can contain across all nested types. This limit helps to prevent out of memory errors when a document contains too many nested objects. Default is 10000. Example: 10000.

number_of_replicas int

The number of replicas each primary shard has. Example: 1.

number_of_shards int

The number of primary shards that an index should have. Example: 1.

mappingNestedObjectsLimit Number

The maximum number of nested JSON objects that a single document can contain across all nested types. This limit helps to prevent out of memory errors when a document contains too many nested objects. Default is 10000. Example: 10000.

numberOfReplicas Number

The number of replicas each primary shard has. Example: 1.

numberOfShards Number

The number of primary shards that an index should have. Example: 1.

Network string

CIDR address block. Example: 10.20.0.0/16.

Description string

Description for IP filter list entry. Example: Production service IP range.

Network string

CIDR address block. Example: 10.20.0.0/16.

Description string

Description for IP filter list entry. Example: Production service IP range.

network String

CIDR address block. Example: 10.20.0.0/16.

description String

Description for IP filter list entry. Example: Production service IP range.

network string

CIDR address block. Example: 10.20.0.0/16.

description string

Description for IP filter list entry. Example: Production service IP range.

network str

CIDR address block. Example: 10.20.0.0/16.

description str

Description for IP filter list entry. Example: Production service IP range.

network String

CIDR address block. Example: 10.20.0.0/16.

description String

Description for IP filter list entry. Example: Production service IP range.

ClientId string

The ID of the OpenID Connect client configured in your IdP. Required.

ClientSecret string

The client secret of the OpenID Connect client configured in your IdP. Required.

ConnectUrl string

The URL of your IdP where the Security plugin can find the OpenID Connect metadata/configuration settings. Example: https://test-account.okta.com/app/exk491jujcVc83LEX697/sso/saml/metadata.

Enabled bool

Enables or disables OpenID Connect authentication for OpenSearch. When enabled, users can authenticate using OpenID Connect with an Identity Provider. Default: true.

Header string

HTTP header name of the JWT token. Optional. Default is Authorization. Default: Authorization.

JwtHeader string

The HTTP header that stores the token. Typically the Authorization header with the Bearer schema: Authorization: Bearer . Optional. Default is Authorization. Example: preferred_username.

JwtUrlParameter string

If the token is not transmitted in the HTTP header, but as an URL parameter, define the name of the parameter here. Optional. Example: preferred_username.

RefreshRateLimitCount int

The maximum number of unknown key IDs in the time frame. Default is 10. Optional. Default: 10.

RefreshRateLimitTimeWindowMs int

The time frame to use when checking the maximum number of unknown key IDs, in milliseconds. Optional.Default is 10000 (10 seconds). Default: 10000.

RolesKey string

The key in the JSON payload that stores the user’s roles. The value of this key must be a comma-separated list of roles. Required only if you want to use roles in the JWT. Example: roles.

Scope string

The scope of the identity token issued by the IdP. Optional. Default is openid profile email address phone.

SubjectKey string

The key in the JSON payload that stores the user’s name. If not defined, the subject registered claim is used. Most IdP providers use the preferred_username claim. Optional. Example: preferred_username.

ClientId string

The ID of the OpenID Connect client configured in your IdP. Required.

ClientSecret string

The client secret of the OpenID Connect client configured in your IdP. Required.

ConnectUrl string

The URL of your IdP where the Security plugin can find the OpenID Connect metadata/configuration settings. Example: https://test-account.okta.com/app/exk491jujcVc83LEX697/sso/saml/metadata.

Enabled bool

Enables or disables OpenID Connect authentication for OpenSearch. When enabled, users can authenticate using OpenID Connect with an Identity Provider. Default: true.

Header string

HTTP header name of the JWT token. Optional. Default is Authorization. Default: Authorization.

JwtHeader string

The HTTP header that stores the token. Typically the Authorization header with the Bearer schema: Authorization: Bearer . Optional. Default is Authorization. Example: preferred_username.

JwtUrlParameter string

If the token is not transmitted in the HTTP header, but as an URL parameter, define the name of the parameter here. Optional. Example: preferred_username.

RefreshRateLimitCount int

The maximum number of unknown key IDs in the time frame. Default is 10. Optional. Default: 10.

RefreshRateLimitTimeWindowMs int

The time frame to use when checking the maximum number of unknown key IDs, in milliseconds. Optional.Default is 10000 (10 seconds). Default: 10000.

RolesKey string

The key in the JSON payload that stores the user’s roles. The value of this key must be a comma-separated list of roles. Required only if you want to use roles in the JWT. Example: roles.

Scope string

The scope of the identity token issued by the IdP. Optional. Default is openid profile email address phone.

SubjectKey string

The key in the JSON payload that stores the user’s name. If not defined, the subject registered claim is used. Most IdP providers use the preferred_username claim. Optional. Example: preferred_username.

clientId String

The ID of the OpenID Connect client configured in your IdP. Required.

clientSecret String

The client secret of the OpenID Connect client configured in your IdP. Required.

connectUrl String

The URL of your IdP where the Security plugin can find the OpenID Connect metadata/configuration settings. Example: https://test-account.okta.com/app/exk491jujcVc83LEX697/sso/saml/metadata.

enabled Boolean

Enables or disables OpenID Connect authentication for OpenSearch. When enabled, users can authenticate using OpenID Connect with an Identity Provider. Default: true.

header String

HTTP header name of the JWT token. Optional. Default is Authorization. Default: Authorization.

jwtHeader String

The HTTP header that stores the token. Typically the Authorization header with the Bearer schema: Authorization: Bearer . Optional. Default is Authorization. Example: preferred_username.

jwtUrlParameter String

If the token is not transmitted in the HTTP header, but as an URL parameter, define the name of the parameter here. Optional. Example: preferred_username.

refreshRateLimitCount Integer

The maximum number of unknown key IDs in the time frame. Default is 10. Optional. Default: 10.

refreshRateLimitTimeWindowMs Integer

The time frame to use when checking the maximum number of unknown key IDs, in milliseconds. Optional.Default is 10000 (10 seconds). Default: 10000.

rolesKey String

The key in the JSON payload that stores the user’s roles. The value of this key must be a comma-separated list of roles. Required only if you want to use roles in the JWT. Example: roles.

scope String

The scope of the identity token issued by the IdP. Optional. Default is openid profile email address phone.

subjectKey String

The key in the JSON payload that stores the user’s name. If not defined, the subject registered claim is used. Most IdP providers use the preferred_username claim. Optional. Example: preferred_username.

clientId string

The ID of the OpenID Connect client configured in your IdP. Required.

clientSecret string

The client secret of the OpenID Connect client configured in your IdP. Required.

connectUrl string

The URL of your IdP where the Security plugin can find the OpenID Connect metadata/configuration settings. Example: https://test-account.okta.com/app/exk491jujcVc83LEX697/sso/saml/metadata.

enabled boolean

Enables or disables OpenID Connect authentication for OpenSearch. When enabled, users can authenticate using OpenID Connect with an Identity Provider. Default: true.

header string

HTTP header name of the JWT token. Optional. Default is Authorization. Default: Authorization.

jwtHeader string

The HTTP header that stores the token. Typically the Authorization header with the Bearer schema: Authorization: Bearer . Optional. Default is Authorization. Example: preferred_username.

jwtUrlParameter string

If the token is not transmitted in the HTTP header, but as an URL parameter, define the name of the parameter here. Optional. Example: preferred_username.

refreshRateLimitCount number

The maximum number of unknown key IDs in the time frame. Default is 10. Optional. Default: 10.

refreshRateLimitTimeWindowMs number

The time frame to use when checking the maximum number of unknown key IDs, in milliseconds. Optional.Default is 10000 (10 seconds). Default: 10000.

rolesKey string

The key in the JSON payload that stores the user’s roles. The value of this key must be a comma-separated list of roles. Required only if you want to use roles in the JWT. Example: roles.

scope string

The scope of the identity token issued by the IdP. Optional. Default is openid profile email address phone.

subjectKey string

The key in the JSON payload that stores the user’s name. If not defined, the subject registered claim is used. Most IdP providers use the preferred_username claim. Optional. Example: preferred_username.

client_id str

The ID of the OpenID Connect client configured in your IdP. Required.

client_secret str

The client secret of the OpenID Connect client configured in your IdP. Required.

connect_url str

The URL of your IdP where the Security plugin can find the OpenID Connect metadata/configuration settings. Example: https://test-account.okta.com/app/exk491jujcVc83LEX697/sso/saml/metadata.

enabled bool

Enables or disables OpenID Connect authentication for OpenSearch. When enabled, users can authenticate using OpenID Connect with an Identity Provider. Default: true.

header str

HTTP header name of the JWT token. Optional. Default is Authorization. Default: Authorization.

jwt_header str

The HTTP header that stores the token. Typically the Authorization header with the Bearer schema: Authorization: Bearer . Optional. Default is Authorization. Example: preferred_username.

jwt_url_parameter str

If the token is not transmitted in the HTTP header, but as an URL parameter, define the name of the parameter here. Optional. Example: preferred_username.

refresh_rate_limit_count int

The maximum number of unknown key IDs in the time frame. Default is 10. Optional. Default: 10.

refresh_rate_limit_time_window_ms int

The time frame to use when checking the maximum number of unknown key IDs, in milliseconds. Optional.Default is 10000 (10 seconds). Default: 10000.

roles_key str

The key in the JSON payload that stores the user’s roles. The value of this key must be a comma-separated list of roles. Required only if you want to use roles in the JWT. Example: roles.

scope str

The scope of the identity token issued by the IdP. Optional. Default is openid profile email address phone.

subject_key str

The key in the JSON payload that stores the user’s name. If not defined, the subject registered claim is used. Most IdP providers use the preferred_username claim. Optional. Example: preferred_username.

clientId String

The ID of the OpenID Connect client configured in your IdP. Required.

clientSecret String

The client secret of the OpenID Connect client configured in your IdP. Required.

connectUrl String

The URL of your IdP where the Security plugin can find the OpenID Connect metadata/configuration settings. Example: https://test-account.okta.com/app/exk491jujcVc83LEX697/sso/saml/metadata.

enabled Boolean

Enables or disables OpenID Connect authentication for OpenSearch. When enabled, users can authenticate using OpenID Connect with an Identity Provider. Default: true.

header String

HTTP header name of the JWT token. Optional. Default is Authorization. Default: Authorization.

jwtHeader String

The HTTP header that stores the token. Typically the Authorization header with the Bearer schema: Authorization: Bearer . Optional. Default is Authorization. Example: preferred_username.

jwtUrlParameter String

If the token is not transmitted in the HTTP header, but as an URL parameter, define the name of the parameter here. Optional. Example: preferred_username.

refreshRateLimitCount Number

The maximum number of unknown key IDs in the time frame. Default is 10. Optional. Default: 10.

refreshRateLimitTimeWindowMs Number

The time frame to use when checking the maximum number of unknown key IDs, in milliseconds. Optional.Default is 10000 (10 seconds). Default: 10000.

rolesKey String

The key in the JSON payload that stores the user’s roles. The value of this key must be a comma-separated list of roles. Required only if you want to use roles in the JWT. Example: roles.

scope String

The scope of the identity token issued by the IdP. Optional. Default is openid profile email address phone.

subjectKey String

The key in the JSON payload that stores the user’s name. If not defined, the subject registered claim is used. Most IdP providers use the preferred_username claim. Optional. Example: preferred_username.

ActionAutoCreateIndexEnabled bool

Explicitly allow or block automatic creation of indices. Defaults to true.

ActionDestructiveRequiresName bool

Require explicit index names when deleting.

AuthFailureListeners GetOpenSearchOpensearchUserConfigOpensearchAuthFailureListeners

Opensearch Security Plugin Settings

ClusterMaxShardsPerNode int

Controls the number of shards allowed in the cluster per data node. Example: 1000.

ClusterRoutingAllocationNodeConcurrentRecoveries int

How many concurrent incoming/outgoing shard recoveries (normally replicas) are allowed to happen on a node. Defaults to node cpu count * 2.

EmailSenderName string

Sender name placeholder to be used in Opensearch Dashboards and Opensearch keystore. Example: alert-sender.

EmailSenderPassword string

Sender password for Opensearch alerts to authenticate with SMTP server. Example: very-secure-mail-password.

EmailSenderUsername string

Sender username for Opensearch alerts. Example: jane@example.com.

EnableSecurityAudit bool

Enable/Disable security audit.

HttpMaxContentLength int

Maximum content length for HTTP requests to the OpenSearch HTTP API, in bytes.

HttpMaxHeaderSize int

The max size of allowed headers, in bytes. Example: 8192.

HttpMaxInitialLineLength int

The max length of an HTTP URL, in bytes. Example: 4096.

IndicesFielddataCacheSize int

Relative amount. Maximum amount of heap memory used for field data cache. This is an expert setting; decreasing the value too much will increase overhead of loading field data; too much memory used for field data cache will decrease amount of heap available for other operations.

IndicesMemoryIndexBufferSize int

Percentage value. Default is 10%. Total amount of heap used for indexing buffer, before writing segments to disk. This is an expert setting. Too low value will slow down indexing; too high value will increase indexing performance but causes performance issues for query performance.

IndicesMemoryMaxIndexBufferSize int

Absolute value. Default is unbound. Doesn't work without indices.memory.index_buffer_size. Maximum amount of heap used for query cache, an absolute indices.memory.index_buffer_size maximum hard limit.

IndicesMemoryMinIndexBufferSize int

Absolute value. Default is 48mb. Doesn't work without indices.memory.index_buffer_size. Minimum amount of heap used for query cache, an absolute indices.memory.index_buffer_size minimal hard limit.

IndicesQueriesCacheSize int

Percentage value. Default is 10%. Maximum amount of heap used for query cache. This is an expert setting. Too low value will decrease query performance and increase performance for other operations; too high value will cause issues with other OpenSearch functionality.

IndicesQueryBoolMaxClauseCount int

Maximum number of clauses Lucene BooleanQuery can have. The default value (1024) is relatively high, and increasing it may cause performance issues. Investigate other approaches first before increasing this value.

IndicesRecoveryMaxBytesPerSec int

Limits total inbound and outbound recovery traffic for each node. Applies to both peer recoveries as well as snapshot recoveries (i.e., restores from a snapshot). Defaults to 40mb.

IndicesRecoveryMaxConcurrentFileChunks int

Number of file chunks sent in parallel for each recovery. Defaults to 2.

IsmEnabled bool

Specifies whether ISM is enabled or not.

IsmHistoryEnabled bool

Specifies whether audit history is enabled or not. The logs from ISM are automatically indexed to a logs document.

IsmHistoryMaxAge int

The maximum age before rolling over the audit history index in hours. Example: 24.

IsmHistoryMaxDocs int

The maximum number of documents before rolling over the audit history index. Example: 2500000.

IsmHistoryRolloverCheckPeriod int

The time between rollover checks for the audit history index in hours. Example: 8.

IsmHistoryRolloverRetentionPeriod int

How long audit history indices are kept in days. Example: 30.

KnnMemoryCircuitBreakerEnabled bool

Enable or disable KNN memory circuit breaker. Defaults to true.

KnnMemoryCircuitBreakerLimit int

Maximum amount of memory that can be used for KNN index. Defaults to 50% of the JVM heap size.

OverrideMainResponseVersion bool

Compatibility mode sets OpenSearch to report its version as 7.10 so clients continue to work. Default is false.

PluginsAlertingFilterByBackendRoles bool

Enable or disable filtering of alerting by backend roles. Requires Security plugin. Defaults to false.

ReindexRemoteWhitelists List<string>

Whitelisted addresses for reindexing. Changing this value will cause all OpenSearch instances to restart.

ScriptMaxCompilationsRate string

Script compilation circuit breaker limits the number of inline script compilations within a period of time. Default is use-context. Example: 75/5m.

SearchBackpressure GetOpenSearchOpensearchUserConfigOpensearchSearchBackpressure

Search Backpressure Settings

SearchMaxBuckets int

Maximum number of aggregation buckets allowed in a single response. OpenSearch default value is used when this is not defined. Example: 10000.

ShardIndexingPressure GetOpenSearchOpensearchUserConfigOpensearchShardIndexingPressure

Shard indexing back pressure settings

ThreadPoolAnalyzeQueueSize int

Size for the thread pool queue. See documentation for exact details.

ThreadPoolAnalyzeSize int

Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.

ThreadPoolForceMergeSize int

Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.

ThreadPoolGetQueueSize int

Size for the thread pool queue. See documentation for exact details.

ThreadPoolGetSize int

Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.

ThreadPoolSearchQueueSize int

Size for the thread pool queue. See documentation for exact details.

ThreadPoolSearchSize int

Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.

ThreadPoolSearchThrottledQueueSize int

Size for the thread pool queue. See documentation for exact details.

ThreadPoolSearchThrottledSize int

Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.

ThreadPoolWriteQueueSize int

Size for the thread pool queue. See documentation for exact details.

ThreadPoolWriteSize int

Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.

ActionAutoCreateIndexEnabled bool

Explicitly allow or block automatic creation of indices. Defaults to true.

ActionDestructiveRequiresName bool

Require explicit index names when deleting.

AuthFailureListeners GetOpenSearchOpensearchUserConfigOpensearchAuthFailureListeners

Opensearch Security Plugin Settings

ClusterMaxShardsPerNode int

Controls the number of shards allowed in the cluster per data node. Example: 1000.

ClusterRoutingAllocationNodeConcurrentRecoveries int

How many concurrent incoming/outgoing shard recoveries (normally replicas) are allowed to happen on a node. Defaults to node cpu count * 2.

EmailSenderName string

Sender name placeholder to be used in Opensearch Dashboards and Opensearch keystore. Example: alert-sender.

EmailSenderPassword string

Sender password for Opensearch alerts to authenticate with SMTP server. Example: very-secure-mail-password.

EmailSenderUsername string

Sender username for Opensearch alerts. Example: jane@example.com.

EnableSecurityAudit bool

Enable/Disable security audit.

HttpMaxContentLength int

Maximum content length for HTTP requests to the OpenSearch HTTP API, in bytes.

HttpMaxHeaderSize int

The max size of allowed headers, in bytes. Example: 8192.

HttpMaxInitialLineLength int

The max length of an HTTP URL, in bytes. Example: 4096.

IndicesFielddataCacheSize int

Relative amount. Maximum amount of heap memory used for field data cache. This is an expert setting; decreasing the value too much will increase overhead of loading field data; too much memory used for field data cache will decrease amount of heap available for other operations.

IndicesMemoryIndexBufferSize int

Percentage value. Default is 10%. Total amount of heap used for indexing buffer, before writing segments to disk. This is an expert setting. Too low value will slow down indexing; too high value will increase indexing performance but causes performance issues for query performance.

IndicesMemoryMaxIndexBufferSize int

Absolute value. Default is unbound. Doesn't work without indices.memory.index_buffer_size. Maximum amount of heap used for query cache, an absolute indices.memory.index_buffer_size maximum hard limit.

IndicesMemoryMinIndexBufferSize int

Absolute value. Default is 48mb. Doesn't work without indices.memory.index_buffer_size. Minimum amount of heap used for query cache, an absolute indices.memory.index_buffer_size minimal hard limit.

IndicesQueriesCacheSize int

Percentage value. Default is 10%. Maximum amount of heap used for query cache. This is an expert setting. Too low value will decrease query performance and increase performance for other operations; too high value will cause issues with other OpenSearch functionality.

IndicesQueryBoolMaxClauseCount int

Maximum number of clauses Lucene BooleanQuery can have. The default value (1024) is relatively high, and increasing it may cause performance issues. Investigate other approaches first before increasing this value.

IndicesRecoveryMaxBytesPerSec int

Limits total inbound and outbound recovery traffic for each node. Applies to both peer recoveries as well as snapshot recoveries (i.e., restores from a snapshot). Defaults to 40mb.

IndicesRecoveryMaxConcurrentFileChunks int

Number of file chunks sent in parallel for each recovery. Defaults to 2.

IsmEnabled bool

Specifies whether ISM is enabled or not.

IsmHistoryEnabled bool

Specifies whether audit history is enabled or not. The logs from ISM are automatically indexed to a logs document.

IsmHistoryMaxAge int

The maximum age before rolling over the audit history index in hours. Example: 24.

IsmHistoryMaxDocs int

The maximum number of documents before rolling over the audit history index. Example: 2500000.

IsmHistoryRolloverCheckPeriod int

The time between rollover checks for the audit history index in hours. Example: 8.

IsmHistoryRolloverRetentionPeriod int

How long audit history indices are kept in days. Example: 30.

KnnMemoryCircuitBreakerEnabled bool

Enable or disable KNN memory circuit breaker. Defaults to true.

KnnMemoryCircuitBreakerLimit int

Maximum amount of memory that can be used for KNN index. Defaults to 50% of the JVM heap size.

OverrideMainResponseVersion bool

Compatibility mode sets OpenSearch to report its version as 7.10 so clients continue to work. Default is false.

PluginsAlertingFilterByBackendRoles bool

Enable or disable filtering of alerting by backend roles. Requires Security plugin. Defaults to false.

ReindexRemoteWhitelists []string

Whitelisted addresses for reindexing. Changing this value will cause all OpenSearch instances to restart.

ScriptMaxCompilationsRate string

Script compilation circuit breaker limits the number of inline script compilations within a period of time. Default is use-context. Example: 75/5m.

SearchBackpressure GetOpenSearchOpensearchUserConfigOpensearchSearchBackpressure

Search Backpressure Settings

SearchMaxBuckets int

Maximum number of aggregation buckets allowed in a single response. OpenSearch default value is used when this is not defined. Example: 10000.

ShardIndexingPressure GetOpenSearchOpensearchUserConfigOpensearchShardIndexingPressure

Shard indexing back pressure settings

ThreadPoolAnalyzeQueueSize int

Size for the thread pool queue. See documentation for exact details.

ThreadPoolAnalyzeSize int

Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.

ThreadPoolForceMergeSize int

Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.

ThreadPoolGetQueueSize int

Size for the thread pool queue. See documentation for exact details.

ThreadPoolGetSize int

Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.

ThreadPoolSearchQueueSize int

Size for the thread pool queue. See documentation for exact details.

ThreadPoolSearchSize int

Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.

ThreadPoolSearchThrottledQueueSize int

Size for the thread pool queue. See documentation for exact details.

ThreadPoolSearchThrottledSize int

Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.

ThreadPoolWriteQueueSize int

Size for the thread pool queue. See documentation for exact details.

ThreadPoolWriteSize int

Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.