Package software.amazon.awscdk.services.cases

Class CfnTemplate.Builder

java.lang.Object

software.amazon.awscdk.services.cases.CfnTemplate.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnTemplate>

Enclosing class:

CfnTemplate

@Stability(Stable)
public static final class CfnTemplate.Builder
extends Object
implements software.amazon.jsii.Builder<CfnTemplate>

A fluent builder for CfnTemplate.

Method Summary

Modifier and Type	Method	Description
CfnTemplate	build()
static CfnTemplate.Builder	create(software.constructs.Construct scope, String id)
CfnTemplate.Builder	description(String description)	A brief description of the template.
CfnTemplate.Builder	domainId(String domainId)	The unique identifier of the Cases domain.
CfnTemplate.Builder	layoutConfiguration(IResolvable layoutConfiguration)	Object to store configuration of layouts associated to the template.
CfnTemplate.Builder	layoutConfiguration(CfnTemplate.LayoutConfigurationProperty layoutConfiguration)	Object to store configuration of layouts associated to the template.
CfnTemplate.Builder	name(String name)	The template name.
CfnTemplate.Builder	requiredFields(List<? extends Object> requiredFields)	A list of fields that must contain a value for a case to be successfully created with this template.
CfnTemplate.Builder	requiredFields(IResolvable requiredFields)	A list of fields that must contain a value for a case to be successfully created with this template.
CfnTemplate.Builder	rules(List<? extends Object> rules)	A list of case rules (also known as case field conditions ) on a template.
CfnTemplate.Builder	rules(IResolvable rules)	A list of case rules (also known as case field conditions ) on a template.
CfnTemplate.Builder	status(String status)	The status of the template.
CfnTemplate.Builder	tags(List<? extends CfnTag> tags)	An array of key-value pairs to apply to this resource.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Stable)
public static CfnTemplate.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnTemplate.Builder.

name

@Stability(Stable)
public CfnTemplate.Builder name(String name)

The template name.

Parameters:

name - The template name. This parameter is required.

Returns:

this

See Also:

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

description

@Stability(Stable)
public CfnTemplate.Builder description(String description)

A brief description of the template.

Parameters:

description - A brief description of the template. This parameter is required.

Returns:

this

See Also:

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

domainId

@Stability(Stable)
public CfnTemplate.Builder domainId(String domainId)

The unique identifier of the Cases domain.

Parameters:

domainId - The unique identifier of the Cases domain. This parameter is required.

Returns:

this

See Also:

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

layoutConfiguration

@Stability(Stable)
public CfnTemplate.Builder layoutConfiguration(IResolvable layoutConfiguration)

Object to store configuration of layouts associated to the template.

Parameters:

layoutConfiguration - Object to store configuration of layouts associated to the template. This parameter is required.

Returns:

this

See Also:

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

layoutConfiguration

@Stability(Stable)
public CfnTemplate.Builder layoutConfiguration(CfnTemplate.LayoutConfigurationProperty layoutConfiguration)

Object to store configuration of layouts associated to the template.

Parameters:

layoutConfiguration - Object to store configuration of layouts associated to the template. This parameter is required.

Returns:

this

See Also:

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

requiredFields

@Stability(Stable)
public CfnTemplate.Builder requiredFields(IResolvable requiredFields)

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

Parameters:

requiredFields - A list of fields that must contain a value for a case to be successfully created with this template. This parameter is required.

Returns:

this

See Also:

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

requiredFields

@Stability(Stable)
public CfnTemplate.Builder requiredFields(List<? extends Object> requiredFields)

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

Parameters:

requiredFields - A list of fields that must contain a value for a case to be successfully created with this template. This parameter is required.

Returns:

this

See Also:

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

rules

@Stability(Stable)
public CfnTemplate.Builder rules(IResolvable rules)

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

Parameters:

rules - A list of case rules (also known as case field conditions ) on a template. This parameter is required.

Returns:

this

See Also:

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

rules

@Stability(Stable)
public CfnTemplate.Builder rules(List<? extends Object> rules)

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

Parameters:

rules - A list of case rules (also known as case field conditions ) on a template. This parameter is required.

Returns:

this

See Also:

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

status

@Stability(Stable)
public CfnTemplate.Builder status(String status)

The status of the template.

Parameters:

status - The status of the template. This parameter is required.

Returns:

this

See Also:

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

tags

@Stability(Stable)
public CfnTemplate.Builder tags(List<? extends CfnTag> tags)

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

Parameters:

tags - An array of key-value pairs to apply to this resource. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnTemplate build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnTemplate>

Returns:

a newly built instance of CfnTemplate.