Package software.amazon.awscdk.services.cassandra

Class CfnType

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.cassandra.CfnType
All Implemented Interfaces:
IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.110.0 (build 336b265)", date="2025-04-17T00:47:00.418Z") @Stability(Stable) public class CfnType extends CfnResource implements IInspectable
The CreateType 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 .

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.cassandra.*;
 CfnType cfnType = CfnType.Builder.create(this, "MyCfnType")
         .fields(List.of(FieldProperty.builder()
                 .fieldName("fieldName")
                 .fieldType("fieldType")
                 .build()))
         .keyspaceName("keyspaceName")
         .typeName("typeName")
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnType

      protected CfnType(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnType

      protected CfnType(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnType

      @Stability(Stable) public CfnType(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnTypeProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrDirectParentTypes

      @Stability(Stable) @NotNull public List<String> getAttrDirectParentTypes()
      A list of user-defined types that use this type.

    • getAttrDirectReferringTables

      @Stability(Stable) @NotNull public List<String> getAttrDirectReferringTables()
      A list of tables that use this type.

    • getAttrKeyspaceArn

      @Stability(Stable) @NotNull public String getAttrKeyspaceArn()
      The unique identifier of the keyspace that contains this type in the format of Amazon Resource Name (ARN).

    • getAttrLastModifiedTimestamp

      @Stability(Stable) @NotNull public IResolvable getAttrLastModifiedTimestamp()
      The last time this type was modified.

    • getAttrMaxNestingDepth

      @Stability(Stable) @NotNull public Number getAttrMaxNestingDepth()
      The maximum nesting depth of this type.

      For more information, see Amazon Keyspaces UDT quotas and default values in the Amazon Keyspaces Developer Guide .

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getFields

      @Stability(Stable) @NotNull public Object getFields()
      A list of fields that define this type.

    • setFields

      @Stability(Stable) public void setFields(@NotNull IResolvable value)
      A list of fields that define this type.

    • setFields

      @Stability(Stable) public void setFields(@NotNull List<Object> value)
      A list of fields that define this type.

    • getKeyspaceName

      @Stability(Stable) @NotNull public String getKeyspaceName()
      The name of the keyspace to create the type in.

    • setKeyspaceName

      @Stability(Stable) public void setKeyspaceName(@NotNull String value)
      The name of the keyspace to create the type in.

    • getTypeName

      @Stability(Stable) @NotNull public String getTypeName()
      The name of the user-defined type.

    • setTypeName

      @Stability(Stable) public void setTypeName(@NotNull String value)
      The name of the user-defined type.