Aiven v6.0.1, Mar 17 23

aiven.Cassandra

The Cassandra resource allows the creation and management of Aiven Cassandra services.

Example Usage

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

return await Deployment.RunAsync(() => 
{
    var bar = new Aiven.Cassandra("bar", new()
    {
        Project = data.Aiven_project.Foo.Project,
        CloudName = "google-europe-west1",
        Plan = "startup-4",
        ServiceName = "test-service-name",
        MaintenanceWindowDow = "monday",
        MaintenanceWindowTime = "10:00:00",
        CassandraUserConfig = new Aiven.Inputs.CassandraCassandraUserConfigArgs
        {
            MigrateSstableloader = true,
            PublicAccess = new Aiven.Inputs.CassandraCassandraUserConfigPublicAccessArgs
            {
                Prometheus = true,
            },
        },
    });

});

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.NewCassandra(ctx, "bar", &aiven.CassandraArgs{
			Project:               pulumi.Any(data.Aiven_project.Foo.Project),
			CloudName:             pulumi.String("google-europe-west1"),
			Plan:                  pulumi.String("startup-4"),
			ServiceName:           pulumi.String("test-service-name"),
			MaintenanceWindowDow:  pulumi.String("monday"),
			MaintenanceWindowTime: pulumi.String("10:00:00"),
			CassandraUserConfig: &aiven.CassandraCassandraUserConfigArgs{
				MigrateSstableloader: pulumi.Bool(true),
				PublicAccess: &aiven.CassandraCassandraUserConfigPublicAccessArgs{
					Prometheus: pulumi.Bool(true),
				},
			},
		})
		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.Cassandra;
import com.pulumi.aiven.CassandraArgs;
import com.pulumi.aiven.inputs.CassandraCassandraUserConfigArgs;
import com.pulumi.aiven.inputs.CassandraCassandraUserConfigPublicAccessArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var bar = new Cassandra("bar", CassandraArgs.builder()        
            .project(data.aiven_project().foo().project())
            .cloudName("google-europe-west1")
            .plan("startup-4")
            .serviceName("test-service-name")
            .maintenanceWindowDow("monday")
            .maintenanceWindowTime("10:00:00")
            .cassandraUserConfig(CassandraCassandraUserConfigArgs.builder()
                .migrateSstableloader(true)
                .publicAccess(CassandraCassandraUserConfigPublicAccessArgs.builder()
                    .prometheus(true)
                    .build())
                .build())
            .build());

    }
}

import pulumi
import pulumi_aiven as aiven

bar = aiven.Cassandra("bar",
    project=data["aiven_project"]["foo"]["project"],
    cloud_name="google-europe-west1",
    plan="startup-4",
    service_name="test-service-name",
    maintenance_window_dow="monday",
    maintenance_window_time="10:00:00",
    cassandra_user_config=aiven.CassandraCassandraUserConfigArgs(
        migrate_sstableloader=True,
        public_access=aiven.CassandraCassandraUserConfigPublicAccessArgs(
            prometheus=True,
        ),
    ))

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

const bar = new aiven.Cassandra("bar", {
    project: data.aiven_project.foo.project,
    cloudName: "google-europe-west1",
    plan: "startup-4",
    serviceName: "test-service-name",
    maintenanceWindowDow: "monday",
    maintenanceWindowTime: "10:00:00",
    cassandraUserConfig: {
        migrateSstableloader: true,
        publicAccess: {
            prometheus: true,
        },
    },
});

resources:
  bar:
    type: aiven:Cassandra
    properties:
      project: ${data.aiven_project.foo.project}
      cloudName: google-europe-west1
      plan: startup-4
      serviceName: test-service-name
      maintenanceWindowDow: monday
      maintenanceWindowTime: 10:00:00
      cassandraUserConfig:
        migrateSstableloader: true
        publicAccess:
          prometheus: true

Create Cassandra Resource

new Cassandra(name: string, args: CassandraArgs, opts?: CustomResourceOptions);

@overload
def Cassandra(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              additional_disk_space: Optional[str] = None,
              cassandra_user_config: Optional[CassandraCassandraUserConfigArgs] = None,
              cloud_name: Optional[str] = None,
              disk_space: Optional[str] = None,
              maintenance_window_dow: Optional[str] = None,
              maintenance_window_time: Optional[str] = None,
              plan: Optional[str] = None,
              project: Optional[str] = None,
              project_vpc_id: Optional[str] = None,
              service_integrations: Optional[Sequence[CassandraServiceIntegrationArgs]] = None,
              service_name: Optional[str] = None,
              static_ips: Optional[Sequence[str]] = None,
              tags: Optional[Sequence[CassandraTagArgs]] = None,
              termination_protection: Optional[bool] = None)
@overload
def Cassandra(resource_name: str,
              args: CassandraArgs,
              opts: Optional[ResourceOptions] = None)

func NewCassandra(ctx *Context, name string, args CassandraArgs, opts ...ResourceOption) (*Cassandra, error)

public Cassandra(string name, CassandraArgs args, CustomResourceOptions? opts = null)

public Cassandra(String name, CassandraArgs args)
public Cassandra(String name, CassandraArgs args, CustomResourceOptions options)

type: aiven:Cassandra
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string: The unique name of the resource.
args CassandraArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args CassandraArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args CassandraArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args CassandraArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args CassandraArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Cassandra Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The Cassandra resource accepts the following input properties:

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.
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.
CassandraUserConfig CassandraCassandraUserConfigArgs: Cassandra user configurable settings
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.
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.
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.
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.
ServiceIntegrations List<CassandraServiceIntegrationArgs>: Service integrations to specify when creating a service. Not applied after initial service creation
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<CassandraTagArgs>: 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.

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.
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.
CassandraUserConfig CassandraCassandraUserConfigArgs: Cassandra user configurable settings
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.
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.
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.
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.
ServiceIntegrations []CassandraServiceIntegrationArgs: Service integrations to specify when creating a service. Not applied after initial service creation
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 []CassandraTagArgs: 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.

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.
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.
cassandraUserConfig CassandraCassandraUserConfigArgs: Cassandra user configurable settings
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.
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.
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.
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.
serviceIntegrations List<CassandraServiceIntegrationArgs>: Service integrations to specify when creating a service. Not applied after initial service creation
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<CassandraTagArgs>: 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.

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.
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.
cassandraUserConfig CassandraCassandraUserConfigArgs: Cassandra user configurable settings
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.
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.
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.
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.
serviceIntegrations CassandraServiceIntegrationArgs[]: Service integrations to specify when creating a service. Not applied after initial service creation
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 CassandraTagArgs[]: 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.

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.
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_config CassandraCassandraUserConfigArgs: Cassandra user configurable settings
cloud_name str: Defines where the cloud provider and region where the service is hosted in. This can be changed freely after service is created. Changing the value will trigger a potentially lengthy migration process for the service. Format is cloud provider name (aws, azure, do google, upcloud, etc.), dash, and the cloud provider specific region name. These are documented on each Cloud provider's own support articles, like here for Google and here for AWS.
disk_space str: Service disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.
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_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_integrations Sequence[CassandraServiceIntegrationArgs]: Service integrations to specify when creating a service. Not applied after initial service creation
static_ips Sequence[str]: Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again
tags Sequence[CassandraTagArgs]: 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.

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.
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.
cassandraUserConfig Property Map: Cassandra user configurable settings
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.
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.
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.
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.
serviceIntegrations List<Property Map>: Service integrations to specify when creating a service. Not applied after initial service creation
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.

Outputs

All input properties are implicitly available as output properties. Additionally, the Cassandra resource produces the following output properties:

CassandraServer List<CassandraCassandra>: Cassandra server provided values
Components List<CassandraComponent>: Service component information objects
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.
ServiceHost string: The hostname of the service.
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

Cassandras []CassandraCassandra: Cassandra server provided values
Components []CassandraComponent: Service component information objects
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.
ServiceHost string: The hostname of the service.
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

cassandras List<CassandraCassandra>: Cassandra server provided values
components List<CassandraComponent>: Service component information objects
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.
serviceHost String: The hostname of the service.
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

cassandras CassandraCassandra[]: Cassandra server provided values
components CassandraComponent[]: Service component information objects
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.
serviceHost string: The hostname of the service.
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

cassandras Sequence[CassandraCassandra]: Cassandra server provided values
components Sequence[CassandraComponent]: Service component information objects
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.
service_host str: The hostname of the service.
service_password str: Password used for connecting to the service, if applicable
service_port int: The port of the service
service_type str: Aiven internal service type code
service_uri str: URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
service_username str: Username used for connecting to the service, if applicable
state str: Service state. One of POWEROFF, REBALANCING, REBUILDING or RUNNING

cassandras List<Property Map>: Cassandra server provided values
components List<Property Map>: Service component information objects
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.
serviceHost String: The hostname of the service.
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

Look up Existing Cassandra Resource

Get an existing Cassandra resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: CassandraState, opts?: CustomResourceOptions): Cassandra

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        additional_disk_space: Optional[str] = None,
        cassandra_user_config: Optional[CassandraCassandraUserConfigArgs] = None,
        cassandras: Optional[Sequence[CassandraCassandraArgs]] = None,
        cloud_name: Optional[str] = None,
        components: Optional[Sequence[CassandraComponentArgs]] = None,
        disk_space: Optional[str] = None,
        disk_space_cap: Optional[str] = None,
        disk_space_default: Optional[str] = None,
        disk_space_step: Optional[str] = None,
        disk_space_used: Optional[str] = None,
        maintenance_window_dow: Optional[str] = None,
        maintenance_window_time: Optional[str] = None,
        plan: Optional[str] = None,
        project: Optional[str] = None,
        project_vpc_id: Optional[str] = None,
        service_host: Optional[str] = None,
        service_integrations: Optional[Sequence[CassandraServiceIntegrationArgs]] = None,
        service_name: Optional[str] = None,
        service_password: Optional[str] = None,
        service_port: Optional[int] = None,
        service_type: Optional[str] = None,
        service_uri: Optional[str] = None,
        service_username: Optional[str] = None,
        state: Optional[str] = None,
        static_ips: Optional[Sequence[str]] = None,
        tags: Optional[Sequence[CassandraTagArgs]] = None,
        termination_protection: Optional[bool] = None) -> Cassandra

func GetCassandra(ctx *Context, name string, id IDInput, state *CassandraState, opts ...ResourceOption) (*Cassandra, error)

public static Cassandra Get(string name, Input<string> id, CassandraState? state, CustomResourceOptions? opts = null)

public static Cassandra get(String name, Output<String> id, CassandraState state, CustomResourceOptions options)

Resource lookup is not supported in YAML

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

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.
CassandraServer List<CassandraCassandraArgs>: Cassandra server provided values
CassandraUserConfig CassandraCassandraUserConfigArgs: Cassandra user configurable settings
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<CassandraComponentArgs>: 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
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<CassandraServiceIntegrationArgs>: 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<CassandraTagArgs>: 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.
CassandraUserConfig CassandraCassandraUserConfigArgs: Cassandra user configurable settings
Cassandras []CassandraCassandraArgs: 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 []CassandraComponentArgs: 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
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 []CassandraServiceIntegrationArgs: 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 []CassandraTagArgs: 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.
cassandraUserConfig CassandraCassandraUserConfigArgs: Cassandra user configurable settings
cassandras List<CassandraCassandraArgs>: 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<CassandraComponentArgs>: 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
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<CassandraServiceIntegrationArgs>: 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<CassandraTagArgs>: 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.
cassandraUserConfig CassandraCassandraUserConfigArgs: Cassandra user configurable settings
cassandras CassandraCassandraArgs[]: 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 CassandraComponentArgs[]: 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
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 CassandraServiceIntegrationArgs[]: 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 CassandraTagArgs[]: 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.
cassandra_user_config CassandraCassandraUserConfigArgs: Cassandra user configurable settings
cassandras Sequence[CassandraCassandraArgs]: 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[CassandraComponentArgs]: 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
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[CassandraServiceIntegrationArgs]: 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[CassandraTagArgs]: 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.
cassandraUserConfig 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
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

CassandraCassandraUserConfig

AdditionalBackupRegions string

Additional Cloud Regions for Backup Replication.

Cassandra CassandraCassandraUserConfigCassandra

cassandra configuration values.

CassandraVersion string

Cassandra major version.

IpFilterObjects List<CassandraCassandraUserConfigIpFilterObject>

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:

This will be removed in v5.0.0 and replaced with 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 CassandraCassandraUserConfigPrivateAccess

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.

PublicAccess CassandraCassandraUserConfigPublicAccess

Allow access to selected service ports from the public Internet.

ServiceToForkFrom string

Name of another service to fork from. This has effect only when a new service is being created.

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.

StaticIps bool

Use static public IP addresses.

AdditionalBackupRegions string

Additional Cloud Regions for Backup Replication.

Cassandra CassandraCassandraUserConfigCassandra

cassandra configuration values.

CassandraVersion string

Cassandra major version.

IpFilterObjects []CassandraCassandraUserConfigIpFilterObject

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:

This will be removed in v5.0.0 and replaced with 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 CassandraCassandraUserConfigPrivateAccess

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.

PublicAccess CassandraCassandraUserConfigPublicAccess

Allow access to selected service ports from the public Internet.

ServiceToForkFrom string

Name of another service to fork from. This has effect only when a new service is being created.

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.

StaticIps bool

Use static public IP addresses.

additionalBackupRegions String

Additional Cloud Regions for Backup Replication.

cassandra CassandraCassandraUserConfigCassandra

cassandra configuration values.

cassandraVersion String

Cassandra major version.

ipFilterObjects List<CassandraCassandraUserConfigIpFilterObject>

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:

This will be removed in v5.0.0 and replaced with 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 CassandraCassandraUserConfigPrivateAccess

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.

publicAccess CassandraCassandraUserConfigPublicAccess

Allow access to selected service ports from the public Internet.

serviceToForkFrom String

Name of another service to fork from. This has effect only when a new service is being created.

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.

staticIps Boolean

Use static public IP addresses.

additionalBackupRegions string

Additional Cloud Regions for Backup Replication.

cassandra CassandraCassandraUserConfigCassandra

cassandra configuration values.

cassandraVersion string

Cassandra major version.

ipFilterObjects CassandraCassandraUserConfigIpFilterObject[]

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:

This will be removed in v5.0.0 and replaced with 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 CassandraCassandraUserConfigPrivateAccess

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.

publicAccess CassandraCassandraUserConfigPublicAccess

Allow access to selected service ports from the public Internet.

serviceToForkFrom string

Name of another service to fork from. This has effect only when a new service is being created.

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.

staticIps boolean

Use static public IP addresses.

additional_backup_regions str

Additional Cloud Regions for Backup Replication.

cassandra CassandraCassandraUserConfigCassandra

cassandra configuration values.

cassandra_version str

Cassandra major version.

ip_filter_objects Sequence[CassandraCassandraUserConfigIpFilterObject]

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:

This will be removed in v5.0.0 and replaced with 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 CassandraCassandraUserConfigPrivateAccess

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.

public_access CassandraCassandraUserConfigPublicAccess

Allow access to selected service ports from the public Internet.

service_to_fork_from str

Name of another service to fork from. This has effect only when a new service is being created.

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.

static_ips bool

Use static public IP addresses.

additionalBackupRegions String

Additional Cloud Regions for Backup Replication.

cassandra Property Map

cassandra configuration values.

cassandraVersion String

Cassandra major version.

ipFilterObjects List<Property Map>

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:

This will be removed in v5.0.0 and replaced with 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.

publicAccess Property Map

Allow access to selected service ports from the public Internet.

serviceToForkFrom String

Name of another service to fork from. This has effect only when a new service is being created.

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.

staticIps Boolean

Use static public IP addresses.

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 str
host str
kafka_authentication_method str
port int
route str
ssl bool
usage str

component String
host String
kafkaAuthenticationMethod String
port Number
route String
ssl Boolean
usage String

CassandraServiceIntegration

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

CassandraTag

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

Import

 $ pulumi import aiven:index/cassandra:Cassandra bar project/service_name

Package Details

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

aiven.Cassandra

Example Usage

Create Cassandra Resource

Cassandra Resource Properties

Inputs

Outputs

Look up Existing Cassandra Resource

Supporting Types

CassandraCassandraUserConfig

CassandraCassandraUserConfigCassandra

CassandraCassandraUserConfigIpFilterObject

CassandraCassandraUserConfigPrivateAccess

CassandraCassandraUserConfigPublicAccess

CassandraComponent

CassandraServiceIntegration

CassandraTag

Import

Package Details

Contents