AWS CDK Reference

Appearance

v2.275.0

CfnFieldProps Struct ​

Properties for defining a CfnField.

Source
Generated code
Type last changed
v2.241.0 · 2 Mar 2026

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_cases as cases } from 'aws-cdk-lib';
const cfnFieldProps: cases.CfnFieldProps = {
  name: 'name',
  type: 'type',

  // the properties below are optional
  attributes: {
    text: {
      isMultiline: false,
    },
  },
  description: 'description',
  domainId: 'domainId',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties ​

attributesoptionalIResolvable | CfnField.FieldAttributesPropertyattributesoptionaltyping.Union[IResolvable, FieldAttributesProperty]attributesoptionalIResolvableAttributesoptionalIResolvableAttributesoptionalinterface{}#
Union of field attributes.
descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#
Description of the field.
domainIdoptionalstringdomain_idoptionalstrdomainIdoptionalStringDomainIdoptionalstringDomainIdoptional*string#
The unique identifier of the Cases domain.
namestringnamestrnameStringNamestringName*stringrequired#
Name of the field.
tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag#
An array of key-value pairs to apply to this resource.
typestringtypestrtypeStringTypestringType*stringrequired#
Type of the field.