aiven.getKafka

Explore with Pulumi AI

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

Example Usage

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

return await Deployment.RunAsync(() => 
{
    var kafka1 = Aiven.GetKafka.Invoke(new()
    {
        Project = data.Aiven_project.Pr1.Project,
        ServiceName = "my-kafka1",
    });

});

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.LookupKafka(ctx, &aiven.LookupKafkaArgs{
			Project:     data.Aiven_project.Pr1.Project,
			ServiceName: "my-kafka1",
		}, 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.GetKafkaArgs;
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 kafka1 = AivenFunctions.getKafka(GetKafkaArgs.builder()
            .project(data.aiven_project().pr1().project())
            .serviceName("my-kafka1")
            .build());

    }
}

import pulumi
import pulumi_aiven as aiven

kafka1 = aiven.get_kafka(project=data["aiven_project"]["pr1"]["project"],
    service_name="my-kafka1")

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

const kafka1 = aiven.getKafka({
    project: data.aiven_project.pr1.project,
    serviceName: "my-kafka1",
});

variables:
  kafka1:
    fn::invoke:
      Function: aiven:getKafka
      Arguments:
        project: ${data.aiven_project.pr1.project}
        serviceName: my-kafka1

Using getKafka

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 getKafka(args: GetKafkaArgs, opts?: InvokeOptions): Promise<GetKafkaResult>
function getKafkaOutput(args: GetKafkaOutputArgs, opts?: InvokeOptions): Output<GetKafkaResult>

def get_kafka(project: Optional[str] = None,
              service_name: Optional[str] = None,
              opts: Optional[InvokeOptions] = None) -> GetKafkaResult
def get_kafka_output(project: Optional[pulumi.Input[str]] = None,
              service_name: Optional[pulumi.Input[str]] = None,
              opts: Optional[InvokeOptions] = None) -> Output[GetKafkaResult]

func LookupKafka(ctx *Context, args *LookupKafkaArgs, opts ...InvokeOption) (*LookupKafkaResult, error)
func LookupKafkaOutput(ctx *Context, args *LookupKafkaOutputArgs, opts ...InvokeOption) LookupKafkaResultOutput

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

public static class GetKafka 
{
    public static Task<GetKafkaResult> InvokeAsync(GetKafkaArgs args, InvokeOptions? opts = null)
    public static Output<GetKafkaResult> Invoke(GetKafkaInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetKafkaResult> getKafka(GetKafkaArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: aiven:index/getKafka:getKafka
  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.

getKafka 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<GetKafkaComponent>: Service component information objects
DefaultAcl bool: Create default wildcard Kafka ACL
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.
KafkaUserConfigs List<GetKafkaKafkaUserConfig>: Kafka user configurable settings
Kafkas List<GetKafkaKafka>: Kafka server provided values
Karapace bool: Switch the service to use Karapace for schema registry and REST proxy
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<GetKafkaServiceIntegration>: 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<GetKafkaTag>: 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 []GetKafkaComponent: Service component information objects
DefaultAcl bool: Create default wildcard Kafka ACL
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.
KafkaUserConfigs []GetKafkaKafkaUserConfig: Kafka user configurable settings
Kafkas []GetKafkaKafka: Kafka server provided values
Karapace bool: Switch the service to use Karapace for schema registry and REST proxy
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 []GetKafkaServiceIntegration: 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 []GetKafkaTag: 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<GetKafkaComponent>: Service component information objects
defaultAcl Boolean: Create default wildcard Kafka ACL
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.
kafkaUserConfigs List<GetKafkaKafkaUserConfig>: Kafka user configurable settings
kafkas List<GetKafkaKafka>: Kafka server provided values
karapace Boolean: Switch the service to use Karapace for schema registry and REST proxy
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<GetKafkaServiceIntegration>: 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<GetKafkaTag>: 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 GetKafkaComponent[]: Service component information objects
defaultAcl boolean: Create default wildcard Kafka ACL
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.
kafkaUserConfigs GetKafkaKafkaUserConfig[]: Kafka user configurable settings
kafkas GetKafkaKafka[]: Kafka server provided values
karapace boolean: Switch the service to use Karapace for schema registry and REST proxy
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 GetKafkaServiceIntegration[]: 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 GetKafkaTag[]: 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[GetKafkaComponent]: Service component information objects
default_acl bool: Create default wildcard Kafka ACL
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.
kafka_user_configs Sequence[GetKafkaKafkaUserConfig]: Kafka user configurable settings
kafkas Sequence[GetKafkaKafka]: Kafka server provided values
karapace bool: Switch the service to use Karapace for schema registry and REST proxy
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[GetKafkaServiceIntegration]: 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[GetKafkaTag]: 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
defaultAcl Boolean: Create default wildcard Kafka ACL
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.
kafkaUserConfigs List<Property Map>: Kafka user configurable settings
kafkas List<Property Map>: Kafka server provided values
karapace Boolean: Switch the service to use Karapace for schema registry and REST proxy
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.