CfnTypeProps

class aws_cdk.aws_cassandra.CfnTypeProps(*, fields, keyspace_name, type_name)

Bases: object

Properties for defining a CfnType.

Parameters:
  • fields (Union[IResolvable, Sequence[Union[IResolvable, FieldProperty, Dict[str, Any]]]]) – A list of fields that define this type.

  • keyspace_name (str) – The name of the keyspace to create the type in. The keyspace must already exist.

  • type_name (str) – 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. For more information, see Create a user-defined type (UDT) in Amazon Keyspaces in the Amazon Keyspaces Developer Guide .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cassandra-type.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_cassandra as cassandra

cfn_type_props = cassandra.CfnTypeProps(
    fields=[cassandra.CfnType.FieldProperty(
        field_name="fieldName",
        field_type="fieldType"
    )],
    keyspace_name="keyspaceName",
    type_name="typeName"
)

Attributes

fields

A list of fields that define this type.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cassandra-type.html#cfn-cassandra-type-fields

keyspace_name

The name of the keyspace to create the type in.

The keyspace must already exist.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cassandra-type.html#cfn-cassandra-type-keyspacename

type_name

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. For more information, see Create a user-defined type (UDT) in Amazon Keyspaces in the Amazon Keyspaces Developer Guide .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cassandra-type.html#cfn-cassandra-type-typename