aiven.Cassandra
Explore with Pulumi AI
Creates and manages an Aiven for Apache Cassandra® service.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as aiven from "@pulumi/aiven";
const exampleCassandra = new aiven.Cassandra("example_cassandra", {
project: exampleProject.project,
cloudName: "google-europe-west1",
plan: "startup-4",
serviceName: "example-cassandra-service",
maintenanceWindowDow: "monday",
maintenanceWindowTime: "10:00:00",
cassandraUserConfig: {
migrateSstableloader: true,
publicAccess: {
prometheus: true,
},
},
});
import pulumi
import pulumi_aiven as aiven
example_cassandra = aiven.Cassandra("example_cassandra",
project=example_project["project"],
cloud_name="google-europe-west1",
plan="startup-4",
service_name="example-cassandra-service",
maintenance_window_dow="monday",
maintenance_window_time="10:00:00",
cassandra_user_config={
"migrate_sstableloader": True,
"public_access": {
"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, "example_cassandra", &aiven.CassandraArgs{
Project: pulumi.Any(exampleProject.Project),
CloudName: pulumi.String("google-europe-west1"),
Plan: pulumi.String("startup-4"),
ServiceName: pulumi.String("example-cassandra-service"),
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
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aiven = Pulumi.Aiven;
return await Deployment.RunAsync(() =>
{
var exampleCassandra = new Aiven.Cassandra("example_cassandra", new()
{
Project = exampleProject.Project,
CloudName = "google-europe-west1",
Plan = "startup-4",
ServiceName = "example-cassandra-service",
MaintenanceWindowDow = "monday",
MaintenanceWindowTime = "10:00:00",
CassandraUserConfig = new Aiven.Inputs.CassandraCassandraUserConfigArgs
{
MigrateSstableloader = true,
PublicAccess = new Aiven.Inputs.CassandraCassandraUserConfigPublicAccessArgs
{
Prometheus = true,
},
},
});
});
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 exampleCassandra = new Cassandra("exampleCassandra", CassandraArgs.builder()
.project(exampleProject.project())
.cloudName("google-europe-west1")
.plan("startup-4")
.serviceName("example-cassandra-service")
.maintenanceWindowDow("monday")
.maintenanceWindowTime("10:00:00")
.cassandraUserConfig(CassandraCassandraUserConfigArgs.builder()
.migrateSstableloader(true)
.publicAccess(CassandraCassandraUserConfigPublicAccessArgs.builder()
.prometheus(true)
.build())
.build())
.build());
}
}
resources:
exampleCassandra:
type: aiven:Cassandra
name: example_cassandra
properties:
project: ${exampleProject.project}
cloudName: google-europe-west1
plan: startup-4
serviceName: example-cassandra-service
maintenanceWindowDow: monday
maintenanceWindowTime: 10:00:00
cassandraUserConfig:
migrateSstableloader: true
publicAccess:
prometheus: true
Create Cassandra Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Cassandra(name: string, args: CassandraArgs, opts?: CustomResourceOptions);
@overload
def Cassandra(resource_name: str,
args: CassandraArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Cassandra(resource_name: str,
opts: Optional[ResourceOptions] = None,
plan: Optional[str] = None,
service_name: Optional[str] = None,
project: Optional[str] = None,
disk_space: Optional[str] = None,
additional_disk_space: Optional[str] = None,
maintenance_window_dow: Optional[str] = None,
maintenance_window_time: Optional[str] = None,
cloud_name: Optional[str] = None,
cassandra_user_config: Optional[CassandraCassandraUserConfigArgs] = None,
project_vpc_id: Optional[str] = None,
service_integrations: Optional[Sequence[CassandraServiceIntegrationArgs]] = None,
cassandra: Optional[CassandraCassandraArgs] = None,
static_ips: Optional[Sequence[str]] = None,
tags: Optional[Sequence[CassandraTagArgs]] = None,
tech_emails: Optional[Sequence[CassandraTechEmailArgs]] = None,
termination_protection: Optional[bool] = 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.
Parameters
- 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.
Constructor example
The following reference example uses placeholder values for all input properties.
var cassandraResource = new Aiven.Cassandra("cassandraResource", new()
{
Plan = "string",
ServiceName = "string",
Project = "string",
AdditionalDiskSpace = "string",
MaintenanceWindowDow = "string",
MaintenanceWindowTime = "string",
CloudName = "string",
CassandraUserConfig = new Aiven.Inputs.CassandraCassandraUserConfigArgs
{
AdditionalBackupRegions = "string",
BackupHour = 0,
BackupMinute = 0,
Cassandra = new Aiven.Inputs.CassandraCassandraUserConfigCassandraArgs
{
BatchSizeFailThresholdInKb = 0,
BatchSizeWarnThresholdInKb = 0,
Datacenter = "string",
ReadRequestTimeoutInMs = 0,
WriteRequestTimeoutInMs = 0,
},
CassandraVersion = "string",
IpFilterObjects = new[]
{
new Aiven.Inputs.CassandraCassandraUserConfigIpFilterObjectArgs
{
Network = "string",
Description = "string",
},
},
IpFilterStrings = new[]
{
"string",
},
MigrateSstableloader = false,
PrivateAccess = new Aiven.Inputs.CassandraCassandraUserConfigPrivateAccessArgs
{
Prometheus = false,
},
ProjectToForkFrom = "string",
PublicAccess = new Aiven.Inputs.CassandraCassandraUserConfigPublicAccessArgs
{
Prometheus = false,
},
ServiceLog = false,
ServiceToForkFrom = "string",
ServiceToJoinWith = "string",
StaticIps = false,
},
ProjectVpcId = "string",
ServiceIntegrations = new[]
{
new Aiven.Inputs.CassandraServiceIntegrationArgs
{
IntegrationType = "string",
SourceServiceName = "string",
},
},
CassandraServer = new Aiven.Inputs.CassandraCassandraArgs
{
Uris = new[]
{
"string",
},
},
StaticIps = new[]
{
"string",
},
Tags = new[]
{
new Aiven.Inputs.CassandraTagArgs
{
Key = "string",
Value = "string",
},
},
TechEmails = new[]
{
new Aiven.Inputs.CassandraTechEmailArgs
{
Email = "string",
},
},
TerminationProtection = false,
});
example, err := aiven.NewCassandra(ctx, "cassandraResource", &aiven.CassandraArgs{
Plan: pulumi.String("string"),
ServiceName: pulumi.String("string"),
Project: pulumi.String("string"),
AdditionalDiskSpace: pulumi.String("string"),
MaintenanceWindowDow: pulumi.String("string"),
MaintenanceWindowTime: pulumi.String("string"),
CloudName: pulumi.String("string"),
CassandraUserConfig: &aiven.CassandraCassandraUserConfigArgs{
AdditionalBackupRegions: pulumi.String("string"),
BackupHour: pulumi.Int(0),
BackupMinute: pulumi.Int(0),
Cassandra: &aiven.CassandraCassandraUserConfigCassandraArgs{
BatchSizeFailThresholdInKb: pulumi.Int(0),
BatchSizeWarnThresholdInKb: pulumi.Int(0),
Datacenter: pulumi.String("string"),
ReadRequestTimeoutInMs: pulumi.Int(0),
WriteRequestTimeoutInMs: pulumi.Int(0),
},
CassandraVersion: pulumi.String("string"),
IpFilterObjects: aiven.CassandraCassandraUserConfigIpFilterObjectArray{
&aiven.CassandraCassandraUserConfigIpFilterObjectArgs{
Network: pulumi.String("string"),
Description: pulumi.String("string"),
},
},
IpFilterStrings: pulumi.StringArray{
pulumi.String("string"),
},
MigrateSstableloader: pulumi.Bool(false),
PrivateAccess: &aiven.CassandraCassandraUserConfigPrivateAccessArgs{
Prometheus: pulumi.Bool(false),
},
ProjectToForkFrom: pulumi.String("string"),
PublicAccess: &aiven.CassandraCassandraUserConfigPublicAccessArgs{
Prometheus: pulumi.Bool(false),
},
ServiceLog: pulumi.Bool(false),
ServiceToForkFrom: pulumi.String("string"),
ServiceToJoinWith: pulumi.String("string"),
StaticIps: pulumi.Bool(false),
},
ProjectVpcId: pulumi.String("string"),
ServiceIntegrations: aiven.CassandraServiceIntegrationArray{
&aiven.CassandraServiceIntegrationArgs{
IntegrationType: pulumi.String("string"),
SourceServiceName: pulumi.String("string"),
},
},
Cassandra: &aiven.CassandraCassandraArgs{
Uris: pulumi.StringArray{
pulumi.String("string"),
},
},
StaticIps: pulumi.StringArray{
pulumi.String("string"),
},
Tags: aiven.CassandraTagArray{
&aiven.CassandraTagArgs{
Key: pulumi.String("string"),
Value: pulumi.String("string"),
},
},
TechEmails: aiven.CassandraTechEmailArray{
&aiven.CassandraTechEmailArgs{
Email: pulumi.String("string"),
},
},
TerminationProtection: pulumi.Bool(false),
})
var cassandraResource = new Cassandra("cassandraResource", CassandraArgs.builder()
.plan("string")
.serviceName("string")
.project("string")
.additionalDiskSpace("string")
.maintenanceWindowDow("string")
.maintenanceWindowTime("string")
.cloudName("string")
.cassandraUserConfig(CassandraCassandraUserConfigArgs.builder()
.additionalBackupRegions("string")
.backupHour(0)
.backupMinute(0)
.cassandra(CassandraCassandraUserConfigCassandraArgs.builder()
.batchSizeFailThresholdInKb(0)
.batchSizeWarnThresholdInKb(0)
.datacenter("string")
.readRequestTimeoutInMs(0)
.writeRequestTimeoutInMs(0)
.build())
.cassandraVersion("string")
.ipFilterObjects(CassandraCassandraUserConfigIpFilterObjectArgs.builder()
.network("string")
.description("string")
.build())
.ipFilterStrings("string")
.migrateSstableloader(false)
.privateAccess(CassandraCassandraUserConfigPrivateAccessArgs.builder()
.prometheus(false)
.build())
.projectToForkFrom("string")
.publicAccess(CassandraCassandraUserConfigPublicAccessArgs.builder()
.prometheus(false)
.build())
.serviceLog(false)
.serviceToForkFrom("string")
.serviceToJoinWith("string")
.staticIps(false)
.build())
.projectVpcId("string")
.serviceIntegrations(CassandraServiceIntegrationArgs.builder()
.integrationType("string")
.sourceServiceName("string")
.build())
.cassandra(CassandraCassandraArgs.builder()
.uris("string")
.build())
.staticIps("string")
.tags(CassandraTagArgs.builder()
.key("string")
.value("string")
.build())
.techEmails(CassandraTechEmailArgs.builder()
.email("string")
.build())
.terminationProtection(false)
.build());
cassandra_resource = aiven.Cassandra("cassandraResource",
plan="string",
service_name="string",
project="string",
additional_disk_space="string",
maintenance_window_dow="string",
maintenance_window_time="string",
cloud_name="string",
cassandra_user_config={
"additional_backup_regions": "string",
"backup_hour": 0,
"backup_minute": 0,
"cassandra": {
"batch_size_fail_threshold_in_kb": 0,
"batch_size_warn_threshold_in_kb": 0,
"datacenter": "string",
"read_request_timeout_in_ms": 0,
"write_request_timeout_in_ms": 0,
},
"cassandra_version": "string",
"ip_filter_objects": [{
"network": "string",
"description": "string",
}],
"ip_filter_strings": ["string"],
"migrate_sstableloader": False,
"private_access": {
"prometheus": False,
},
"project_to_fork_from": "string",
"public_access": {
"prometheus": False,
},
"service_log": False,
"service_to_fork_from": "string",
"service_to_join_with": "string",
"static_ips": False,
},
project_vpc_id="string",
service_integrations=[{
"integration_type": "string",
"source_service_name": "string",
}],
cassandra={
"uris": ["string"],
},
static_ips=["string"],
tags=[{
"key": "string",
"value": "string",
}],
tech_emails=[{
"email": "string",
}],
termination_protection=False)
const cassandraResource = new aiven.Cassandra("cassandraResource", {
plan: "string",
serviceName: "string",
project: "string",
additionalDiskSpace: "string",
maintenanceWindowDow: "string",
maintenanceWindowTime: "string",
cloudName: "string",
cassandraUserConfig: {
additionalBackupRegions: "string",
backupHour: 0,
backupMinute: 0,
cassandra: {
batchSizeFailThresholdInKb: 0,
batchSizeWarnThresholdInKb: 0,
datacenter: "string",
readRequestTimeoutInMs: 0,
writeRequestTimeoutInMs: 0,
},
cassandraVersion: "string",
ipFilterObjects: [{
network: "string",
description: "string",
}],
ipFilterStrings: ["string"],
migrateSstableloader: false,
privateAccess: {
prometheus: false,
},
projectToForkFrom: "string",
publicAccess: {
prometheus: false,
},
serviceLog: false,
serviceToForkFrom: "string",
serviceToJoinWith: "string",
staticIps: false,
},
projectVpcId: "string",
serviceIntegrations: [{
integrationType: "string",
sourceServiceName: "string",
}],
cassandra: {
uris: ["string"],
},
staticIps: ["string"],
tags: [{
key: "string",
value: "string",
}],
techEmails: [{
email: "string",
}],
terminationProtection: false,
});
type: aiven:Cassandra
properties:
additionalDiskSpace: string
cassandra:
uris:
- string
cassandraUserConfig:
additionalBackupRegions: string
backupHour: 0
backupMinute: 0
cassandra:
batchSizeFailThresholdInKb: 0
batchSizeWarnThresholdInKb: 0
datacenter: string
readRequestTimeoutInMs: 0
writeRequestTimeoutInMs: 0
cassandraVersion: string
ipFilterObjects:
- description: string
network: string
ipFilterStrings:
- string
migrateSstableloader: false
privateAccess:
prometheus: false
projectToForkFrom: string
publicAccess:
prometheus: false
serviceLog: false
serviceToForkFrom: string
serviceToJoinWith: string
staticIps: false
cloudName: string
maintenanceWindowDow: string
maintenanceWindowTime: string
plan: string
project: string
projectVpcId: string
serviceIntegrations:
- integrationType: string
sourceServiceName: string
serviceName: string
staticIps:
- string
tags:
- key: string
value: string
techEmails:
- email: string
terminationProtection: false
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
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The Cassandra resource accepts the following input properties:
- 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
andpremium-x
wherex
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 seen 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.
- Service
Name 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.
- Additional
Disk stringSpace - Add disk storage in increments of 30 GiB to scale your service. The maximum value depends on the service type and cloud provider. Removing additional storage causes the service nodes to go through a rolling restart and there might be a short downtime for services with no HA capabilities.
- Cassandra
Server CassandraCassandra - Values provided by the Cassandra server.
- Cassandra
User CassandraConfig Cassandra User Config - Cassandra user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
- Cloud
Name 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. - Disk
Space 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.
- Maintenance
Window stringDow - Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
- Maintenance
Window stringTime - Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
- Project
Vpc stringId - 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 List<CassandraService Integration> - Service integrations to specify when creating a service. Not applied after initial service creation
- Static
Ips 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
- List<Cassandra
Tag> - Tags are key-value pairs that allow you to categorize services.
- Tech
Emails List<CassandraTech Email> - 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.
- 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
andpremium-x
wherex
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 seen 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.
- Service
Name 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.
- Additional
Disk stringSpace - Add disk storage in increments of 30 GiB to scale your service. The maximum value depends on the service type and cloud provider. Removing additional storage causes the service nodes to go through a rolling restart and there might be a short downtime for services with no HA capabilities.
- Cassandra
Cassandra
Cassandra Args - Values provided by the Cassandra server.
- Cassandra
User CassandraConfig Cassandra User Config Args - Cassandra user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
- Cloud
Name 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. - Disk
Space 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.
- Maintenance
Window stringDow - Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
- Maintenance
Window stringTime - Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
- Project
Vpc stringId - 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 []CassandraService Integration Args - Service integrations to specify when creating a service. Not applied after initial service creation
- Static
Ips []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
- []Cassandra
Tag Args - Tags are key-value pairs that allow you to categorize services.
- Tech
Emails []CassandraTech Email Args - 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.
- 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
andpremium-x
wherex
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 seen 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.
- service
Name 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.
- additional
Disk StringSpace - Add disk storage in increments of 30 GiB to scale your service. The maximum value depends on the service type and cloud provider. Removing additional storage causes the service nodes to go through a rolling restart and there might be a short downtime for services with no HA capabilities.
- cassandra
Cassandra
Cassandra - Values provided by the Cassandra server.
- cassandra
User CassandraConfig Cassandra User Config - Cassandra user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
- cloud
Name 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. - disk
Space 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.
- maintenance
Window StringDow - Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
- maintenance
Window StringTime - Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
- project
Vpc StringId - 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 List<CassandraService Integration> - Service integrations to specify when creating a service. Not applied after initial service creation
- static
Ips 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
- List<Cassandra
Tag> - Tags are key-value pairs that allow you to categorize services.
- tech
Emails List<CassandraTech Email> - 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 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.
- 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
andpremium-x
wherex
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 seen 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.
- service
Name 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.
- additional
Disk stringSpace - Add disk storage in increments of 30 GiB to scale your service. The maximum value depends on the service type and cloud provider. Removing additional storage causes the service nodes to go through a rolling restart and there might be a short downtime for services with no HA capabilities.
- cassandra
Cassandra
Cassandra - Values provided by the Cassandra server.
- cassandra
User CassandraConfig Cassandra User Config - Cassandra user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
- cloud
Name 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. - disk
Space 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.
- maintenance
Window stringDow - Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
- maintenance
Window stringTime - Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
- project
Vpc stringId - 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 CassandraService Integration[] - Service integrations to specify when creating a service. Not applied after initial service creation
- static
Ips 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
- Cassandra
Tag[] - Tags are key-value pairs that allow you to categorize services.
- tech
Emails CassandraTech Email[] - 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 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.
- 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
andpremium-x
wherex
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 seen 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.
- 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_ strspace - Add disk storage in increments of 30 GiB to scale your service. The maximum value depends on the service type and cloud provider. Removing additional storage causes the service nodes to go through a rolling restart and there might be a short downtime for services with no HA capabilities.
- cassandra
Cassandra
Cassandra Args - Values provided by the Cassandra server.
- cassandra_
user_ Cassandraconfig Cassandra User Config Args - Cassandra user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
- 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_ strdow - Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
- maintenance_
window_ strtime - Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
- project_
vpc_ strid - 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[CassandraService Integration Args] - 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
- Sequence[Cassandra
Tag Args] - Tags are key-value pairs that allow you to categorize services.
- tech_
emails Sequence[CassandraTech Email Args] - 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.
- 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
andpremium-x
wherex
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 seen 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.
- service
Name 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.
- additional
Disk StringSpace - Add disk storage in increments of 30 GiB to scale your service. The maximum value depends on the service type and cloud provider. Removing additional storage causes the service nodes to go through a rolling restart and there might be a short downtime for services with no HA capabilities.
- cassandra Property Map
- Values provided by the Cassandra server.
- cassandra
User Property MapConfig - Cassandra user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
- cloud
Name 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. - disk
Space 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.
- maintenance
Window StringDow - Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
- maintenance
Window StringTime - Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
- project
Vpc StringId - 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 List<Property Map> - Service integrations to specify when creating a service. Not applied after initial service creation
- static
Ips 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
- List<Property Map>
- Tags are key-value pairs that allow you to categorize services.
- tech
Emails 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.
- termination
Protection 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:
- Components
List<Cassandra
Component> - Service component information objects
- Disk
Space stringCap - The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
- Disk
Space stringDefault - 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 stringStep - 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 fromdisk_space_default
by increments of this size. - Disk
Space stringUsed - Disk space that service is currently using
- Id string
- The provider-assigned unique ID for this managed resource.
- Service
Host string - The hostname of the service.
- Service
Password string - Password used for connecting to the service, if applicable
- Service
Port int - The port of the service
- Service
Type string - Aiven internal service type code
- Service
Uri string - URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
- Service
Username string - Username used for connecting to the service, if applicable
- State string
- Service state. One of
POWEROFF
,REBALANCING
,REBUILDING
orRUNNING
- Components
[]Cassandra
Component - Service component information objects
- Disk
Space stringCap - The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
- Disk
Space stringDefault - 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 stringStep - 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 fromdisk_space_default
by increments of this size. - Disk
Space stringUsed - Disk space that service is currently using
- Id string
- The provider-assigned unique ID for this managed resource.
- Service
Host string - The hostname of the service.
- Service
Password string - Password used for connecting to the service, if applicable
- Service
Port int - The port of the service
- Service
Type string - Aiven internal service type code
- Service
Uri string - URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
- Service
Username string - Username used for connecting to the service, if applicable
- State string
- Service state. One of
POWEROFF
,REBALANCING
,REBUILDING
orRUNNING
- components
List<Cassandra
Component> - Service component information objects
- disk
Space StringCap - The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
- disk
Space StringDefault - 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 StringStep - 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 fromdisk_space_default
by increments of this size. - disk
Space StringUsed - Disk space that service is currently using
- id String
- The provider-assigned unique ID for this managed resource.
- service
Host String - The hostname of the service.
- service
Password String - Password used for connecting to the service, if applicable
- service
Port Integer - The port of the service
- service
Type String - Aiven internal service type code
- service
Uri String - URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
- service
Username String - Username used for connecting to the service, if applicable
- state String
- Service state. One of
POWEROFF
,REBALANCING
,REBUILDING
orRUNNING
- components
Cassandra
Component[] - Service component information objects
- disk
Space stringCap - The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
- disk
Space stringDefault - 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 stringStep - 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 fromdisk_space_default
by increments of this size. - disk
Space stringUsed - Disk space that service is currently using
- id string
- The provider-assigned unique ID for this managed resource.
- service
Host string - The hostname of the service.
- service
Password string - Password used for connecting to the service, if applicable
- service
Port number - The port of the service
- service
Type string - Aiven internal service type code
- service
Uri string - URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
- service
Username string - Username used for connecting to the service, if applicable
- state string
- Service state. One of
POWEROFF
,REBALANCING
,REBUILDING
orRUNNING
- components
Sequence[Cassandra
Component] - Service component information objects
- disk_
space_ strcap - The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
- disk_
space_ strdefault - 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_ strstep - 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 fromdisk_space_default
by increments of this size. - disk_
space_ strused - 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
orRUNNING
- components List<Property Map>
- Service component information objects
- disk
Space StringCap - The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
- disk
Space StringDefault - 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 StringStep - 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 fromdisk_space_default
by increments of this size. - disk
Space StringUsed - Disk space that service is currently using
- id String
- The provider-assigned unique ID for this managed resource.
- service
Host String - The hostname of the service.
- service
Password String - Password used for connecting to the service, if applicable
- service
Port Number - The port of the service
- service
Type String - Aiven internal service type code
- service
Uri String - URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
- service
Username String - Username used for connecting to the service, if applicable
- state String
- Service state. One of
POWEROFF
,REBALANCING
,REBUILDING
orRUNNING
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: Optional[CassandraCassandraArgs] = None,
cassandra_user_config: Optional[CassandraCassandraUserConfigArgs] = 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,
tech_emails: Optional[Sequence[CassandraTechEmailArgs]] = 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.
- Additional
Disk stringSpace - Add disk storage in increments of 30 GiB to scale your service. The maximum value depends on the service type and cloud provider. Removing additional storage causes the service nodes to go through a rolling restart and there might be a short downtime for services with no HA capabilities.
- Cassandra
Server CassandraCassandra - Values provided by the Cassandra server.
- Cassandra
User CassandraConfig Cassandra User Config - Cassandra user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
- Cloud
Name 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<Cassandra
Component> - Service component information objects
- Disk
Space 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.
- Disk
Space stringCap - The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
- Disk
Space stringDefault - 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 stringStep - 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 fromdisk_space_default
by increments of this size. - Disk
Space stringUsed - Disk space that service is currently using
- Maintenance
Window stringDow - Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
- Maintenance
Window stringTime - 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
andpremium-x
wherex
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 seen 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.
- Project
Vpc stringId - 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 string - The hostname of the service.
- Service
Integrations List<CassandraService Integration> - Service integrations to specify when creating a service. Not applied after initial service creation
- Service
Name 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.
- Service
Password string - Password used for connecting to the service, if applicable
- Service
Port int - The port of the service
- Service
Type string - Aiven internal service type code
- Service
Uri string - URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
- Service
Username string - Username used for connecting to the service, if applicable
- State string
- Service state. One of
POWEROFF
,REBALANCING
,REBUILDING
orRUNNING
- Static
Ips 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
- List<Cassandra
Tag> - Tags are key-value pairs that allow you to categorize services.
- Tech
Emails List<CassandraTech Email> - 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.
- Additional
Disk stringSpace - Add disk storage in increments of 30 GiB to scale your service. The maximum value depends on the service type and cloud provider. Removing additional storage causes the service nodes to go through a rolling restart and there might be a short downtime for services with no HA capabilities.
- Cassandra
Cassandra
Cassandra Args - Values provided by the Cassandra server.
- Cassandra
User CassandraConfig Cassandra User Config Args - Cassandra user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
- Cloud
Name 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
[]Cassandra
Component Args - Service component information objects
- Disk
Space 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.
- Disk
Space stringCap - The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
- Disk
Space stringDefault - 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 stringStep - 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 fromdisk_space_default
by increments of this size. - Disk
Space stringUsed - Disk space that service is currently using
- Maintenance
Window stringDow - Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
- Maintenance
Window stringTime - 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
andpremium-x
wherex
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 seen 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.
- Project
Vpc stringId - 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 string - The hostname of the service.
- Service
Integrations []CassandraService Integration Args - Service integrations to specify when creating a service. Not applied after initial service creation
- Service
Name 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.
- Service
Password string - Password used for connecting to the service, if applicable
- Service
Port int - The port of the service
- Service
Type string - Aiven internal service type code
- Service
Uri string - URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
- Service
Username string - Username used for connecting to the service, if applicable
- State string
- Service state. One of
POWEROFF
,REBALANCING
,REBUILDING
orRUNNING
- Static
Ips []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
- []Cassandra
Tag Args - Tags are key-value pairs that allow you to categorize services.
- Tech
Emails []CassandraTech Email Args - 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.
- additional
Disk StringSpace - Add disk storage in increments of 30 GiB to scale your service. The maximum value depends on the service type and cloud provider. Removing additional storage causes the service nodes to go through a rolling restart and there might be a short downtime for services with no HA capabilities.
- cassandra
Cassandra
Cassandra - Values provided by the Cassandra server.
- cassandra
User CassandraConfig Cassandra User Config - Cassandra user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
- cloud
Name 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<Cassandra
Component> - Service component information objects
- disk
Space 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.
- disk
Space StringCap - The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
- disk
Space StringDefault - 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 StringStep - 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 fromdisk_space_default
by increments of this size. - disk
Space StringUsed - Disk space that service is currently using
- maintenance
Window StringDow - Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
- maintenance
Window StringTime - 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
andpremium-x
wherex
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 seen 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.
- project
Vpc StringId - 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 String - The hostname of the service.
- service
Integrations List<CassandraService Integration> - Service integrations to specify when creating a service. Not applied after initial service creation
- service
Name 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.
- service
Password String - Password used for connecting to the service, if applicable
- service
Port Integer - The port of the service
- service
Type String - Aiven internal service type code
- service
Uri String - URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
- service
Username String - Username used for connecting to the service, if applicable
- state String
- Service state. One of
POWEROFF
,REBALANCING
,REBUILDING
orRUNNING
- static
Ips 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
- List<Cassandra
Tag> - Tags are key-value pairs that allow you to categorize services.
- tech
Emails List<CassandraTech Email> - 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 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 stringSpace - Add disk storage in increments of 30 GiB to scale your service. The maximum value depends on the service type and cloud provider. Removing additional storage causes the service nodes to go through a rolling restart and there might be a short downtime for services with no HA capabilities.
- cassandra
Cassandra
Cassandra - Values provided by the Cassandra server.
- cassandra
User CassandraConfig Cassandra User Config - Cassandra user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
- cloud
Name 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
Cassandra
Component[] - Service component information objects
- disk
Space 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.
- disk
Space stringCap - The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
- disk
Space stringDefault - 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 stringStep - 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 fromdisk_space_default
by increments of this size. - disk
Space stringUsed - Disk space that service is currently using
- maintenance
Window stringDow - Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
- maintenance
Window stringTime - 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
andpremium-x
wherex
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 seen 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.
- project
Vpc stringId - 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 string - The hostname of the service.
- service
Integrations CassandraService Integration[] - Service integrations to specify when creating a service. Not applied after initial service creation
- service
Name 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.
- service
Password string - Password used for connecting to the service, if applicable
- service
Port number - The port of the service
- service
Type string - Aiven internal service type code
- service
Uri string - URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
- service
Username string - Username used for connecting to the service, if applicable
- state string
- Service state. One of
POWEROFF
,REBALANCING
,REBUILDING
orRUNNING
- static
Ips 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
- Cassandra
Tag[] - Tags are key-value pairs that allow you to categorize services.
- tech
Emails CassandraTech Email[] - 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 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_ strspace - Add disk storage in increments of 30 GiB to scale your service. The maximum value depends on the service type and cloud provider. Removing additional storage causes the service nodes to go through a rolling restart and there might be a short downtime for services with no HA capabilities.
- cassandra
Cassandra
Cassandra Args - Values provided by the Cassandra server.
- cassandra_
user_ Cassandraconfig Cassandra User Config Args - Cassandra user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
- 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[Cassandra
Component Args] - 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_ strcap - The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
- disk_
space_ strdefault - 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_ strstep - 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 fromdisk_space_default
by increments of this size. - disk_
space_ strused - Disk space that service is currently using
- maintenance_
window_ strdow - Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
- maintenance_
window_ strtime - 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
andpremium-x
wherex
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 seen 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_ strid - 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[CassandraService Integration Args] - 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
orRUNNING
- 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
- Sequence[Cassandra
Tag Args] - Tags are key-value pairs that allow you to categorize services.
- tech_
emails Sequence[CassandraTech Email Args] - 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.
- additional
Disk StringSpace - Add disk storage in increments of 30 GiB to scale your service. The maximum value depends on the service type and cloud provider. Removing additional storage causes the service nodes to go through a rolling restart and there might be a short downtime for services with no HA capabilities.
- cassandra Property Map
- Values provided by the Cassandra server.
- cassandra
User Property MapConfig - Cassandra user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
- cloud
Name 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
- disk
Space 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.
- disk
Space StringCap - The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
- disk
Space StringDefault - 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 StringStep - 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 fromdisk_space_default
by increments of this size. - disk
Space StringUsed - Disk space that service is currently using
- maintenance
Window StringDow - Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
- maintenance
Window StringTime - 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
andpremium-x
wherex
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 seen 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.
- project
Vpc StringId - 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 String - The hostname of the service.
- service
Integrations List<Property Map> - Service integrations to specify when creating a service. Not applied after initial service creation
- service
Name 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.
- service
Password String - Password used for connecting to the service, if applicable
- service
Port Number - The port of the service
- service
Type String - Aiven internal service type code
- service
Uri String - URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
- service
Username String - Username used for connecting to the service, if applicable
- state String
- Service state. One of
POWEROFF
,REBALANCING
,REBUILDING
orRUNNING
- static
Ips 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
- List<Property Map>
- Tags are key-value pairs that allow you to categorize services.
- tech
Emails 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.
- termination
Protection 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
CassandraCassandra, CassandraCassandraArgs
- 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.
CassandraCassandraUserConfig, CassandraCassandraUserConfigArgs
- Additional
Backup stringRegions - Additional Cloud Regions for Backup Replication.
- 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
Cassandra
Cassandra User Config Cassandra - Cassandra configuration values
- Cassandra
Version string - Enum:
3
,4
,4.1
, and newer. Cassandra version. - Ip
Filter List<CassandraObjects Cassandra User Config Ip Filter Object> - Allow incoming connections from CIDR address block, e.g.
10.20.0.0/16
- Ip
Filter List<string>Strings - Allow incoming connections from CIDR address block, e.g.
10.20.0.0/16
. - Ip
Filters List<string> - Allow incoming connections from CIDR address block, e.g.
10.20.0.0/16
. - 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 CassandraCassandra User Config Private Access - Allow access to selected service ports from private networks
- Project
To stringFork From - Name of another project to fork a service from. This has effect only when a new service is being created. Example:
anotherprojectname
. - Public
Access CassandraCassandra User Config Public Access - 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 stringFork From - Name of another service to fork from. This has effect only when a new service is being created. Example:
anotherservicename
. - Service
To stringJoin With - 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.
- Additional
Backup stringRegions - Additional Cloud Regions for Backup Replication.
- 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
Cassandra
Cassandra User Config Cassandra - Cassandra configuration values
- Cassandra
Version string - Enum:
3
,4
,4.1
, and newer. Cassandra version. - Ip
Filter []CassandraObjects Cassandra User Config Ip Filter Object - Allow incoming connections from CIDR address block, e.g.
10.20.0.0/16
- Ip
Filter []stringStrings - Allow incoming connections from CIDR address block, e.g.
10.20.0.0/16
. - Ip
Filters []string - Allow incoming connections from CIDR address block, e.g.
10.20.0.0/16
. - 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 CassandraCassandra User Config Private Access - Allow access to selected service ports from private networks
- Project
To stringFork From - Name of another project to fork a service from. This has effect only when a new service is being created. Example:
anotherprojectname
. - Public
Access CassandraCassandra User Config Public Access - 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 stringFork From - Name of another service to fork from. This has effect only when a new service is being created. Example:
anotherservicename
. - Service
To stringJoin With - 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.
- additional
Backup StringRegions - Additional Cloud Regions for Backup Replication.
- backup
Hour 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
. - backup
Minute 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
Cassandra
Cassandra User Config Cassandra - Cassandra configuration values
- cassandra
Version String - Enum:
3
,4
,4.1
, and newer. Cassandra version. - ip
Filter List<CassandraObjects Cassandra User Config Ip Filter Object> - Allow incoming connections from CIDR address block, e.g.
10.20.0.0/16
- ip
Filter List<String>Strings - Allow incoming connections from CIDR address block, e.g.
10.20.0.0/16
. - ip
Filters List<String> - Allow incoming connections from CIDR address block, e.g.
10.20.0.0/16
. - migrate
Sstableloader Boolean - 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 CassandraCassandra User Config Private Access - Allow access to selected service ports from private networks
- project
To StringFork From - Name of another project to fork a service from. This has effect only when a new service is being created. Example:
anotherprojectname
. - public
Access CassandraCassandra User Config Public Access - Allow access to selected service ports from the public Internet
- service
Log Boolean - Store logs for the service so that they are available in the HTTP API and console.
- service
To StringFork From - Name of another service to fork from. This has effect only when a new service is being created. Example:
anotherservicename
. - service
To StringJoin With - 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 Boolean - Use static public IP addresses.
- additional
Backup stringRegions - Additional Cloud Regions for Backup Replication.
- backup
Hour 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
. - backup
Minute 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
Cassandra
Cassandra User Config Cassandra - Cassandra configuration values
- cassandra
Version string - Enum:
3
,4
,4.1
, and newer. Cassandra version. - ip
Filter CassandraObjects Cassandra User Config Ip Filter Object[] - Allow incoming connections from CIDR address block, e.g.
10.20.0.0/16
- ip
Filter string[]Strings - Allow incoming connections from CIDR address block, e.g.
10.20.0.0/16
. - ip
Filters string[] - Allow incoming connections from CIDR address block, e.g.
10.20.0.0/16
. - migrate
Sstableloader boolean - 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 CassandraCassandra User Config Private Access - Allow access to selected service ports from private networks
- project
To stringFork From - Name of another project to fork a service from. This has effect only when a new service is being created. Example:
anotherprojectname
. - public
Access CassandraCassandra User Config Public Access - Allow access to selected service ports from the public Internet
- service
Log boolean - Store logs for the service so that they are available in the HTTP API and console.
- service
To stringFork From - Name of another service to fork from. This has effect only when a new service is being created. Example:
anotherservicename
. - service
To stringJoin With - 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 boolean - Use static public IP addresses.
- additional_
backup_ strregions - Additional Cloud Regions for Backup Replication.
- 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
Cassandra
Cassandra User Config Cassandra - Cassandra configuration values
- cassandra_
version str - Enum:
3
,4
,4.1
, and newer. Cassandra version. - ip_
filter_ Sequence[Cassandraobjects Cassandra User Config Ip Filter Object] - Allow incoming connections from CIDR address block, e.g.
10.20.0.0/16
- ip_
filter_ Sequence[str]strings - 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
. - 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 CassandraCassandra User Config Private Access - Allow access to selected service ports from private networks
- project_
to_ strfork_ from - Name of another project to fork a service from. This has effect only when a new service is being created. Example:
anotherprojectname
. - public_
access CassandraCassandra User Config Public Access - 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_ strfork_ from - Name of another service to fork from. This has effect only when a new service is being created. Example:
anotherservicename
. - service_
to_ strjoin_ with - 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.
- additional
Backup StringRegions - Additional Cloud Regions for Backup Replication.
- backup
Hour 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
. - backup
Minute 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
- cassandra
Version String - Enum:
3
,4
,4.1
, and newer. Cassandra version. - ip
Filter List<Property Map>Objects - Allow incoming connections from CIDR address block, e.g.
10.20.0.0/16
- ip
Filter List<String>Strings - Allow incoming connections from CIDR address block, e.g.
10.20.0.0/16
. - ip
Filters List<String> - Allow incoming connections from CIDR address block, e.g.
10.20.0.0/16
. - migrate
Sstableloader Boolean - 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 Property Map - Allow access to selected service ports from private networks
- project
To StringFork From - Name of another project to fork a service from. This has effect only when a new service is being created. Example:
anotherprojectname
. - public
Access Property Map - Allow access to selected service ports from the public Internet
- service
Log Boolean - Store logs for the service so that they are available in the HTTP API and console.
- service
To StringFork From - Name of another service to fork from. This has effect only when a new service is being created. Example:
anotherservicename
. - service
To StringJoin With - 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 Boolean - Use static public IP addresses.
CassandraCassandraUserConfigCassandra, CassandraCassandraUserConfigCassandraArgs
- Batch
Size intFail Threshold In Kb - Fail any multiple-partition batch exceeding this value. 50kb (10x warn threshold) by default. Example:
50
. - Batch
Size intWarn Threshold In Kb - 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
. - Read
Request intTimeout In Ms - How long the coordinator waits for read operations to complete before timing it out. 5 seconds by default. Example:
5000
. - Write
Request intTimeout In Ms - How long the coordinator waits for write requests to complete with at least one node in the local datacenter. 2 seconds by default. Example:
2000
.
- Batch
Size intFail Threshold In Kb - Fail any multiple-partition batch exceeding this value. 50kb (10x warn threshold) by default. Example:
50
. - Batch
Size intWarn Threshold In Kb - 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
. - Read
Request intTimeout In Ms - How long the coordinator waits for read operations to complete before timing it out. 5 seconds by default. Example:
5000
. - Write
Request intTimeout In Ms - How long the coordinator waits for write requests to complete with at least one node in the local datacenter. 2 seconds by default. Example:
2000
.
- batch
Size IntegerFail Threshold In Kb - Fail any multiple-partition batch exceeding this value. 50kb (10x warn threshold) by default. Example:
50
. - batch
Size IntegerWarn Threshold In Kb - 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
. - read
Request IntegerTimeout In Ms - How long the coordinator waits for read operations to complete before timing it out. 5 seconds by default. Example:
5000
. - write
Request IntegerTimeout In Ms - How long the coordinator waits for write requests to complete with at least one node in the local datacenter. 2 seconds by default. Example:
2000
.
- batch
Size numberFail Threshold In Kb - Fail any multiple-partition batch exceeding this value. 50kb (10x warn threshold) by default. Example:
50
. - batch
Size numberWarn Threshold In Kb - 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
. - read
Request numberTimeout In Ms - How long the coordinator waits for read operations to complete before timing it out. 5 seconds by default. Example:
5000
. - write
Request numberTimeout In Ms - How long the coordinator waits for write requests to complete with at least one node in the local datacenter. 2 seconds by default. Example:
2000
.
- batch_
size_ intfail_ threshold_ in_ kb - Fail any multiple-partition batch exceeding this value. 50kb (10x warn threshold) by default. Example:
50
. - batch_
size_ intwarn_ threshold_ in_ kb - 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
. - read_
request_ inttimeout_ in_ ms - How long the coordinator waits for read operations to complete before timing it out. 5 seconds by default. Example:
5000
. - write_
request_ inttimeout_ in_ ms - How long the coordinator waits for write requests to complete with at least one node in the local datacenter. 2 seconds by default. Example:
2000
.
- batch
Size NumberFail Threshold In Kb - Fail any multiple-partition batch exceeding this value. 50kb (10x warn threshold) by default. Example:
50
. - batch
Size NumberWarn Threshold In Kb - 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
. - read
Request NumberTimeout In Ms - How long the coordinator waits for read operations to complete before timing it out. 5 seconds by default. Example:
5000
. - write
Request NumberTimeout In Ms - How long the coordinator waits for write requests to complete with at least one node in the local datacenter. 2 seconds by default. Example:
2000
.
CassandraCassandraUserConfigIpFilterObject, CassandraCassandraUserConfigIpFilterObjectArgs
- 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
.
CassandraCassandraUserConfigPrivateAccess, CassandraCassandraUserConfigPrivateAccessArgs
- 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.
CassandraCassandraUserConfigPublicAccess, CassandraCassandraUserConfigPublicAccessArgs
- 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.
CassandraComponent, CassandraComponentArgs
- Component string
- Service component name
- Connection
Uri 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
- Kafka
Authentication stringMethod - 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
- Connection
Uri 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
- Kafka
Authentication stringMethod - 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
- connection
Uri 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
- kafka
Authentication StringMethod - 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
- connection
Uri 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
- kafka
Authentication stringMethod - 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_ strmethod - 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
- connection
Uri 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
- kafka
Authentication StringMethod - 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
CassandraServiceIntegration, CassandraServiceIntegrationArgs
- Integration
Type string - Type of the service integration. The only supported value at the moment is
read_replica
- Source
Service stringName - Name of the source service
- Integration
Type string - Type of the service integration. The only supported value at the moment is
read_replica
- Source
Service stringName - Name of the source service
- integration
Type String - Type of the service integration. The only supported value at the moment is
read_replica
- source
Service StringName - Name of the source service
- integration
Type string - Type of the service integration. The only supported value at the moment is
read_replica
- source
Service stringName - 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_ strname - Name of the source service
- integration
Type String - Type of the service integration. The only supported value at the moment is
read_replica
- source
Service StringName - Name of the source service
CassandraTag, CassandraTagArgs
CassandraTechEmail, CassandraTechEmailArgs
- 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
Import
$ pulumi import aiven:index/cassandra:Cassandra example_cassandra PROJECT/SERVICE_NAME
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Aiven pulumi/pulumi-aiven
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
aiven
Terraform Provider.