Package software.amazon.awscdk.services.apptest

Class CfnTestCase

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.apptest.CfnTestCase

All Implemented Interfaces:

IInspectable, ITaggableV2, ITestCaseRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)",
           date="2025-10-29T11:15:32.739Z")
@Stability(Stable)
public class CfnTestCase
extends CfnResource
implements IInspectable, ITestCaseRef, ITaggableV2

Creates a test case for an application.

For more information about test cases, see Test cases and Application Testing concepts in the AWS Mainframe Modernization User Guide .

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.apptest.*;
 CfnTestCase cfnTestCase = CfnTestCase.Builder.create(this, "MyCfnTestCase")
         .name("name")
         .steps(List.of(StepProperty.builder()
                 .action(StepActionProperty.builder()
                         .compareAction(CompareActionProperty.builder()
                                 .input(InputProperty.builder()
                                         .file(InputFileProperty.builder()
                                                 .fileMetadata(FileMetadataProperty.builder()
                                                         .databaseCdc(DatabaseCDCProperty.builder()
                                                                 .sourceMetadata(SourceDatabaseMetadataProperty.builder()
                                                                         .captureTool("captureTool")
                                                                         .type("type")
                                                                         .build())
                                                                 .targetMetadata(TargetDatabaseMetadataProperty.builder()
                                                                         .captureTool("captureTool")
                                                                         .type("type")
                                                                         .build())
                                                                 .build())
                                                         .dataSets(List.of(DataSetProperty.builder()
                                                                 .ccsid("ccsid")
                                                                 .format("format")
                                                                 .length(123)
                                                                 .name("name")
                                                                 .type("type")
                                                                 .build()))
                                                         .build())
                                                 .sourceLocation("sourceLocation")
                                                 .targetLocation("targetLocation")
                                                 .build())
                                         .build())
                                 // the properties below are optional
                                 .output(OutputProperty.builder()
                                         .file(OutputFileProperty.builder()
                                                 .fileLocation("fileLocation")
                                                 .build())
                                         .build())
                                 .build())
                         .mainframeAction(MainframeActionProperty.builder()
                                 .actionType(MainframeActionTypeProperty.builder()
                                         .batch(BatchProperty.builder()
                                                 .batchJobName("batchJobName")
                                                 // the properties below are optional
                                                 .batchJobParameters(Map.of(
                                                         "batchJobParametersKey", "batchJobParameters"))
                                                 .exportDataSetNames(List.of("exportDataSetNames"))
                                                 .build())
                                         .tn3270(TN3270Property.builder()
                                                 .script(ScriptProperty.builder()
                                                         .scriptLocation("scriptLocation")
                                                         .type("type")
                                                         .build())
                                                 // the properties below are optional
                                                 .exportDataSetNames(List.of("exportDataSetNames"))
                                                 .build())
                                         .build())
                                 .resource("resource")
                                 // the properties below are optional
                                 .properties(MainframeActionPropertiesProperty.builder()
                                         .dmsTaskArn("dmsTaskArn")
                                         .build())
                                 .build())
                         .resourceAction(ResourceActionProperty.builder()
                                 .cloudFormationAction(CloudFormationActionProperty.builder()
                                         .resource("resource")
                                         // the properties below are optional
                                         .actionType("actionType")
                                         .build())
                                 .m2ManagedApplicationAction(M2ManagedApplicationActionProperty.builder()
                                         .actionType("actionType")
                                         .resource("resource")
                                         // the properties below are optional
                                         .properties(M2ManagedActionPropertiesProperty.builder()
                                                 .forceStop(false)
                                                 .importDataSetLocation("importDataSetLocation")
                                                 .build())
                                         .build())
                                 .m2NonManagedApplicationAction(M2NonManagedApplicationActionProperty.builder()
                                         .actionType("actionType")
                                         .resource("resource")
                                         .build())
                                 .build())
                         .build())
                 .name("name")
                 // the properties below are optional
                 .description("description")
                 .build()))
         // the properties below are optional
         .description("description")
         .tags(Map.of(
                 "tagsKey", "tags"))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apptest-testcase.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CfnTestCase.BatchProperty	Defines a batch.
static final class	CfnTestCase.Builder	A fluent builder for CfnTestCase.
static interface	CfnTestCase.CloudFormationActionProperty	Specifies the CloudFormation action.
static interface	CfnTestCase.CompareActionProperty	Compares the action.
static interface	CfnTestCase.DatabaseCDCProperty	Defines the Change Data Capture (CDC) of the database.
static interface	CfnTestCase.DataSetProperty	Defines a data set.
static interface	CfnTestCase.FileMetadataProperty	Specifies a file metadata.
static interface	CfnTestCase.InputFileProperty	Specifies the input file.
static interface	CfnTestCase.InputProperty	Specifies the input.
static interface	CfnTestCase.M2ManagedActionPropertiesProperty	Specifies the Mainframe Modernization managed action properties.
static interface	CfnTestCase.M2ManagedApplicationActionProperty	Specifies the Mainframe Modernization managed application action.
static interface	CfnTestCase.M2NonManagedApplicationActionProperty	Specifies the Mainframe Modernization non-managed application action.
static interface	CfnTestCase.MainframeActionPropertiesProperty	Specifies the mainframe action properties.
static interface	CfnTestCase.MainframeActionProperty	Specifies the mainframe action.
static interface	CfnTestCase.MainframeActionTypeProperty	Specifies the mainframe action type.
static interface	CfnTestCase.OutputFileProperty	Specifies an output file.
static interface	CfnTestCase.OutputProperty	Specifies an output.
static interface	CfnTestCase.ResourceActionProperty	Specifies a resource action.
static interface	CfnTestCase.ScriptProperty	Specifies the script.
static interface	CfnTestCase.SourceDatabaseMetadataProperty	Specifies the source database metadata.
static interface	CfnTestCase.StepActionProperty	Specifies a step action.
static interface	CfnTestCase.StepProperty	Defines a step.
static interface	CfnTestCase.TargetDatabaseMetadataProperty	Specifies a target database metadata.
static interface	CfnTestCase.TestCaseLatestVersionProperty	Specifies the latest version of a test case.
static interface	CfnTestCase.TN3270Property	Specifies the TN3270 protocol.

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

software.amazon.jsii.JsiiObject.InitializationMode

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

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggableV2

ITaggableV2.Jsii$Default, ITaggableV2.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.apptest.ITestCaseRef

ITestCaseRef.Jsii$Default, ITestCaseRef.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnTestCase(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnTestCase(software.amazon.jsii.JsiiObjectRef objRef)
	CfnTestCase(software.constructs.Construct scope, String id, CfnTestCaseProps props)

Method Summary

Modifier and Type	Method	Description
static ITestCaseRef	fromTestCaseArn(software.constructs.Construct scope, String id, String arn)	Creates a new ITestCaseRef from an ARN.
static ITestCaseRef	fromTestCaseId(software.constructs.Construct scope, String id, String testCaseId)	Creates a new ITestCaseRef from a testCaseId.
String	getAttrCreationTime()	The creation time of the test case.
String	getAttrLastUpdateTime()	The last update time of the test case.
IResolvable	getAttrLatestVersion()
String	getAttrStatus()	The status of the test case.
String	getAttrTestCaseArn()	The Amazon Resource Name (ARN) of the test case.
String	getAttrTestCaseId()	The response test case ID of the test case.
IResolvable	getAttrTestCaseVersion()	The version of the test case.
TagManager	getCdkTagManager()	Tag Manager which manages the tags for this resource.
protected Map<String,Object>	getCfnProperties()
String	getDescription()	The description of the test case.
String	getName()	The name of the test case.
Object	getSteps()	The steps in the test case.
Map<String,String>	getTags()	The specified tags of the test case.
TestCaseReference	getTestCaseRef()	A reference to a TestCase resource.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDescription(String value)	The description of the test case.
void	setName(String value)	The name of the test case.
void	setSteps(List<Object> value)	The steps in the test case.
void	setSteps(IResolvable value)	The steps in the test case.
void	setTags(Map<String,String> value)	The specified tags of the test case.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

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, wait, wait, wait

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnTestCase

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

CfnTestCase

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

CfnTestCase

@Stability(Stable)
public CfnTestCase(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnTestCaseProps props)

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.

props - Resource properties. This parameter is required.

Method Details

fromTestCaseArn

@Stability(Stable)
@NotNull
public static ITestCaseRef fromTestCaseArn(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 String arn)

Creates a new ITestCaseRef from an ARN.

Parameters:

scope - This parameter is required.

id - This parameter is required.

arn - This parameter is required.

fromTestCaseId

@Stability(Stable)
@NotNull
public static ITestCaseRef fromTestCaseId(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 String testCaseId)

Creates a new ITestCaseRef from a testCaseId.

Parameters:

scope - This parameter is required.

id - This parameter is required.

testCaseId - This parameter is required.

inspect

@Stability(Stable)
public void inspect(@NotNull
 TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> renderProperties(@NotNull
 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrCreationTime

@Stability(Stable)
@NotNull
public String getAttrCreationTime()

The creation time of the test case.

getAttrLastUpdateTime

@Stability(Stable)
@NotNull
public String getAttrLastUpdateTime()

The last update time of the test case.

getAttrLatestVersion

@Stability(Stable)
@NotNull
public IResolvable getAttrLatestVersion()

getAttrStatus

@Stability(Stable)
@NotNull
public String getAttrStatus()

The status of the test case.

getAttrTestCaseArn

@Stability(Stable)
@NotNull
public String getAttrTestCaseArn()

The Amazon Resource Name (ARN) of the test case.

getAttrTestCaseId

@Stability(Stable)
@NotNull
public String getAttrTestCaseId()

The response test case ID of the test case.

getAttrTestCaseVersion

@Stability(Stable)
@NotNull
public IResolvable getAttrTestCaseVersion()

The version of the test case.

getCdkTagManager

@Stability(Stable)
@NotNull
public TagManager getCdkTagManager()

Tag Manager which manages the tags for this resource.

Specified by:

getCdkTagManager in interface ITaggableV2

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTestCaseRef

@Stability(Stable)
@NotNull
public TestCaseReference getTestCaseRef()

A reference to a TestCase resource.

Specified by:

getTestCaseRef in interface ITestCaseRef

getName

@Stability(Stable)
@NotNull
public String getName()

The name of the test case.

setName

@Stability(Stable)
public void setName(@NotNull
 String value)

The name of the test case.

getSteps

@Stability(Stable)
@NotNull
public Object getSteps()

The steps in the test case.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnTestCase.StepProperty>

setSteps

@Stability(Stable)
public void setSteps(@NotNull
 IResolvable value)

The steps in the test case.

setSteps

@Stability(Stable)
public void setSteps(@NotNull
 List<Object> value)

The steps in the test case.

getDescription

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

The description of the test case.

setDescription

@Stability(Stable)
public void setDescription(@Nullable
 String value)

The description of the test case.

getTags

@Stability(Stable)
@Nullable
public Map<String,String> getTags()

The specified tags of the test case.

setTags

@Stability(Stable)
public void setTags(@Nullable
 Map<String,String> value)

The specified tags of the test case.