Aiven v6.37.0, Apr 10 25

Aiven v6.37.0 published on Thursday, Apr 10, 2025 by Pulumi

aiven.getM3Db

Explore with Pulumi AI

Aiven v6.37.0 published on Thursday, Apr 10, 2025 by Pulumi

!> End of life notice After 30 April 2025 all running Aiven for M3 services will be powered off and deleted, making data from these services inaccessible. You cannot create M3DB services in Aiven projects that didn’t have M3DB services before. To avoid interruptions to your service, migrate to Aiven for Thanos Metrics before the end of life date.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aiven from "@pulumi/aiven";

const exampleM3db = aiven.getM3Db({
    project: exampleProject.project,
    serviceName: "example-m3db-service",
});

import pulumi
import pulumi_aiven as aiven

example_m3db = aiven.get_m3_db(project=example_project["project"],
    service_name="example-m3db-service")

package main

import (
	"github.com/pulumi/pulumi-aiven/sdk/v6/go/aiven"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := aiven.LookupM3Db(ctx, &aiven.LookupM3DbArgs{
			Project:     exampleProject.Project,
			ServiceName: "example-m3db-service",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aiven = Pulumi.Aiven;

return await Deployment.RunAsync(() => 
{
    var exampleM3db = Aiven.GetM3Db.Invoke(new()
    {
        Project = exampleProject.Project,
        ServiceName = "example-m3db-service",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aiven.AivenFunctions;
import com.pulumi.aiven.inputs.GetM3DbArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var exampleM3db = AivenFunctions.getM3Db(GetM3DbArgs.builder()
            .project(exampleProject.project())
            .serviceName("example-m3db-service")
            .build());

    }
}

variables:
  exampleM3db:
    fn::invoke:
      function: aiven:getM3Db
      arguments:
        project: ${exampleProject.project}
        serviceName: example-m3db-service

Using getM3Db

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getM3Db(args: GetM3DbArgs, opts?: InvokeOptions): Promise<GetM3DbResult>
function getM3DbOutput(args: GetM3DbOutputArgs, opts?: InvokeOptions): Output<GetM3DbResult>

def get_m3_db(project: Optional[str] = None,
              service_name: Optional[str] = None,
              opts: Optional[InvokeOptions] = None) -> GetM3DbResult
def get_m3_db_output(project: Optional[pulumi.Input[str]] = None,
              service_name: Optional[pulumi.Input[str]] = None,
              opts: Optional[InvokeOptions] = None) -> Output[GetM3DbResult]

func LookupM3Db(ctx *Context, args *LookupM3DbArgs, opts ...InvokeOption) (*LookupM3DbResult, error)
func LookupM3DbOutput(ctx *Context, args *LookupM3DbOutputArgs, opts ...InvokeOption) LookupM3DbResultOutput

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

public static class GetM3Db 
{
    public static Task<GetM3DbResult> InvokeAsync(GetM3DbArgs args, InvokeOptions? opts = null)
    public static Output<GetM3DbResult> Invoke(GetM3DbInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetM3DbResult> getM3Db(GetM3DbArgs args, InvokeOptions options)
public static Output<GetM3DbResult> getM3Db(GetM3DbArgs args, InvokeOptions options)

fn::invoke:
  function: aiven:index/getM3Db:getM3Db
  arguments:
    # arguments dictionary

The following arguments are supported:

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.

getM3Db Result

The following output properties are available:

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 without an autoscaler integration or high availability capabilities. The field can be safely removed when autoscaler is enabled without causing any changes.
CloudName string: The cloud provider and region the service is hosted in. The format is provider-region, for example: google-europe-west1. The available cloud regions can differ per project and service. Changing this value migrates the service to another cloud provider or region. The migration runs in the background and includes a DNS update to redirect traffic to the new region. Most services experience no downtime, but some databases may have a brief interruption during DNS propagation.
Components List<GetM3DbComponent>: 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.
M3dbUserConfigs List<GetM3DbM3dbUserConfig>: M3db user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
M3dbs List<GetM3DbM3db>: Values provided by the M3DB server.
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.
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<GetM3DbServiceIntegration>: 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
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<GetM3DbTag>: Tags are key-value pairs that allow you to categorize services.
TechEmails List<GetM3DbTechEmail>: 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 without an autoscaler integration or high availability capabilities. The field can be safely removed when autoscaler is enabled without causing any changes.
CloudName string: The cloud provider and region the service is hosted in. The format is provider-region, for example: google-europe-west1. The available cloud regions can differ per project and service. Changing this value migrates the service to another cloud provider or region. The migration runs in the background and includes a DNS update to redirect traffic to the new region. Most services experience no downtime, but some databases may have a brief interruption during DNS propagation.
Components []GetM3DbComponent: 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.
M3dbUserConfigs []GetM3DbM3dbUserConfig: M3db user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
M3dbs []GetM3DbM3db: Values provided by the M3DB server.
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.
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 []GetM3DbServiceIntegration: 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
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 []GetM3DbTag: Tags are key-value pairs that allow you to categorize services.
TechEmails []GetM3DbTechEmail: 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 without an autoscaler integration or high availability capabilities. The field can be safely removed when autoscaler is enabled without causing any changes.
cloudName String: The cloud provider and region the service is hosted in. The format is provider-region, for example: google-europe-west1. The available cloud regions can differ per project and service. Changing this value migrates the service to another cloud provider or region. The migration runs in the background and includes a DNS update to redirect traffic to the new region. Most services experience no downtime, but some databases may have a brief interruption during DNS propagation.
components List<GetM3DbComponent>: 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.
m3dbUserConfigs List<GetM3DbM3dbUserConfig>: M3db user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
m3dbs List<GetM3DbM3db>: Values provided by the M3DB server.
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.
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<GetM3DbServiceIntegration>: 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
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<GetM3DbTag>: Tags are key-value pairs that allow you to categorize services.
techEmails List<GetM3DbTechEmail>: 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 without an autoscaler integration or high availability capabilities. The field can be safely removed when autoscaler is enabled without causing any changes.
cloudName string: The cloud provider and region the service is hosted in. The format is provider-region, for example: google-europe-west1. The available cloud regions can differ per project and service. Changing this value migrates the service to another cloud provider or region. The migration runs in the background and includes a DNS update to redirect traffic to the new region. Most services experience no downtime, but some databases may have a brief interruption during DNS propagation.
components GetM3DbComponent[]: 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.
m3dbUserConfigs GetM3DbM3dbUserConfig[]: M3db user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
m3dbs GetM3DbM3db[]: Values provided by the M3DB server.
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.
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 GetM3DbServiceIntegration[]: 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
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 GetM3DbTag[]: Tags are key-value pairs that allow you to categorize services.
techEmails GetM3DbTechEmail[]: 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 without an autoscaler integration or high availability capabilities. The field can be safely removed when autoscaler is enabled without causing any changes.
cloud_name str: The cloud provider and region the service is hosted in. The format is provider-region, for example: google-europe-west1. The available cloud regions can differ per project and service. Changing this value migrates the service to another cloud provider or region. The migration runs in the background and includes a DNS update to redirect traffic to the new region. Most services experience no downtime, but some databases may have a brief interruption during DNS propagation.
components Sequence[GetM3DbComponent]: 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.
m3db_user_configs Sequence[GetM3DbM3dbUserConfig]: M3db user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
m3dbs Sequence[GetM3DbM3db]: Values provided by the M3DB server.
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.
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[GetM3DbServiceIntegration]: 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
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[GetM3DbTag]: Tags are key-value pairs that allow you to categorize services.
tech_emails Sequence[GetM3DbTechEmail]: 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 without an autoscaler integration or high availability capabilities. The field can be safely removed when autoscaler is enabled without causing any changes.
cloudName String: The cloud provider and region the service is hosted in. The format is provider-region, for example: google-europe-west1. The available cloud regions can differ per project and service. Changing this value migrates the service to another cloud provider or region. The migration runs in the background and includes a DNS update to redirect traffic to the new region. Most services experience no downtime, but some databases may have a brief interruption during DNS propagation.
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.
m3dbUserConfigs List<Property Map>: M3db user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
m3dbs List<Property Map>: Values provided by the M3DB server.
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.
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
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.

Supporting Types

GetM3DbComponent

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
KafkaSslCa string: Kafka certificate used. The possible values are letsencrypt and project_ca.
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
KafkaSslCa string: Kafka certificate used. The possible values are letsencrypt and project_ca.
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
kafkaSslCa String: Kafka certificate used. The possible values are letsencrypt and project_ca.
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
kafkaSslCa string: Kafka certificate used. The possible values are letsencrypt and project_ca.
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
kafka_ssl_ca str: Kafka certificate used. The possible values are letsencrypt and project_ca.
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
kafkaSslCa String: Kafka certificate used. The possible values are letsencrypt and project_ca.
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

GetM3DbM3db

HttpClusterUri string: M3DB cluster URI.
HttpNodeUri string: M3DB node URI.
InfluxdbUri string: InfluxDB URI.
PrometheusRemoteReadUri string: Prometheus remote read URI.
PrometheusRemoteWriteUri string: Prometheus remote write URI.
Uris List<string>: M3DB server URIs.

HttpClusterUri string: M3DB cluster URI.
HttpNodeUri string: M3DB node URI.
InfluxdbUri string: InfluxDB URI.
PrometheusRemoteReadUri string: Prometheus remote read URI.
PrometheusRemoteWriteUri string: Prometheus remote write URI.
Uris []string: M3DB server URIs.

httpClusterUri String: M3DB cluster URI.
httpNodeUri String: M3DB node URI.
influxdbUri String: InfluxDB URI.
prometheusRemoteReadUri String: Prometheus remote read URI.
prometheusRemoteWriteUri String: Prometheus remote write URI.
uris List<String>: M3DB server URIs.

httpClusterUri string: M3DB cluster URI.
httpNodeUri string: M3DB node URI.
influxdbUri string: InfluxDB URI.
prometheusRemoteReadUri string: Prometheus remote read URI.
prometheusRemoteWriteUri string: Prometheus remote write URI.
uris string[]: M3DB server URIs.

http_cluster_uri str: M3DB cluster URI.
http_node_uri str: M3DB node URI.
influxdb_uri str: InfluxDB URI.
prometheus_remote_read_uri str: Prometheus remote read URI.
prometheus_remote_write_uri str: Prometheus remote write URI.
uris Sequence[str]: M3DB server URIs.

httpClusterUri String: M3DB cluster URI.
httpNodeUri String: M3DB node URI.
influxdbUri String: InfluxDB URI.
prometheusRemoteReadUri String: Prometheus remote read URI.
prometheusRemoteWriteUri String: Prometheus remote write URI.
uris List<String>: M3DB server URIs.

GetM3DbM3dbUserConfig

AdditionalBackupRegions string: Additional Cloud Regions for Backup Replication.
CustomDomain string: Serve the web frontend using a custom CNAME pointing to the Aiven DNS name. Example: grafana.example.org.
IpFilterObjects List<GetM3DbM3dbUserConfigIpFilterObject>: 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.
Limits GetM3DbM3dbUserConfigLimits: M3 limits
M3 GetM3DbM3dbUserConfigM3: M3 specific configuration options
M3Version string: Enum: 1.1, 1.2, 1.5, and newer. M3 major version (deprecated, use m3db_version).
M3coordinatorEnableGraphiteCarbonIngest bool: Enables access to Graphite Carbon plaintext metrics ingestion. It can be enabled only for services inside VPCs. The metrics are written to aggregated namespaces only.
M3dbVersion string: Enum: 1.1, 1.2, 1.5, and newer. M3 major version (the minimum compatible version).
Namespaces List<GetM3DbM3dbUserConfigNamespace>: List of M3 namespaces
PrivateAccess GetM3DbM3dbUserConfigPrivateAccess: Allow access to selected service ports from private networks
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 GetM3DbM3dbUserConfigPublicAccess: Allow access to selected service ports from the public Internet
Rules GetM3DbM3dbUserConfigRules: M3 rules
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.
CustomDomain string: Serve the web frontend using a custom CNAME pointing to the Aiven DNS name. Example: grafana.example.org.
IpFilterObjects []GetM3DbM3dbUserConfigIpFilterObject: 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.
Limits GetM3DbM3dbUserConfigLimits: M3 limits
M3 GetM3DbM3dbUserConfigM3: M3 specific configuration options
M3Version string: Enum: 1.1, 1.2, 1.5, and newer. M3 major version (deprecated, use m3db_version).
M3coordinatorEnableGraphiteCarbonIngest bool: Enables access to Graphite Carbon plaintext metrics ingestion. It can be enabled only for services inside VPCs. The metrics are written to aggregated namespaces only.
M3dbVersion string: Enum: 1.1, 1.2, 1.5, and newer. M3 major version (the minimum compatible version).
Namespaces []GetM3DbM3dbUserConfigNamespace: List of M3 namespaces
PrivateAccess GetM3DbM3dbUserConfigPrivateAccess: Allow access to selected service ports from private networks
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 GetM3DbM3dbUserConfigPublicAccess: Allow access to selected service ports from the public Internet
Rules GetM3DbM3dbUserConfigRules: M3 rules
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.
customDomain String: Serve the web frontend using a custom CNAME pointing to the Aiven DNS name. Example: grafana.example.org.
ipFilterObjects List<GetM3DbM3dbUserConfigIpFilterObject>: 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.
limits GetM3DbM3dbUserConfigLimits: M3 limits
m3 GetM3DbM3dbUserConfigM3: M3 specific configuration options
m3Version String: Enum: 1.1, 1.2, 1.5, and newer. M3 major version (deprecated, use m3db_version).
m3coordinatorEnableGraphiteCarbonIngest Boolean: Enables access to Graphite Carbon plaintext metrics ingestion. It can be enabled only for services inside VPCs. The metrics are written to aggregated namespaces only.
m3dbVersion String: Enum: 1.1, 1.2, 1.5, and newer. M3 major version (the minimum compatible version).
namespaces List<GetM3DbM3dbUserConfigNamespace>: List of M3 namespaces
privateAccess GetM3DbM3dbUserConfigPrivateAccess: Allow access to selected service ports from private networks
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 GetM3DbM3dbUserConfigPublicAccess: Allow access to selected service ports from the public Internet
rules GetM3DbM3dbUserConfigRules: M3 rules
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.
customDomain string: Serve the web frontend using a custom CNAME pointing to the Aiven DNS name. Example: grafana.example.org.
ipFilterObjects GetM3DbM3dbUserConfigIpFilterObject[]: 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.
limits GetM3DbM3dbUserConfigLimits: M3 limits
m3 GetM3DbM3dbUserConfigM3: M3 specific configuration options
m3Version string: Enum: 1.1, 1.2, 1.5, and newer. M3 major version (deprecated, use m3db_version).
m3coordinatorEnableGraphiteCarbonIngest boolean: Enables access to Graphite Carbon plaintext metrics ingestion. It can be enabled only for services inside VPCs. The metrics are written to aggregated namespaces only.
m3dbVersion string: Enum: 1.1, 1.2, 1.5, and newer. M3 major version (the minimum compatible version).
namespaces GetM3DbM3dbUserConfigNamespace[]: List of M3 namespaces
privateAccess GetM3DbM3dbUserConfigPrivateAccess: Allow access to selected service ports from private networks
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 GetM3DbM3dbUserConfigPublicAccess: Allow access to selected service ports from the public Internet
rules GetM3DbM3dbUserConfigRules: M3 rules
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.
custom_domain str: Serve the web frontend using a custom CNAME pointing to the Aiven DNS name. Example: grafana.example.org.
ip_filter_objects Sequence[GetM3DbM3dbUserConfigIpFilterObject]: 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.
limits GetM3DbM3dbUserConfigLimits: M3 limits
m3 GetM3DbM3dbUserConfigM3: M3 specific configuration options
m3_version str: Enum: 1.1, 1.2, 1.5, and newer. M3 major version (deprecated, use m3db_version).
m3coordinator_enable_graphite_carbon_ingest bool: Enables access to Graphite Carbon plaintext metrics ingestion. It can be enabled only for services inside VPCs. The metrics are written to aggregated namespaces only.
m3db_version str: Enum: 1.1, 1.2, 1.5, and newer. M3 major version (the minimum compatible version).
namespaces Sequence[GetM3DbM3dbUserConfigNamespace]: List of M3 namespaces
private_access GetM3DbM3dbUserConfigPrivateAccess: Allow access to selected service ports from private networks
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 GetM3DbM3dbUserConfigPublicAccess: Allow access to selected service ports from the public Internet
rules GetM3DbM3dbUserConfigRules: M3 rules
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.
customDomain String: Serve the web frontend using a custom CNAME pointing to the Aiven DNS name. Example: grafana.example.org.
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.
limits Property Map: M3 limits
m3 Property Map: M3 specific configuration options
m3Version String: Enum: 1.1, 1.2, 1.5, and newer. M3 major version (deprecated, use m3db_version).
m3coordinatorEnableGraphiteCarbonIngest Boolean: Enables access to Graphite Carbon plaintext metrics ingestion. It can be enabled only for services inside VPCs. The metrics are written to aggregated namespaces only.
m3dbVersion String: Enum: 1.1, 1.2, 1.5, and newer. M3 major version (the minimum compatible version).
namespaces List<Property Map>: List of M3 namespaces
privateAccess Property Map: Allow access to selected service ports from private networks
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
rules Property Map: M3 rules
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.

GetM3DbM3dbUserConfigIpFilterObject

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.

GetM3DbM3dbUserConfigLimits

MaxRecentlyQueriedSeriesBlocks int: The maximum number of blocks that can be read in a given lookback period. Example: 20000.
MaxRecentlyQueriedSeriesDiskBytesRead int: The maximum number of disk bytes that can be read in a given lookback period. Example: 104857600.
MaxRecentlyQueriedSeriesLookback string: The lookback period for max_recently_queried_series_blocks and max_recently_queried_series_disk_bytes_read. Example: 15s.
QueryDocs int: The maximum number of docs fetched in single query. Example: 100000.
QueryRequireExhaustive bool: When query limits are exceeded, whether to return error or return partial results.
QuerySeries int: The maximum number of series fetched in single query. Example: 100000.

MaxRecentlyQueriedSeriesBlocks int: The maximum number of blocks that can be read in a given lookback period. Example: 20000.
MaxRecentlyQueriedSeriesDiskBytesRead int: The maximum number of disk bytes that can be read in a given lookback period. Example: 104857600.
MaxRecentlyQueriedSeriesLookback string: The lookback period for max_recently_queried_series_blocks and max_recently_queried_series_disk_bytes_read. Example: 15s.
QueryDocs int: The maximum number of docs fetched in single query. Example: 100000.
QueryRequireExhaustive bool: When query limits are exceeded, whether to return error or return partial results.
QuerySeries int: The maximum number of series fetched in single query. Example: 100000.

maxRecentlyQueriedSeriesBlocks Integer: The maximum number of blocks that can be read in a given lookback period. Example: 20000.
maxRecentlyQueriedSeriesDiskBytesRead Integer: The maximum number of disk bytes that can be read in a given lookback period. Example: 104857600.
maxRecentlyQueriedSeriesLookback String: The lookback period for max_recently_queried_series_blocks and max_recently_queried_series_disk_bytes_read. Example: 15s.
queryDocs Integer: The maximum number of docs fetched in single query. Example: 100000.
queryRequireExhaustive Boolean: When query limits are exceeded, whether to return error or return partial results.
querySeries Integer: The maximum number of series fetched in single query. Example: 100000.

maxRecentlyQueriedSeriesBlocks number: The maximum number of blocks that can be read in a given lookback period. Example: 20000.
maxRecentlyQueriedSeriesDiskBytesRead number: The maximum number of disk bytes that can be read in a given lookback period. Example: 104857600.
maxRecentlyQueriedSeriesLookback string: The lookback period for max_recently_queried_series_blocks and max_recently_queried_series_disk_bytes_read. Example: 15s.
queryDocs number: The maximum number of docs fetched in single query. Example: 100000.
queryRequireExhaustive boolean: When query limits are exceeded, whether to return error or return partial results.
querySeries number: The maximum number of series fetched in single query. Example: 100000.

max_recently_queried_series_blocks int: The maximum number of blocks that can be read in a given lookback period. Example: 20000.
max_recently_queried_series_disk_bytes_read int: The maximum number of disk bytes that can be read in a given lookback period. Example: 104857600.
max_recently_queried_series_lookback str: The lookback period for max_recently_queried_series_blocks and max_recently_queried_series_disk_bytes_read. Example: 15s.
query_docs int: The maximum number of docs fetched in single query. Example: 100000.
query_require_exhaustive bool: When query limits are exceeded, whether to return error or return partial results.
query_series int: The maximum number of series fetched in single query. Example: 100000.

maxRecentlyQueriedSeriesBlocks Number: The maximum number of blocks that can be read in a given lookback period. Example: 20000.
maxRecentlyQueriedSeriesDiskBytesRead Number: The maximum number of disk bytes that can be read in a given lookback period. Example: 104857600.
maxRecentlyQueriedSeriesLookback String: The lookback period for max_recently_queried_series_blocks and max_recently_queried_series_disk_bytes_read. Example: 15s.
queryDocs Number: The maximum number of docs fetched in single query. Example: 100000.
queryRequireExhaustive Boolean: When query limits are exceeded, whether to return error or return partial results.
querySeries Number: The maximum number of series fetched in single query. Example: 100000.

GetM3DbM3dbUserConfigM3

TagOptions GetM3DbM3dbUserConfigM3TagOptions: M3 Tag Options

TagOptions GetM3DbM3dbUserConfigM3TagOptions: M3 Tag Options

tagOptions GetM3DbM3dbUserConfigM3TagOptions: M3 Tag Options

tagOptions GetM3DbM3dbUserConfigM3TagOptions: M3 Tag Options

tag_options GetM3DbM3dbUserConfigM3TagOptions: M3 Tag Options

tagOptions Property Map: M3 Tag Options

GetM3DbM3dbUserConfigM3TagOptions

AllowTagNameDuplicates bool: Allows for duplicate tags to appear on series (not allowed by default).
AllowTagValueEmpty bool: Allows for empty tags to appear on series (not allowed by default).

AllowTagNameDuplicates bool: Allows for duplicate tags to appear on series (not allowed by default).
AllowTagValueEmpty bool: Allows for empty tags to appear on series (not allowed by default).

allowTagNameDuplicates Boolean: Allows for duplicate tags to appear on series (not allowed by default).
allowTagValueEmpty Boolean: Allows for empty tags to appear on series (not allowed by default).

allowTagNameDuplicates boolean: Allows for duplicate tags to appear on series (not allowed by default).
allowTagValueEmpty boolean: Allows for empty tags to appear on series (not allowed by default).

allow_tag_name_duplicates bool: Allows for duplicate tags to appear on series (not allowed by default).
allow_tag_value_empty bool: Allows for empty tags to appear on series (not allowed by default).

allowTagNameDuplicates Boolean: Allows for duplicate tags to appear on series (not allowed by default).
allowTagValueEmpty Boolean: Allows for empty tags to appear on series (not allowed by default).

GetM3DbM3dbUserConfigNamespace

Name string: The name of the namespace. Example: default.
Type string: Enum: aggregated, unaggregated. The type of aggregation (aggregated/unaggregated).
Options GetM3DbM3dbUserConfigNamespaceOptions: Namespace options
Resolution string: The resolution for an aggregated namespace. Example: 30s.

Name string: The name of the namespace. Example: default.
Type string: Enum: aggregated, unaggregated. The type of aggregation (aggregated/unaggregated).
Options GetM3DbM3dbUserConfigNamespaceOptions: Namespace options
Resolution string: The resolution for an aggregated namespace. Example: 30s.

name String: The name of the namespace. Example: default.
type String: Enum: aggregated, unaggregated. The type of aggregation (aggregated/unaggregated).
options GetM3DbM3dbUserConfigNamespaceOptions: Namespace options
resolution String: The resolution for an aggregated namespace. Example: 30s.

name string: The name of the namespace. Example: default.
type string: Enum: aggregated, unaggregated. The type of aggregation (aggregated/unaggregated).
options GetM3DbM3dbUserConfigNamespaceOptions: Namespace options
resolution string: The resolution for an aggregated namespace. Example: 30s.

name str: The name of the namespace. Example: default.
type str: Enum: aggregated, unaggregated. The type of aggregation (aggregated/unaggregated).
options GetM3DbM3dbUserConfigNamespaceOptions: Namespace options
resolution str: The resolution for an aggregated namespace. Example: 30s.

name String: The name of the namespace. Example: default.
type String: Enum: aggregated, unaggregated. The type of aggregation (aggregated/unaggregated).
options Property Map: Namespace options
resolution String: The resolution for an aggregated namespace. Example: 30s.

GetM3DbM3dbUserConfigNamespaceOptions

RetentionOptions GetM3DbM3dbUserConfigNamespaceOptionsRetentionOptions: Retention options
SnapshotEnabled bool: Controls whether M3DB will create snapshot files for this namespace.
WritesToCommitlog bool: Controls whether M3DB will include writes to this namespace in the commitlog.

RetentionOptions GetM3DbM3dbUserConfigNamespaceOptionsRetentionOptions: Retention options
SnapshotEnabled bool: Controls whether M3DB will create snapshot files for this namespace.
WritesToCommitlog bool: Controls whether M3DB will include writes to this namespace in the commitlog.

retentionOptions GetM3DbM3dbUserConfigNamespaceOptionsRetentionOptions: Retention options
snapshotEnabled Boolean: Controls whether M3DB will create snapshot files for this namespace.
writesToCommitlog Boolean: Controls whether M3DB will include writes to this namespace in the commitlog.

retentionOptions GetM3DbM3dbUserConfigNamespaceOptionsRetentionOptions: Retention options
snapshotEnabled boolean: Controls whether M3DB will create snapshot files for this namespace.
writesToCommitlog boolean: Controls whether M3DB will include writes to this namespace in the commitlog.

retention_options GetM3DbM3dbUserConfigNamespaceOptionsRetentionOptions: Retention options
snapshot_enabled bool: Controls whether M3DB will create snapshot files for this namespace.
writes_to_commitlog bool: Controls whether M3DB will include writes to this namespace in the commitlog.

retentionOptions Property Map: Retention options
snapshotEnabled Boolean: Controls whether M3DB will create snapshot files for this namespace.
writesToCommitlog Boolean: Controls whether M3DB will include writes to this namespace in the commitlog.

GetM3DbM3dbUserConfigNamespaceOptionsRetentionOptions

BlockDataExpiryDuration string: Controls how long we wait before expiring stale data. Example: 5m.
BlocksizeDuration string: Controls how long to keep a block in memory before flushing to a fileset on disk. Example: 2h.
BufferFutureDuration string: Controls how far into the future writes to the namespace will be accepted. Example: 10m.
BufferPastDuration string: Controls how far into the past writes to the namespace will be accepted. Example: 10m.
RetentionPeriodDuration string: Controls the duration of time that M3DB will retain data for the namespace. Example: 48h.

BlockDataExpiryDuration string: Controls how long we wait before expiring stale data. Example: 5m.
BlocksizeDuration string: Controls how long to keep a block in memory before flushing to a fileset on disk. Example: 2h.
BufferFutureDuration string: Controls how far into the future writes to the namespace will be accepted. Example: 10m.
BufferPastDuration string: Controls how far into the past writes to the namespace will be accepted. Example: 10m.
RetentionPeriodDuration string: Controls the duration of time that M3DB will retain data for the namespace. Example: 48h.

blockDataExpiryDuration String: Controls how long we wait before expiring stale data. Example: 5m.
blocksizeDuration String: Controls how long to keep a block in memory before flushing to a fileset on disk. Example: 2h.
bufferFutureDuration String: Controls how far into the future writes to the namespace will be accepted. Example: 10m.
bufferPastDuration String: Controls how far into the past writes to the namespace will be accepted. Example: 10m.
retentionPeriodDuration String: Controls the duration of time that M3DB will retain data for the namespace. Example: 48h.

blockDataExpiryDuration string: Controls how long we wait before expiring stale data. Example: 5m.
blocksizeDuration string: Controls how long to keep a block in memory before flushing to a fileset on disk. Example: 2h.
bufferFutureDuration string: Controls how far into the future writes to the namespace will be accepted. Example: 10m.
bufferPastDuration string: Controls how far into the past writes to the namespace will be accepted. Example: 10m.
retentionPeriodDuration string: Controls the duration of time that M3DB will retain data for the namespace. Example: 48h.

block_data_expiry_duration str: Controls how long we wait before expiring stale data. Example: 5m.
blocksize_duration str: Controls how long to keep a block in memory before flushing to a fileset on disk. Example: 2h.
buffer_future_duration str: Controls how far into the future writes to the namespace will be accepted. Example: 10m.
buffer_past_duration str: Controls how far into the past writes to the namespace will be accepted. Example: 10m.
retention_period_duration str: Controls the duration of time that M3DB will retain data for the namespace. Example: 48h.

blockDataExpiryDuration String: Controls how long we wait before expiring stale data. Example: 5m.
blocksizeDuration String: Controls how long to keep a block in memory before flushing to a fileset on disk. Example: 2h.
bufferFutureDuration String: Controls how far into the future writes to the namespace will be accepted. Example: 10m.
bufferPastDuration String: Controls how far into the past writes to the namespace will be accepted. Example: 10m.
retentionPeriodDuration String: Controls the duration of time that M3DB will retain data for the namespace. Example: 48h.

GetM3DbM3dbUserConfigPrivateAccess

M3coordinator bool: Allow clients to connect to m3coordinator with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.

M3coordinator bool: Allow clients to connect to m3coordinator with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.

m3coordinator Boolean: Allow clients to connect to m3coordinator with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.

m3coordinator boolean: Allow clients to connect to m3coordinator with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.

m3coordinator bool: Allow clients to connect to m3coordinator with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.

m3coordinator Boolean: Allow clients to connect to m3coordinator with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.

GetM3DbM3dbUserConfigPublicAccess

M3coordinator bool: Allow clients to connect to m3coordinator from the public internet for service nodes that are in a project VPC or another type of private network.

M3coordinator bool: Allow clients to connect to m3coordinator from the public internet for service nodes that are in a project VPC or another type of private network.

m3coordinator Boolean: Allow clients to connect to m3coordinator from the public internet for service nodes that are in a project VPC or another type of private network.

m3coordinator boolean: Allow clients to connect to m3coordinator from the public internet for service nodes that are in a project VPC or another type of private network.

m3coordinator bool: Allow clients to connect to m3coordinator from the public internet for service nodes that are in a project VPC or another type of private network.

m3coordinator Boolean: Allow clients to connect to m3coordinator from the public internet for service nodes that are in a project VPC or another type of private network.

GetM3DbM3dbUserConfigRules

Mappings List<GetM3DbM3dbUserConfigRulesMapping>: List of M3 mapping rules

Mappings []GetM3DbM3dbUserConfigRulesMapping: List of M3 mapping rules

mappings List<GetM3DbM3dbUserConfigRulesMapping>: List of M3 mapping rules

mappings GetM3DbM3dbUserConfigRulesMapping[]: List of M3 mapping rules

mappings Sequence[GetM3DbM3dbUserConfigRulesMapping]: List of M3 mapping rules

mappings List<Property Map>: List of M3 mapping rules

GetM3DbM3dbUserConfigRulesMapping

Filter string: Matching metric names with wildcards (using name:wildcard) or matching tags and their (optionally wildcarded) values. For value, ! can be used at start of value for negation, and multiple filters can be supplied using space as separator. Example: __name__:disk_* host:important-42 mount:!*/sda.
Aggregations List<string>: List of aggregations to be applied.
Drop bool: Only store the derived metric (as specified in the roll-up rules), if any.
Name string: The (optional) name of the rule. Example: important disk metrics.
Namespaces List<string>: This rule will be used to store the metrics in the given namespace(s). If a namespace is target of rules, the global default aggregation will be automatically disabled. Note that specifying filters that match no namespaces whatsoever will be returned as an error. Filter the namespace by glob (=wildcards).
Deprecated: Deprecated. Use namespaces_string instead.
NamespacesObjects List<GetM3DbM3dbUserConfigRulesMappingNamespacesObject>: This rule will be used to store the metrics in the given namespace(s). If a namespace is target of rules, the global default aggregation will be automatically disabled. Note that specifying filters that match no namespaces whatsoever will be returned as an error. Filter the namespace by exact match of retention period and resolution
NamespacesStrings List<string>: This rule will be used to store the metrics in the given namespace(s). If a namespace is target of rules, the global default aggregation will be automatically disabled. Note that specifying filters that match no namespaces whatsoever will be returned as an error. Filter the namespace by glob (=wildcards).
Tags List<GetM3DbM3dbUserConfigRulesMappingTag>: List of tags to be appended to matching metrics

Filter string: Matching metric names with wildcards (using name:wildcard) or matching tags and their (optionally wildcarded) values. For value, ! can be used at start of value for negation, and multiple filters can be supplied using space as separator. Example: __name__:disk_* host:important-42 mount:!*/sda.
Aggregations []string: List of aggregations to be applied.
Drop bool: Only store the derived metric (as specified in the roll-up rules), if any.
Name string: The (optional) name of the rule. Example: important disk metrics.
Namespaces []string: This rule will be used to store the metrics in the given namespace(s). If a namespace is target of rules, the global default aggregation will be automatically disabled. Note that specifying filters that match no namespaces whatsoever will be returned as an error. Filter the namespace by glob (=wildcards).
Deprecated: Deprecated. Use namespaces_string instead.
NamespacesObjects []GetM3DbM3dbUserConfigRulesMappingNamespacesObject: This rule will be used to store the metrics in the given namespace(s). If a namespace is target of rules, the global default aggregation will be automatically disabled. Note that specifying filters that match no namespaces whatsoever will be returned as an error. Filter the namespace by exact match of retention period and resolution
NamespacesStrings []string: This rule will be used to store the metrics in the given namespace(s). If a namespace is target of rules, the global default aggregation will be automatically disabled. Note that specifying filters that match no namespaces whatsoever will be returned as an error. Filter the namespace by glob (=wildcards).
Tags []GetM3DbM3dbUserConfigRulesMappingTag: List of tags to be appended to matching metrics

filter String: Matching metric names with wildcards (using name:wildcard) or matching tags and their (optionally wildcarded) values. For value, ! can be used at start of value for negation, and multiple filters can be supplied using space as separator. Example: __name__:disk_* host:important-42 mount:!*/sda.
aggregations List<String>: List of aggregations to be applied.
drop Boolean: Only store the derived metric (as specified in the roll-up rules), if any.
name String: The (optional) name of the rule. Example: important disk metrics.
namespaces List<String>: This rule will be used to store the metrics in the given namespace(s). If a namespace is target of rules, the global default aggregation will be automatically disabled. Note that specifying filters that match no namespaces whatsoever will be returned as an error. Filter the namespace by glob (=wildcards).
Deprecated: Deprecated. Use namespaces_string instead.
namespacesObjects List<GetM3DbM3dbUserConfigRulesMappingNamespacesObject>: This rule will be used to store the metrics in the given namespace(s). If a namespace is target of rules, the global default aggregation will be automatically disabled. Note that specifying filters that match no namespaces whatsoever will be returned as an error. Filter the namespace by exact match of retention period and resolution
namespacesStrings List<String>: This rule will be used to store the metrics in the given namespace(s). If a namespace is target of rules, the global default aggregation will be automatically disabled. Note that specifying filters that match no namespaces whatsoever will be returned as an error. Filter the namespace by glob (=wildcards).
tags List<GetM3DbM3dbUserConfigRulesMappingTag>: List of tags to be appended to matching metrics

filter string: Matching metric names with wildcards (using name:wildcard) or matching tags and their (optionally wildcarded) values. For value, ! can be used at start of value for negation, and multiple filters can be supplied using space as separator. Example: __name__:disk_* host:important-42 mount:!*/sda.
aggregations string[]: List of aggregations to be applied.
drop boolean: Only store the derived metric (as specified in the roll-up rules), if any.
name string: The (optional) name of the rule. Example: important disk metrics.
namespaces string[]: This rule will be used to store the metrics in the given namespace(s). If a namespace is target of rules, the global default aggregation will be automatically disabled. Note that specifying filters that match no namespaces whatsoever will be returned as an error. Filter the namespace by glob (=wildcards).
Deprecated: Deprecated. Use namespaces_string instead.
namespacesObjects GetM3DbM3dbUserConfigRulesMappingNamespacesObject[]: This rule will be used to store the metrics in the given namespace(s). If a namespace is target of rules, the global default aggregation will be automatically disabled. Note that specifying filters that match no namespaces whatsoever will be returned as an error. Filter the namespace by exact match of retention period and resolution
namespacesStrings string[]: This rule will be used to store the metrics in the given namespace(s). If a namespace is target of rules, the global default aggregation will be automatically disabled. Note that specifying filters that match no namespaces whatsoever will be returned as an error. Filter the namespace by glob (=wildcards).
tags GetM3DbM3dbUserConfigRulesMappingTag[]: List of tags to be appended to matching metrics

filter str: Matching metric names with wildcards (using name:wildcard) or matching tags and their (optionally wildcarded) values. For value, ! can be used at start of value for negation, and multiple filters can be supplied using space as separator. Example: __name__:disk_* host:important-42 mount:!*/sda.
aggregations Sequence[str]: List of aggregations to be applied.
drop bool: Only store the derived metric (as specified in the roll-up rules), if any.
name str: The (optional) name of the rule. Example: important disk metrics.
namespaces Sequence[str]: This rule will be used to store the metrics in the given namespace(s). If a namespace is target of rules, the global default aggregation will be automatically disabled. Note that specifying filters that match no namespaces whatsoever will be returned as an error. Filter the namespace by glob (=wildcards).
Deprecated: Deprecated. Use namespaces_string instead.
namespaces_objects Sequence[GetM3DbM3dbUserConfigRulesMappingNamespacesObject]: This rule will be used to store the metrics in the given namespace(s). If a namespace is target of rules, the global default aggregation will be automatically disabled. Note that specifying filters that match no namespaces whatsoever will be returned as an error. Filter the namespace by exact match of retention period and resolution
namespaces_strings Sequence[str]: This rule will be used to store the metrics in the given namespace(s). If a namespace is target of rules, the global default aggregation will be automatically disabled. Note that specifying filters that match no namespaces whatsoever will be returned as an error. Filter the namespace by glob (=wildcards).
tags Sequence[GetM3DbM3dbUserConfigRulesMappingTag]: List of tags to be appended to matching metrics

filter String: Matching metric names with wildcards (using name:wildcard) or matching tags and their (optionally wildcarded) values. For value, ! can be used at start of value for negation, and multiple filters can be supplied using space as separator. Example: __name__:disk_* host:important-42 mount:!*/sda.
aggregations List<String>: List of aggregations to be applied.
drop Boolean: Only store the derived metric (as specified in the roll-up rules), if any.
name String: The (optional) name of the rule. Example: important disk metrics.
namespaces List<String>: This rule will be used to store the metrics in the given namespace(s). If a namespace is target of rules, the global default aggregation will be automatically disabled. Note that specifying filters that match no namespaces whatsoever will be returned as an error. Filter the namespace by glob (=wildcards).
Deprecated: Deprecated. Use namespaces_string instead.
namespacesObjects List<Property Map>: This rule will be used to store the metrics in the given namespace(s). If a namespace is target of rules, the global default aggregation will be automatically disabled. Note that specifying filters that match no namespaces whatsoever will be returned as an error. Filter the namespace by exact match of retention period and resolution
namespacesStrings List<String>: This rule will be used to store the metrics in the given namespace(s). If a namespace is target of rules, the global default aggregation will be automatically disabled. Note that specifying filters that match no namespaces whatsoever will be returned as an error. Filter the namespace by glob (=wildcards).
tags List<Property Map>: List of tags to be appended to matching metrics

GetM3DbM3dbUserConfigRulesMappingNamespacesObject

Resolution string: The resolution for the matching namespace. Example: 30s.
Retention string: The retention period of the matching namespace. Example: 48h.

Resolution string: The resolution for the matching namespace. Example: 30s.
Retention string: The retention period of the matching namespace. Example: 48h.

resolution String: The resolution for the matching namespace. Example: 30s.
retention String: The retention period of the matching namespace. Example: 48h.

resolution string: The resolution for the matching namespace. Example: 30s.
retention string: The retention period of the matching namespace. Example: 48h.

resolution str: The resolution for the matching namespace. Example: 30s.
retention str: The retention period of the matching namespace. Example: 48h.

resolution String: The resolution for the matching namespace. Example: 30s.
retention String: The retention period of the matching namespace. Example: 48h.

GetM3DbM3dbUserConfigRulesMappingTag

Name string: Name of the tag. Example: my_tag.
Value string: Value of the tag. Example: my_value.

Name string: Name of the tag. Example: my_tag.
Value string: Value of the tag. Example: my_value.

name String: Name of the tag. Example: my_tag.
value String: Value of the tag. Example: my_value.

name string: Name of the tag. Example: my_tag.
value string: Value of the tag. Example: my_value.

name str: Name of the tag. Example: my_tag.
value str: Value of the tag. Example: my_value.

name String: Name of the tag. Example: my_tag.
value String: Value of the tag. Example: my_value.

GetM3DbServiceIntegration

IntegrationType string: Type of the service integration
SourceServiceName string: Name of the source service

IntegrationType string: Type of the service integration
SourceServiceName string: Name of the source service

integrationType String: Type of the service integration
sourceServiceName String: Name of the source service

integrationType string: Type of the service integration
sourceServiceName string: Name of the source service

integration_type str: Type of the service integration
source_service_name str: Name of the source service

integrationType String: Type of the service integration
sourceServiceName String: Name of the source service

GetM3DbTag

Key string: Service tag key
Value string: Service tag value

Key string: Service tag key
Value string: Service tag value

key String: Service tag key
value String: Service tag value

key string: Service tag key
value string: Service tag value

key str: Service tag key
value str: Service tag value

key String: Service tag key
value String: Service tag value

GetM3DbTechEmail

Email string: An email address to contact for technical issues

Email string: An email address to contact for technical issues

email String: An email address to contact for technical issues

email string: An email address to contact for technical issues

email str: An email address to contact for technical issues

email String: An email address to contact for technical issues

Package Details

Repository: Aiven pulumi/pulumi-aiven
License: Apache-2.0
Notes: This Pulumi package is based on the aiven Terraform Provider.

Aiven v6.37.0 published on Thursday, Apr 10, 2025 by Pulumi

pulumi/pulumi-aiven

aiven.getM3Db

On this page

On this page

Example Usage

Using getM3Db

getM3Db Result

Supporting Types

GetM3DbComponent

GetM3DbM3db

GetM3DbM3dbUserConfig

GetM3DbM3dbUserConfigIpFilterObject

GetM3DbM3dbUserConfigLimits

GetM3DbM3dbUserConfigM3

GetM3DbM3dbUserConfigM3TagOptions

GetM3DbM3dbUserConfigNamespace

GetM3DbM3dbUserConfigNamespaceOptions

GetM3DbM3dbUserConfigNamespaceOptionsRetentionOptions

GetM3DbM3dbUserConfigPrivateAccess

GetM3DbM3dbUserConfigPublicAccess

GetM3DbM3dbUserConfigRules

GetM3DbM3dbUserConfigRulesMapping

GetM3DbM3dbUserConfigRulesMappingNamespacesObject

GetM3DbM3dbUserConfigRulesMappingTag

GetM3DbServiceIntegration

GetM3DbTag

GetM3DbTechEmail

Package Details

On this page

On this page