Aiven v6.18.0, Jun 27 24

Aiven v6.18.0 published on Thursday, Jun 27, 2024 by Pulumi

aiven.getCassandra

Explore with Pulumi AI

Aiven v6.18.0 published on Thursday, Jun 27, 2024 by Pulumi

Example Usage

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

const bar = aiven.getCassandra({
    project: foo.project,
    serviceName: "<SERVICE_NAME>",
});

import pulumi
import pulumi_aiven as aiven

bar = aiven.get_cassandra(project=foo["project"],
    service_name="<SERVICE_NAME>")

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.LookupCassandra(ctx, &aiven.LookupCassandraArgs{
			Project:     foo.Project,
			ServiceName: "<SERVICE_NAME>",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var bar = Aiven.GetCassandra.Invoke(new()
    {
        Project = foo.Project,
        ServiceName = "<SERVICE_NAME>",
    });

});

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.GetCassandraArgs;
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 bar = AivenFunctions.getCassandra(GetCassandraArgs.builder()
            .project(foo.project())
            .serviceName("<SERVICE_NAME>")
            .build());

    }
}

variables:
  bar:
    fn::invoke:
      Function: aiven:getCassandra
      Arguments:
        project: ${foo.project}
        serviceName: <SERVICE_NAME>

Using getCassandra

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 getCassandra(args: GetCassandraArgs, opts?: InvokeOptions): Promise<GetCassandraResult>
function getCassandraOutput(args: GetCassandraOutputArgs, opts?: InvokeOptions): Output<GetCassandraResult>

def get_cassandra(project: Optional[str] = None,
                  service_name: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetCassandraResult
def get_cassandra_output(project: Optional[pulumi.Input[str]] = None,
                  service_name: Optional[pulumi.Input[str]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetCassandraResult]

func LookupCassandra(ctx *Context, args *LookupCassandraArgs, opts ...InvokeOption) (*LookupCassandraResult, error)
func LookupCassandraOutput(ctx *Context, args *LookupCassandraOutputArgs, opts ...InvokeOption) LookupCassandraResultOutput

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

public static class GetCassandra 
{
    public static Task<GetCassandraResult> InvokeAsync(GetCassandraArgs args, InvokeOptions? opts = null)
    public static Output<GetCassandraResult> Invoke(GetCassandraInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetCassandraResult> getCassandra(GetCassandraArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: aiven:index/getCassandra:getCassandra
  arguments:
    # arguments dictionary

The following arguments are supported:

Project string: The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
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: The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
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: The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
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: The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
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: The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
service_name str: Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.

project String: The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
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.

getCassandra 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.
CassandraUserConfigs List<GetCassandraCassandraUserConfig>: Cassandra user configurable settings
Cassandras List<GetCassandraCassandra>: Cassandra server provided values
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<GetCassandraComponent>: 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.
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: The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
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<GetCassandraServiceIntegration>: 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<GetCassandraTag>: Tags are key-value pairs that allow you to categorize services.
TechEmails List<GetCassandraTechEmail>: The email addresses for service contacts, who will receive important alerts and updates about this service. You can also set email contacts at the project level.
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.
CassandraUserConfigs []GetCassandraCassandraUserConfig: Cassandra user configurable settings
Cassandras []GetCassandraCassandra: Cassandra server provided values
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 []GetCassandraComponent: 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.
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: The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
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 []GetCassandraServiceIntegration: 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 []GetCassandraTag: Tags are key-value pairs that allow you to categorize services.
TechEmails []GetCassandraTechEmail: The email addresses for service contacts, who will receive important alerts and updates about this service. You can also set email contacts at the project level.
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.
cassandraUserConfigs List<GetCassandraCassandraUserConfig>: Cassandra user configurable settings
cassandras List<GetCassandraCassandra>: Cassandra server provided values
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<GetCassandraComponent>: 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.
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: The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
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<GetCassandraServiceIntegration>: 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<GetCassandraTag>: Tags are key-value pairs that allow you to categorize services.
techEmails List<GetCassandraTechEmail>: The email addresses for service contacts, who will receive important alerts and updates about this service. You can also set email contacts at the project level.
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.
cassandraUserConfigs GetCassandraCassandraUserConfig[]: Cassandra user configurable settings
cassandras GetCassandraCassandra[]: Cassandra server provided values
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 GetCassandraComponent[]: 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.
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: The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
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 GetCassandraServiceIntegration[]: 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 GetCassandraTag[]: Tags are key-value pairs that allow you to categorize services.
techEmails GetCassandraTechEmail[]: The email addresses for service contacts, who will receive important alerts and updates about this service. You can also set email contacts at the project level.
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.
cassandra_user_configs Sequence[GetCassandraCassandraUserConfig]: Cassandra user configurable settings
cassandras Sequence[GetCassandraCassandra]: Cassandra server provided values
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[GetCassandraComponent]: 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.
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: The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
project_vpc_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[GetCassandraServiceIntegration]: 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[GetCassandraTag]: Tags are key-value pairs that allow you to categorize services.
tech_emails Sequence[GetCassandraTechEmail]: The email addresses for service contacts, who will receive important alerts and updates about this service. You can also set email contacts at the project level.
termination_protection bool: Prevents the service from being deleted. It is recommended to set this to true for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.

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.
cassandraUserConfigs List<Property Map>: Cassandra user configurable settings
cassandras List<Property Map>: Cassandra server provided values
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.
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: The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
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.
techEmails List<Property Map>: The email addresses for service contacts, who will receive important alerts and updates about this service. You can also set email contacts at the project level.
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

GetCassandraCassandra

Uris List<string>: Cassandra server URIs.

Uris []string: Cassandra server URIs.

uris List<String>: Cassandra server URIs.

uris string[]: Cassandra server URIs.

uris Sequence[str]: Cassandra server URIs.

uris List<String>: Cassandra server URIs.

GetCassandraCassandraUserConfig

AdditionalBackupRegions string: Additional Cloud Regions for Backup Replication.
Deprecated: This property is deprecated.
BackupHour int: The hour of day (in UTC) when backup for the service is started. New backup is only started if previous backup has already completed. Example: 3.
BackupMinute int: The minute of an hour when backup for the service is started. New backup is only started if previous backup has already completed. Example: 30.
Cassandra GetCassandraCassandraUserConfigCassandra: Cassandra configuration values
CassandraVersion string: Enum: 3, 4, 4.1, and newer. Cassandra version.
IpFilterObjects List<GetCassandraCassandraUserConfigIpFilterObject>: Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16
IpFilterStrings List<string>: Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.
IpFilters List<string>: Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.
Deprecated: Deprecated. Use ip_filter_string instead.
MigrateSstableloader bool: Sets the service into migration mode enabling the sstableloader utility to be used to upload Cassandra data files. Available only on service create.
PrivateAccess GetCassandraCassandraUserConfigPrivateAccess: Allow access to selected service ports from private networks
ProjectToForkFrom string: Name of another project to fork a service from. This has effect only when a new service is being created. Example: anotherprojectname.
PublicAccess GetCassandraCassandraUserConfigPublicAccess: Allow access to selected service ports from the public Internet
ServiceLog bool: Store logs for the service so that they are available in the HTTP API and console.
ServiceToForkFrom string: Name of another service to fork from. This has effect only when a new service is being created. Example: anotherservicename.
ServiceToJoinWith string: When bootstrapping, instead of creating a new Cassandra cluster try to join an existing one from another service. Can only be set on service creation. Example: my-test-cassandra.
StaticIps bool: Use static public IP addresses.

AdditionalBackupRegions string: Additional Cloud Regions for Backup Replication.
Deprecated: This property is deprecated.
BackupHour int: The hour of day (in UTC) when backup for the service is started. New backup is only started if previous backup has already completed. Example: 3.
BackupMinute int: The minute of an hour when backup for the service is started. New backup is only started if previous backup has already completed. Example: 30.
Cassandra GetCassandraCassandraUserConfigCassandra: Cassandra configuration values
CassandraVersion string: Enum: 3, 4, 4.1, and newer. Cassandra version.
IpFilterObjects []GetCassandraCassandraUserConfigIpFilterObject: Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16
IpFilterStrings []string: Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.
IpFilters []string: Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.
Deprecated: Deprecated. Use ip_filter_string instead.
MigrateSstableloader bool: Sets the service into migration mode enabling the sstableloader utility to be used to upload Cassandra data files. Available only on service create.
PrivateAccess GetCassandraCassandraUserConfigPrivateAccess: Allow access to selected service ports from private networks
ProjectToForkFrom string: Name of another project to fork a service from. This has effect only when a new service is being created. Example: anotherprojectname.
PublicAccess GetCassandraCassandraUserConfigPublicAccess: Allow access to selected service ports from the public Internet
ServiceLog bool: Store logs for the service so that they are available in the HTTP API and console.
ServiceToForkFrom string: Name of another service to fork from. This has effect only when a new service is being created. Example: anotherservicename.
ServiceToJoinWith string: When bootstrapping, instead of creating a new Cassandra cluster try to join an existing one from another service. Can only be set on service creation. Example: my-test-cassandra.
StaticIps bool: Use static public IP addresses.

additionalBackupRegions String: Additional Cloud Regions for Backup Replication.
Deprecated: This property is deprecated.
backupHour Integer: The hour of day (in UTC) when backup for the service is started. New backup is only started if previous backup has already completed. Example: 3.
backupMinute Integer: The minute of an hour when backup for the service is started. New backup is only started if previous backup has already completed. Example: 30.
cassandra GetCassandraCassandraUserConfigCassandra: Cassandra configuration values
cassandraVersion String: Enum: 3, 4, 4.1, and newer. Cassandra version.
ipFilterObjects List<GetCassandraCassandraUserConfigIpFilterObject>: Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16
ipFilterStrings List<String>: Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.
ipFilters List<String>: Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.
Deprecated: Deprecated. Use ip_filter_string instead.
migrateSstableloader Boolean: Sets the service into migration mode enabling the sstableloader utility to be used to upload Cassandra data files. Available only on service create.
privateAccess GetCassandraCassandraUserConfigPrivateAccess: Allow access to selected service ports from private networks
projectToForkFrom String: Name of another project to fork a service from. This has effect only when a new service is being created. Example: anotherprojectname.
publicAccess GetCassandraCassandraUserConfigPublicAccess: Allow access to selected service ports from the public Internet
serviceLog Boolean: Store logs for the service so that they are available in the HTTP API and console.
serviceToForkFrom String: Name of another service to fork from. This has effect only when a new service is being created. Example: anotherservicename.
serviceToJoinWith String: When bootstrapping, instead of creating a new Cassandra cluster try to join an existing one from another service. Can only be set on service creation. Example: my-test-cassandra.
staticIps Boolean: Use static public IP addresses.

additionalBackupRegions string: Additional Cloud Regions for Backup Replication.
Deprecated: This property is deprecated.
backupHour number: The hour of day (in UTC) when backup for the service is started. New backup is only started if previous backup has already completed. Example: 3.
backupMinute number: The minute of an hour when backup for the service is started. New backup is only started if previous backup has already completed. Example: 30.
cassandra GetCassandraCassandraUserConfigCassandra: Cassandra configuration values
cassandraVersion string: Enum: 3, 4, 4.1, and newer. Cassandra version.
ipFilterObjects GetCassandraCassandraUserConfigIpFilterObject[]: Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16
ipFilterStrings string[]: Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.
ipFilters string[]: Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.
Deprecated: Deprecated. Use ip_filter_string instead.
migrateSstableloader boolean: Sets the service into migration mode enabling the sstableloader utility to be used to upload Cassandra data files. Available only on service create.
privateAccess GetCassandraCassandraUserConfigPrivateAccess: Allow access to selected service ports from private networks
projectToForkFrom string: Name of another project to fork a service from. This has effect only when a new service is being created. Example: anotherprojectname.
publicAccess GetCassandraCassandraUserConfigPublicAccess: Allow access to selected service ports from the public Internet
serviceLog boolean: Store logs for the service so that they are available in the HTTP API and console.
serviceToForkFrom string: Name of another service to fork from. This has effect only when a new service is being created. Example: anotherservicename.
serviceToJoinWith string: When bootstrapping, instead of creating a new Cassandra cluster try to join an existing one from another service. Can only be set on service creation. Example: my-test-cassandra.
staticIps boolean: Use static public IP addresses.

additional_backup_regions str: Additional Cloud Regions for Backup Replication.
Deprecated: This property is deprecated.
backup_hour int: The hour of day (in UTC) when backup for the service is started. New backup is only started if previous backup has already completed. Example: 3.
backup_minute int: The minute of an hour when backup for the service is started. New backup is only started if previous backup has already completed. Example: 30.
cassandra GetCassandraCassandraUserConfigCassandra: Cassandra configuration values
cassandra_version str: Enum: 3, 4, 4.1, and newer. Cassandra version.
ip_filter_objects Sequence[GetCassandraCassandraUserConfigIpFilterObject]: Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16
ip_filter_strings Sequence[str]: Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.
ip_filters Sequence[str]: Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.
Deprecated: Deprecated. Use ip_filter_string instead.
migrate_sstableloader bool: Sets the service into migration mode enabling the sstableloader utility to be used to upload Cassandra data files. Available only on service create.
private_access GetCassandraCassandraUserConfigPrivateAccess: Allow access to selected service ports from private networks
project_to_fork_from str: Name of another project to fork a service from. This has effect only when a new service is being created. Example: anotherprojectname.
public_access GetCassandraCassandraUserConfigPublicAccess: Allow access to selected service ports from the public Internet
service_log bool: Store logs for the service so that they are available in the HTTP API and console.
service_to_fork_from str: Name of another service to fork from. This has effect only when a new service is being created. Example: anotherservicename.
service_to_join_with str: When bootstrapping, instead of creating a new Cassandra cluster try to join an existing one from another service. Can only be set on service creation. Example: my-test-cassandra.
static_ips bool: Use static public IP addresses.

additionalBackupRegions String: Additional Cloud Regions for Backup Replication.
Deprecated: This property is deprecated.
backupHour Number: The hour of day (in UTC) when backup for the service is started. New backup is only started if previous backup has already completed. Example: 3.
backupMinute Number: The minute of an hour when backup for the service is started. New backup is only started if previous backup has already completed. Example: 30.
cassandra Property Map: Cassandra configuration values
cassandraVersion String: Enum: 3, 4, 4.1, and newer. Cassandra version.
ipFilterObjects List<Property Map>: Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16
ipFilterStrings List<String>: Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.
ipFilters List<String>: Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.
Deprecated: Deprecated. Use ip_filter_string instead.
migrateSstableloader Boolean: Sets the service into migration mode enabling the sstableloader utility to be used to upload Cassandra data files. Available only on service create.
privateAccess Property Map: Allow access to selected service ports from private networks
projectToForkFrom String: Name of another project to fork a service from. This has effect only when a new service is being created. Example: anotherprojectname.
publicAccess Property Map: Allow access to selected service ports from the public Internet
serviceLog Boolean: Store logs for the service so that they are available in the HTTP API and console.
serviceToForkFrom String: Name of another service to fork from. This has effect only when a new service is being created. Example: anotherservicename.
serviceToJoinWith String: When bootstrapping, instead of creating a new Cassandra cluster try to join an existing one from another service. Can only be set on service creation. Example: my-test-cassandra.
staticIps Boolean: Use static public IP addresses.

GetCassandraCassandraUserConfigCassandra

BatchSizeFailThresholdInKb int: Fail any multiple-partition batch exceeding this value. 50kb (10x warn threshold) by default. Example: 50.
BatchSizeWarnThresholdInKb int: Log a warning message on any multiple-partition batch size exceeding this value.5kb per batch by default.Caution should be taken on increasing the size of this thresholdas it can lead to node instability. Example: 5.
Datacenter string: Name of the datacenter to which nodes of this service belong. Can be set only when creating the service. Example: my-service-google-west1.

BatchSizeFailThresholdInKb int: Fail any multiple-partition batch exceeding this value. 50kb (10x warn threshold) by default. Example: 50.
BatchSizeWarnThresholdInKb int: Log a warning message on any multiple-partition batch size exceeding this value.5kb per batch by default.Caution should be taken on increasing the size of this thresholdas it can lead to node instability. Example: 5.
Datacenter string: Name of the datacenter to which nodes of this service belong. Can be set only when creating the service. Example: my-service-google-west1.

batchSizeFailThresholdInKb Integer: Fail any multiple-partition batch exceeding this value. 50kb (10x warn threshold) by default. Example: 50.
batchSizeWarnThresholdInKb Integer: Log a warning message on any multiple-partition batch size exceeding this value.5kb per batch by default.Caution should be taken on increasing the size of this thresholdas it can lead to node instability. Example: 5.
datacenter String: Name of the datacenter to which nodes of this service belong. Can be set only when creating the service. Example: my-service-google-west1.

batchSizeFailThresholdInKb number: Fail any multiple-partition batch exceeding this value. 50kb (10x warn threshold) by default. Example: 50.
batchSizeWarnThresholdInKb number: Log a warning message on any multiple-partition batch size exceeding this value.5kb per batch by default.Caution should be taken on increasing the size of this thresholdas it can lead to node instability. Example: 5.
datacenter string: Name of the datacenter to which nodes of this service belong. Can be set only when creating the service. Example: my-service-google-west1.

batch_size_fail_threshold_in_kb int: Fail any multiple-partition batch exceeding this value. 50kb (10x warn threshold) by default. Example: 50.
batch_size_warn_threshold_in_kb int: Log a warning message on any multiple-partition batch size exceeding this value.5kb per batch by default.Caution should be taken on increasing the size of this thresholdas it can lead to node instability. Example: 5.
datacenter str: Name of the datacenter to which nodes of this service belong. Can be set only when creating the service. Example: my-service-google-west1.

batchSizeFailThresholdInKb Number: Fail any multiple-partition batch exceeding this value. 50kb (10x warn threshold) by default. Example: 50.
batchSizeWarnThresholdInKb Number: Log a warning message on any multiple-partition batch size exceeding this value.5kb per batch by default.Caution should be taken on increasing the size of this thresholdas it can lead to node instability. Example: 5.
datacenter String: Name of the datacenter to which nodes of this service belong. Can be set only when creating the service. Example: my-service-google-west1.

GetCassandraCassandraUserConfigIpFilterObject

Network string: CIDR address block. Example: 10.20.0.0/16.
Description string: Description for IP filter list entry. Example: Production service IP range.

Network string: CIDR address block. Example: 10.20.0.0/16.
Description string: Description for IP filter list entry. Example: Production service IP range.

network String: CIDR address block. Example: 10.20.0.0/16.
description String: Description for IP filter list entry. Example: Production service IP range.

network string: CIDR address block. Example: 10.20.0.0/16.
description string: Description for IP filter list entry. Example: Production service IP range.

network str: CIDR address block. Example: 10.20.0.0/16.
description str: Description for IP filter list entry. Example: Production service IP range.

network String: CIDR address block. Example: 10.20.0.0/16.
description String: Description for IP filter list entry. Example: Production service IP range.

GetCassandraCassandraUserConfigPrivateAccess

Prometheus bool: Allow clients to connect to prometheus with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.

Prometheus bool: Allow clients to connect to prometheus with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.

prometheus Boolean: Allow clients to connect to prometheus with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.

prometheus boolean: Allow clients to connect to prometheus with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.

prometheus bool: Allow clients to connect to prometheus with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.

prometheus Boolean: Allow clients to connect to prometheus with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.

GetCassandraCassandraUserConfigPublicAccess

Prometheus bool: Allow clients to connect to prometheus from the public internet for service nodes that are in a project VPC or another type of private network.

Prometheus bool: Allow clients to connect to prometheus from the public internet for service nodes that are in a project VPC or another type of private network.

prometheus Boolean: Allow clients to connect to prometheus from the public internet for service nodes that are in a project VPC or another type of private network.

prometheus boolean: Allow clients to connect to prometheus from the public internet for service nodes that are in a project VPC or another type of private network.

prometheus bool: Allow clients to connect to prometheus from the public internet for service nodes that are in a project VPC or another type of private network.

prometheus Boolean: Allow clients to connect to prometheus from the public internet for service nodes that are in a project VPC or another type of private network.

GetCassandraComponent

Component string: Service component name
ConnectionUri string: Connection info for connecting to the service component. This is a combination of host and port.
Host string: Host name for connecting to the service component
KafkaAuthenticationMethod string: Kafka authentication method. This is a value specific to the 'kafka' service component
Port int: Port number for connecting to the service component
Route string: Network access route
Ssl bool: Whether the endpoint is encrypted or accepts plaintext. By default endpoints are always encrypted and this property is only included for service components they may disable encryption
Usage string: DNS usage name

Component string: Service component name
ConnectionUri string: Connection info for connecting to the service component. This is a combination of host and port.
Host string: Host name for connecting to the service component
KafkaAuthenticationMethod string: Kafka authentication method. This is a value specific to the 'kafka' service component
Port int: Port number for connecting to the service component
Route string: Network access route
Ssl bool: Whether the endpoint is encrypted or accepts plaintext. By default endpoints are always encrypted and this property is only included for service components they may disable encryption
Usage string: DNS usage name

component String: Service component name
connectionUri String: Connection info for connecting to the service component. This is a combination of host and port.
host String: Host name for connecting to the service component
kafkaAuthenticationMethod String: Kafka authentication method. This is a value specific to the 'kafka' service component
port Integer: Port number for connecting to the service component
route String: Network access route
ssl Boolean: Whether the endpoint is encrypted or accepts plaintext. By default endpoints are always encrypted and this property is only included for service components they may disable encryption
usage String: DNS usage name

component string: Service component name
connectionUri string: Connection info for connecting to the service component. This is a combination of host and port.
host string: Host name for connecting to the service component
kafkaAuthenticationMethod string: Kafka authentication method. This is a value specific to the 'kafka' service component
port number: Port number for connecting to the service component
route string: Network access route
ssl boolean: Whether the endpoint is encrypted or accepts plaintext. By default endpoints are always encrypted and this property is only included for service components they may disable encryption
usage string: DNS usage name

component str: Service component name
connection_uri str: Connection info for connecting to the service component. This is a combination of host and port.
host str: Host name for connecting to the service component
kafka_authentication_method str: Kafka authentication method. This is a value specific to the 'kafka' service component
port int: Port number for connecting to the service component
route str: Network access route
ssl bool: Whether the endpoint is encrypted or accepts plaintext. By default endpoints are always encrypted and this property is only included for service components they may disable encryption
usage str: DNS usage name

component String: Service component name
connectionUri String: Connection info for connecting to the service component. This is a combination of host and port.
host String: Host name for connecting to the service component
kafkaAuthenticationMethod String: Kafka authentication method. This is a value specific to the 'kafka' service component
port Number: Port number for connecting to the service component
route String: Network access route
ssl Boolean: Whether the endpoint is encrypted or accepts plaintext. By default endpoints are always encrypted and this property is only included for service components they may disable encryption
usage String: DNS usage name

GetCassandraServiceIntegration

IntegrationType string: Type of the service integration. The only supported value at the moment is read_replica
SourceServiceName string: Name of the source service

IntegrationType string: Type of the service integration. The only supported value at the moment is read_replica
SourceServiceName string: Name of the source service

integrationType String: Type of the service integration. The only supported value at the moment is read_replica
sourceServiceName String: Name of the source service

integrationType string: Type of the service integration. The only supported value at the moment is read_replica
sourceServiceName string: Name of the source service

integration_type str: Type of the service integration. The only supported value at the moment is read_replica
source_service_name str: Name of the source service

integrationType String: Type of the service integration. The only supported value at the moment is read_replica
sourceServiceName String: Name of the source service

GetCassandraTag

Key string: Service tag key
Value string: Service tag value

Key string: Service tag key
Value string: Service tag value

key String: Service tag key
value String: Service tag value

key string: Service tag key
value string: Service tag value

key str: Service tag key
value str: Service tag value

key String: Service tag key
value String: Service tag value

GetCassandraTechEmail

Email string: An email address to contact for technical issues

Email string: An email address to contact for technical issues

email String: An email address to contact for technical issues

email string: An email address to contact for technical issues

email str: An email address to contact for technical issues

email String: An email address to contact for technical issues

Package Details

Repository: Aiven pulumi/pulumi-aiven
License: Apache-2.0
Notes: This Pulumi package is based on the aiven Terraform Provider.

Aiven v6.18.0 published on Thursday, Jun 27, 2024 by Pulumi

pulumi/pulumi-aiven

aiven.getCassandra

On this page

On this page

Example Usage

Using getCassandra

getCassandra Result

Supporting Types

GetCassandraCassandra

GetCassandraCassandraUserConfig

GetCassandraCassandraUserConfigCassandra

GetCassandraCassandraUserConfigIpFilterObject

GetCassandraCassandraUserConfigPrivateAccess

GetCassandraCassandraUserConfigPublicAccess

GetCassandraComponent

GetCassandraServiceIntegration

GetCassandraTag

GetCassandraTechEmail

Package Details

On this page

On this page