Package software.amazon.awscdk.cfnpropertymixins.services.cases

Interface CfnTemplateMixinProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTemplateMixinProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:19:56.810Z")
@Stability(Stable)
public interface CfnTemplateMixinProps
extends software.amazon.jsii.JsiiSerializable

Properties for CfnTemplatePropsMixin.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.cases.*;
 CfnTemplateMixinProps cfnTemplateMixinProps = CfnTemplateMixinProps.builder()
         .description("description")
         .domainId("domainId")
         .layoutConfiguration(LayoutConfigurationProperty.builder()
                 .defaultLayout("defaultLayout")
                 .build())
         .name("name")
         .requiredFields(List.of(RequiredFieldProperty.builder()
                 .fieldId("fieldId")
                 .build()))
         .rules(List.of(TemplateRuleProperty.builder()
                 .caseRuleId("caseRuleId")
                 .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	CfnTemplateMixinProps.Builder	A builder for CfnTemplateMixinProps
static final class	CfnTemplateMixinProps.Jsii$Proxy	An implementation for CfnTemplateMixinProps

Method Summary

Modifier and Type	Method	Description
static CfnTemplateMixinProps.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.
default 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

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 CfnTemplatePropsMixin.LayoutConfigurationProperty

See Also:

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

getName

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

The template name.

See Also:

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

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 CfnTemplatePropsMixin.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 CfnTemplatePropsMixin.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 CfnTemplateMixinProps.Builder builder()

Returns:

a CfnTemplateMixinProps.Builder of CfnTemplateMixinProps