Package software.amazon.awscdk.services.cases

Interface CfnTemplateProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTemplateProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.125.0 (build fdbe357)",
           date="2026-01-09T10:20:13.567Z")
@Stability(Stable)
public interface CfnTemplateProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnTemplate.

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.*;
 CfnTemplateProps cfnTemplateProps = CfnTemplateProps.builder()
         .name("name")
         // the properties below are optional
         .description("description")
         .domainId("domainId")
         .layoutConfiguration(LayoutConfigurationProperty.builder()
                 .defaultLayout("defaultLayout")
                 .build())
         .requiredFields(List.of(RequiredFieldProperty.builder()
                 .fieldId("fieldId")
                 .build()))
         .rules(List.of(TemplateRuleProperty.builder()
                 .caseRuleId("caseRuleId")
                 // the properties below are optional
                 .fieldId("fieldId")
                 .build()))
         .status("status")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnTemplateProps.Builder	builder()
default String	getDescription()	A brief description of the template.
default String	getDomainId()	The unique identifier of the Cases domain.
default Object	getLayoutConfiguration()	Object to store configuration of layouts associated to the template.
String	getName()	The template name.
default Object	getRequiredFields()	A list of fields that must contain a value for a case to be successfully created with this template.
default Object	getRules()	A list of case rules (also known as case field conditions ) on a template.
default String	getStatus()	The status of the template.
default List<CfnTag>	getTags()	An array of key-value pairs to apply to this resource.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getName

@Stability(Stable)
@NotNull
String getName()

The template name.

See Also:

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

getDescription

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

A brief description of the template.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cases-template.html#cfn-cases-template-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-template.html#cfn-cases-template-domainid

getLayoutConfiguration

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

Object to store configuration of layouts associated to the template.

Returns union: either IResolvable or CfnTemplate.LayoutConfigurationProperty

See Also:

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

getRequiredFields

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

A list of fields that must contain a value for a case to be successfully created with this template.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnTemplate.RequiredFieldProperty>

See Also:

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

getRules

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

A list of case rules (also known as case field conditions ) on a template.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnTemplate.TemplateRuleProperty>

See Also:

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

getStatus

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

The status of the template.

See Also:

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

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-template.html#cfn-cases-template-tags

builder

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

Returns:

a CfnTemplateProps.Builder of CfnTemplateProps