aiven.M3Db
Explore with Pulumi AI
Creates and manages an Aiven for M3DB service.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as aiven from "@pulumi/aiven";
const exampleM3db = new aiven.M3Db("example_m3db", {
project: exampleProject.project,
cloudName: "google-europe-west1",
plan: "business-8",
serviceName: "example-m3db-service",
maintenanceWindowDow: "monday",
maintenanceWindowTime: "10:00:00",
m3dbUserConfig: {
m3dbVersion: "1.1",
namespaces: [{
name: "example-namespace",
type: "unaggregated",
}],
},
});
import pulumi
import pulumi_aiven as aiven
example_m3db = aiven.M3Db("example_m3db",
project=example_project["project"],
cloud_name="google-europe-west1",
plan="business-8",
service_name="example-m3db-service",
maintenance_window_dow="monday",
maintenance_window_time="10:00:00",
m3db_user_config={
"m3db_version": "1.1",
"namespaces": [{
"name": "example-namespace",
"type": "unaggregated",
}],
})
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.NewM3Db(ctx, "example_m3db", &aiven.M3DbArgs{
Project: pulumi.Any(exampleProject.Project),
CloudName: pulumi.String("google-europe-west1"),
Plan: pulumi.String("business-8"),
ServiceName: pulumi.String("example-m3db-service"),
MaintenanceWindowDow: pulumi.String("monday"),
MaintenanceWindowTime: pulumi.String("10:00:00"),
M3dbUserConfig: &aiven.M3DbM3dbUserConfigArgs{
M3dbVersion: pulumi.String("1.1"),
Namespaces: aiven.M3DbM3dbUserConfigNamespaceArray{
&aiven.M3DbM3dbUserConfigNamespaceArgs{
Name: pulumi.String("example-namespace"),
Type: pulumi.String("unaggregated"),
},
},
},
})
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 = new Aiven.M3Db("example_m3db", new()
{
Project = exampleProject.Project,
CloudName = "google-europe-west1",
Plan = "business-8",
ServiceName = "example-m3db-service",
MaintenanceWindowDow = "monday",
MaintenanceWindowTime = "10:00:00",
M3dbUserConfig = new Aiven.Inputs.M3DbM3dbUserConfigArgs
{
M3dbVersion = "1.1",
Namespaces = new[]
{
new Aiven.Inputs.M3DbM3dbUserConfigNamespaceArgs
{
Name = "example-namespace",
Type = "unaggregated",
},
},
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aiven.M3Db;
import com.pulumi.aiven.M3DbArgs;
import com.pulumi.aiven.inputs.M3DbM3dbUserConfigArgs;
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) {
var exampleM3db = new M3Db("exampleM3db", M3DbArgs.builder()
.project(exampleProject.project())
.cloudName("google-europe-west1")
.plan("business-8")
.serviceName("example-m3db-service")
.maintenanceWindowDow("monday")
.maintenanceWindowTime("10:00:00")
.m3dbUserConfig(M3DbM3dbUserConfigArgs.builder()
.m3dbVersion(1.1)
.namespaces(M3DbM3dbUserConfigNamespaceArgs.builder()
.name("example-namespace")
.type("unaggregated")
.build())
.build())
.build());
}
}
resources:
exampleM3db:
type: aiven:M3Db
name: example_m3db
properties:
project: ${exampleProject.project}
cloudName: google-europe-west1
plan: business-8
serviceName: example-m3db-service
maintenanceWindowDow: monday
maintenanceWindowTime: 10:00:00
m3dbUserConfig:
m3dbVersion: 1.1
namespaces:
- name: example-namespace
type: unaggregated
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,
plan: Optional[str] = None,
service_name: Optional[str] = None,
project: Optional[str] = None,
m3db_user_config: Optional[M3DbM3dbUserConfigArgs] = None,
additional_disk_space: Optional[str] = None,
maintenance_window_dow: Optional[str] = None,
maintenance_window_time: Optional[str] = None,
m3db: Optional[M3DbM3dbArgs] = None,
disk_space: Optional[str] = None,
project_vpc_id: Optional[str] = None,
service_integrations: Optional[Sequence[M3DbServiceIntegrationArgs]] = None,
cloud_name: Optional[str] = None,
static_ips: Optional[Sequence[str]] = None,
tags: Optional[Sequence[M3DbTagArgs]] = None,
tech_emails: Optional[Sequence[M3DbTechEmailArgs]] = 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)
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()
{
Plan = "string",
ServiceName = "string",
Project = "string",
M3dbUserConfig = new Aiven.Inputs.M3DbM3dbUserConfigArgs
{
AdditionalBackupRegions = "string",
CustomDomain = "string",
IpFilterObjects = new[]
{
new Aiven.Inputs.M3DbM3dbUserConfigIpFilterObjectArgs
{
Network = "string",
Description = "string",
},
},
IpFilterStrings = new[]
{
"string",
},
Limits = new Aiven.Inputs.M3DbM3dbUserConfigLimitsArgs
{
MaxRecentlyQueriedSeriesBlocks = 0,
MaxRecentlyQueriedSeriesDiskBytesRead = 0,
MaxRecentlyQueriedSeriesLookback = "string",
QueryDocs = 0,
QueryRequireExhaustive = false,
QuerySeries = 0,
},
M3 = new Aiven.Inputs.M3DbM3dbUserConfigM3Args
{
TagOptions = new Aiven.Inputs.M3DbM3dbUserConfigM3TagOptionsArgs
{
AllowTagNameDuplicates = false,
AllowTagValueEmpty = false,
},
},
M3Version = "string",
M3coordinatorEnableGraphiteCarbonIngest = false,
M3dbVersion = "string",
Namespaces = new[]
{
new Aiven.Inputs.M3DbM3dbUserConfigNamespaceArgs
{
Name = "string",
Type = "string",
Options = new Aiven.Inputs.M3DbM3dbUserConfigNamespaceOptionsArgs
{
RetentionOptions = new Aiven.Inputs.M3DbM3dbUserConfigNamespaceOptionsRetentionOptionsArgs
{
BlockDataExpiryDuration = "string",
BlocksizeDuration = "string",
BufferFutureDuration = "string",
BufferPastDuration = "string",
RetentionPeriodDuration = "string",
},
SnapshotEnabled = false,
WritesToCommitlog = false,
},
Resolution = "string",
},
},
PrivateAccess = new Aiven.Inputs.M3DbM3dbUserConfigPrivateAccessArgs
{
M3coordinator = false,
},
ProjectToForkFrom = "string",
PublicAccess = new Aiven.Inputs.M3DbM3dbUserConfigPublicAccessArgs
{
M3coordinator = false,
},
Rules = new Aiven.Inputs.M3DbM3dbUserConfigRulesArgs
{
Mappings = new[]
{
new Aiven.Inputs.M3DbM3dbUserConfigRulesMappingArgs
{
Filter = "string",
Aggregations = new[]
{
"string",
},
Drop = false,
Name = "string",
NamespacesObjects = new[]
{
new Aiven.Inputs.M3DbM3dbUserConfigRulesMappingNamespacesObjectArgs
{
Resolution = "string",
Retention = "string",
},
},
NamespacesStrings = new[]
{
"string",
},
Tags = new[]
{
new Aiven.Inputs.M3DbM3dbUserConfigRulesMappingTagArgs
{
Name = "string",
Value = "string",
},
},
},
},
},
ServiceLog = false,
ServiceToForkFrom = "string",
StaticIps = false,
},
AdditionalDiskSpace = "string",
MaintenanceWindowDow = "string",
MaintenanceWindowTime = "string",
M3db = new Aiven.Inputs.M3DbM3dbArgs
{
HttpClusterUri = "string",
HttpNodeUri = "string",
InfluxdbUri = "string",
PrometheusRemoteReadUri = "string",
PrometheusRemoteWriteUri = "string",
Uris = new[]
{
"string",
},
},
ProjectVpcId = "string",
ServiceIntegrations = new[]
{
new Aiven.Inputs.M3DbServiceIntegrationArgs
{
IntegrationType = "string",
SourceServiceName = "string",
},
},
CloudName = "string",
StaticIps = new[]
{
"string",
},
Tags = new[]
{
new Aiven.Inputs.M3DbTagArgs
{
Key = "string",
Value = "string",
},
},
TechEmails = new[]
{
new Aiven.Inputs.M3DbTechEmailArgs
{
Email = "string",
},
},
TerminationProtection = false,
});
example, err := aiven.NewM3Db(ctx, "m3dbResource", &aiven.M3DbArgs{
Plan: pulumi.String("string"),
ServiceName: pulumi.String("string"),
Project: pulumi.String("string"),
M3dbUserConfig: &aiven.M3DbM3dbUserConfigArgs{
AdditionalBackupRegions: pulumi.String("string"),
CustomDomain: pulumi.String("string"),
IpFilterObjects: aiven.M3DbM3dbUserConfigIpFilterObjectArray{
&aiven.M3DbM3dbUserConfigIpFilterObjectArgs{
Network: pulumi.String("string"),
Description: pulumi.String("string"),
},
},
IpFilterStrings: pulumi.StringArray{
pulumi.String("string"),
},
Limits: &aiven.M3DbM3dbUserConfigLimitsArgs{
MaxRecentlyQueriedSeriesBlocks: pulumi.Int(0),
MaxRecentlyQueriedSeriesDiskBytesRead: pulumi.Int(0),
MaxRecentlyQueriedSeriesLookback: pulumi.String("string"),
QueryDocs: pulumi.Int(0),
QueryRequireExhaustive: pulumi.Bool(false),
QuerySeries: pulumi.Int(0),
},
M3: &aiven.M3DbM3dbUserConfigM3Args{
TagOptions: &aiven.M3DbM3dbUserConfigM3TagOptionsArgs{
AllowTagNameDuplicates: pulumi.Bool(false),
AllowTagValueEmpty: pulumi.Bool(false),
},
},
M3Version: pulumi.String("string"),
M3coordinatorEnableGraphiteCarbonIngest: pulumi.Bool(false),
M3dbVersion: pulumi.String("string"),
Namespaces: aiven.M3DbM3dbUserConfigNamespaceArray{
&aiven.M3DbM3dbUserConfigNamespaceArgs{
Name: pulumi.String("string"),
Type: 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.Bool(false),
WritesToCommitlog: pulumi.Bool(false),
},
Resolution: pulumi.String("string"),
},
},
PrivateAccess: &aiven.M3DbM3dbUserConfigPrivateAccessArgs{
M3coordinator: pulumi.Bool(false),
},
ProjectToForkFrom: pulumi.String("string"),
PublicAccess: &aiven.M3DbM3dbUserConfigPublicAccessArgs{
M3coordinator: pulumi.Bool(false),
},
Rules: &aiven.M3DbM3dbUserConfigRulesArgs{
Mappings: aiven.M3DbM3dbUserConfigRulesMappingArray{
&aiven.M3DbM3dbUserConfigRulesMappingArgs{
Filter: pulumi.String("string"),
Aggregations: pulumi.StringArray{
pulumi.String("string"),
},
Drop: pulumi.Bool(false),
Name: pulumi.String("string"),
NamespacesObjects: aiven.M3DbM3dbUserConfigRulesMappingNamespacesObjectArray{
&aiven.M3DbM3dbUserConfigRulesMappingNamespacesObjectArgs{
Resolution: pulumi.String("string"),
Retention: pulumi.String("string"),
},
},
NamespacesStrings: pulumi.StringArray{
pulumi.String("string"),
},
Tags: aiven.M3DbM3dbUserConfigRulesMappingTagArray{
&aiven.M3DbM3dbUserConfigRulesMappingTagArgs{
Name: pulumi.String("string"),
Value: pulumi.String("string"),
},
},
},
},
},
ServiceLog: pulumi.Bool(false),
ServiceToForkFrom: pulumi.String("string"),
StaticIps: pulumi.Bool(false),
},
AdditionalDiskSpace: pulumi.String("string"),
MaintenanceWindowDow: pulumi.String("string"),
MaintenanceWindowTime: pulumi.String("string"),
M3db: &aiven.M3DbM3dbArgs{
HttpClusterUri: pulumi.String("string"),
HttpNodeUri: pulumi.String("string"),
InfluxdbUri: pulumi.String("string"),
PrometheusRemoteReadUri: pulumi.String("string"),
PrometheusRemoteWriteUri: pulumi.String("string"),
Uris: pulumi.StringArray{
pulumi.String("string"),
},
},
ProjectVpcId: pulumi.String("string"),
ServiceIntegrations: aiven.M3DbServiceIntegrationArray{
&aiven.M3DbServiceIntegrationArgs{
IntegrationType: pulumi.String("string"),
SourceServiceName: pulumi.String("string"),
},
},
CloudName: pulumi.String("string"),
StaticIps: pulumi.StringArray{
pulumi.String("string"),
},
Tags: aiven.M3DbTagArray{
&aiven.M3DbTagArgs{
Key: pulumi.String("string"),
Value: pulumi.String("string"),
},
},
TechEmails: aiven.M3DbTechEmailArray{
&aiven.M3DbTechEmailArgs{
Email: pulumi.String("string"),
},
},
TerminationProtection: pulumi.Bool(false),
})
var m3dbResource = new M3Db("m3dbResource", M3DbArgs.builder()
.plan("string")
.serviceName("string")
.project("string")
.m3dbUserConfig(M3DbM3dbUserConfigArgs.builder()
.additionalBackupRegions("string")
.customDomain("string")
.ipFilterObjects(M3DbM3dbUserConfigIpFilterObjectArgs.builder()
.network("string")
.description("string")
.build())
.ipFilterStrings("string")
.limits(M3DbM3dbUserConfigLimitsArgs.builder()
.maxRecentlyQueriedSeriesBlocks(0)
.maxRecentlyQueriedSeriesDiskBytesRead(0)
.maxRecentlyQueriedSeriesLookback("string")
.queryDocs(0)
.queryRequireExhaustive(false)
.querySeries(0)
.build())
.m3(M3DbM3dbUserConfigM3Args.builder()
.tagOptions(M3DbM3dbUserConfigM3TagOptionsArgs.builder()
.allowTagNameDuplicates(false)
.allowTagValueEmpty(false)
.build())
.build())
.m3Version("string")
.m3coordinatorEnableGraphiteCarbonIngest(false)
.m3dbVersion("string")
.namespaces(M3DbM3dbUserConfigNamespaceArgs.builder()
.name("string")
.type("string")
.options(M3DbM3dbUserConfigNamespaceOptionsArgs.builder()
.retentionOptions(M3DbM3dbUserConfigNamespaceOptionsRetentionOptionsArgs.builder()
.blockDataExpiryDuration("string")
.blocksizeDuration("string")
.bufferFutureDuration("string")
.bufferPastDuration("string")
.retentionPeriodDuration("string")
.build())
.snapshotEnabled(false)
.writesToCommitlog(false)
.build())
.resolution("string")
.build())
.privateAccess(M3DbM3dbUserConfigPrivateAccessArgs.builder()
.m3coordinator(false)
.build())
.projectToForkFrom("string")
.publicAccess(M3DbM3dbUserConfigPublicAccessArgs.builder()
.m3coordinator(false)
.build())
.rules(M3DbM3dbUserConfigRulesArgs.builder()
.mappings(M3DbM3dbUserConfigRulesMappingArgs.builder()
.filter("string")
.aggregations("string")
.drop(false)
.name("string")
.namespacesObjects(M3DbM3dbUserConfigRulesMappingNamespacesObjectArgs.builder()
.resolution("string")
.retention("string")
.build())
.namespacesStrings("string")
.tags(M3DbM3dbUserConfigRulesMappingTagArgs.builder()
.name("string")
.value("string")
.build())
.build())
.build())
.serviceLog(false)
.serviceToForkFrom("string")
.staticIps(false)
.build())
.additionalDiskSpace("string")
.maintenanceWindowDow("string")
.maintenanceWindowTime("string")
.m3db(M3DbM3dbArgs.builder()
.httpClusterUri("string")
.httpNodeUri("string")
.influxdbUri("string")
.prometheusRemoteReadUri("string")
.prometheusRemoteWriteUri("string")
.uris("string")
.build())
.projectVpcId("string")
.serviceIntegrations(M3DbServiceIntegrationArgs.builder()
.integrationType("string")
.sourceServiceName("string")
.build())
.cloudName("string")
.staticIps("string")
.tags(M3DbTagArgs.builder()
.key("string")
.value("string")
.build())
.techEmails(M3DbTechEmailArgs.builder()
.email("string")
.build())
.terminationProtection(false)
.build());
m3db_resource = aiven.M3Db("m3dbResource",
plan="string",
service_name="string",
project="string",
m3db_user_config={
"additional_backup_regions": "string",
"custom_domain": "string",
"ip_filter_objects": [{
"network": "string",
"description": "string",
}],
"ip_filter_strings": ["string"],
"limits": {
"max_recently_queried_series_blocks": 0,
"max_recently_queried_series_disk_bytes_read": 0,
"max_recently_queried_series_lookback": "string",
"query_docs": 0,
"query_require_exhaustive": False,
"query_series": 0,
},
"m3": {
"tag_options": {
"allow_tag_name_duplicates": False,
"allow_tag_value_empty": False,
},
},
"m3_version": "string",
"m3coordinator_enable_graphite_carbon_ingest": False,
"m3db_version": "string",
"namespaces": [{
"name": "string",
"type": "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": False,
"writes_to_commitlog": False,
},
"resolution": "string",
}],
"private_access": {
"m3coordinator": False,
},
"project_to_fork_from": "string",
"public_access": {
"m3coordinator": False,
},
"rules": {
"mappings": [{
"filter": "string",
"aggregations": ["string"],
"drop": False,
"name": "string",
"namespaces_objects": [{
"resolution": "string",
"retention": "string",
}],
"namespaces_strings": ["string"],
"tags": [{
"name": "string",
"value": "string",
}],
}],
},
"service_log": False,
"service_to_fork_from": "string",
"static_ips": False,
},
additional_disk_space="string",
maintenance_window_dow="string",
maintenance_window_time="string",
m3db={
"http_cluster_uri": "string",
"http_node_uri": "string",
"influxdb_uri": "string",
"prometheus_remote_read_uri": "string",
"prometheus_remote_write_uri": "string",
"uris": ["string"],
},
project_vpc_id="string",
service_integrations=[{
"integration_type": "string",
"source_service_name": "string",
}],
cloud_name="string",
static_ips=["string"],
tags=[{
"key": "string",
"value": "string",
}],
tech_emails=[{
"email": "string",
}],
termination_protection=False)
const m3dbResource = new aiven.M3Db("m3dbResource", {
plan: "string",
serviceName: "string",
project: "string",
m3dbUserConfig: {
additionalBackupRegions: "string",
customDomain: "string",
ipFilterObjects: [{
network: "string",
description: "string",
}],
ipFilterStrings: ["string"],
limits: {
maxRecentlyQueriedSeriesBlocks: 0,
maxRecentlyQueriedSeriesDiskBytesRead: 0,
maxRecentlyQueriedSeriesLookback: "string",
queryDocs: 0,
queryRequireExhaustive: false,
querySeries: 0,
},
m3: {
tagOptions: {
allowTagNameDuplicates: false,
allowTagValueEmpty: false,
},
},
m3Version: "string",
m3coordinatorEnableGraphiteCarbonIngest: false,
m3dbVersion: "string",
namespaces: [{
name: "string",
type: "string",
options: {
retentionOptions: {
blockDataExpiryDuration: "string",
blocksizeDuration: "string",
bufferFutureDuration: "string",
bufferPastDuration: "string",
retentionPeriodDuration: "string",
},
snapshotEnabled: false,
writesToCommitlog: false,
},
resolution: "string",
}],
privateAccess: {
m3coordinator: false,
},
projectToForkFrom: "string",
publicAccess: {
m3coordinator: false,
},
rules: {
mappings: [{
filter: "string",
aggregations: ["string"],
drop: false,
name: "string",
namespacesObjects: [{
resolution: "string",
retention: "string",
}],
namespacesStrings: ["string"],
tags: [{
name: "string",
value: "string",
}],
}],
},
serviceLog: false,
serviceToForkFrom: "string",
staticIps: false,
},
additionalDiskSpace: "string",
maintenanceWindowDow: "string",
maintenanceWindowTime: "string",
m3db: {
httpClusterUri: "string",
httpNodeUri: "string",
influxdbUri: "string",
prometheusRemoteReadUri: "string",
prometheusRemoteWriteUri: "string",
uris: ["string"],
},
projectVpcId: "string",
serviceIntegrations: [{
integrationType: "string",
sourceServiceName: "string",
}],
cloudName: "string",
staticIps: ["string"],
tags: [{
key: "string",
value: "string",
}],
techEmails: [{
email: "string",
}],
terminationProtection: false,
});
type: aiven:M3Db
properties:
additionalDiskSpace: string
cloudName: string
m3db:
httpClusterUri: string
httpNodeUri: string
influxdbUri: string
prometheusRemoteReadUri: string
prometheusRemoteWriteUri: string
uris:
- string
m3dbUserConfig:
additionalBackupRegions: string
customDomain: string
ipFilterObjects:
- description: string
network: string
ipFilterStrings:
- string
limits:
maxRecentlyQueriedSeriesBlocks: 0
maxRecentlyQueriedSeriesDiskBytesRead: 0
maxRecentlyQueriedSeriesLookback: string
queryDocs: 0
queryRequireExhaustive: false
querySeries: 0
m3:
tagOptions:
allowTagNameDuplicates: false
allowTagValueEmpty: false
m3Version: string
m3coordinatorEnableGraphiteCarbonIngest: false
m3dbVersion: string
namespaces:
- name: string
options:
retentionOptions:
blockDataExpiryDuration: string
blocksizeDuration: string
bufferFutureDuration: string
bufferPastDuration: string
retentionPeriodDuration: string
snapshotEnabled: false
writesToCommitlog: false
resolution: string
type: string
privateAccess:
m3coordinator: false
projectToForkFrom: string
publicAccess:
m3coordinator: false
rules:
mappings:
- aggregations:
- string
drop: false
filter: string
name: string
namespacesObjects:
- resolution: string
retention: string
namespacesStrings:
- string
tags:
- name: string
value: string
serviceLog: false
serviceToForkFrom: string
staticIps: false
maintenanceWindowDow: string
maintenanceWindowTime: string
plan: string
project: string
projectVpcId: string
serviceIntegrations:
- integrationType: string
sourceServiceName: string
serviceName: string
staticIps:
- string
tags:
- key: string
value: string
techEmails:
- email: 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:
- 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
andpremium-x
wherex
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.
- Service
Name 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.
- Additional
Disk stringSpace - Add disk storage in increments of 30 GiB to scale your service. The maximum value depends on the service type and cloud provider. Removing additional storage causes the service nodes to go through a rolling restart and there might be a short downtime for services with no HA capabilities.
- Cloud
Name 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. - Disk
Space 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.
- M3db
M3Db
M3db - Values provided by the M3DB server.
- M3db
User M3DbConfig M3db User Config - M3db user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
- Maintenance
Window stringDow - Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
- Maintenance
Window stringTime - Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
- Project
Vpc stringId - 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 List<M3DbService Integration> - Service integrations to specify when creating a service. Not applied after initial service creation
- Static
Ips 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
- List<M3Db
Tag> - Tags are key-value pairs that allow you to categorize services.
- Tech
Emails List<M3DbTech Email> - 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.
- 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
andpremium-x
wherex
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.
- Service
Name 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.
- Additional
Disk stringSpace - Add disk storage in increments of 30 GiB to scale your service. The maximum value depends on the service type and cloud provider. Removing additional storage causes the service nodes to go through a rolling restart and there might be a short downtime for services with no HA capabilities.
- Cloud
Name 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. - Disk
Space 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.
- M3db
M3Db
M3db Args - Values provided by the M3DB server.
- M3db
User M3DbConfig M3db User Config Args - M3db user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
- Maintenance
Window stringDow - Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
- Maintenance
Window stringTime - Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
- Project
Vpc stringId - 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 []M3DbService Integration Args - Service integrations to specify when creating a service. Not applied after initial service creation
- Static
Ips []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
- []M3Db
Tag Args - Tags are key-value pairs that allow you to categorize services.
- Tech
Emails []M3DbTech Email Args - 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.
- 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
andpremium-x
wherex
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.
- service
Name 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.
- additional
Disk StringSpace - Add disk storage in increments of 30 GiB to scale your service. The maximum value depends on the service type and cloud provider. Removing additional storage causes the service nodes to go through a rolling restart and there might be a short downtime for services with no HA capabilities.
- cloud
Name 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. - disk
Space 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.
- m3db
M3Db
M3db - Values provided by the M3DB server.
- m3db
User M3DbConfig M3db User Config - M3db user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
- maintenance
Window StringDow - Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
- maintenance
Window StringTime - Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
- project
Vpc StringId - 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 List<M3DbService Integration> - Service integrations to specify when creating a service. Not applied after initial service creation
- static
Ips 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
- List<M3Db
Tag> - Tags are key-value pairs that allow you to categorize services.
- tech
Emails List<M3DbTech Email> - 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 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.
- 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
andpremium-x
wherex
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.
- service
Name 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.
- additional
Disk stringSpace - Add disk storage in increments of 30 GiB to scale your service. The maximum value depends on the service type and cloud provider. Removing additional storage causes the service nodes to go through a rolling restart and there might be a short downtime for services with no HA capabilities.
- cloud
Name 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. - disk
Space 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.
- m3db
M3Db
M3db - Values provided by the M3DB server.
- m3db
User M3DbConfig M3db User Config - M3db user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
- maintenance
Window stringDow - Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
- maintenance
Window stringTime - Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
- project
Vpc stringId - 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 M3DbService Integration[] - Service integrations to specify when creating a service. Not applied after initial service creation
- static
Ips 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
- M3Db
Tag[] - Tags are key-value pairs that allow you to categorize services.
- tech
Emails M3DbTech Email[] - 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 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.
- 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
andpremium-x
wherex
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.
- 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.
- additional_
disk_ strspace - Add disk storage in increments of 30 GiB to scale your service. The maximum value depends on the service type and cloud provider. Removing additional storage causes the service nodes to go through a rolling restart and there might be a short downtime for services with no HA capabilities.
- cloud_
name str - Defines where the cloud provider and region where the service is hosted in. This can be changed freely after service is created. Changing the value will trigger a potentially lengthy migration process for the service. Format is cloud provider name (
aws
,azure
,do
google
,upcloud
, etc.), dash, and the cloud provider specific region name. These are documented on each Cloud provider's own support articles, like here for Google and here for AWS. - 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.
- m3db
M3Db
M3db Args - Values provided by the M3DB server.
- m3db_
user_ M3Dbconfig M3db User Config Args - M3db user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
- maintenance_
window_ strdow - Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
- maintenance_
window_ strtime - Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
- project_
vpc_ strid - 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[M3DbService Integration Args] - 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
- Sequence[M3Db
Tag Args] - Tags are key-value pairs that allow you to categorize services.
- tech_
emails Sequence[M3DbTech Email Args] - 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.
- 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
andpremium-x
wherex
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.
- service
Name 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.
- additional
Disk StringSpace - Add disk storage in increments of 30 GiB to scale your service. The maximum value depends on the service type and cloud provider. Removing additional storage causes the service nodes to go through a rolling restart and there might be a short downtime for services with no HA capabilities.
- cloud
Name 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. - disk
Space 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.
- m3db Property Map
- Values provided by the M3DB server.
- m3db
User Property MapConfig - M3db user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
- maintenance
Window StringDow - Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
- maintenance
Window StringTime - Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
- project
Vpc StringId - 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 List<Property Map> - Service integrations to specify when creating a service. Not applied after initial service creation
- static
Ips 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
- List<Property Map>
- Tags are key-value pairs that allow you to categorize services.
- tech
Emails 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.
- termination
Protection 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<M3Db
Component> - Service component information objects
- Disk
Space stringCap - The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
- Disk
Space stringDefault - 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 stringStep - 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 fromdisk_space_default
by increments of this size. - Disk
Space stringUsed - Disk space that service is currently using
- Id string
- The provider-assigned unique ID for this managed resource.
- Service
Host string - The hostname of the service.
- Service
Password string - Password used for connecting to the service, if applicable
- Service
Port int - The port of the service
- Service
Type string - Aiven internal service type code
- Service
Uri string - URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
- Service
Username string - Username used for connecting to the service, if applicable
- State string
- Service state. One of
POWEROFF
,REBALANCING
,REBUILDING
orRUNNING
- Components
[]M3Db
Component - Service component information objects
- Disk
Space stringCap - The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
- Disk
Space stringDefault - 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 stringStep - 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 fromdisk_space_default
by increments of this size. - Disk
Space stringUsed - Disk space that service is currently using
- Id string
- The provider-assigned unique ID for this managed resource.
- Service
Host string - The hostname of the service.
- Service
Password string - Password used for connecting to the service, if applicable
- Service
Port int - The port of the service
- Service
Type string - Aiven internal service type code
- Service
Uri string - URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
- Service
Username string - Username used for connecting to the service, if applicable
- State string
- Service state. One of
POWEROFF
,REBALANCING
,REBUILDING
orRUNNING
- components
List<M3Db
Component> - Service component information objects
- disk
Space StringCap - The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
- disk
Space StringDefault - 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 StringStep - 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 fromdisk_space_default
by increments of this size. - disk
Space StringUsed - Disk space that service is currently using
- id String
- The provider-assigned unique ID for this managed resource.
- service
Host String - The hostname of the service.
- service
Password String - Password used for connecting to the service, if applicable
- service
Port Integer - The port of the service
- service
Type String - Aiven internal service type code
- service
Uri String - URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
- service
Username String - Username used for connecting to the service, if applicable
- state String
- Service state. One of
POWEROFF
,REBALANCING
,REBUILDING
orRUNNING
- components
M3Db
Component[] - Service component information objects
- disk
Space stringCap - The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
- disk
Space stringDefault - 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 stringStep - 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 fromdisk_space_default
by increments of this size. - disk
Space stringUsed - Disk space that service is currently using
- id string
- The provider-assigned unique ID for this managed resource.
- service
Host string - The hostname of the service.
- service
Password string - Password used for connecting to the service, if applicable
- service
Port number - The port of the service
- service
Type string - Aiven internal service type code
- service
Uri string - URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
- service
Username string - Username used for connecting to the service, if applicable
- state string
- Service state. One of
POWEROFF
,REBALANCING
,REBUILDING
orRUNNING
- components
Sequence[M3Db
Component] - Service component information objects
- disk_
space_ strcap - The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
- disk_
space_ strdefault - 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_ strstep - 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 fromdisk_space_default
by increments of this size. - disk_
space_ strused - Disk space that service is currently using
- id str
- The provider-assigned unique ID for this managed resource.
- 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
orRUNNING
- components List<Property Map>
- Service component information objects
- disk
Space StringCap - The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
- disk
Space StringDefault - 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 StringStep - 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 fromdisk_space_default
by increments of this size. - disk
Space StringUsed - Disk space that service is currently using
- id String
- The provider-assigned unique ID for this managed resource.
- service
Host String - The hostname of the service.
- service
Password String - Password used for connecting to the service, if applicable
- service
Port Number - The port of the service
- service
Type String - Aiven internal service type code
- service
Uri String - URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
- service
Username String - Username used for connecting to the service, if applicable
- state String
- Service state. One of
POWEROFF
,REBALANCING
,REBUILDING
orRUNNING
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,
additional_disk_space: Optional[str] = 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: Optional[M3DbM3dbArgs] = None,
m3db_user_config: Optional[M3DbM3dbUserConfigArgs] = 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,
tags: Optional[Sequence[M3DbTagArgs]] = None,
tech_emails: Optional[Sequence[M3DbTechEmailArgs]] = 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)
Resource lookup is not supported in YAML
- 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.
- Additional
Disk stringSpace - Add disk storage in increments of 30 GiB to scale your service. The maximum value depends on the service type and cloud provider. Removing additional storage causes the service nodes to go through a rolling restart and there might be a short downtime for services with no HA capabilities.
- Cloud
Name 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<M3Db
Component> - Service component information objects
- Disk
Space 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.
- Disk
Space stringCap - The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
- Disk
Space stringDefault - 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 stringStep - 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 fromdisk_space_default
by increments of this size. - Disk
Space stringUsed - Disk space that service is currently using
- M3db
M3Db
M3db - Values provided by the M3DB server.
- M3db
User M3DbConfig M3db User Config - M3db user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
- Maintenance
Window stringDow - Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
- Maintenance
Window stringTime - 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
andpremium-x
wherex
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.
- Project
Vpc stringId - 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 string - The hostname of the service.
- Service
Integrations List<M3DbService Integration> - Service integrations to specify when creating a service. Not applied after initial service creation
- Service
Name 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.
- Service
Password string - Password used for connecting to the service, if applicable
- Service
Port int - The port of the service
- Service
Type string - Aiven internal service type code
- Service
Uri string - URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
- Service
Username string - Username used for connecting to the service, if applicable
- State string
- Service state. One of
POWEROFF
,REBALANCING
,REBUILDING
orRUNNING
- Static
Ips 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
- List<M3Db
Tag> - Tags are key-value pairs that allow you to categorize services.
- Tech
Emails List<M3DbTech Email> - 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.
- Additional
Disk stringSpace - Add disk storage in increments of 30 GiB to scale your service. The maximum value depends on the service type and cloud provider. Removing additional storage causes the service nodes to go through a rolling restart and there might be a short downtime for services with no HA capabilities.
- Cloud
Name 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
[]M3Db
Component Args - Service component information objects
- Disk
Space 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.
- Disk
Space stringCap - The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
- Disk
Space stringDefault - 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 stringStep - 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 fromdisk_space_default
by increments of this size. - Disk
Space stringUsed - Disk space that service is currently using
- M3db
M3Db
M3db Args - Values provided by the M3DB server.
- M3db
User M3DbConfig M3db User Config Args - M3db user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
- Maintenance
Window stringDow - Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
- Maintenance
Window stringTime - 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
andpremium-x
wherex
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.
- Project
Vpc stringId - 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 string - The hostname of the service.
- Service
Integrations []M3DbService Integration Args - Service integrations to specify when creating a service. Not applied after initial service creation
- Service
Name 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.
- Service
Password string - Password used for connecting to the service, if applicable
- Service
Port int - The port of the service
- Service
Type string - Aiven internal service type code
- Service
Uri string - URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
- Service
Username string - Username used for connecting to the service, if applicable
- State string
- Service state. One of
POWEROFF
,REBALANCING
,REBUILDING
orRUNNING
- Static
Ips []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
- []M3Db
Tag Args - Tags are key-value pairs that allow you to categorize services.
- Tech
Emails []M3DbTech Email Args - 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.
- additional
Disk StringSpace - Add disk storage in increments of 30 GiB to scale your service. The maximum value depends on the service type and cloud provider. Removing additional storage causes the service nodes to go through a rolling restart and there might be a short downtime for services with no HA capabilities.
- cloud
Name 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<M3Db
Component> - Service component information objects
- disk
Space 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.
- disk
Space StringCap - The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
- disk
Space StringDefault - 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 StringStep - 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 fromdisk_space_default
by increments of this size. - disk
Space StringUsed - Disk space that service is currently using
- m3db
M3Db
M3db - Values provided by the M3DB server.
- m3db
User M3DbConfig M3db User Config - M3db user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
- maintenance
Window StringDow - Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
- maintenance
Window StringTime - 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
andpremium-x
wherex
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.
- project
Vpc StringId - 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 String - The hostname of the service.
- service
Integrations List<M3DbService Integration> - Service integrations to specify when creating a service. Not applied after initial service creation
- service
Name 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.
- service
Password String - Password used for connecting to the service, if applicable
- service
Port Integer - The port of the service
- service
Type String - Aiven internal service type code
- service
Uri String - URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
- service
Username String - Username used for connecting to the service, if applicable
- state String
- Service state. One of
POWEROFF
,REBALANCING
,REBUILDING
orRUNNING
- static
Ips 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
- List<M3Db
Tag> - Tags are key-value pairs that allow you to categorize services.
- tech
Emails List<M3DbTech Email> - 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 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 stringSpace - Add disk storage in increments of 30 GiB to scale your service. The maximum value depends on the service type and cloud provider. Removing additional storage causes the service nodes to go through a rolling restart and there might be a short downtime for services with no HA capabilities.
- cloud
Name 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
M3Db
Component[] - Service component information objects
- disk
Space 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.
- disk
Space stringCap - The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
- disk
Space stringDefault - 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 stringStep - 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 fromdisk_space_default
by increments of this size. - disk
Space stringUsed - Disk space that service is currently using
- m3db
M3Db
M3db - Values provided by the M3DB server.
- m3db
User M3DbConfig M3db User Config - M3db user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
- maintenance
Window stringDow - Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
- maintenance
Window stringTime - 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
andpremium-x
wherex
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.
- project
Vpc stringId - 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 string - The hostname of the service.
- service
Integrations M3DbService Integration[] - Service integrations to specify when creating a service. Not applied after initial service creation
- service
Name 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.
- service
Password string - Password used for connecting to the service, if applicable
- service
Port number - The port of the service
- service
Type string - Aiven internal service type code
- service
Uri string - URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
- service
Username string - Username used for connecting to the service, if applicable
- state string
- Service state. One of
POWEROFF
,REBALANCING
,REBUILDING
orRUNNING
- static
Ips 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
- M3Db
Tag[] - Tags are key-value pairs that allow you to categorize services.
- tech
Emails M3DbTech Email[] - 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 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_ strspace - Add disk storage in increments of 30 GiB to scale your service. The maximum value depends on the service type and cloud provider. Removing additional storage causes the service nodes to go through a rolling restart and there might be a short downtime for services with no HA capabilities.
- cloud_
name str - Defines where the cloud provider and region where the service is hosted in. This can be changed freely after service is created. Changing the value will trigger a potentially lengthy migration process for the service. Format is cloud provider name (
aws
,azure
,do
google
,upcloud
, etc.), dash, and the cloud provider specific region name. These are documented on each Cloud provider's own support articles, like here for Google and here for AWS. - components
Sequence[M3Db
Component Args] - 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_ strcap - The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
- disk_
space_ strdefault - 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_ strstep - 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 fromdisk_space_default
by increments of this size. - disk_
space_ strused - Disk space that service is currently using
- m3db
M3Db
M3db Args - Values provided by the M3DB server.
- m3db_
user_ M3Dbconfig M3db User Config Args - M3db user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
- maintenance_
window_ strdow - Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
- maintenance_
window_ strtime - 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
andpremium-x
wherex
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_ strid - 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[M3DbService Integration Args] - 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
orRUNNING
- 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
- Sequence[M3Db
Tag Args] - Tags are key-value pairs that allow you to categorize services.
- tech_
emails Sequence[M3DbTech Email Args] - 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.
- additional
Disk StringSpace - Add disk storage in increments of 30 GiB to scale your service. The maximum value depends on the service type and cloud provider. Removing additional storage causes the service nodes to go through a rolling restart and there might be a short downtime for services with no HA capabilities.
- cloud
Name 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
- disk
Space 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.
- disk
Space StringCap - The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
- disk
Space StringDefault - 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 StringStep - 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 fromdisk_space_default
by increments of this size. - disk
Space StringUsed - Disk space that service is currently using
- m3db Property Map
- Values provided by the M3DB server.
- m3db
User Property MapConfig - M3db user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
- maintenance
Window StringDow - Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
- maintenance
Window StringTime - 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
andpremium-x
wherex
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.
- project
Vpc StringId - 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 String - The hostname of the service.
- service
Integrations List<Property Map> - Service integrations to specify when creating a service. Not applied after initial service creation
- service
Name 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.
- service
Password String - Password used for connecting to the service, if applicable
- service
Port Number - The port of the service
- service
Type String - Aiven internal service type code
- service
Uri String - URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
- service
Username String - Username used for connecting to the service, if applicable
- state String
- Service state. One of
POWEROFF
,REBALANCING
,REBUILDING
orRUNNING
- static
Ips 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
- List<Property Map>
- Tags are key-value pairs that allow you to categorize services.
- tech
Emails 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.
- termination
Protection 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
- Service component name
- Connection
Uri 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
- Kafka
Authentication stringMethod - Kafka authentication method. This is a value specific to the 'kafka' service component
- Port int
- Port number for connecting to the service component
- Route string
- Network access route
- Ssl bool
- Whether the endpoint is encrypted or accepts plaintext. By default endpoints are always encrypted and this property is only included for service components they may disable encryption
- Usage string
- DNS usage name
- Component string
- Service component name
- Connection
Uri 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
- Kafka
Authentication stringMethod - Kafka authentication method. This is a value specific to the 'kafka' service component
- Port int
- Port number for connecting to the service component
- Route string
- Network access route
- Ssl bool
- Whether the endpoint is encrypted or accepts plaintext. By default endpoints are always encrypted and this property is only included for service components they may disable encryption
- Usage string
- DNS usage name
- component String
- Service component name
- connection
Uri 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
- kafka
Authentication StringMethod - Kafka authentication method. This is a value specific to the 'kafka' service component
- port Integer
- Port number for connecting to the service component
- route String
- Network access route
- ssl Boolean
- Whether the endpoint is encrypted or accepts plaintext. By default endpoints are always encrypted and this property is only included for service components they may disable encryption
- usage String
- DNS usage name
- component string
- Service component name
- connection
Uri 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
- kafka
Authentication stringMethod - Kafka authentication method. This is a value specific to the 'kafka' service component
- port number
- Port number for connecting to the service component
- route string
- Network access route
- ssl boolean
- Whether the endpoint is encrypted or accepts plaintext. By default endpoints are always encrypted and this property is only included for service components they may disable encryption
- usage string
- DNS usage name
- component str
- Service component name
- connection_
uri str - Connection info for connecting to the service component. This is a combination of host and port.
- host str
- Host name for connecting to the service component
- kafka_
authentication_ strmethod - Kafka authentication method. This is a value specific to the 'kafka' service component
- port int
- Port number for connecting to the service component
- route str
- Network access route
- ssl bool
- Whether the endpoint is encrypted or accepts plaintext. By default endpoints are always encrypted and this property is only included for service components they may disable encryption
- usage str
- DNS usage name
- component String
- Service component name
- connection
Uri 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
- kafka
Authentication StringMethod - Kafka authentication method. This is a value specific to the 'kafka' service component
- port Number
- Port number for connecting to the service component
- route String
- Network access route
- ssl Boolean
- Whether the endpoint is encrypted or accepts plaintext. By default endpoints are always encrypted and this property is only included for service components they may disable encryption
- usage String
- DNS usage name
M3DbM3db, M3DbM3dbArgs
- Http
Cluster stringUri - M3DB cluster URI.
- Http
Node stringUri - M3DB node URI.
- Influxdb
Uri string - InfluxDB URI.
- Prometheus
Remote stringRead Uri - Prometheus remote read URI.
- Prometheus
Remote stringWrite Uri - Prometheus remote write URI.
- Uris List<string>
- M3DB server URIs.
- Http
Cluster stringUri - M3DB cluster URI.
- Http
Node stringUri - M3DB node URI.
- Influxdb
Uri string - InfluxDB URI.
- Prometheus
Remote stringRead Uri - Prometheus remote read URI.
- Prometheus
Remote stringWrite Uri - Prometheus remote write URI.
- Uris []string
- M3DB server URIs.
- http
Cluster StringUri - M3DB cluster URI.
- http
Node StringUri - M3DB node URI.
- influxdb
Uri String - InfluxDB URI.
- prometheus
Remote StringRead Uri - Prometheus remote read URI.
- prometheus
Remote StringWrite Uri - Prometheus remote write URI.
- uris List<String>
- M3DB server URIs.
- http
Cluster stringUri - M3DB cluster URI.
- http
Node stringUri - M3DB node URI.
- influxdb
Uri string - InfluxDB URI.
- prometheus
Remote stringRead Uri - Prometheus remote read URI.
- prometheus
Remote stringWrite Uri - Prometheus remote write URI.
- uris string[]
- M3DB server URIs.
- http_
cluster_ struri - M3DB cluster URI.
- http_
node_ struri - M3DB node URI.
- influxdb_
uri str - InfluxDB URI.
- prometheus_
remote_ strread_ uri - Prometheus remote read URI.
- prometheus_
remote_ strwrite_ uri - Prometheus remote write URI.
- uris Sequence[str]
- M3DB server URIs.
- http
Cluster StringUri - M3DB cluster URI.
- http
Node StringUri - M3DB node URI.
- influxdb
Uri String - InfluxDB URI.
- prometheus
Remote StringRead Uri - Prometheus remote read URI.
- prometheus
Remote StringWrite Uri - Prometheus remote write URI.
- uris List<String>
- M3DB server URIs.
M3DbM3dbUserConfig, M3DbM3dbUserConfigArgs
- Additional
Backup stringRegions - Additional Cloud Regions for Backup Replication.
- Custom
Domain string - Serve the web frontend using a custom CNAME pointing to the Aiven DNS name. Example:
grafana.example.org
. - Ip
Filter List<M3DbObjects M3db User Config Ip Filter Object> - Allow incoming connections from CIDR address block, e.g.
10.20.0.0/16
- Ip
Filter List<string>Strings - Allow incoming connections from CIDR address block, e.g.
10.20.0.0/16
. - Ip
Filters List<string> - Allow incoming connections from CIDR address block, e.g.
10.20.0.0/16
. - Limits
M3Db
M3db User Config Limits - M3 limits
- M3
M3Db
M3db User Config M3 - M3 specific configuration options
- M3Version string
- Enum:
1.1
,1.2
,1.5
, and newer. M3 major version (deprecated, use m3db_version). - M3coordinator
Enable boolGraphite Carbon Ingest - 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 string - Enum:
1.1
,1.2
,1.5
, and newer. M3 major version (the minimum compatible version). - Namespaces
List<M3Db
M3db User Config Namespace> - List of M3 namespaces
- Private
Access M3DbM3db User Config Private Access - Allow access to selected service ports from private networks
- Project
To stringFork From - Name of another project to fork a service from. This has effect only when a new service is being created. Example:
anotherprojectname
. - Public
Access M3DbM3db User Config Public Access - Allow access to selected service ports from the public Internet
- Rules
M3Db
M3db User Config Rules - M3 rules
- Service
Log bool - Store logs for the service so that they are available in the HTTP API and console.
- Service
To stringFork From - 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.
- Additional
Backup stringRegions - Additional Cloud Regions for Backup Replication.
- Custom
Domain string - Serve the web frontend using a custom CNAME pointing to the Aiven DNS name. Example:
grafana.example.org
. - Ip
Filter []M3DbObjects M3db User Config Ip Filter Object - Allow incoming connections from CIDR address block, e.g.
10.20.0.0/16
- Ip
Filter []stringStrings - Allow incoming connections from CIDR address block, e.g.
10.20.0.0/16
. - Ip
Filters []string - Allow incoming connections from CIDR address block, e.g.
10.20.0.0/16
. - Limits
M3Db
M3db User Config Limits - M3 limits
- M3
M3Db
M3db User Config M3 - M3 specific configuration options
- M3Version string
- Enum:
1.1
,1.2
,1.5
, and newer. M3 major version (deprecated, use m3db_version). - M3coordinator
Enable boolGraphite Carbon Ingest - 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 string - Enum:
1.1
,1.2
,1.5
, and newer. M3 major version (the minimum compatible version). - Namespaces
[]M3Db
M3db User Config Namespace - List of M3 namespaces
- Private
Access M3DbM3db User Config Private Access - Allow access to selected service ports from private networks
- Project
To stringFork From - Name of another project to fork a service from. This has effect only when a new service is being created. Example:
anotherprojectname
. - Public
Access M3DbM3db User Config Public Access - Allow access to selected service ports from the public Internet
- Rules
M3Db
M3db User Config Rules - M3 rules
- Service
Log bool - Store logs for the service so that they are available in the HTTP API and console.
- Service
To stringFork From - 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.
- additional
Backup StringRegions - Additional Cloud Regions for Backup Replication.
- custom
Domain String - Serve the web frontend using a custom CNAME pointing to the Aiven DNS name. Example:
grafana.example.org
. - ip
Filter List<M3DbObjects M3db User Config Ip Filter Object> - Allow incoming connections from CIDR address block, e.g.
10.20.0.0/16
- ip
Filter List<String>Strings - Allow incoming connections from CIDR address block, e.g.
10.20.0.0/16
. - ip
Filters List<String> - Allow incoming connections from CIDR address block, e.g.
10.20.0.0/16
. - limits
M3Db
M3db User Config Limits - M3 limits
- m3
M3Db
M3db User Config M3 - M3 specific configuration options
- m3Version String
- Enum:
1.1
,1.2
,1.5
, and newer. M3 major version (deprecated, use m3db_version). - m3coordinator
Enable BooleanGraphite Carbon Ingest - 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 String - Enum:
1.1
,1.2
,1.5
, and newer. M3 major version (the minimum compatible version). - namespaces
List<M3Db
M3db User Config Namespace> - List of M3 namespaces
- private
Access M3DbM3db User Config Private Access - Allow access to selected service ports from private networks
- project
To StringFork From - Name of another project to fork a service from. This has effect only when a new service is being created. Example:
anotherprojectname
. - public
Access M3DbM3db User Config Public Access - Allow access to selected service ports from the public Internet
- rules
M3Db
M3db User Config Rules - M3 rules
- service
Log Boolean - Store logs for the service so that they are available in the HTTP API and console.
- service
To StringFork From - Name of another service to fork from. This has effect only when a new service is being created. Example:
anotherservicename
. - static
Ips Boolean - Use static public IP addresses.
- additional
Backup stringRegions - Additional Cloud Regions for Backup Replication.
- custom
Domain string - Serve the web frontend using a custom CNAME pointing to the Aiven DNS name. Example:
grafana.example.org
. - ip
Filter M3DbObjects M3db User Config Ip Filter Object[] - Allow incoming connections from CIDR address block, e.g.
10.20.0.0/16
- ip
Filter string[]Strings - Allow incoming connections from CIDR address block, e.g.
10.20.0.0/16
. - ip
Filters string[] - Allow incoming connections from CIDR address block, e.g.
10.20.0.0/16
. - limits
M3Db
M3db User Config Limits - M3 limits
- m3
M3Db
M3db User Config M3 - M3 specific configuration options
- m3Version string
- Enum:
1.1
,1.2
,1.5
, and newer. M3 major version (deprecated, use m3db_version). - m3coordinator
Enable booleanGraphite Carbon Ingest - 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 string - Enum:
1.1
,1.2
,1.5
, and newer. M3 major version (the minimum compatible version). - namespaces
M3Db
M3db User Config Namespace[] - List of M3 namespaces
- private
Access M3DbM3db User Config Private Access - Allow access to selected service ports from private networks
- project
To stringFork From - Name of another project to fork a service from. This has effect only when a new service is being created. Example:
anotherprojectname
. - public
Access M3DbM3db User Config Public Access - Allow access to selected service ports from the public Internet
- rules
M3Db
M3db User Config Rules - M3 rules
- service
Log boolean - Store logs for the service so that they are available in the HTTP API and console.
- service
To stringFork From - Name of another service to fork from. This has effect only when a new service is being created. Example:
anotherservicename
. - static
Ips boolean - Use static public IP addresses.
- additional_
backup_ strregions - 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_ Sequence[M3Dbobjects M3db User Config Ip Filter Object] - Allow incoming connections from CIDR address block, e.g.
10.20.0.0/16
- ip_
filter_ Sequence[str]strings - 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
. - limits
M3Db
M3db User Config Limits - M3 limits
- m3
M3Db
M3db User Config M3 - 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_ boolgraphite_ carbon_ ingest - 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[M3Db
M3db User Config Namespace] - List of M3 namespaces
- private_
access M3DbM3db User Config Private Access - Allow access to selected service ports from private networks
- project_
to_ strfork_ from - Name of another project to fork a service from. This has effect only when a new service is being created. Example:
anotherprojectname
. - public_
access M3DbM3db User Config Public Access - Allow access to selected service ports from the public Internet
- rules
M3Db
M3db User Config Rules - M3 rules
- service_
log bool - Store logs for the service so that they are available in the HTTP API and console.
- service_
to_ strfork_ from - 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.
- additional
Backup StringRegions - Additional Cloud Regions for Backup Replication.
- custom
Domain String - Serve the web frontend using a custom CNAME pointing to the Aiven DNS name. Example:
grafana.example.org
. - ip
Filter List<Property Map>Objects - Allow incoming connections from CIDR address block, e.g.
10.20.0.0/16
- ip
Filter List<String>Strings - Allow incoming connections from CIDR address block, e.g.
10.20.0.0/16
. - ip
Filters List<String> - Allow incoming connections from CIDR address block, e.g.
10.20.0.0/16
. - 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). - m3coordinator
Enable BooleanGraphite Carbon Ingest - 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 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
- private
Access Property Map - Allow access to selected service ports from private networks
- project
To StringFork From - Name of another project to fork a service from. This has effect only when a new service is being created. Example:
anotherprojectname
. - public
Access Property Map - Allow access to selected service ports from the public Internet
- rules Property Map
- M3 rules
- service
Log Boolean - Store logs for the service so that they are available in the HTTP API and console.
- service
To StringFork From - Name of another service to fork from. This has effect only when a new service is being created. Example:
anotherservicename
. - static
Ips Boolean - Use static public IP addresses.
M3DbM3dbUserConfigIpFilterObject, M3DbM3dbUserConfigIpFilterObjectArgs
- 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
.
M3DbM3dbUserConfigLimits, M3DbM3dbUserConfigLimitsArgs
- Max
Recently intQueried Series Blocks - The maximum number of blocks that can be read in a given lookback period. Example:
20000
. - Max
Recently intQueried Series Disk Bytes Read - The maximum number of disk bytes that can be read in a given lookback period. Example:
104857600
. - Max
Recently stringQueried Series Lookback - The lookback period for
max_recently_queried_series_blocks
andmax_recently_queried_series_disk_bytes_read
. Example:15s
. - Query
Docs int - The maximum number of docs fetched in single query. Example:
100000
. - Query
Require boolExhaustive - 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
.
- Max
Recently intQueried Series Blocks - The maximum number of blocks that can be read in a given lookback period. Example:
20000
. - Max
Recently intQueried Series Disk Bytes Read - The maximum number of disk bytes that can be read in a given lookback period. Example:
104857600
. - Max
Recently stringQueried Series Lookback - The lookback period for
max_recently_queried_series_blocks
andmax_recently_queried_series_disk_bytes_read
. Example:15s
. - Query
Docs int - The maximum number of docs fetched in single query. Example:
100000
. - Query
Require boolExhaustive - 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
.
- max
Recently IntegerQueried Series Blocks - The maximum number of blocks that can be read in a given lookback period. Example:
20000
. - max
Recently IntegerQueried Series Disk Bytes Read - The maximum number of disk bytes that can be read in a given lookback period. Example:
104857600
. - max
Recently StringQueried Series Lookback - The lookback period for
max_recently_queried_series_blocks
andmax_recently_queried_series_disk_bytes_read
. Example:15s
. - query
Docs Integer - The maximum number of docs fetched in single query. Example:
100000
. - query
Require BooleanExhaustive - When query limits are exceeded, whether to return error or return partial results.
- query
Series Integer - The maximum number of series fetched in single query. Example:
100000
.
- max
Recently numberQueried Series Blocks - The maximum number of blocks that can be read in a given lookback period. Example:
20000
. - max
Recently numberQueried Series Disk Bytes Read - The maximum number of disk bytes that can be read in a given lookback period. Example:
104857600
. - max
Recently stringQueried Series Lookback - The lookback period for
max_recently_queried_series_blocks
andmax_recently_queried_series_disk_bytes_read
. Example:15s
. - query
Docs number - The maximum number of docs fetched in single query. Example:
100000
. - query
Require booleanExhaustive - When query limits are exceeded, whether to return error or return partial results.
- query
Series number - The maximum number of series fetched in single query. Example:
100000
.
- max_
recently_ intqueried_ series_ blocks - The maximum number of blocks that can be read in a given lookback period. Example:
20000
. - max_
recently_ intqueried_ series_ disk_ bytes_ read - The maximum number of disk bytes that can be read in a given lookback period. Example:
104857600
. - max_
recently_ strqueried_ series_ lookback - The lookback period for
max_recently_queried_series_blocks
andmax_recently_queried_series_disk_bytes_read
. Example:15s
. - query_
docs int - The maximum number of docs fetched in single query. Example:
100000
. - query_
require_ boolexhaustive - 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
.
- max
Recently NumberQueried Series Blocks - The maximum number of blocks that can be read in a given lookback period. Example:
20000
. - max
Recently NumberQueried Series Disk Bytes Read - The maximum number of disk bytes that can be read in a given lookback period. Example:
104857600
. - max
Recently StringQueried Series Lookback - The lookback period for
max_recently_queried_series_blocks
andmax_recently_queried_series_disk_bytes_read
. Example:15s
. - query
Docs Number - The maximum number of docs fetched in single query. Example:
100000
. - query
Require BooleanExhaustive - When query limits are exceeded, whether to return error or return partial results.
- query
Series Number - The maximum number of series fetched in single query. Example:
100000
.
M3DbM3dbUserConfigM3, M3DbM3dbUserConfigM3Args
- Tag
Options M3DbM3db User Config M3Tag Options - M3 Tag Options
- Tag
Options M3DbM3db User Config M3Tag Options - M3 Tag Options
- tag
Options M3DbM3db User Config M3Tag Options - M3 Tag Options
- tag
Options M3DbM3db User Config M3Tag Options - M3 Tag Options
- tag_
options M3DbM3db User Config M3Tag Options - M3 Tag Options
- tag
Options Property Map - M3 Tag Options
M3DbM3dbUserConfigM3TagOptions, M3DbM3dbUserConfigM3TagOptionsArgs
- Allow
Tag boolName Duplicates - Allows for duplicate tags to appear on series (not allowed by default).
- Allow
Tag boolValue Empty - Allows for empty tags to appear on series (not allowed by default).
- Allow
Tag boolName Duplicates - Allows for duplicate tags to appear on series (not allowed by default).
- Allow
Tag boolValue Empty - Allows for empty tags to appear on series (not allowed by default).
- allow
Tag BooleanName Duplicates - Allows for duplicate tags to appear on series (not allowed by default).
- allow
Tag BooleanValue Empty - Allows for empty tags to appear on series (not allowed by default).
- allow
Tag booleanName Duplicates - Allows for duplicate tags to appear on series (not allowed by default).
- allow
Tag booleanValue Empty - Allows for empty tags to appear on series (not allowed by default).
- allow_
tag_ boolname_ duplicates - Allows for duplicate tags to appear on series (not allowed by default).
- allow_
tag_ boolvalue_ empty - Allows for empty tags to appear on series (not allowed by default).
- allow
Tag BooleanName Duplicates - Allows for duplicate tags to appear on series (not allowed by default).
- allow
Tag BooleanValue Empty - Allows for empty tags to appear on series (not allowed by default).
M3DbM3dbUserConfigNamespace, M3DbM3dbUserConfigNamespaceArgs
- Name string
- The name of the namespace. Example:
default
. - Type string
- Enum:
aggregated
,unaggregated
. The type of aggregation (aggregated/unaggregated). - Options
M3Db
M3db User Config Namespace Options - 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
M3Db
M3db User Config Namespace Options - 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
M3Db
M3db User Config Namespace Options - 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
M3Db
M3db User Config Namespace Options - 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
M3Db
M3db User Config Namespace Options - 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
.
M3DbM3dbUserConfigNamespaceOptions, M3DbM3dbUserConfigNamespaceOptionsArgs
- Retention
Options M3DbM3db User Config Namespace Options Retention Options - Retention options
- Snapshot
Enabled bool - Controls whether M3DB will create snapshot files for this namespace.
- Writes
To boolCommitlog - Controls whether M3DB will include writes to this namespace in the commitlog.
- Retention
Options M3DbM3db User Config Namespace Options Retention Options - Retention options
- Snapshot
Enabled bool - Controls whether M3DB will create snapshot files for this namespace.
- Writes
To boolCommitlog - Controls whether M3DB will include writes to this namespace in the commitlog.
- retention
Options M3DbM3db User Config Namespace Options Retention Options - Retention options
- snapshot
Enabled Boolean - Controls whether M3DB will create snapshot files for this namespace.
- writes
To BooleanCommitlog - Controls whether M3DB will include writes to this namespace in the commitlog.
- retention
Options M3DbM3db User Config Namespace Options Retention Options - Retention options
- snapshot
Enabled boolean - Controls whether M3DB will create snapshot files for this namespace.
- writes
To booleanCommitlog - Controls whether M3DB will include writes to this namespace in the commitlog.
- retention_
options M3DbM3db User Config Namespace Options Retention Options - Retention options
- snapshot_
enabled bool - Controls whether M3DB will create snapshot files for this namespace.
- writes_
to_ boolcommitlog - Controls whether M3DB will include writes to this namespace in the commitlog.
- retention
Options Property Map - Retention options
- snapshot
Enabled Boolean - Controls whether M3DB will create snapshot files for this namespace.
- writes
To BooleanCommitlog - Controls whether M3DB will include writes to this namespace in the commitlog.
M3DbM3dbUserConfigNamespaceOptionsRetentionOptions, M3DbM3dbUserConfigNamespaceOptionsRetentionOptionsArgs
- Block
Data stringExpiry Duration - Controls how long we wait before expiring stale data. Example:
5m
. - Blocksize
Duration string - Controls how long to keep a block in memory before flushing to a fileset on disk. Example:
2h
. - Buffer
Future stringDuration - Controls how far into the future writes to the namespace will be accepted. Example:
10m
. - Buffer
Past stringDuration - Controls how far into the past writes to the namespace will be accepted. Example:
10m
. - Retention
Period stringDuration - Controls the duration of time that M3DB will retain data for the namespace. Example:
48h
.
- Block
Data stringExpiry Duration - Controls how long we wait before expiring stale data. Example:
5m
. - Blocksize
Duration string - Controls how long to keep a block in memory before flushing to a fileset on disk. Example:
2h
. - Buffer
Future stringDuration - Controls how far into the future writes to the namespace will be accepted. Example:
10m
. - Buffer
Past stringDuration - Controls how far into the past writes to the namespace will be accepted. Example:
10m
. - Retention
Period stringDuration - Controls the duration of time that M3DB will retain data for the namespace. Example:
48h
.
- block
Data StringExpiry Duration - Controls how long we wait before expiring stale data. Example:
5m
. - blocksize
Duration String - Controls how long to keep a block in memory before flushing to a fileset on disk. Example:
2h
. - buffer
Future StringDuration - Controls how far into the future writes to the namespace will be accepted. Example:
10m
. - buffer
Past StringDuration - Controls how far into the past writes to the namespace will be accepted. Example:
10m
. - retention
Period StringDuration - Controls the duration of time that M3DB will retain data for the namespace. Example:
48h
.
- block
Data stringExpiry Duration - Controls how long we wait before expiring stale data. Example:
5m
. - blocksize
Duration string - Controls how long to keep a block in memory before flushing to a fileset on disk. Example:
2h
. - buffer
Future stringDuration - Controls how far into the future writes to the namespace will be accepted. Example:
10m
. - buffer
Past stringDuration - Controls how far into the past writes to the namespace will be accepted. Example:
10m
. - retention
Period stringDuration - Controls the duration of time that M3DB will retain data for the namespace. Example:
48h
.
- block_
data_ strexpiry_ duration - 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_ strduration - Controls how far into the future writes to the namespace will be accepted. Example:
10m
. - buffer_
past_ strduration - Controls how far into the past writes to the namespace will be accepted. Example:
10m
. - retention_
period_ strduration - Controls the duration of time that M3DB will retain data for the namespace. Example:
48h
.
- block
Data StringExpiry Duration - Controls how long we wait before expiring stale data. Example:
5m
. - blocksize
Duration String - Controls how long to keep a block in memory before flushing to a fileset on disk. Example:
2h
. - buffer
Future StringDuration - Controls how far into the future writes to the namespace will be accepted. Example:
10m
. - buffer
Past StringDuration - Controls how far into the past writes to the namespace will be accepted. Example:
10m
. - retention
Period StringDuration - Controls the duration of time that M3DB will retain data for the namespace. Example:
48h
.
M3DbM3dbUserConfigPrivateAccess, M3DbM3dbUserConfigPrivateAccessArgs
- 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.
M3DbM3dbUserConfigPublicAccess, M3DbM3dbUserConfigPublicAccessArgs
- 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.
M3DbM3dbUserConfigRules, M3DbM3dbUserConfigRulesArgs
- Mappings
List<M3Db
M3db User Config Rules Mapping> - List of M3 mapping rules
- Mappings
[]M3Db
M3db User Config Rules Mapping - List of M3 mapping rules
- mappings
List<M3Db
M3db User Config Rules Mapping> - List of M3 mapping rules
- mappings
M3Db
M3db User Config Rules Mapping[] - List of M3 mapping rules
- mappings
Sequence[M3Db
M3db User Config Rules Mapping] - List of M3 mapping rules
- mappings List<Property Map>
- List of M3 mapping rules
M3DbM3dbUserConfigRulesMapping, M3DbM3dbUserConfigRulesMappingArgs
- 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).
- Namespaces
Objects List<M3DbM3db User Config Rules Mapping Namespaces Object> - 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 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).
- List<M3Db
M3db User Config Rules Mapping Tag> - 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).
- Namespaces
Objects []M3DbM3db User Config Rules Mapping Namespaces Object - 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 []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).
- []M3Db
M3db User Config Rules Mapping Tag - 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).
- namespaces
Objects List<M3DbM3db User Config Rules Mapping Namespaces Object> - 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 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).
- List<M3Db
M3db User Config Rules Mapping Tag> - 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).
- namespaces
Objects M3DbM3db User Config Rules Mapping Namespaces Object[] - 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 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).
- M3Db
M3db User Config Rules Mapping Tag[] - 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).
- namespaces_
objects Sequence[M3DbM3db User Config Rules Mapping Namespaces Object] - 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).
- Sequence[M3Db
M3db User Config Rules Mapping Tag] - 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).
- namespaces
Objects 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
- namespaces
Strings 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).
- List<Property Map>
- List of tags to be appended to matching metrics
M3DbM3dbUserConfigRulesMappingNamespacesObject, M3DbM3dbUserConfigRulesMappingNamespacesObjectArgs
- 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
.
M3DbM3dbUserConfigRulesMappingTag, M3DbM3dbUserConfigRulesMappingTagArgs
M3DbServiceIntegration, M3DbServiceIntegrationArgs
- Integration
Type string - Type of the service integration. The only supported value at the moment is
read_replica
- Source
Service stringName - Name of the source service
- Integration
Type string - Type of the service integration. The only supported value at the moment is
read_replica
- Source
Service stringName - Name of the source service
- integration
Type String - Type of the service integration. The only supported value at the moment is
read_replica
- source
Service StringName - Name of the source service
- integration
Type string - Type of the service integration. The only supported value at the moment is
read_replica
- source
Service stringName - 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_ strname - Name of the source service
- integration
Type String - Type of the service integration. The only supported value at the moment is
read_replica
- source
Service StringName - Name of the source service
M3DbTag, M3DbTagArgs
M3DbTechEmail, M3DbTechEmailArgs
- 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
Import
$ pulumi import aiven:index/m3Db:M3Db example_m3db PROJECT/SERVICE_NAME
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Aiven pulumi/pulumi-aiven
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
aiven
Terraform Provider.