<!-- Copyright IBM Corp. 2014, 2026 --> <!-- SPDX-License-Identifier: MPL-2.0 -->

ExampleCompany::ExampleService::ExampleResource

An example resource schema demonstrating some basic constructs and validation rules.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

<pre> { "Type" : "ExampleCompany::ExampleService::ExampleResource", "Properties" : { "<a href="#title" title="Title">Title</a>" : <i>String</i>, "<a href="#coversheetincluded" title="CoverSheetIncluded">CoverSheetIncluded</a>" : <i>Boolean</i>, "<a href="#duedate" title="DueDate">DueDate</a>" : <i>String</i>, "<a href="#approvaldate" title="ApprovalDate">ApprovalDate</a>" : <i>String</i>, "<a href="#memo" title="Memo">Memo</a>" : <i><a href="memo.md">Memo</a></i>, "<a href="#secondcopyofmemo" title="SecondCopyOfMemo">SecondCopyOfMemo</a>" : <i><a href="memo.md">Memo</a></i>, "<a href="#testcode" title="TestCode">TestCode</a>" : <i>String</i>, "<a href="#authors" title="Authors">Authors</a>" : <i>[ String, ... ]</i>, "<a href="#tags" title="Tags">Tags</a>" : <i>[ <a href="tag.md">Tag</a>, ... ]</i> } } </pre>

YAML

<pre> Type: ExampleCompany::ExampleService::ExampleResource Properties: <a href="#title" title="Title">Title</a>: <i>String</i> <a href="#coversheetincluded" title="CoverSheetIncluded">CoverSheetIncluded</a>: <i>Boolean</i> <a href="#duedate" title="DueDate">DueDate</a>: <i>String</i> <a href="#approvaldate" title="ApprovalDate">ApprovalDate</a>: <i>String</i> <a href="#memo" title="Memo">Memo</a>: <i><a href="memo.md">Memo</a></i> <a href="#secondcopyofmemo" title="SecondCopyOfMemo">SecondCopyOfMemo</a>: <i><a href="memo.md">Memo</a></i> <a href="#testcode" title="TestCode">TestCode</a>: <i>String</i> <a href="#authors" title="Authors">Authors</a>: <i> - String</i> <a href="#tags" title="Tags">Tags</a>: <i> - <a href="tag.md">Tag</a></i> </pre>

Properties

Title

The title of the TPS report is a mandatory element.

Required: Yes

Type: String

Minimum Length: <code>20</code>

Maximum Length: <code>250</code>

Update requires: No interruption

CoverSheetIncluded

Required for all TPS Reports submitted after 2/19/1999

Required: No

Type: Boolean

Update requires: No interruption

DueDate

Required: No

Type: String

Update requires: No interruption

ApprovalDate

Required: No

Type: String

Update requires: No interruption

Memo

Required: No

Type: <a href="memo.md">Memo</a>

Update requires: No interruption

SecondCopyOfMemo

Required: No

Type: <a href="memo.md">Memo</a>

Update requires: No interruption

TestCode

Required: Yes

Type: String

Allowed Values: <code>NOT_STARTED</code> | <code>CANCELLED</code>

Update requires: No interruption

Authors

Required: No

Type: List of String

Update requires: No interruption

Tags

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

Required: No

Type: List of <a href="tag.md">Tag</a>

Update requires: No interruption

Return Values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the TPSCode.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

TPSCode

A TPS Code is automatically generated on creation and assigned as the unique identifier.