1. Packages
  2. Aiven
  3. API Docs
  4. getM3Db
Aiven v6.7.2 published on Tuesday, Oct 31, 2023 by Pulumi

aiven.getM3Db

Explore with Pulumi AI

aiven logo
Aiven v6.7.2 published on Tuesday, Oct 31, 2023 by Pulumi

    The M3 DB data source provides information about the existing Aiven M3 services.

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Aiven = Pulumi.Aiven;
    
    return await Deployment.RunAsync(() => 
    {
        var m3 = Aiven.GetM3Db.Invoke(new()
        {
            Project = data.Aiven_project.Foo.Project,
            ServiceName = "my-m3db",
        });
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aiven/sdk/v6/go/aiven"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := aiven.LookupM3Db(ctx, &aiven.LookupM3DbArgs{
    			Project:     data.Aiven_project.Foo.Project,
    			ServiceName: "my-m3db",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aiven.AivenFunctions;
    import com.pulumi.aiven.inputs.GetM3DbArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            final var m3 = AivenFunctions.getM3Db(GetM3DbArgs.builder()
                .project(data.aiven_project().foo().project())
                .serviceName("my-m3db")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_aiven as aiven
    
    m3 = aiven.get_m3_db(project=data["aiven_project"]["foo"]["project"],
        service_name="my-m3db")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as aiven from "@pulumi/aiven";
    
    const m3 = aiven.getM3Db({
        project: data.aiven_project.foo.project,
        serviceName: "my-m3db",
    });
    
    variables:
      m3:
        fn::invoke:
          Function: aiven:getM3Db
          Arguments:
            project: ${data.aiven_project.foo.project}
            serviceName: my-m3db
    

    Using getM3Db

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

    function getM3Db(args: GetM3DbArgs, opts?: InvokeOptions): Promise<GetM3DbResult>
    function getM3DbOutput(args: GetM3DbOutputArgs, opts?: InvokeOptions): Output<GetM3DbResult>
    def get_m3_db(project: Optional[str] = None,
                  service_name: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetM3DbResult
    def get_m3_db_output(project: Optional[pulumi.Input[str]] = None,
                  service_name: Optional[pulumi.Input[str]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetM3DbResult]
    func LookupM3Db(ctx *Context, args *LookupM3DbArgs, opts ...InvokeOption) (*LookupM3DbResult, error)
    func LookupM3DbOutput(ctx *Context, args *LookupM3DbOutputArgs, opts ...InvokeOption) LookupM3DbResultOutput

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

    public static class GetM3Db 
    {
        public static Task<GetM3DbResult> InvokeAsync(GetM3DbArgs args, InvokeOptions? opts = null)
        public static Output<GetM3DbResult> Invoke(GetM3DbInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetM3DbResult> getM3Db(GetM3DbArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: aiven:index/getM3Db:getM3Db
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Project string

    Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.

    ServiceName string

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

    Project string

    Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.

    ServiceName string

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

    project String

    Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.

    serviceName String

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

    project string

    Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.

    serviceName string

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

    project str

    Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.

    service_name str

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

    project String

    Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.

    serviceName String

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

    getM3Db Result

    The following output properties are available:

    AdditionalDiskSpace string

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

    CloudName string

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

    Components List<GetM3DbComponent>

    Service component information objects

    DiskSpace string

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

    DiskSpaceCap string

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

    DiskSpaceDefault string

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

    DiskSpaceStep string

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

    DiskSpaceUsed string

    Disk space that service is currently using

    Id string

    The provider-assigned unique ID for this managed resource.

    M3dbUserConfigs List<GetM3DbM3dbUserConfig>

    M3db user configurable settings

    M3dbs List<GetM3DbM3db>

    M3 specific server provided values

    MaintenanceWindowDow string

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

    MaintenanceWindowTime string

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

    Plan string

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

    Project string

    Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.

    ProjectVpcId string

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

    ServiceHost string

    The hostname of the service.

    ServiceIntegrations List<GetM3DbServiceIntegration>

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

    ServiceName string

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

    ServicePassword string

    Password used for connecting to the service, if applicable

    ServicePort int

    The port of the service

    ServiceType string

    Aiven internal service type code

    ServiceUri string

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

    ServiceUsername string

    Username used for connecting to the service, if applicable

    State string

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

    StaticIps List<string>

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

    Tags List<GetM3DbTag>

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

    TerminationProtection bool

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

    AdditionalDiskSpace string

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

    CloudName string

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

    Components []GetM3DbComponent

    Service component information objects

    DiskSpace string

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

    DiskSpaceCap string

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

    DiskSpaceDefault string

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

    DiskSpaceStep string

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

    DiskSpaceUsed string

    Disk space that service is currently using

    Id string

    The provider-assigned unique ID for this managed resource.

    M3dbUserConfigs []GetM3DbM3dbUserConfig

    M3db user configurable settings

    M3dbs []GetM3DbM3db

    M3 specific server provided values

    MaintenanceWindowDow string

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

    MaintenanceWindowTime string

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

    Plan string

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

    Project string

    Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.

    ProjectVpcId string

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

    ServiceHost string

    The hostname of the service.

    ServiceIntegrations []GetM3DbServiceIntegration

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

    ServiceName string

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

    ServicePassword string

    Password used for connecting to the service, if applicable

    ServicePort int

    The port of the service

    ServiceType string

    Aiven internal service type code

    ServiceUri string

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

    ServiceUsername string

    Username used for connecting to the service, if applicable

    State string

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

    StaticIps []string

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

    Tags []GetM3DbTag

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

    TerminationProtection bool

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

    additionalDiskSpace String

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

    cloudName String

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

    components List<GetM3DbComponent>

    Service component information objects

    diskSpace String

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

    diskSpaceCap String

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

    diskSpaceDefault String

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

    diskSpaceStep String

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

    diskSpaceUsed String

    Disk space that service is currently using

    id String

    The provider-assigned unique ID for this managed resource.

    m3dbUserConfigs List<GetM3DbM3dbUserConfig>

    M3db user configurable settings

    m3dbs List<GetM3DbM3db>

    M3 specific server provided values

    maintenanceWindowDow String

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

    maintenanceWindowTime String

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

    plan String

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

    project String

    Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.

    projectVpcId String

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

    serviceHost String

    The hostname of the service.

    serviceIntegrations List<GetM3DbServiceIntegration>

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

    serviceName String

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

    servicePassword String

    Password used for connecting to the service, if applicable

    servicePort Integer

    The port of the service

    serviceType String

    Aiven internal service type code

    serviceUri String

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

    serviceUsername String

    Username used for connecting to the service, if applicable

    state String

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

    staticIps List<String>

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

    tags List<GetM3DbTag>

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

    terminationProtection Boolean

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

    additionalDiskSpace string

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

    cloudName string

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

    components GetM3DbComponent[]

    Service component information objects

    diskSpace string

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

    diskSpaceCap string

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

    diskSpaceDefault string

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

    diskSpaceStep string

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

    diskSpaceUsed string

    Disk space that service is currently using

    id string

    The provider-assigned unique ID for this managed resource.

    m3dbUserConfigs GetM3DbM3dbUserConfig[]

    M3db user configurable settings

    m3dbs GetM3DbM3db[]

    M3 specific server provided values

    maintenanceWindowDow string

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

    maintenanceWindowTime string

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

    plan string

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

    project string

    Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.

    projectVpcId string

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

    serviceHost string

    The hostname of the service.

    serviceIntegrations GetM3DbServiceIntegration[]

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

    serviceName string

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

    servicePassword string

    Password used for connecting to the service, if applicable

    servicePort number

    The port of the service

    serviceType string

    Aiven internal service type code

    serviceUri string

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

    serviceUsername string

    Username used for connecting to the service, if applicable

    state string

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

    staticIps string[]

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

    tags GetM3DbTag[]

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

    terminationProtection boolean

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

    additional_disk_space str

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

    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[GetM3DbComponent]

    Service component information objects

    disk_space str

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

    disk_space_cap str

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

    disk_space_default str

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

    disk_space_step str

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

    disk_space_used str

    Disk space that service is currently using

    id str

    The provider-assigned unique ID for this managed resource.

    m3db_user_configs Sequence[GetM3DbM3dbUserConfig]

    M3db user configurable settings

    m3dbs Sequence[GetM3DbM3db]

    M3 specific server provided values

    maintenance_window_dow str

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

    maintenance_window_time str

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

    plan str

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

    project str

    Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.

    project_vpc_id str

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

    service_host str

    The hostname of the service.

    service_integrations Sequence[GetM3DbServiceIntegration]

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

    service_name str

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

    service_password str

    Password used for connecting to the service, if applicable

    service_port int

    The port of the service

    service_type str

    Aiven internal service type code

    service_uri str

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

    service_username str

    Username used for connecting to the service, if applicable

    state str

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

    static_ips Sequence[str]

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

    tags Sequence[GetM3DbTag]

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

    termination_protection bool

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

    additionalDiskSpace String

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

    cloudName String

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

    components List<Property Map>

    Service component information objects

    diskSpace String

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

    diskSpaceCap String

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

    diskSpaceDefault String

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

    diskSpaceStep String

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

    diskSpaceUsed String

    Disk space that service is currently using

    id String

    The provider-assigned unique ID for this managed resource.

    m3dbUserConfigs List<Property Map>

    M3db user configurable settings

    m3dbs List<Property Map>

    M3 specific server provided values

    maintenanceWindowDow String

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

    maintenanceWindowTime String

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

    plan String

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

    project String

    Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.

    projectVpcId String

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

    serviceHost String

    The hostname of the service.

    serviceIntegrations List<Property Map>

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

    serviceName String

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

    servicePassword String

    Password used for connecting to the service, if applicable

    servicePort Number

    The port of the service

    serviceType String

    Aiven internal service type code

    serviceUri String

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

    serviceUsername String

    Username used for connecting to the service, if applicable

    state String

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

    staticIps List<String>

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

    tags List<Property Map>

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

    terminationProtection Boolean

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

    Supporting Types

    GetM3DbComponent

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

    GetM3DbM3dbUserConfig

    additionalBackupRegions String
    customDomain String
    ipFilterObjects List<Property Map>
    ipFilterStrings List<String>
    ipFilters List<String>

    Deprecated:

    This will be removed in v5.0.0 and replaced with ip_filter_string instead.

    limits Property Map
    m3 Property Map
    m3Version String

    Deprecated:

    Usage of this field is discouraged.

    m3coordinatorEnableGraphiteCarbonIngest Boolean
    m3dbVersion String
    namespaces List<Property Map>
    privateAccess Property Map
    projectToForkFrom String
    publicAccess Property Map
    rules Property Map
    serviceToForkFrom String
    staticIps Boolean

    GetM3DbM3dbUserConfigIpFilterObject

    Network string
    Description string
    Network string
    Description string
    network String
    description String
    network string
    description string
    network String
    description String

    GetM3DbM3dbUserConfigLimits

    GetM3DbM3dbUserConfigM3

    GetM3DbM3dbUserConfigM3TagOptions

    GetM3DbM3dbUserConfigNamespace

    GetM3DbM3dbUserConfigNamespaceOptions

    GetM3DbM3dbUserConfigNamespaceOptionsRetentionOptions

    GetM3DbM3dbUserConfigPrivateAccess

    GetM3DbM3dbUserConfigPublicAccess

    GetM3DbM3dbUserConfigRules

    GetM3DbM3dbUserConfigRulesMapping

    Filter string
    Aggregations List<string>
    Drop bool
    Name string
    Namespaces List<string>

    Deprecated:

    This will be removed in v5.0.0 and replaced with namespaces_string instead.

    NamespacesObjects List<GetM3DbM3dbUserConfigRulesMappingNamespacesObject>
    NamespacesStrings List<string>
    Tags List<GetM3DbM3dbUserConfigRulesMappingTag>
    Filter string
    Aggregations []string
    Drop bool
    Name string
    Namespaces []string

    Deprecated:

    This will be removed in v5.0.0 and replaced with namespaces_string instead.

    NamespacesObjects []GetM3DbM3dbUserConfigRulesMappingNamespacesObject
    NamespacesStrings []string
    Tags []GetM3DbM3dbUserConfigRulesMappingTag
    filter String
    aggregations List<String>
    drop Boolean
    name String
    namespaces List<String>

    Deprecated:

    This will be removed in v5.0.0 and replaced with namespaces_string instead.

    namespacesObjects List<GetM3DbM3dbUserConfigRulesMappingNamespacesObject>
    namespacesStrings List<String>
    tags List<GetM3DbM3dbUserConfigRulesMappingTag>
    filter string
    aggregations string[]
    drop boolean
    name string
    namespaces string[]

    Deprecated:

    This will be removed in v5.0.0 and replaced with namespaces_string instead.

    namespacesObjects GetM3DbM3dbUserConfigRulesMappingNamespacesObject[]
    namespacesStrings string[]
    tags GetM3DbM3dbUserConfigRulesMappingTag[]
    filter str
    aggregations Sequence[str]
    drop bool
    name str
    namespaces Sequence[str]

    Deprecated:

    This will be removed in v5.0.0 and replaced with namespaces_string instead.

    namespaces_objects Sequence[GetM3DbM3dbUserConfigRulesMappingNamespacesObject]
    namespaces_strings Sequence[str]
    tags Sequence[GetM3DbM3dbUserConfigRulesMappingTag]
    filter String
    aggregations List<String>
    drop Boolean
    name String
    namespaces List<String>

    Deprecated:

    This will be removed in v5.0.0 and replaced with namespaces_string instead.

    namespacesObjects List<Property Map>
    namespacesStrings List<String>
    tags List<Property Map>

    GetM3DbM3dbUserConfigRulesMappingNamespacesObject

    Resolution string
    Retention string
    Resolution string
    Retention string
    resolution String
    retention String
    resolution string
    retention string
    resolution String
    retention String

    GetM3DbM3dbUserConfigRulesMappingTag

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

    GetM3DbServiceIntegration

    GetM3DbTag

    Key string
    Value string
    Key string
    Value string
    key String
    value String
    key string
    value string
    key str
    value str
    key String
    value String

    Package Details

    Repository
    Aiven pulumi/pulumi-aiven
    License
    Apache-2.0
    Notes

    This Pulumi package is based on the aiven Terraform Provider.

    aiven logo
    Aiven v6.7.2 published on Tuesday, Oct 31, 2023 by Pulumi