1. Packages
  2. Aiven Provider
  3. API Docs
  4. M3Db
Viewing docs for Aiven v4.5.2 (Older version)
published on Monday, Mar 9, 2026 by Pulumi
Go to latest version
Schema (JSON)
pulumi/pulumi-aiven

aiven.M3Db

aiven logo
Viewing docs for Aiven v4.5.2 (Older version)
published on Monday, Mar 9, 2026 by Pulumi
Go to latest version
Schema (JSON)
pulumi/pulumi-aiven

    The M3 DB resource allows the creation and management of Aiven M3 services.

    Example Usage

    using Pulumi;
using Aiven = Pulumi.Aiven;

class MyStack : Stack
{
    public MyStack()
    {
        var m3 = new Aiven.M3Db("m3", new Aiven.M3DbArgs
        {
            Project = data.Aiven_project.Foo.Project,
            CloudName = "google-europe-west1",
            Plan = "business-8",
            ServiceName = "my-m3db",
            MaintenanceWindowDow = "monday",
            MaintenanceWindowTime = "10:00:00",
            M3dbUserConfig = new Aiven.Inputs.M3DbM3dbUserConfigArgs
            {
                M3dbVersion = "0.15",
                Namespaces = 
                {
                    new Aiven.Inputs.M3DbM3dbUserConfigNamespaceArgs
                    {
                        Name = "my-ns1",
                        Type = "unaggregated",
                    },
                },
            },
        });
    }

}

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := aiven.NewM3Db(ctx, "m3", &aiven.M3DbArgs{
			Project:               pulumi.Any(data.Aiven_project.Foo.Project),
			CloudName:             pulumi.String("google-europe-west1"),
			Plan:                  pulumi.String("business-8"),
			ServiceName:           pulumi.String("my-m3db"),
			MaintenanceWindowDow:  pulumi.String("monday"),
			MaintenanceWindowTime: pulumi.String("10:00:00"),
			M3dbUserConfig: &M3DbM3dbUserConfigArgs{
				M3dbVersion: pulumi.String("0.15"),
				Namespaces: M3DbM3dbUserConfigNamespaceArray{
					&M3DbM3dbUserConfigNamespaceArgs{
						Name: pulumi.String("my-ns1"),
						Type: pulumi.String("unaggregated"),
					},
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    Example coming soon!

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

const m3 = new aiven.M3Db("m3", {
    project: data.aiven_project.foo.project,
    cloudName: "google-europe-west1",
    plan: "business-8",
    serviceName: "my-m3db",
    maintenanceWindowDow: "monday",
    maintenanceWindowTime: "10:00:00",
    m3dbUserConfig: {
        m3dbVersion: "0.15",
        namespaces: [{
            name: "my-ns1",
            type: "unaggregated",
        }],
    },
});

    import pulumi
import pulumi_aiven as aiven

m3 = aiven.M3Db("m3",
    project=data["aiven_project"]["foo"]["project"],
    cloud_name="google-europe-west1",
    plan="business-8",
    service_name="my-m3db",
    maintenance_window_dow="monday",
    maintenance_window_time="10:00:00",
    m3db_user_config=aiven.M3DbM3dbUserConfigArgs(
        m3db_version="0.15",
        namespaces=[aiven.M3DbM3dbUserConfigNamespaceArgs(
            name="my-ns1",
            type="unaggregated",
        )],
    ))

    Example coming soon!

    Create M3Db Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new M3Db(name: string, args: M3DbArgs, opts?: CustomResourceOptions);
    @overload
def M3Db(resource_name: str,
         args: M3DbArgs,
         opts: Optional[ResourceOptions] = None)

@overload
def M3Db(resource_name: str,
         opts: Optional[ResourceOptions] = None,
         project: Optional[str] = None,
         service_name: Optional[str] = None,
         cloud_name: Optional[str] = None,
         disk_space: Optional[str] = None,
         m3db_user_config: Optional[M3DbM3dbUserConfigArgs] = None,
         maintenance_window_dow: Optional[str] = None,
         maintenance_window_time: Optional[str] = None,
         plan: Optional[str] = None,
         project_vpc_id: Optional[str] = None,
         service_integrations: Optional[Sequence[M3DbServiceIntegrationArgs]] = None,
         static_ips: Optional[Sequence[str]] = None,
         termination_protection: Optional[bool] = None)
    func NewM3Db(ctx *Context, name string, args M3DbArgs, opts ...ResourceOption) (*M3Db, error)
    public M3Db(string name, M3DbArgs args, CustomResourceOptions? opts = null)
    public M3Db(String name, M3DbArgs args)
public M3Db(String name, M3DbArgs args, CustomResourceOptions options)

    type: aiven:M3Db
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args M3DbArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args M3DbArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args M3DbArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args M3DbArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args M3DbArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var m3dbResource = new Aiven.M3Db("m3dbResource", new()
{
    Project = "string",
    ServiceName = "string",
    CloudName = "string",
    DiskSpace = "string",
    M3dbUserConfig = new Aiven.Inputs.M3DbM3dbUserConfigArgs
    {
        CustomDomain = "string",
        IpFilters = new[]
        {
            "string",
        },
        Limits = new Aiven.Inputs.M3DbM3dbUserConfigLimitsArgs
        {
            QueryRequireExhaustive = "string",
            QuerySeries = "string",
        },
        M3Version = "string",
        M3coordinatorEnableGraphiteCarbonIngest = "string",
        M3dbVersion = "string",
        Namespaces = new[]
        {
            new Aiven.Inputs.M3DbM3dbUserConfigNamespaceArgs
            {
                Name = "string",
                Options = new Aiven.Inputs.M3DbM3dbUserConfigNamespaceOptionsArgs
                {
                    RetentionOptions = new Aiven.Inputs.M3DbM3dbUserConfigNamespaceOptionsRetentionOptionsArgs
                    {
                        BlockDataExpiryDuration = "string",
                        BlocksizeDuration = "string",
                        BufferFutureDuration = "string",
                        BufferPastDuration = "string",
                        RetentionPeriodDuration = "string",
                    },
                    SnapshotEnabled = "string",
                    WritesToCommitlog = "string",
                },
                Resolution = "string",
                Type = "string",
            },
        },
        PrivateAccess = new Aiven.Inputs.M3DbM3dbUserConfigPrivateAccessArgs
        {
            M3coordinator = "string",
        },
        ProjectToForkFrom = "string",
        PublicAccess = new Aiven.Inputs.M3DbM3dbUserConfigPublicAccessArgs
        {
            M3coordinator = "string",
        },
        Rules = new Aiven.Inputs.M3DbM3dbUserConfigRulesArgs
        {
            Mappings = new[]
            {
                new Aiven.Inputs.M3DbM3dbUserConfigRulesMappingArgs
                {
                    Aggregations = new[]
                    {
                        "string",
                    },
                    Drop = "string",
                    Filter = "string",
                    Name = "string",
                    Namespaces = new[]
                    {
                        "string",
                    },
                    Tags = new[]
                    {
                        new Aiven.Inputs.M3DbM3dbUserConfigRulesMappingTagArgs
                        {
                            Name = "string",
                            Value = "string",
                        },
                    },
                },
            },
        },
        ServiceToForkFrom = "string",
        StaticIps = "string",
    },
    MaintenanceWindowDow = "string",
    MaintenanceWindowTime = "string",
    Plan = "string",
    ProjectVpcId = "string",
    ServiceIntegrations = new[]
    {
        new Aiven.Inputs.M3DbServiceIntegrationArgs
        {
            IntegrationType = "string",
            SourceServiceName = "string",
        },
    },
    StaticIps = new[]
    {
        "string",
    },
    TerminationProtection = false,
});

    example, err := aiven.NewM3Db(ctx, "m3dbResource", &aiven.M3DbArgs{
	Project:     pulumi.String("string"),
	ServiceName: pulumi.String("string"),
	CloudName:   pulumi.String("string"),
	DiskSpace:   pulumi.String("string"),
	M3dbUserConfig: &aiven.M3DbM3dbUserConfigArgs{
		CustomDomain: pulumi.String("string"),
		IpFilters: pulumi.StringArray{
			pulumi.String("string"),
		},
		Limits: &aiven.M3DbM3dbUserConfigLimitsArgs{
			QueryRequireExhaustive: pulumi.String("string"),
			QuerySeries:            pulumi.String("string"),
		},
		M3Version:                               pulumi.String("string"),
		M3coordinatorEnableGraphiteCarbonIngest: pulumi.String("string"),
		M3dbVersion:                             pulumi.String("string"),
		Namespaces: aiven.M3DbM3dbUserConfigNamespaceArray{
			&aiven.M3DbM3dbUserConfigNamespaceArgs{
				Name: pulumi.String("string"),
				Options: &aiven.M3DbM3dbUserConfigNamespaceOptionsArgs{
					RetentionOptions: &aiven.M3DbM3dbUserConfigNamespaceOptionsRetentionOptionsArgs{
						BlockDataExpiryDuration: pulumi.String("string"),
						BlocksizeDuration:       pulumi.String("string"),
						BufferFutureDuration:    pulumi.String("string"),
						BufferPastDuration:      pulumi.String("string"),
						RetentionPeriodDuration: pulumi.String("string"),
					},
					SnapshotEnabled:   pulumi.String("string"),
					WritesToCommitlog: pulumi.String("string"),
				},
				Resolution: pulumi.String("string"),
				Type:       pulumi.String("string"),
			},
		},
		PrivateAccess: &aiven.M3DbM3dbUserConfigPrivateAccessArgs{
			M3coordinator: pulumi.String("string"),
		},
		ProjectToForkFrom: pulumi.String("string"),
		PublicAccess: &aiven.M3DbM3dbUserConfigPublicAccessArgs{
			M3coordinator: pulumi.String("string"),
		},
		Rules: &aiven.M3DbM3dbUserConfigRulesArgs{
			Mappings: aiven.M3DbM3dbUserConfigRulesMappingArray{
				&aiven.M3DbM3dbUserConfigRulesMappingArgs{
					Aggregations: pulumi.StringArray{
						pulumi.String("string"),
					},
					Drop:   pulumi.String("string"),
					Filter: pulumi.String("string"),
					Name:   pulumi.String("string"),
					Namespaces: pulumi.StringArray{
						pulumi.String("string"),
					},
					Tags: aiven.M3DbM3dbUserConfigRulesMappingTagArray{
						&aiven.M3DbM3dbUserConfigRulesMappingTagArgs{
							Name:  pulumi.String("string"),
							Value: pulumi.String("string"),
						},
					},
				},
			},
		},
		ServiceToForkFrom: pulumi.String("string"),
		StaticIps:         pulumi.String("string"),
	},
	MaintenanceWindowDow:  pulumi.String("string"),
	MaintenanceWindowTime: pulumi.String("string"),
	Plan:                  pulumi.String("string"),
	ProjectVpcId:          pulumi.String("string"),
	ServiceIntegrations: aiven.M3DbServiceIntegrationArray{
		&aiven.M3DbServiceIntegrationArgs{
			IntegrationType:   pulumi.String("string"),
			SourceServiceName: pulumi.String("string"),
		},
	},
	StaticIps: pulumi.StringArray{
		pulumi.String("string"),
	},
	TerminationProtection: pulumi.Bool(false),
})

    var m3dbResource = new M3Db("m3dbResource", M3DbArgs.builder()
    .project("string")
    .serviceName("string")
    .cloudName("string")
    .diskSpace("string")
    .m3dbUserConfig(M3DbM3dbUserConfigArgs.builder()
        .customDomain("string")
        .ipFilters("string")
        .limits(M3DbM3dbUserConfigLimitsArgs.builder()
            .queryRequireExhaustive("string")
            .querySeries("string")
            .build())
        .m3Version("string")
        .m3coordinatorEnableGraphiteCarbonIngest("string")
        .m3dbVersion("string")
        .namespaces(M3DbM3dbUserConfigNamespaceArgs.builder()
            .name("string")
            .options(M3DbM3dbUserConfigNamespaceOptionsArgs.builder()
                .retentionOptions(M3DbM3dbUserConfigNamespaceOptionsRetentionOptionsArgs.builder()
                    .blockDataExpiryDuration("string")
                    .blocksizeDuration("string")
                    .bufferFutureDuration("string")
                    .bufferPastDuration("string")
                    .retentionPeriodDuration("string")
                    .build())
                .snapshotEnabled("string")
                .writesToCommitlog("string")
                .build())
            .resolution("string")
            .type("string")
            .build())
        .privateAccess(M3DbM3dbUserConfigPrivateAccessArgs.builder()
            .m3coordinator("string")
            .build())
        .projectToForkFrom("string")
        .publicAccess(M3DbM3dbUserConfigPublicAccessArgs.builder()
            .m3coordinator("string")
            .build())
        .rules(M3DbM3dbUserConfigRulesArgs.builder()
            .mappings(M3DbM3dbUserConfigRulesMappingArgs.builder()
                .aggregations("string")
                .drop("string")
                .filter("string")
                .name("string")
                .namespaces("string")
                .tags(M3DbM3dbUserConfigRulesMappingTagArgs.builder()
                    .name("string")
                    .value("string")
                    .build())
                .build())
            .build())
        .serviceToForkFrom("string")
        .staticIps("string")
        .build())
    .maintenanceWindowDow("string")
    .maintenanceWindowTime("string")
    .plan("string")
    .projectVpcId("string")
    .serviceIntegrations(M3DbServiceIntegrationArgs.builder()
        .integrationType("string")
        .sourceServiceName("string")
        .build())
    .staticIps("string")
    .terminationProtection(false)
    .build());

    m3db_resource = aiven.M3Db("m3dbResource",
    project="string",
    service_name="string",
    cloud_name="string",
    disk_space="string",
    m3db_user_config={
        "custom_domain": "string",
        "ip_filters": ["string"],
        "limits": {
            "query_require_exhaustive": "string",
            "query_series": "string",
        },
        "m3_version": "string",
        "m3coordinator_enable_graphite_carbon_ingest": "string",
        "m3db_version": "string",
        "namespaces": [{
            "name": "string",
            "options": {
                "retention_options": {
                    "block_data_expiry_duration": "string",
                    "blocksize_duration": "string",
                    "buffer_future_duration": "string",
                    "buffer_past_duration": "string",
                    "retention_period_duration": "string",
                },
                "snapshot_enabled": "string",
                "writes_to_commitlog": "string",
            },
            "resolution": "string",
            "type": "string",
        }],
        "private_access": {
            "m3coordinator": "string",
        },
        "project_to_fork_from": "string",
        "public_access": {
            "m3coordinator": "string",
        },
        "rules": {
            "mappings": [{
                "aggregations": ["string"],
                "drop": "string",
                "filter": "string",
                "name": "string",
                "namespaces": ["string"],
                "tags": [{
                    "name": "string",
                    "value": "string",
                }],
            }],
        },
        "service_to_fork_from": "string",
        "static_ips": "string",
    },
    maintenance_window_dow="string",
    maintenance_window_time="string",
    plan="string",
    project_vpc_id="string",
    service_integrations=[{
        "integration_type": "string",
        "source_service_name": "string",
    }],
    static_ips=["string"],
    termination_protection=False)

    const m3dbResource = new aiven.M3Db("m3dbResource", {
    project: "string",
    serviceName: "string",
    cloudName: "string",
    diskSpace: "string",
    m3dbUserConfig: {
        customDomain: "string",
        ipFilters: ["string"],
        limits: {
            queryRequireExhaustive: "string",
            querySeries: "string",
        },
        m3Version: "string",
        m3coordinatorEnableGraphiteCarbonIngest: "string",
        m3dbVersion: "string",
        namespaces: [{
            name: "string",
            options: {
                retentionOptions: {
                    blockDataExpiryDuration: "string",
                    blocksizeDuration: "string",
                    bufferFutureDuration: "string",
                    bufferPastDuration: "string",
                    retentionPeriodDuration: "string",
                },
                snapshotEnabled: "string",
                writesToCommitlog: "string",
            },
            resolution: "string",
            type: "string",
        }],
        privateAccess: {
            m3coordinator: "string",
        },
        projectToForkFrom: "string",
        publicAccess: {
            m3coordinator: "string",
        },
        rules: {
            mappings: [{
                aggregations: ["string"],
                drop: "string",
                filter: "string",
                name: "string",
                namespaces: ["string"],
                tags: [{
                    name: "string",
                    value: "string",
                }],
            }],
        },
        serviceToForkFrom: "string",
        staticIps: "string",
    },
    maintenanceWindowDow: "string",
    maintenanceWindowTime: "string",
    plan: "string",
    projectVpcId: "string",
    serviceIntegrations: [{
        integrationType: "string",
        sourceServiceName: "string",
    }],
    staticIps: ["string"],
    terminationProtection: false,
});

    type: aiven:M3Db
properties:
    cloudName: string
    diskSpace: string
    m3dbUserConfig:
        customDomain: string
        ipFilters:
            - string
        limits:
            queryRequireExhaustive: string
            querySeries: string
        m3Version: string
        m3coordinatorEnableGraphiteCarbonIngest: string
        m3dbVersion: string
        namespaces:
            - name: string
              options:
                retentionOptions:
                    blockDataExpiryDuration: string
                    blocksizeDuration: string
                    bufferFutureDuration: string
                    bufferPastDuration: string
                    retentionPeriodDuration: string
                snapshotEnabled: string
                writesToCommitlog: string
              resolution: string
              type: string
        privateAccess:
            m3coordinator: string
        projectToForkFrom: string
        publicAccess:
            m3coordinator: string
        rules:
            mappings:
                - aggregations:
                    - string
                  drop: string
                  filter: string
                  name: string
                  namespaces:
                    - string
                  tags:
                    - name: string
                      value: string
        serviceToForkFrom: string
        staticIps: string
    maintenanceWindowDow: string
    maintenanceWindowTime: string
    plan: string
    project: string
    projectVpcId: string
    serviceIntegrations:
        - integrationType: string
          sourceServiceName: string
    serviceName: string
    staticIps:
        - string
    terminationProtection: false

    M3Db Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The M3Db resource accepts the following input properties:

    Project string
    Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so 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.
    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.
    DiskSpace string
    The disk space of the service, possible values depend on the service type, the cloud provider and the project. Reducing will result in the service rebalancing.
    M3dbUserConfig M3DbM3dbUserConfig
    M3db user configurable settings
    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 seem from the Aiven pricing page.
    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.
    ServiceIntegrations List<M3DbServiceIntegration>
    Service integrations to specify when creating a service. Not applied after initial service creation
    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
    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.
    Project string
    Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so 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.
    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.
    DiskSpace string
    The disk space of the service, possible values depend on the service type, the cloud provider and the project. Reducing will result in the service rebalancing.
    M3dbUserConfig M3DbM3dbUserConfigArgs
    M3db user configurable settings
    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 seem from the Aiven pricing page.
    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.
    ServiceIntegrations []M3DbServiceIntegrationArgs
    Service integrations to specify when creating a service. Not applied after initial service creation
    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
    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.
    project String
    Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so 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.
    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.
    diskSpace String
    The disk space of the service, possible values depend on the service type, the cloud provider and the project. Reducing will result in the service rebalancing.
    m3dbUserConfig M3DbM3dbUserConfig
    M3db user configurable settings
    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 seem from the Aiven pricing page.
    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.
    serviceIntegrations List<M3DbServiceIntegration>
    Service integrations to specify when creating a service. Not applied after initial service creation
    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
    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.
    project string
    Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so 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.
    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.
    diskSpace string
    The disk space of the service, possible values depend on the service type, the cloud provider and the project. Reducing will result in the service rebalancing.
    m3dbUserConfig M3DbM3dbUserConfig
    M3db user configurable settings
    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 seem from the Aiven pricing page.
    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.
    serviceIntegrations M3DbServiceIntegration[]
    Service integrations to specify when creating a service. Not applied after initial service creation
    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
    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.
    project str
    Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so 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.
    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.
    disk_space str
    The disk space of the service, possible values depend on the service type, the cloud provider and the project. Reducing will result in the service rebalancing.
    m3db_user_config M3DbM3dbUserConfigArgs
    M3db user configurable settings
    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 seem from the Aiven pricing page.
    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_integrations Sequence[M3DbServiceIntegrationArgs]
    Service integrations to specify when creating a service. Not applied after initial service creation
    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
    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.
    project String
    Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so 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.
    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.
    diskSpace String
    The disk space of the service, possible values depend on the service type, the cloud provider and the project. Reducing will result in the service rebalancing.
    m3dbUserConfig Property Map
    M3db user configurable settings
    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 seem from the Aiven pricing page.
    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.
    serviceIntegrations List<Property Map>
    Service integrations to specify when creating a service. Not applied after initial service creation
    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
    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.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the M3Db resource produces the following output properties:

    Components List<M3DbComponent>
    Service component information objects
    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.
    M3dbs List<M3DbM3db>
    M3 specific server provided values
    ServiceHost string
    The hostname of the service.
    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
    Components []M3DbComponent
    Service component information objects
    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.
    M3dbs []M3DbM3db
    M3 specific server provided values
    ServiceHost string
    The hostname of the service.
    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
    components List<M3DbComponent>
    Service component information objects
    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.
    m3dbs List<M3DbM3db>
    M3 specific server provided values
    serviceHost String
    The hostname of the service.
    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
    components M3DbComponent[]
    Service component information objects
    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.
    m3dbs M3DbM3db[]
    M3 specific server provided values
    serviceHost string
    The hostname of the service.
    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
    components Sequence[M3DbComponent]
    Service component information objects
    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.
    m3dbs Sequence[M3DbM3db]
    M3 specific server provided values
    service_host str
    The hostname of the service.
    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
    components List<Property Map>
    Service component information objects
    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.
    m3dbs List<Property Map>
    M3 specific server provided values
    serviceHost String
    The hostname of the service.
    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

    Look up Existing M3Db Resource

    Get an existing M3Db resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: M3DbState, opts?: CustomResourceOptions): M3Db
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        cloud_name: Optional[str] = None,
        components: Optional[Sequence[M3DbComponentArgs]] = None,
        disk_space: Optional[str] = None,
        disk_space_cap: Optional[str] = None,
        disk_space_default: Optional[str] = None,
        disk_space_step: Optional[str] = None,
        disk_space_used: Optional[str] = None,
        m3db_user_config: Optional[M3DbM3dbUserConfigArgs] = None,
        m3dbs: Optional[Sequence[M3DbM3dbArgs]] = None,
        maintenance_window_dow: Optional[str] = None,
        maintenance_window_time: Optional[str] = None,
        plan: Optional[str] = None,
        project: Optional[str] = None,
        project_vpc_id: Optional[str] = None,
        service_host: Optional[str] = None,
        service_integrations: Optional[Sequence[M3DbServiceIntegrationArgs]] = None,
        service_name: Optional[str] = None,
        service_password: Optional[str] = None,
        service_port: Optional[int] = None,
        service_type: Optional[str] = None,
        service_uri: Optional[str] = None,
        service_username: Optional[str] = None,
        state: Optional[str] = None,
        static_ips: Optional[Sequence[str]] = None,
        termination_protection: Optional[bool] = None) -> M3Db
    func GetM3Db(ctx *Context, name string, id IDInput, state *M3DbState, opts ...ResourceOption) (*M3Db, error)
    public static M3Db Get(string name, Input<string> id, M3DbState? state, CustomResourceOptions? opts = null)
    public static M3Db get(String name, Output<String> id, M3DbState state, CustomResourceOptions options)
    resources:  _:    type: aiven:M3Db    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    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<M3DbComponent>
    Service component information objects
    DiskSpace string
    The disk space of the service, possible values depend on the service type, the cloud provider and the project. 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
    M3dbUserConfig M3DbM3dbUserConfig
    M3db user configurable settings
    M3dbs List<M3DbM3db>
    M3 specific server provided values
    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 seem from the Aiven pricing page.
    Project string
    Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so 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<M3DbServiceIntegration>
    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
    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.
    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 []M3DbComponentArgs
    Service component information objects
    DiskSpace string
    The disk space of the service, possible values depend on the service type, the cloud provider and the project. 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
    M3dbUserConfig M3DbM3dbUserConfigArgs
    M3db user configurable settings
    M3dbs []M3DbM3dbArgs
    M3 specific server provided values
    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 seem from the Aiven pricing page.
    Project string
    Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so 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 []M3DbServiceIntegrationArgs
    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
    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.
    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<M3DbComponent>
    Service component information objects
    diskSpace String
    The disk space of the service, possible values depend on the service type, the cloud provider and the project. 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
    m3dbUserConfig M3DbM3dbUserConfig
    M3db user configurable settings
    m3dbs List<M3DbM3db>
    M3 specific server provided values
    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 seem from the Aiven pricing page.
    project String
    Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so 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<M3DbServiceIntegration>
    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
    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.
    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 M3DbComponent[]
    Service component information objects
    diskSpace string
    The disk space of the service, possible values depend on the service type, the cloud provider and the project. 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
    m3dbUserConfig M3DbM3dbUserConfig
    M3db user configurable settings
    m3dbs M3DbM3db[]
    M3 specific server provided values
    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 seem from the Aiven pricing page.
    project string
    Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so 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 M3DbServiceIntegration[]
    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
    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.
    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[M3DbComponentArgs]
    Service component information objects
    disk_space str
    The disk space of the service, possible values depend on the service type, the cloud provider and the project. 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
    m3db_user_config M3DbM3dbUserConfigArgs
    M3db user configurable settings
    m3dbs Sequence[M3DbM3dbArgs]
    M3 specific server provided values
    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 seem from the Aiven pricing page.
    project str
    Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so 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[M3DbServiceIntegrationArgs]
    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
    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.
    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
    The disk space of the service, possible values depend on the service type, the cloud provider and the project. 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
    m3dbUserConfig Property Map
    M3db user configurable settings
    m3dbs List<Property Map>
    M3 specific server provided values
    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 seem from the Aiven pricing page.
    project String
    Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so 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
    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

    M3DbComponent, M3DbComponentArgs

    Component string
    Host string
    KafkaAuthenticationMethod string
    Port int
    Route string
    Ssl bool
    Usage string
    Component string
    Host string
    KafkaAuthenticationMethod string
    Port int
    Route string
    Ssl bool
    Usage string
    component String
    host String
    kafkaAuthenticationMethod String
    port Integer
    route String
    ssl Boolean
    usage String
    component string
    host string
    kafkaAuthenticationMethod string
    port number
    route string
    ssl boolean
    usage string
    component String
    host String
    kafkaAuthenticationMethod String
    port Number
    route String
    ssl Boolean
    usage String

    M3DbM3dbUserConfig, M3DbM3dbUserConfigArgs

    CustomDomain string
    Custom domain
    IpFilters List<string>
    IP filter
    Limits M3DbM3dbUserConfigLimits
    M3 limits
    M3Version string
    M3 major version (deprecated, use m3db_version)
    M3coordinatorEnableGraphiteCarbonIngest string
    Enable Graphite ingestion using Carbon plaintext protocol
    M3dbVersion string
    M3 major version (the minimum compatible version)
    Namespaces List<M3DbM3dbUserConfigNamespace>
    List of M3 namespaces
    PrivateAccess M3DbM3dbUserConfigPrivateAccess
    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.
    PublicAccess M3DbM3dbUserConfigPublicAccess
    Allow access to selected service ports from the public Internet
    Rules M3DbM3dbUserConfigRules
    M3 rules
    ServiceToForkFrom string
    Name of another service to fork from. This has effect only when a new service is being created.
    StaticIps string
    Static IP addresses
    CustomDomain string
    Custom domain
    IpFilters []string
    IP filter
    Limits M3DbM3dbUserConfigLimits
    M3 limits
    M3Version string
    M3 major version (deprecated, use m3db_version)
    M3coordinatorEnableGraphiteCarbonIngest string
    Enable Graphite ingestion using Carbon plaintext protocol
    M3dbVersion string
    M3 major version (the minimum compatible version)
    Namespaces []M3DbM3dbUserConfigNamespace
    List of M3 namespaces
    PrivateAccess M3DbM3dbUserConfigPrivateAccess
    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.
    PublicAccess M3DbM3dbUserConfigPublicAccess
    Allow access to selected service ports from the public Internet
    Rules M3DbM3dbUserConfigRules
    M3 rules
    ServiceToForkFrom string
    Name of another service to fork from. This has effect only when a new service is being created.
    StaticIps string
    Static IP addresses
    customDomain String
    Custom domain
    ipFilters List<String>
    IP filter
    limits M3DbM3dbUserConfigLimits
    M3 limits
    m3Version String
    M3 major version (deprecated, use m3db_version)
    m3coordinatorEnableGraphiteCarbonIngest String
    Enable Graphite ingestion using Carbon plaintext protocol
    m3dbVersion String
    M3 major version (the minimum compatible version)
    namespaces List<M3DbM3dbUserConfigNamespace>
    List of M3 namespaces
    privateAccess M3DbM3dbUserConfigPrivateAccess
    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.
    publicAccess M3DbM3dbUserConfigPublicAccess
    Allow access to selected service ports from the public Internet
    rules M3DbM3dbUserConfigRules
    M3 rules
    serviceToForkFrom String
    Name of another service to fork from. This has effect only when a new service is being created.
    staticIps String
    Static IP addresses
    customDomain string
    Custom domain
    ipFilters string[]
    IP filter
    limits M3DbM3dbUserConfigLimits
    M3 limits
    m3Version string
    M3 major version (deprecated, use m3db_version)
    m3coordinatorEnableGraphiteCarbonIngest string
    Enable Graphite ingestion using Carbon plaintext protocol
    m3dbVersion string
    M3 major version (the minimum compatible version)
    namespaces M3DbM3dbUserConfigNamespace[]
    List of M3 namespaces
    privateAccess M3DbM3dbUserConfigPrivateAccess
    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.
    publicAccess M3DbM3dbUserConfigPublicAccess
    Allow access to selected service ports from the public Internet
    rules M3DbM3dbUserConfigRules
    M3 rules
    serviceToForkFrom string
    Name of another service to fork from. This has effect only when a new service is being created.
    staticIps string
    Static IP addresses
    custom_domain str
    Custom domain
    ip_filters Sequence[str]
    IP filter
    limits M3DbM3dbUserConfigLimits
    M3 limits
    m3_version str
    M3 major version (deprecated, use m3db_version)
    m3coordinator_enable_graphite_carbon_ingest str
    Enable Graphite ingestion using Carbon plaintext protocol
    m3db_version str
    M3 major version (the minimum compatible version)
    namespaces Sequence[M3DbM3dbUserConfigNamespace]
    List of M3 namespaces
    private_access M3DbM3dbUserConfigPrivateAccess
    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.
    public_access M3DbM3dbUserConfigPublicAccess
    Allow access to selected service ports from the public Internet
    rules M3DbM3dbUserConfigRules
    M3 rules
    service_to_fork_from str
    Name of another service to fork from. This has effect only when a new service is being created.
    static_ips str
    Static IP addresses
    customDomain String
    Custom domain
    ipFilters List<String>
    IP filter
    limits Property Map
    M3 limits
    m3Version String
    M3 major version (deprecated, use m3db_version)
    m3coordinatorEnableGraphiteCarbonIngest String
    Enable Graphite ingestion using Carbon plaintext protocol
    m3dbVersion String
    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.
    publicAccess Property Map
    Allow access to selected service ports from the public Internet
    rules Property Map
    M3 rules
    serviceToForkFrom String
    Name of another service to fork from. This has effect only when a new service is being created.
    staticIps String
    Static IP addresses

    M3DbM3dbUserConfigLimits, M3DbM3dbUserConfigLimitsArgs

    M3DbM3dbUserConfigNamespace, M3DbM3dbUserConfigNamespaceArgs

    M3DbM3dbUserConfigNamespaceOptions, M3DbM3dbUserConfigNamespaceOptionsArgs

    M3DbM3dbUserConfigNamespaceOptionsRetentionOptions, M3DbM3dbUserConfigNamespaceOptionsRetentionOptionsArgs

    M3DbM3dbUserConfigPrivateAccess, M3DbM3dbUserConfigPrivateAccessArgs

    M3DbM3dbUserConfigPublicAccess, M3DbM3dbUserConfigPublicAccessArgs

    M3DbM3dbUserConfigRules, M3DbM3dbUserConfigRulesArgs

    M3DbM3dbUserConfigRulesMapping, M3DbM3dbUserConfigRulesMappingArgs

    aggregations List<String>
    drop String
    filter String
    name String
    namespaces List<String>
    tags List<Property Map>

    M3DbM3dbUserConfigRulesMappingTag, M3DbM3dbUserConfigRulesMappingTagArgs

    Name string
    Value string
    Name string
    Value string
    name String
    value String
    name string
    value string
    name str
    value str
    name String
    value String

    M3DbServiceIntegration, M3DbServiceIntegrationArgs

    IntegrationType string
    Type of the service integration. The only supported value at the moment is read_replica
    SourceServiceName string
    Name of the source service
    IntegrationType string
    Type of the service integration. The only supported value at the moment is read_replica
    SourceServiceName string
    Name of the source service
    integrationType String
    Type of the service integration. The only supported value at the moment is read_replica
    sourceServiceName String
    Name of the source service
    integrationType string
    Type of the service integration. The only supported value at the moment is read_replica
    sourceServiceName string
    Name of the source service
    integration_type str
    Type of the service integration. The only supported value at the moment is read_replica
    source_service_name str
    Name of the source service
    integrationType String
    Type of the service integration. The only supported value at the moment is read_replica
    sourceServiceName String
    Name of the source service

    Package Details

    Repository
    Aiven pulumi/pulumi-aiven
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aiven Terraform Provider.
    aiven logo
    Viewing docs for Aiven v4.5.2 (Older version)
    published on Monday, Mar 9, 2026 by Pulumi
    Go to latest version
    Schema (JSON)
    pulumi/pulumi-aiven
      Try Pulumi Cloud free. Your team will thank you.