Package software.amazon.awscdk.services.cases

Interface CfnFieldProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnFieldProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-04-02T21:55:06.021Z")
@Stability(Stable)
public interface CfnFieldProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnField.

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.cases.*;
 CfnFieldProps cfnFieldProps = CfnFieldProps.builder()
         .name("name")
         .type("type")
         // the properties below are optional
         .attributes(FieldAttributesProperty.builder()
                 .text(TextAttributesProperty.builder()
                         .isMultiline(false)
                         .build())
                 .build())
         .description("description")
         .domainId("domainId")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cases-field.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnFieldProps.Builder	A builder for CfnFieldProps
static final class	CfnFieldProps.Jsii$Proxy	An implementation for CfnFieldProps

Method Summary

Modifier and Type	Method	Description
static CfnFieldProps.Builder	builder()
default Object	getAttributes()	Union of field attributes.
default String	getDescription()	Description of the field.
default String	getDomainId()	The unique identifier of the Cases domain.
String	getName()	Name of the field.
default List<CfnTag>	getTags()	An array of key-value pairs to apply to this resource.
String	getType()	Type of the field.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getName

@Stability(Stable)
@NotNull
String getName()

Name of the field.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cases-field.html#cfn-cases-field-name

getType

@Stability(Stable)
@NotNull
String getType()

Type of the field.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cases-field.html#cfn-cases-field-type

getAttributes

@Stability(Stable)
@Nullable
default Object getAttributes()

Union of field attributes.

Returns union: either IResolvable or CfnField.FieldAttributesProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cases-field.html#cfn-cases-field-attributes

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

Description of the field.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cases-field.html#cfn-cases-field-description

getDomainId

@Stability(Stable)
@Nullable
default String getDomainId()

The unique identifier of the Cases domain.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cases-field.html#cfn-cases-field-domainid

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

An array of key-value pairs to apply to this resource.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cases-field.html#cfn-cases-field-tags

builder

@Stability(Stable)
static CfnFieldProps.Builder builder()

Returns:

a CfnFieldProps.Builder of CfnFieldProps