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

aiven.getKafka

Explore with Pulumi AI

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

    The Kafka data source provides information about the existing Aiven Kafka services.

    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.

    Supporting Types

    GetKafkaComponent

    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

    GetKafkaKafka

    GetKafkaKafkaUserConfig

    additionalBackupRegions String
    customDomain String
    ipFilterObjects List<GetKafkaKafkaUserConfigIpFilterObject>
    ipFilterStrings List<String>
    ipFilters List<String>

    Deprecated:

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

    kafka GetKafkaKafkaUserConfigKafka
    kafkaAuthenticationMethods GetKafkaKafkaUserConfigKafkaAuthenticationMethods
    kafkaConnect Boolean
    kafkaConnectConfig GetKafkaKafkaUserConfigKafkaConnectConfig
    kafkaRest Boolean
    kafkaRestAuthorization Boolean
    kafkaRestConfig GetKafkaKafkaUserConfigKafkaRestConfig
    kafkaVersion String
    privateAccess GetKafkaKafkaUserConfigPrivateAccess
    privatelinkAccess GetKafkaKafkaUserConfigPrivatelinkAccess
    publicAccess GetKafkaKafkaUserConfigPublicAccess
    schemaRegistry Boolean
    schemaRegistryConfig GetKafkaKafkaUserConfigSchemaRegistryConfig
    staticIps Boolean
    additional_backup_regions str
    custom_domain str
    ip_filter_objects Sequence[GetKafkaKafkaUserConfigIpFilterObject]
    ip_filter_strings Sequence[str]
    ip_filters Sequence[str]

    Deprecated:

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

    kafka GetKafkaKafkaUserConfigKafka
    kafka_authentication_methods GetKafkaKafkaUserConfigKafkaAuthenticationMethods
    kafka_connect bool
    kafka_connect_config GetKafkaKafkaUserConfigKafkaConnectConfig
    kafka_rest bool
    kafka_rest_authorization bool
    kafka_rest_config GetKafkaKafkaUserConfigKafkaRestConfig
    kafka_version str
    private_access GetKafkaKafkaUserConfigPrivateAccess
    privatelink_access GetKafkaKafkaUserConfigPrivatelinkAccess
    public_access GetKafkaKafkaUserConfigPublicAccess
    schema_registry bool
    schema_registry_config GetKafkaKafkaUserConfigSchemaRegistryConfig
    static_ips bool

    GetKafkaKafkaUserConfigIpFilterObject

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

    GetKafkaKafkaUserConfigKafka

    AutoCreateTopicsEnable bool
    CompressionType string
    ConnectionsMaxIdleMs int
    DefaultReplicationFactor int
    GroupInitialRebalanceDelayMs int
    GroupMaxSessionTimeoutMs int
    GroupMinSessionTimeoutMs int
    LogCleanerDeleteRetentionMs int
    LogCleanerMaxCompactionLagMs int
    LogCleanerMinCleanableRatio double
    LogCleanerMinCompactionLagMs int
    LogCleanupPolicy string
    LogFlushIntervalMessages int
    LogFlushIntervalMs int
    LogIndexIntervalBytes int
    LogIndexSizeMaxBytes int
    LogMessageDownconversionEnable bool
    LogMessageTimestampDifferenceMaxMs int
    LogMessageTimestampType string
    LogPreallocate bool
    LogRetentionBytes int
    LogRetentionHours int
    LogRetentionMs int
    LogRollJitterMs int
    LogRollMs int
    LogSegmentBytes int
    LogSegmentDeleteDelayMs int
    MaxConnectionsPerIp int
    MaxIncrementalFetchSessionCacheSlots int
    MessageMaxBytes int
    MinInsyncReplicas int
    NumPartitions int
    OffsetsRetentionMinutes int
    ProducerPurgatoryPurgeIntervalRequests int
    ReplicaFetchMaxBytes int
    ReplicaFetchResponseMaxBytes int
    SocketRequestMaxBytes int
    TransactionRemoveExpiredTransactionCleanupIntervalMs int
    TransactionStateLogSegmentBytes int
    AutoCreateTopicsEnable bool
    CompressionType string
    ConnectionsMaxIdleMs int
    DefaultReplicationFactor int
    GroupInitialRebalanceDelayMs int
    GroupMaxSessionTimeoutMs int
    GroupMinSessionTimeoutMs int
    LogCleanerDeleteRetentionMs int
    LogCleanerMaxCompactionLagMs int
    LogCleanerMinCleanableRatio float64
    LogCleanerMinCompactionLagMs int
    LogCleanupPolicy string
    LogFlushIntervalMessages int
    LogFlushIntervalMs int
    LogIndexIntervalBytes int
    LogIndexSizeMaxBytes int
    LogMessageDownconversionEnable bool
    LogMessageTimestampDifferenceMaxMs int
    LogMessageTimestampType string
    LogPreallocate bool
    LogRetentionBytes int
    LogRetentionHours int
    LogRetentionMs int
    LogRollJitterMs int
    LogRollMs int
    LogSegmentBytes int
    LogSegmentDeleteDelayMs int
    MaxConnectionsPerIp int
    MaxIncrementalFetchSessionCacheSlots int
    MessageMaxBytes int
    MinInsyncReplicas int
    NumPartitions int
    OffsetsRetentionMinutes int
    ProducerPurgatoryPurgeIntervalRequests int
    ReplicaFetchMaxBytes int
    ReplicaFetchResponseMaxBytes int
    SocketRequestMaxBytes int
    TransactionRemoveExpiredTransactionCleanupIntervalMs int
    TransactionStateLogSegmentBytes int
    autoCreateTopicsEnable Boolean
    compressionType String
    connectionsMaxIdleMs Integer
    defaultReplicationFactor Integer
    groupInitialRebalanceDelayMs Integer
    groupMaxSessionTimeoutMs Integer
    groupMinSessionTimeoutMs Integer
    logCleanerDeleteRetentionMs Integer
    logCleanerMaxCompactionLagMs Integer
    logCleanerMinCleanableRatio Double
    logCleanerMinCompactionLagMs Integer
    logCleanupPolicy String
    logFlushIntervalMessages Integer
    logFlushIntervalMs Integer
    logIndexIntervalBytes Integer
    logIndexSizeMaxBytes Integer
    logMessageDownconversionEnable Boolean
    logMessageTimestampDifferenceMaxMs Integer
    logMessageTimestampType String
    logPreallocate Boolean
    logRetentionBytes Integer
    logRetentionHours Integer
    logRetentionMs Integer
    logRollJitterMs Integer
    logRollMs Integer
    logSegmentBytes Integer
    logSegmentDeleteDelayMs Integer
    maxConnectionsPerIp Integer
    maxIncrementalFetchSessionCacheSlots Integer
    messageMaxBytes Integer
    minInsyncReplicas Integer
    numPartitions Integer
    offsetsRetentionMinutes Integer
    producerPurgatoryPurgeIntervalRequests Integer
    replicaFetchMaxBytes Integer
    replicaFetchResponseMaxBytes Integer
    socketRequestMaxBytes Integer
    transactionRemoveExpiredTransactionCleanupIntervalMs Integer
    transactionStateLogSegmentBytes Integer
    autoCreateTopicsEnable boolean
    compressionType string
    connectionsMaxIdleMs number
    defaultReplicationFactor number
    groupInitialRebalanceDelayMs number
    groupMaxSessionTimeoutMs number
    groupMinSessionTimeoutMs number
    logCleanerDeleteRetentionMs number
    logCleanerMaxCompactionLagMs number
    logCleanerMinCleanableRatio number
    logCleanerMinCompactionLagMs number
    logCleanupPolicy string
    logFlushIntervalMessages number
    logFlushIntervalMs number
    logIndexIntervalBytes number
    logIndexSizeMaxBytes number
    logMessageDownconversionEnable boolean
    logMessageTimestampDifferenceMaxMs number
    logMessageTimestampType string
    logPreallocate boolean
    logRetentionBytes number
    logRetentionHours number
    logRetentionMs number
    logRollJitterMs number
    logRollMs number
    logSegmentBytes number
    logSegmentDeleteDelayMs number
    maxConnectionsPerIp number
    maxIncrementalFetchSessionCacheSlots number
    messageMaxBytes number
    minInsyncReplicas number
    numPartitions number
    offsetsRetentionMinutes number
    producerPurgatoryPurgeIntervalRequests number
    replicaFetchMaxBytes number
    replicaFetchResponseMaxBytes number
    socketRequestMaxBytes number
    transactionRemoveExpiredTransactionCleanupIntervalMs number
    transactionStateLogSegmentBytes number
    auto_create_topics_enable bool
    compression_type str
    connections_max_idle_ms int
    default_replication_factor int
    group_initial_rebalance_delay_ms int
    group_max_session_timeout_ms int
    group_min_session_timeout_ms int
    log_cleaner_delete_retention_ms int
    log_cleaner_max_compaction_lag_ms int
    log_cleaner_min_cleanable_ratio float
    log_cleaner_min_compaction_lag_ms int
    log_cleanup_policy str
    log_flush_interval_messages int
    log_flush_interval_ms int
    log_index_interval_bytes int
    log_index_size_max_bytes int
    log_message_downconversion_enable bool
    log_message_timestamp_difference_max_ms int
    log_message_timestamp_type str
    log_preallocate bool
    log_retention_bytes int
    log_retention_hours int
    log_retention_ms int
    log_roll_jitter_ms int
    log_roll_ms int
    log_segment_bytes int
    log_segment_delete_delay_ms int
    max_connections_per_ip int
    max_incremental_fetch_session_cache_slots int
    message_max_bytes int
    min_insync_replicas int
    num_partitions int
    offsets_retention_minutes int
    producer_purgatory_purge_interval_requests int
    replica_fetch_max_bytes int
    replica_fetch_response_max_bytes int
    socket_request_max_bytes int
    transaction_remove_expired_transaction_cleanup_interval_ms int
    transaction_state_log_segment_bytes int
    autoCreateTopicsEnable Boolean
    compressionType String
    connectionsMaxIdleMs Number
    defaultReplicationFactor Number
    groupInitialRebalanceDelayMs Number
    groupMaxSessionTimeoutMs Number
    groupMinSessionTimeoutMs Number
    logCleanerDeleteRetentionMs Number
    logCleanerMaxCompactionLagMs Number
    logCleanerMinCleanableRatio Number
    logCleanerMinCompactionLagMs Number
    logCleanupPolicy String
    logFlushIntervalMessages Number
    logFlushIntervalMs Number
    logIndexIntervalBytes Number
    logIndexSizeMaxBytes Number
    logMessageDownconversionEnable Boolean
    logMessageTimestampDifferenceMaxMs Number
    logMessageTimestampType String
    logPreallocate Boolean
    logRetentionBytes Number
    logRetentionHours Number
    logRetentionMs Number
    logRollJitterMs Number
    logRollMs Number
    logSegmentBytes Number
    logSegmentDeleteDelayMs Number
    maxConnectionsPerIp Number
    maxIncrementalFetchSessionCacheSlots Number
    messageMaxBytes Number
    minInsyncReplicas Number
    numPartitions Number
    offsetsRetentionMinutes Number
    producerPurgatoryPurgeIntervalRequests Number
    replicaFetchMaxBytes Number
    replicaFetchResponseMaxBytes Number
    socketRequestMaxBytes Number
    transactionRemoveExpiredTransactionCleanupIntervalMs Number
    transactionStateLogSegmentBytes Number

    GetKafkaKafkaUserConfigKafkaAuthenticationMethods

    Certificate bool
    Sasl bool
    Certificate bool
    Sasl bool
    certificate Boolean
    sasl Boolean
    certificate boolean
    sasl boolean
    certificate bool
    sasl bool
    certificate Boolean
    sasl Boolean

    GetKafkaKafkaUserConfigKafkaConnectConfig

    GetKafkaKafkaUserConfigKafkaRestConfig

    GetKafkaKafkaUserConfigPrivateAccess

    kafka Boolean
    kafkaConnect Boolean
    kafkaRest Boolean
    prometheus Boolean
    schemaRegistry Boolean
    kafka boolean
    kafkaConnect boolean
    kafkaRest boolean
    prometheus boolean
    schemaRegistry boolean
    kafka Boolean
    kafkaConnect Boolean
    kafkaRest Boolean
    prometheus Boolean
    schemaRegistry Boolean

    GetKafkaKafkaUserConfigPrivatelinkAccess

    jolokia Boolean
    kafka Boolean
    kafkaConnect Boolean
    kafkaRest Boolean
    prometheus Boolean
    schemaRegistry Boolean
    jolokia boolean
    kafka boolean
    kafkaConnect boolean
    kafkaRest boolean
    prometheus boolean
    schemaRegistry boolean
    jolokia Boolean
    kafka Boolean
    kafkaConnect Boolean
    kafkaRest Boolean
    prometheus Boolean
    schemaRegistry Boolean

    GetKafkaKafkaUserConfigPublicAccess

    kafka Boolean
    kafkaConnect Boolean
    kafkaRest Boolean
    prometheus Boolean
    schemaRegistry Boolean
    kafka boolean
    kafkaConnect boolean
    kafkaRest boolean
    prometheus boolean
    schemaRegistry boolean
    kafka Boolean
    kafkaConnect Boolean
    kafkaRest Boolean
    prometheus Boolean
    schemaRegistry Boolean

    GetKafkaKafkaUserConfigSchemaRegistryConfig

    GetKafkaServiceIntegration

    GetKafkaTag

    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