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

Class CfnTemplatePropsMixin

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.Mixin

software.amazon.awscdk.cfnpropertymixins.services.cases.CfnTemplatePropsMixin

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable, software.constructs.IMixin

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:19:56.811Z")
@Stability(Stable)
public class CfnTemplatePropsMixin
extends Mixin
implements software.constructs.IMixin

Creates a template in the Cases domain.

This template is used to define the case object model (that is, to define what data can be captured on cases) in a Cases domain. A template must have a unique name within a domain, and it must reference existing field IDs and layout IDs. Additionally, multiple fields with same IDs are not allowed within the same Template. A template can be either Active or Inactive, as indicated by its status. Inactive templates cannot be used to create cases.

Other template APIs are:

• DeleteTemplate
• GetTemplate
• ListTemplates
• UpdateTemplate

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.*;
 import software.amazon.awscdk.*;
 IMergeStrategy mergeStrategy;
 CfnTemplatePropsMixin cfnTemplatePropsMixin = CfnTemplatePropsMixin.Builder.create(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())
 .strategy(mergeStrategy)
 .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnTemplatePropsMixin.Builder	A fluent builder for CfnTemplatePropsMixin.
static interface	CfnTemplatePropsMixin.LayoutConfigurationProperty	Object to store configuration of layouts associated to the template.
static interface	CfnTemplatePropsMixin.RequiredFieldProperty	List of fields that must have a value provided to create a case.
static interface	CfnTemplatePropsMixin.TemplateRuleProperty	An association representing a case rule acting upon a field.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IMixin

software.constructs.IMixin.Jsii$Default, software.constructs.IMixin.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
protected static final List<String>	CFN_PROPERTY_KEYS

Constructor Summary

Constructors

Modifier	Constructor	Description
	CfnTemplatePropsMixin(CfnTemplateMixinProps props)	Create a mixin to apply properties to AWS::Cases::Template.
	CfnTemplatePropsMixin(CfnTemplateMixinProps props, CfnPropertyMixinOptions options)	Create a mixin to apply properties to AWS::Cases::Template.
protected	CfnTemplatePropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnTemplatePropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
void	applyTo(software.constructs.IConstruct construct)	Apply the mixin properties to the construct.
protected CfnTemplateMixinProps	getProps()
protected IMergeStrategy	getStrategy()
Boolean	supports(software.constructs.IConstruct construct)	Check if this mixin supports the given construct.

Methods inherited from class software.amazon.awscdk.Mixin

isMixin

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_PROPERTY_KEYS

@Stability(Stable)
protected static final List<String> CFN_PROPERTY_KEYS

Constructor Details

CfnTemplatePropsMixin

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

CfnTemplatePropsMixin

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

CfnTemplatePropsMixin

@Stability(Stable)
public CfnTemplatePropsMixin(@NotNull
 CfnTemplateMixinProps props,
 @Nullable
 CfnPropertyMixinOptions options)

Create a mixin to apply properties to AWS::Cases::Template.

Parameters:

props - L1 properties to apply. This parameter is required.

options - Mixin options.

CfnTemplatePropsMixin

@Stability(Stable)
public CfnTemplatePropsMixin(@NotNull
 CfnTemplateMixinProps props)

Create a mixin to apply properties to AWS::Cases::Template.

Parameters:

props - L1 properties to apply. This parameter is required.

Method Details

applyTo

@Stability(Stable)
public void applyTo(@NotNull
 software.constructs.IConstruct construct)

Apply the mixin properties to the construct.

Specified by:

applyTo in interface software.constructs.IMixin

Specified by:

applyTo in class Mixin

Parameters:

construct - This parameter is required.

supports

@Stability(Stable)
@NotNull
public Boolean supports(@NotNull
 software.constructs.IConstruct construct)

Check if this mixin supports the given construct.

Specified by:

supports in interface software.constructs.IMixin

Overrides:

supports in class Mixin

Parameters:

construct - This parameter is required.

getProps

@Stability(Stable)
@NotNull
protected CfnTemplateMixinProps getProps()

getStrategy

@Stability(Stable)
@NotNull
protected IMergeStrategy getStrategy()