Amazon Managed Apache Cassandra Service / Keyspaces

[markvdlaan93]

Community Note

• Please vote on this issue by adding a 👍 reaction to the original issue to help the community and maintainers prioritize this request
• Please do not leave "+1" or "me too" comments, they generate extra noise for issue followers and do not help prioritize the request
• If you are interested in working on this issue or have submitted a pull request, please leave a comment

Description

Since one week, AWS released Managed Apache Cassandra service in a couple of regions: https://aws.amazon.com/mcs/. Obviously, I can't find anything in the Terraform docs, so I'm assuming that this still needs to be implemented. If this is the case, I would like to contribute. Please have a look at the potential Terraform configuration below.

New or Affected Resource(s)

I'm not sure which existing resources are affected by this but new resources could be named:

• aws_mcs_keyspace
• aws_mcs_table

Potential Terraform Configuration

"aws_mcs_keyspace" "example" {
     name = "mcs-keyspace-example"
     exists = "true"
     region = "eu-north-1"
     replication {
         class = "SingleRegionStrategy"
     }
}

"aws_mcs_table" "example" {
   name = "mcs-table-example"
   keyspace_arn = "${aws_mcs_keyspace.example.arn}"
   exists = "true"
   fields {
       columns {
            name = "name",
            type = "text",
       }
       columns {
            name = "email",
            type = "text",
       }
   }
   primary_key = ["email", "name"]
   # clustering key?
}

References

• https://aws.amazon.com/blogs/aws/new-amazon-managed-apache-cassandra-service-mcs/
• https://aws.amazon.com/mcs/pricing/

[bflad]

Hi @markvdlaan93 👋 Thank you for submitting this.

At this current time, AWS has not released an API or SDK for this new service:

• https://docs.aws.amazon.com/mcs/latest/devguide/what-is-mcs.html
• https://docs.aws.amazon.com/sdk-for-go/api/

Without these, we cannot implement support for this AWS service in Terraform. Please reach out to AWS Support or your account managers to ask about API support.

[ansha1]

Hi Everyone !
I am also looking for terraform documentation for setting up mcs. Please let us know if we have any
Thanks,
Anurag

[ewbankkit]

Amazon Keyspaces (for Apache Cassandra) is now generally available:

• Announcement
• Blog post

No support in the AWS SDK yet though.

[kvaidas]

It appears some sort of integration with an IAM user might be necessary since that's where one would create a Cassandra credential that's used by clients to connect.

[codingconcepts]

Hey all,

I was battling with this today and wanted to share my solution in case it's helpful for anyone else. I ended up using CloudFormation via Terraform as follows to create a keyspace and a table:

main.tf

provider "aws" {
  region = "eu-central-1"
  version = "~> 3.0"
}

resource "aws_cloudformation_stack" "keyspaces" {
  name = "my-keyspace"

  template_body = file("./keyspace.yaml")
}

keyspace.yaml

AWSTemplateFormatVersion: 2010-09-09
Resources:
  MyKeyspace:
    Type: AWS::Cassandra::Keyspace
    Properties:
      KeyspaceName: abc
  
  MyTable:
    Type: AWS::Cassandra::Table
    DependsOn: MyKeyspace
    Properties:
      KeyspaceName: abc
      TableName: my_table
      PartitionKeyColumns:
        - ColumnName: id
          ColumnType: TEXT
      BillingMode:
        Mode: ON_DEMAND

NOTE: Column changes aren't currently supported by CloudFormation, so once your table has been created, you can't change it with Terraform/CloudFormation.

[trajano]

Amazon renamed MCS to Keyspaces. https://ca-central-1.console.aws.amazon.com/keyspaces/home we should use that name instead and change the title of the bug accordingly so people can find it more easily.

[FrailWords]

Another workaround is to use a JSON template -

{
  "Resources": {
    "Keyspace1": {
      "Type": "AWS::Cassandra::Keyspace",
      "Properties": {
        "KeyspaceName": "${keyspaces_name}"
      }
    },
    %{ for table in tables ~}
    "table${table.index}": {
      "Type": "AWS::Cassandra::Table",
      "Properties": {
        "KeyspaceName": {
          "Ref": "Keyspace1"
        },
        "TableName": "${table.name}",
        "RegularColumns": [
          %{ for regular_column in table.regular_columns ~}
          {
            "ColumnName": "${regular_column.name}",
            "ColumnType": "${regular_column.type}"
          },
          %{ endfor ~}
        ],
        "PartitionKeyColumns": [
          %{ for partition_key_column in table.partition_key_columns ~}
          {
            "ColumnName": "${partition_key_column.name}",
            "ColumnType": "${partition_key_column.type}"
          },
          %{ endfor ~}
        ],
        "ClusteringKeyColumns": [
          %{ for clustering_key_column in table.clustering_key_columns ~}
          {
            "Column": {
              "ColumnName": "${clustering_key_column.name}",
              "ColumnType": "${clustering_key_column.type}"
            },
            "OrderBy":"%{ if clustering_key_column.order_by != "" }${clustering_key_column.order_by}%{ else }"ASC"%{ endif }"
          },
          %{ endfor ~}
        ],
        "BillingMode":{
          "Mode":"%{ if table.billing.mode != "" }${table.billing.mode}%{ else }"ON_DEMAND"%{ endif }"
          %{ if table.billing.mode == "PROVISIONED" }
          , "ProvisionedThroughput":{
            "ReadCapacityUnits":${table.billing.read_capacity_units},
            "WriteCapacityUnits":${table.billing.write_capacity_units}
          }
          %{ endif }
        }, "Tags": [
          %{ for tag in table.tags ~}
          {
            "Key": "${tag.key}",
            "Value": "${tag.value}"
          },
          %{ endfor ~}
        ],
        "PointInTimeRecoveryEnabled": ${table.point_in_time_recovery}
      }
    }
    %{ endfor ~}
  }
}

and use an input to the templatefile function from terraform with an input like -

{
  "keyspaces_name": "k12",
  "tables": [
    {
      "name": "some_table",
      "index": 1,
      "partition_key_columns": [
        {
          "name": "p_test1",
          "type": "ascii"
        },
        {
          "name": "p_test2",
          "type": "int"
        }
      ],
      "clustering_key_columns": [
        {
          "name": "c_test1",
          "type": "text",
          "order_by": "asc"
        },
        {
          "name": "c_test2",
          "type": "text",
          "order_by": "desc"
        }
      ],
      "regular_columns": [
        {
          "name": "r_test1",
          "type": "set<text>"
        },
        {
          "name": "r_test2",
          "type": "list<int>"
        }
      ],
      "billing": {
        "mode": "PROVISIONED",
        "read_capacity_units": 5,
        "write_capacity_units": 5
      },
      "tags": [
        {
          "key": "tag1",
          "value": "value1"
        },
        {
          "key": "tag2",
          "value": "value2"
        }
      ],
      "point_in_time_recovery": true
    }
  ]
}

[AndreyNovik1993]

What date will it be released?

[daryl-d]

Looks like this can be managed in sdk

https://aws.amazon.com/about-aws/whats-new/2022/03/amazon-keyspaces-automate-resource-management-sdk/

[ewbankkit]

AWS SDK for Go support released in v1.43.10.
Relates #23494.

[roberth-k]

I'll pick this up over the next few weeks.

[saurabh-program]

I'll pick this up over the next few weeks.

Hi @roberth-k. Thanks for picking this up. Even I was planning to work on this. Maybe we can coordinate and work together on this.

[roberth-k]

I'll pick this up over the next few weeks.

Hi @roberth-k. Thanks for picking this up. Even I was planning to work on this. Maybe we can coordinate and work together on this.

Hi @saurabh-program.

I don't think it's likely that we could efficiently work on the same resource at the same time. However, I've just published a PR (#23770) for aws_keyspaces_keyspace, and you're welcome to pick up aws_keyspaces_table if you'd like. Please let me know if that is what you prefer.

[saurabh-program]

Sure. I

I'll pick this up over the next few weeks.

Hi @roberth-k. Thanks for picking this up. Even I was planning to work on this. Maybe we can coordinate and work together on this.

Hi @saurabh-program.

I don't think it's likely that we could efficiently work on the same resource at the same time. However, I've just published a PR (#23770) for aws_keyspaces_keyspace, and you're welcome to pick up aws_keyspaces_table if you'd like. Please let me know if that is what you prefer.

That works. I'll pick up the aws_keyspaces_table resource.

[pranayw333]

Similar: #24265 Adding support for table resource #24351

[breathingdust]

Hi all 👋 Just letting you know that support for the aws_keyspaces_table resource is featured on this quarters roadmap. If a PR exists to close the issue a maintainer will review and either make changes directly, or work with the original author to get the contribution merged. If you have written a PR to resolve the issue please ensure the "Allow edits from maintainers" box is checked. Thanks for your patience and we are looking forward to getting this merged soon!

[github-actions]

I'm going to lock this issue because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues.
If you have found a problem that seems similar to this, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.