Skip to content

Create Type

keyspaces_create_type R Documentation

The CreateType operation creates a new user-defined type in the specified keyspace

Description

The create_type operation creates a new user-defined type in the specified keyspace.

To configure the required permissions, see Permissions to create a UDT in the Amazon Keyspaces Developer Guide.

For more information, see User-defined types (UDTs) in the Amazon Keyspaces Developer Guide.

Usage

keyspaces_create_type(keyspaceName, typeName, fieldDefinitions)

Arguments

keyspaceName

[required] The name of the keyspace.

typeName

[required] The name of the user-defined type.

UDT names must contain 48 characters or less, must begin with an alphabetic character, and can only contain alpha-numeric characters and underscores. Amazon Keyspaces converts upper case characters automatically into lower case characters.

Alternatively, you can declare a UDT name in double quotes. When declaring a UDT name inside double quotes, Amazon Keyspaces preserves upper casing and allows special characters.

You can also use double quotes as part of the name when you create the UDT, but you must escape each double quote character with an additional double quote character.

fieldDefinitions

[required] The field definitions, consisting of names and types, that define this type.

Value

A list with the following syntax: 

list(
  keyspaceArn = "string",
  typeName = "string"
)

Request syntax

svc$create_type(
  keyspaceName = "string",
  typeName = "string",
  fieldDefinitions = list(
    list(
      name = "string",
      type = "string"
    )
  )
)