CfnTestCase
- class aws_cdk.aws_apptest.CfnTestCase(scope, id, *, name, steps, description=None, tags=None)
Bases:
CfnResource
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 .
- See:
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apptest-testcase.html
- CloudformationResource:
AWS::AppTest::TestCase
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_apptest as apptest cfn_test_case = apptest.CfnTestCase(self, "MyCfnTestCase", name="name", steps=[apptest.CfnTestCase.StepProperty( action=apptest.CfnTestCase.StepActionProperty( compare_action=apptest.CfnTestCase.CompareActionProperty( input=apptest.CfnTestCase.InputProperty( file=apptest.CfnTestCase.InputFileProperty( file_metadata=apptest.CfnTestCase.FileMetadataProperty( database_cdc=apptest.CfnTestCase.DatabaseCDCProperty( source_metadata=apptest.CfnTestCase.SourceDatabaseMetadataProperty( capture_tool="captureTool", type="type" ), target_metadata=apptest.CfnTestCase.TargetDatabaseMetadataProperty( capture_tool="captureTool", type="type" ) ), data_sets=[apptest.CfnTestCase.DataSetProperty( ccsid="ccsid", format="format", length=123, name="name", type="type" )] ), source_location="sourceLocation", target_location="targetLocation" ) ), # the properties below are optional output=apptest.CfnTestCase.OutputProperty( file=apptest.CfnTestCase.OutputFileProperty( file_location="fileLocation" ) ) ), mainframe_action=apptest.CfnTestCase.MainframeActionProperty( action_type=apptest.CfnTestCase.MainframeActionTypeProperty( batch=apptest.CfnTestCase.BatchProperty( batch_job_name="batchJobName", # the properties below are optional batch_job_parameters={ "batch_job_parameters_key": "batchJobParameters" }, export_data_set_names=["exportDataSetNames"] ), tn3270=apptest.CfnTestCase.TN3270Property( script=apptest.CfnTestCase.ScriptProperty( script_location="scriptLocation", type="type" ), # the properties below are optional export_data_set_names=["exportDataSetNames"] ) ), resource="resource", # the properties below are optional properties=apptest.CfnTestCase.MainframeActionPropertiesProperty( dms_task_arn="dmsTaskArn" ) ), resource_action=apptest.CfnTestCase.ResourceActionProperty( cloud_formation_action=apptest.CfnTestCase.CloudFormationActionProperty( resource="resource", # the properties below are optional action_type="actionType" ), m2_managed_application_action=apptest.CfnTestCase.M2ManagedApplicationActionProperty( action_type="actionType", resource="resource", # the properties below are optional properties=apptest.CfnTestCase.M2ManagedActionPropertiesProperty( force_stop=False, import_data_set_location="importDataSetLocation" ) ), m2_non_managed_application_action=apptest.CfnTestCase.M2NonManagedApplicationActionProperty( action_type="actionType", resource="resource" ) ) ), name="name", # the properties below are optional description="description" )], # the properties below are optional description="description", tags={ "tags_key": "tags" } )
- Parameters:
scope (
Construct
) – Scope in which this resource is defined.id (
str
) – Construct identifier for this resource (unique in its scope).name (
str
) – The name of the test case.steps (
Union
[IResolvable
,Sequence
[Union
[IResolvable
,StepProperty
,Dict
[str
,Any
]]]]) – The steps in the test case.description (
Optional
[str
]) – The description of the test case.tags (
Optional
[Mapping
[str
,str
]]) – The specified tags of the test case.
Methods
- add_deletion_override(path)
Syntactic sugar for
addOverride(path, undefined)
.- Parameters:
path (
str
) – The path of the value to delete.- Return type:
None
- add_dependency(target)
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.
- Parameters:
target (
CfnResource
) –- Return type:
None
- add_depends_on(target)
(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
- Parameters:
target (
CfnResource
) –- Deprecated:
use addDependency
- Stability:
deprecated
- Return type:
None
- add_metadata(key, value)
Add a value to the CloudFormation Resource Metadata.
- Parameters:
key (
str
) –value (
Any
) –
- See:
- Return type:
None
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.
- add_override(path, value)
Adds an override to the synthesized CloudFormation resource.
To add a property override, either use
addPropertyOverride
or prefixpath
with “Properties.” (i.e.Properties.TopicName
).If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.
To include a literal
.
in the property name, prefix with a\
. In most programming languages you will need to write this as"\\."
because the\
itself will need to be escaped.For example:
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"]) cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")
would add the overrides Example:
"Properties": { "GlobalSecondaryIndexes": [ { "Projection": { "NonKeyAttributes": [ "myattribute" ] ... } ... }, { "ProjectionType": "INCLUDE" ... }, ] ... }
The
value
argument toaddOverride
will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.- Parameters:
path (
str
) –The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed.
value (
Any
) –The value. Could be primitive or complex.
- Return type:
None
- add_property_deletion_override(property_path)
Adds an override that deletes the value of a property from the resource definition.
- Parameters:
property_path (
str
) – The path to the property.- Return type:
None
- add_property_override(property_path, value)
Adds an override to a resource property.
Syntactic sugar for
addOverride("Properties.<...>", value)
.- Parameters:
property_path (
str
) – The path of the property.value (
Any
) – The value.
- Return type:
None
- apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)
Sets the deletion policy of the resource based on the removal policy specified.
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.
The resource can be deleted (
RemovalPolicy.DESTROY
), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN
). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT
). A list of resources that support this policy can be found in the following link:- Parameters:
policy (
Optional
[RemovalPolicy
]) –apply_to_update_replace_policy (
Optional
[bool
]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: truedefault (
Optional
[RemovalPolicy
]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resource, please consult that specific resource’s documentation.
- See:
- Return type:
None
- get_att(attribute_name, type_hint=None)
Returns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g.
resource.arn
), but this can be used for future compatibility in case there is no generated attribute.- Parameters:
attribute_name (
str
) – The name of the attribute.type_hint (
Optional
[ResolutionTypeHint
]) –
- Return type:
- get_metadata(key)
Retrieve a value value from the CloudFormation Resource Metadata.
- Parameters:
key (
str
) –- See:
- Return type:
Any
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.
- inspect(inspector)
Examines the CloudFormation resource and discloses attributes.
- Parameters:
inspector (
TreeInspector
) – tree inspector to collect and process attributes.- Return type:
None
- obtain_dependencies()
Retrieves an array of resources this resource depends on.
This assembles dependencies on resources across stacks (including nested stacks) automatically.
- Return type:
List
[Union
[Stack
,CfnResource
]]
- obtain_resource_dependencies()
Get a shallow copy of dependencies between this resource and other resources in the same stack.
- Return type:
List
[CfnResource
]
- override_logical_id(new_logical_id)
Overrides the auto-generated logical ID with a specific ID.
- Parameters:
new_logical_id (
str
) – The new logical ID to use for this stack element.- Return type:
None
- remove_dependency(target)
Indicates that this resource no longer depends on another resource.
This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.
- Parameters:
target (
CfnResource
) –- Return type:
None
- replace_dependency(target, new_target)
Replaces one dependency with another.
- Parameters:
target (
CfnResource
) – The dependency to replace.new_target (
CfnResource
) – The new dependency to add.
- Return type:
None
- to_string()
Returns a string representation of this construct.
- Return type:
str
- Returns:
a string representation of this resource
Attributes
- CFN_RESOURCE_TYPE_NAME = 'AWS::AppTest::TestCase'
- attr_creation_time
The creation time of the test case.
- CloudformationAttribute:
CreationTime
- attr_last_update_time
The last update time of the test case.
- CloudformationAttribute:
LastUpdateTime
- attr_latest_version
LatestVersion
- Type:
cloudformationAttribute
- attr_status
The status of the test case.
- CloudformationAttribute:
Status
- attr_test_case_arn
The Amazon Resource Name (ARN) of the test case.
- CloudformationAttribute:
TestCaseArn
- attr_test_case_id
The response test case ID of the test case.
- CloudformationAttribute:
TestCaseId
- attr_test_case_version
The version of the test case.
- CloudformationAttribute:
TestCaseVersion
- cdk_tag_manager
Tag Manager which manages the tags for this resource.
- cfn_options
Options for this resource, such as condition, update policy etc.
- cfn_resource_type
AWS resource type.
- creation_stack
return:
the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.
- description
The description of the test case.
- logical_id
The logical ID for this CloudFormation stack element.
The logical ID of the element is calculated from the path of the resource node in the construct tree.
To override this value, use
overrideLogicalId(newLogicalId)
.- Returns:
the logical ID as a stringified token. This value will only get resolved during synthesis.
- name
The name of the test case.
- node
The tree node.
- ref
Return a string that will be resolved to a CloudFormation
{ Ref }
for this element.If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through
Lazy.any({ produce: resource.ref })
.
- stack
The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
- steps
The steps in the test case.
- tags
The specified tags of the test case.
Static Methods
- classmethod is_cfn_element(x)
Returns
true
if a construct is a stack element (i.e. part of the synthesized cloudformation template).Uses duck-typing instead of
instanceof
to allow stack elements from different versions of this library to be included in the same stack.- Parameters:
x (
Any
) –- Return type:
bool
- Returns:
The construct as a stack element or undefined if it is not a stack element.
- classmethod is_cfn_resource(x)
Check whether the given object is a CfnResource.
- Parameters:
x (
Any
) –- Return type:
bool
- classmethod is_construct(x)
Checks if
x
is a construct.Use this method instead of
instanceof
to properly detectConstruct
instances, even when the construct library is symlinked.Explanation: in JavaScript, multiple copies of the
constructs
library on disk are seen as independent, completely different libraries. As a consequence, the classConstruct
in each copy of theconstructs
library is seen as a different class, and an instance of one class will not test asinstanceof
the other class.npm install
will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of theconstructs
library can be accidentally installed, andinstanceof
will behave unpredictably. It is safest to avoid usinginstanceof
, and using this type-testing method instead.- Parameters:
x (
Any
) – Any object.- Return type:
bool
- Returns:
true if
x
is an object created from a class which extendsConstruct
.
BatchProperty
- class CfnTestCase.BatchProperty(*, batch_job_name, batch_job_parameters=None, export_data_set_names=None)
Bases:
object
Defines a batch.
- Parameters:
batch_job_name (
str
) – The job name of the batch.batch_job_parameters (
Union
[IResolvable
,Mapping
[str
,str
],None
]) – The batch job parameters of the batch.export_data_set_names (
Optional
[Sequence
[str
]]) – The export data set names of the batch.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_apptest as apptest batch_property = apptest.CfnTestCase.BatchProperty( batch_job_name="batchJobName", # the properties below are optional batch_job_parameters={ "batch_job_parameters_key": "batchJobParameters" }, export_data_set_names=["exportDataSetNames"] )
Attributes
- batch_job_name
The job name of the batch.
- batch_job_parameters
The batch job parameters of the batch.
- export_data_set_names
The export data set names of the batch.
CloudFormationActionProperty
- class CfnTestCase.CloudFormationActionProperty(*, resource, action_type=None)
Bases:
object
Specifies the CloudFormation action.
- Parameters:
resource (
str
) – The resource of the CloudFormation action.action_type (
Optional
[str
]) – The action type of the CloudFormation action.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_apptest as apptest cloud_formation_action_property = apptest.CfnTestCase.CloudFormationActionProperty( resource="resource", # the properties below are optional action_type="actionType" )
Attributes
- action_type
The action type of the CloudFormation action.
- resource
The resource of the CloudFormation action.
CompareActionProperty
- class CfnTestCase.CompareActionProperty(*, input, output=None)
Bases:
object
Compares the action.
- Parameters:
input (
Union
[IResolvable
,InputProperty
,Dict
[str
,Any
]]) – The input of the compare action.output (
Union
[IResolvable
,OutputProperty
,Dict
[str
,Any
],None
]) – The output of the compare action.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_apptest as apptest compare_action_property = apptest.CfnTestCase.CompareActionProperty( input=apptest.CfnTestCase.InputProperty( file=apptest.CfnTestCase.InputFileProperty( file_metadata=apptest.CfnTestCase.FileMetadataProperty( database_cdc=apptest.CfnTestCase.DatabaseCDCProperty( source_metadata=apptest.CfnTestCase.SourceDatabaseMetadataProperty( capture_tool="captureTool", type="type" ), target_metadata=apptest.CfnTestCase.TargetDatabaseMetadataProperty( capture_tool="captureTool", type="type" ) ), data_sets=[apptest.CfnTestCase.DataSetProperty( ccsid="ccsid", format="format", length=123, name="name", type="type" )] ), source_location="sourceLocation", target_location="targetLocation" ) ), # the properties below are optional output=apptest.CfnTestCase.OutputProperty( file=apptest.CfnTestCase.OutputFileProperty( file_location="fileLocation" ) ) )
Attributes
- input
The input of the compare action.
- output
The output of the compare action.
DataSetProperty
- class CfnTestCase.DataSetProperty(*, ccsid, format, length, name, type)
Bases:
object
Defines a data set.
- Parameters:
ccsid (
str
) – The CCSID of the data set.format (
str
) – The format of the data set.length (
Union
[int
,float
]) – The length of the data set.name (
str
) – The name of the data set.type (
str
) – The type of the data set.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_apptest as apptest data_set_property = apptest.CfnTestCase.DataSetProperty( ccsid="ccsid", format="format", length=123, name="name", type="type" )
Attributes
- ccsid
The CCSID of the data set.
- format
The format of the data set.
- length
The length of the data set.
- name
The name of the data set.
- type
The type of the data set.
DatabaseCDCProperty
- class CfnTestCase.DatabaseCDCProperty(*, source_metadata, target_metadata)
Bases:
object
Defines the Change Data Capture (CDC) of the database.
- Parameters:
source_metadata (
Union
[IResolvable
,SourceDatabaseMetadataProperty
,Dict
[str
,Any
]]) – The source metadata of the database CDC.target_metadata (
Union
[IResolvable
,TargetDatabaseMetadataProperty
,Dict
[str
,Any
]]) – The target metadata of the database CDC.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_apptest as apptest database_cDCProperty = apptest.CfnTestCase.DatabaseCDCProperty( source_metadata=apptest.CfnTestCase.SourceDatabaseMetadataProperty( capture_tool="captureTool", type="type" ), target_metadata=apptest.CfnTestCase.TargetDatabaseMetadataProperty( capture_tool="captureTool", type="type" ) )
Attributes
- source_metadata
The source metadata of the database CDC.
- target_metadata
The target metadata of the database CDC.
FileMetadataProperty
- class CfnTestCase.FileMetadataProperty(*, database_cdc=None, data_sets=None)
Bases:
object
Specifies a file metadata.
- Parameters:
database_cdc (
Union
[IResolvable
,DatabaseCDCProperty
,Dict
[str
,Any
],None
]) – The database CDC of the file metadata.data_sets (
Union
[IResolvable
,Sequence
[Union
[IResolvable
,DataSetProperty
,Dict
[str
,Any
]]],None
]) – The data sets of the file metadata.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_apptest as apptest file_metadata_property = apptest.CfnTestCase.FileMetadataProperty( database_cdc=apptest.CfnTestCase.DatabaseCDCProperty( source_metadata=apptest.CfnTestCase.SourceDatabaseMetadataProperty( capture_tool="captureTool", type="type" ), target_metadata=apptest.CfnTestCase.TargetDatabaseMetadataProperty( capture_tool="captureTool", type="type" ) ), data_sets=[apptest.CfnTestCase.DataSetProperty( ccsid="ccsid", format="format", length=123, name="name", type="type" )] )
Attributes
- data_sets
The data sets of the file metadata.
- database_cdc
The database CDC of the file metadata.
InputFileProperty
- class CfnTestCase.InputFileProperty(*, file_metadata, source_location, target_location)
Bases:
object
Specifies the input file.
- Parameters:
file_metadata (
Union
[IResolvable
,FileMetadataProperty
,Dict
[str
,Any
]]) – The file metadata of the input file.source_location (
str
) – The source location of the input file.target_location (
str
) – The target location of the input file.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_apptest as apptest input_file_property = apptest.CfnTestCase.InputFileProperty( file_metadata=apptest.CfnTestCase.FileMetadataProperty( database_cdc=apptest.CfnTestCase.DatabaseCDCProperty( source_metadata=apptest.CfnTestCase.SourceDatabaseMetadataProperty( capture_tool="captureTool", type="type" ), target_metadata=apptest.CfnTestCase.TargetDatabaseMetadataProperty( capture_tool="captureTool", type="type" ) ), data_sets=[apptest.CfnTestCase.DataSetProperty( ccsid="ccsid", format="format", length=123, name="name", type="type" )] ), source_location="sourceLocation", target_location="targetLocation" )
Attributes
- file_metadata
The file metadata of the input file.
- source_location
The source location of the input file.
- target_location
The target location of the input file.
InputProperty
- class CfnTestCase.InputProperty(*, file)
Bases:
object
Specifies the input.
- Parameters:
file (
Union
[IResolvable
,InputFileProperty
,Dict
[str
,Any
]]) – The file in the input.- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_apptest as apptest input_property = apptest.CfnTestCase.InputProperty( file=apptest.CfnTestCase.InputFileProperty( file_metadata=apptest.CfnTestCase.FileMetadataProperty( database_cdc=apptest.CfnTestCase.DatabaseCDCProperty( source_metadata=apptest.CfnTestCase.SourceDatabaseMetadataProperty( capture_tool="captureTool", type="type" ), target_metadata=apptest.CfnTestCase.TargetDatabaseMetadataProperty( capture_tool="captureTool", type="type" ) ), data_sets=[apptest.CfnTestCase.DataSetProperty( ccsid="ccsid", format="format", length=123, name="name", type="type" )] ), source_location="sourceLocation", target_location="targetLocation" ) )
Attributes
M2ManagedActionPropertiesProperty
- class CfnTestCase.M2ManagedActionPropertiesProperty(*, force_stop=None, import_data_set_location=None)
Bases:
object
Specifies the Mainframe Modernization managed action properties.
- Parameters:
force_stop (
Union
[bool
,IResolvable
,None
]) – Force stops the Mainframe Modernization managed action properties.import_data_set_location (
Optional
[str
]) – The import data set location of the Mainframe Modernization managed action properties.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_apptest as apptest m2_managed_action_properties_property = apptest.CfnTestCase.M2ManagedActionPropertiesProperty( force_stop=False, import_data_set_location="importDataSetLocation" )
Attributes
- force_stop
Force stops the Mainframe Modernization managed action properties.
- import_data_set_location
The import data set location of the Mainframe Modernization managed action properties.
M2ManagedApplicationActionProperty
- class CfnTestCase.M2ManagedApplicationActionProperty(*, action_type, resource, properties=None)
Bases:
object
Specifies the Mainframe Modernization managed application action.
- Parameters:
action_type (
str
) – The action type of the Mainframe Modernization managed application action.resource (
str
) – The resource of the Mainframe Modernization managed application action.properties (
Union
[IResolvable
,M2ManagedActionPropertiesProperty
,Dict
[str
,Any
],None
]) – The properties of the Mainframe Modernization managed application action.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_apptest as apptest m2_managed_application_action_property = apptest.CfnTestCase.M2ManagedApplicationActionProperty( action_type="actionType", resource="resource", # the properties below are optional properties=apptest.CfnTestCase.M2ManagedActionPropertiesProperty( force_stop=False, import_data_set_location="importDataSetLocation" ) )
Attributes
- action_type
The action type of the Mainframe Modernization managed application action.
- properties
The properties of the Mainframe Modernization managed application action.
- resource
The resource of the Mainframe Modernization managed application action.
M2NonManagedApplicationActionProperty
- class CfnTestCase.M2NonManagedApplicationActionProperty(*, action_type, resource)
Bases:
object
Specifies the Mainframe Modernization non-managed application action.
- Parameters:
action_type (
str
) – The action type of the Mainframe Modernization non-managed application action.resource (
str
) – The resource of the Mainframe Modernization non-managed application action.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_apptest as apptest m2_non_managed_application_action_property = apptest.CfnTestCase.M2NonManagedApplicationActionProperty( action_type="actionType", resource="resource" )
Attributes
- action_type
The action type of the Mainframe Modernization non-managed application action.
- resource
The resource of the Mainframe Modernization non-managed application action.
MainframeActionPropertiesProperty
- class CfnTestCase.MainframeActionPropertiesProperty(*, dms_task_arn=None)
Bases:
object
Specifies the mainframe action properties.
- Parameters:
dms_task_arn (
Optional
[str
]) – The DMS task ARN of the mainframe action properties.- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_apptest as apptest mainframe_action_properties_property = apptest.CfnTestCase.MainframeActionPropertiesProperty( dms_task_arn="dmsTaskArn" )
Attributes
- dms_task_arn
The DMS task ARN of the mainframe action properties.
MainframeActionProperty
- class CfnTestCase.MainframeActionProperty(*, action_type, resource, properties=None)
Bases:
object
Specifies the mainframe action.
- Parameters:
action_type (
Union
[IResolvable
,MainframeActionTypeProperty
,Dict
[str
,Any
]]) – The action type of the mainframe action.resource (
str
) – The resource of the mainframe action.properties (
Union
[IResolvable
,MainframeActionPropertiesProperty
,Dict
[str
,Any
],None
]) – The properties of the mainframe action.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_apptest as apptest mainframe_action_property = apptest.CfnTestCase.MainframeActionProperty( action_type=apptest.CfnTestCase.MainframeActionTypeProperty( batch=apptest.CfnTestCase.BatchProperty( batch_job_name="batchJobName", # the properties below are optional batch_job_parameters={ "batch_job_parameters_key": "batchJobParameters" }, export_data_set_names=["exportDataSetNames"] ), tn3270=apptest.CfnTestCase.TN3270Property( script=apptest.CfnTestCase.ScriptProperty( script_location="scriptLocation", type="type" ), # the properties below are optional export_data_set_names=["exportDataSetNames"] ) ), resource="resource", # the properties below are optional properties=apptest.CfnTestCase.MainframeActionPropertiesProperty( dms_task_arn="dmsTaskArn" ) )
Attributes
- action_type
The action type of the mainframe action.
- properties
The properties of the mainframe action.
- resource
The resource of the mainframe action.
MainframeActionTypeProperty
- class CfnTestCase.MainframeActionTypeProperty(*, batch=None, tn3270=None)
Bases:
object
Specifies the mainframe action type.
- Parameters:
batch (
Union
[IResolvable
,BatchProperty
,Dict
[str
,Any
],None
]) – The batch of the mainframe action type.tn3270 (
Union
[IResolvable
,TN3270Property
,Dict
[str
,Any
],None
]) – The tn3270 port of the mainframe action type.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_apptest as apptest mainframe_action_type_property = apptest.CfnTestCase.MainframeActionTypeProperty( batch=apptest.CfnTestCase.BatchProperty( batch_job_name="batchJobName", # the properties below are optional batch_job_parameters={ "batch_job_parameters_key": "batchJobParameters" }, export_data_set_names=["exportDataSetNames"] ), tn3270=apptest.CfnTestCase.TN3270Property( script=apptest.CfnTestCase.ScriptProperty( script_location="scriptLocation", type="type" ), # the properties below are optional export_data_set_names=["exportDataSetNames"] ) )
Attributes
- batch
The batch of the mainframe action type.
- tn3270
The tn3270 port of the mainframe action type.
OutputFileProperty
- class CfnTestCase.OutputFileProperty(*, file_location=None)
Bases:
object
Specifies an output file.
- Parameters:
file_location (
Optional
[str
]) – The file location of the output file.- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_apptest as apptest output_file_property = apptest.CfnTestCase.OutputFileProperty( file_location="fileLocation" )
Attributes
- file_location
The file location of the output file.
OutputProperty
- class CfnTestCase.OutputProperty(*, file)
Bases:
object
Specifies an output.
- Parameters:
file (
Union
[IResolvable
,OutputFileProperty
,Dict
[str
,Any
]]) – The file of the output.- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_apptest as apptest output_property = apptest.CfnTestCase.OutputProperty( file=apptest.CfnTestCase.OutputFileProperty( file_location="fileLocation" ) )
Attributes
ResourceActionProperty
- class CfnTestCase.ResourceActionProperty(*, cloud_formation_action=None, m2_managed_application_action=None, m2_non_managed_application_action=None)
Bases:
object
Specifies a resource action.
- Parameters:
cloud_formation_action (
Union
[IResolvable
,CloudFormationActionProperty
,Dict
[str
,Any
],None
]) – The CloudFormation action of the resource action.m2_managed_application_action (
Union
[IResolvable
,M2ManagedApplicationActionProperty
,Dict
[str
,Any
],None
]) – The Mainframe Modernization managed application action of the resource action.m2_non_managed_application_action (
Union
[IResolvable
,M2NonManagedApplicationActionProperty
,Dict
[str
,Any
],None
]) – The Mainframe Modernization non-managed application action of the resource action.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_apptest as apptest resource_action_property = apptest.CfnTestCase.ResourceActionProperty( cloud_formation_action=apptest.CfnTestCase.CloudFormationActionProperty( resource="resource", # the properties below are optional action_type="actionType" ), m2_managed_application_action=apptest.CfnTestCase.M2ManagedApplicationActionProperty( action_type="actionType", resource="resource", # the properties below are optional properties=apptest.CfnTestCase.M2ManagedActionPropertiesProperty( force_stop=False, import_data_set_location="importDataSetLocation" ) ), m2_non_managed_application_action=apptest.CfnTestCase.M2NonManagedApplicationActionProperty( action_type="actionType", resource="resource" ) )
Attributes
- cloud_formation_action
The CloudFormation action of the resource action.
- m2_managed_application_action
The Mainframe Modernization managed application action of the resource action.
- m2_non_managed_application_action
The Mainframe Modernization non-managed application action of the resource action.
ScriptProperty
- class CfnTestCase.ScriptProperty(*, script_location, type)
Bases:
object
Specifies the script.
- Parameters:
script_location (
str
) – The script location of the scripts.type (
str
) – The type of the scripts.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_apptest as apptest script_property = apptest.CfnTestCase.ScriptProperty( script_location="scriptLocation", type="type" )
Attributes
- script_location
The script location of the scripts.
- type
The type of the scripts.
SourceDatabaseMetadataProperty
- class CfnTestCase.SourceDatabaseMetadataProperty(*, capture_tool, type)
Bases:
object
Specifies the source database metadata.
- Parameters:
capture_tool (
str
) – The capture tool of the source database metadata.type (
str
) – The type of the source database metadata.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_apptest as apptest source_database_metadata_property = apptest.CfnTestCase.SourceDatabaseMetadataProperty( capture_tool="captureTool", type="type" )
Attributes
- capture_tool
The capture tool of the source database metadata.
- type
The type of the source database metadata.
StepActionProperty
- class CfnTestCase.StepActionProperty(*, compare_action=None, mainframe_action=None, resource_action=None)
Bases:
object
Specifies a step action.
- Parameters:
compare_action (
Union
[IResolvable
,CompareActionProperty
,Dict
[str
,Any
],None
]) – The compare action of the step action.mainframe_action (
Union
[IResolvable
,MainframeActionProperty
,Dict
[str
,Any
],None
]) – The mainframe action of the step action.resource_action (
Union
[IResolvable
,ResourceActionProperty
,Dict
[str
,Any
],None
]) – The resource action of the step action.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_apptest as apptest step_action_property = apptest.CfnTestCase.StepActionProperty( compare_action=apptest.CfnTestCase.CompareActionProperty( input=apptest.CfnTestCase.InputProperty( file=apptest.CfnTestCase.InputFileProperty( file_metadata=apptest.CfnTestCase.FileMetadataProperty( database_cdc=apptest.CfnTestCase.DatabaseCDCProperty( source_metadata=apptest.CfnTestCase.SourceDatabaseMetadataProperty( capture_tool="captureTool", type="type" ), target_metadata=apptest.CfnTestCase.TargetDatabaseMetadataProperty( capture_tool="captureTool", type="type" ) ), data_sets=[apptest.CfnTestCase.DataSetProperty( ccsid="ccsid", format="format", length=123, name="name", type="type" )] ), source_location="sourceLocation", target_location="targetLocation" ) ), # the properties below are optional output=apptest.CfnTestCase.OutputProperty( file=apptest.CfnTestCase.OutputFileProperty( file_location="fileLocation" ) ) ), mainframe_action=apptest.CfnTestCase.MainframeActionProperty( action_type=apptest.CfnTestCase.MainframeActionTypeProperty( batch=apptest.CfnTestCase.BatchProperty( batch_job_name="batchJobName", # the properties below are optional batch_job_parameters={ "batch_job_parameters_key": "batchJobParameters" }, export_data_set_names=["exportDataSetNames"] ), tn3270=apptest.CfnTestCase.TN3270Property( script=apptest.CfnTestCase.ScriptProperty( script_location="scriptLocation", type="type" ), # the properties below are optional export_data_set_names=["exportDataSetNames"] ) ), resource="resource", # the properties below are optional properties=apptest.CfnTestCase.MainframeActionPropertiesProperty( dms_task_arn="dmsTaskArn" ) ), resource_action=apptest.CfnTestCase.ResourceActionProperty( cloud_formation_action=apptest.CfnTestCase.CloudFormationActionProperty( resource="resource", # the properties below are optional action_type="actionType" ), m2_managed_application_action=apptest.CfnTestCase.M2ManagedApplicationActionProperty( action_type="actionType", resource="resource", # the properties below are optional properties=apptest.CfnTestCase.M2ManagedActionPropertiesProperty( force_stop=False, import_data_set_location="importDataSetLocation" ) ), m2_non_managed_application_action=apptest.CfnTestCase.M2NonManagedApplicationActionProperty( action_type="actionType", resource="resource" ) ) )
Attributes
- compare_action
The compare action of the step action.
- mainframe_action
The mainframe action of the step action.
- resource_action
The resource action of the step action.
StepProperty
- class CfnTestCase.StepProperty(*, action, name, description=None)
Bases:
object
Defines a step.
- Parameters:
action (
Union
[IResolvable
,StepActionProperty
,Dict
[str
,Any
]]) – The action of the step.name (
str
) – The name of the step.description (
Optional
[str
]) – The description of the step.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_apptest as apptest step_property = apptest.CfnTestCase.StepProperty( action=apptest.CfnTestCase.StepActionProperty( compare_action=apptest.CfnTestCase.CompareActionProperty( input=apptest.CfnTestCase.InputProperty( file=apptest.CfnTestCase.InputFileProperty( file_metadata=apptest.CfnTestCase.FileMetadataProperty( database_cdc=apptest.CfnTestCase.DatabaseCDCProperty( source_metadata=apptest.CfnTestCase.SourceDatabaseMetadataProperty( capture_tool="captureTool", type="type" ), target_metadata=apptest.CfnTestCase.TargetDatabaseMetadataProperty( capture_tool="captureTool", type="type" ) ), data_sets=[apptest.CfnTestCase.DataSetProperty( ccsid="ccsid", format="format", length=123, name="name", type="type" )] ), source_location="sourceLocation", target_location="targetLocation" ) ), # the properties below are optional output=apptest.CfnTestCase.OutputProperty( file=apptest.CfnTestCase.OutputFileProperty( file_location="fileLocation" ) ) ), mainframe_action=apptest.CfnTestCase.MainframeActionProperty( action_type=apptest.CfnTestCase.MainframeActionTypeProperty( batch=apptest.CfnTestCase.BatchProperty( batch_job_name="batchJobName", # the properties below are optional batch_job_parameters={ "batch_job_parameters_key": "batchJobParameters" }, export_data_set_names=["exportDataSetNames"] ), tn3270=apptest.CfnTestCase.TN3270Property( script=apptest.CfnTestCase.ScriptProperty( script_location="scriptLocation", type="type" ), # the properties below are optional export_data_set_names=["exportDataSetNames"] ) ), resource="resource", # the properties below are optional properties=apptest.CfnTestCase.MainframeActionPropertiesProperty( dms_task_arn="dmsTaskArn" ) ), resource_action=apptest.CfnTestCase.ResourceActionProperty( cloud_formation_action=apptest.CfnTestCase.CloudFormationActionProperty( resource="resource", # the properties below are optional action_type="actionType" ), m2_managed_application_action=apptest.CfnTestCase.M2ManagedApplicationActionProperty( action_type="actionType", resource="resource", # the properties below are optional properties=apptest.CfnTestCase.M2ManagedActionPropertiesProperty( force_stop=False, import_data_set_location="importDataSetLocation" ) ), m2_non_managed_application_action=apptest.CfnTestCase.M2NonManagedApplicationActionProperty( action_type="actionType", resource="resource" ) ) ), name="name", # the properties below are optional description="description" )
Attributes
- action
The action of the step.
- description
The description of the step.
TN3270Property
- class CfnTestCase.TN3270Property(*, script, export_data_set_names=None)
Bases:
object
Specifies the TN3270 protocol.
- Parameters:
script (
Union
[IResolvable
,ScriptProperty
,Dict
[str
,Any
]]) – The script of the TN3270 protocol.export_data_set_names (
Optional
[Sequence
[str
]]) – The data set names of the TN3270 protocol.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_apptest as apptest t_n3270_property = apptest.CfnTestCase.TN3270Property( script=apptest.CfnTestCase.ScriptProperty( script_location="scriptLocation", type="type" ), # the properties below are optional export_data_set_names=["exportDataSetNames"] )
Attributes
- export_data_set_names
The data set names of the TN3270 protocol.
- script
The script of the TN3270 protocol.
TargetDatabaseMetadataProperty
- class CfnTestCase.TargetDatabaseMetadataProperty(*, capture_tool, type)
Bases:
object
Specifies a target database metadata.
- Parameters:
capture_tool (
str
) – The capture tool of the target database metadata.type (
str
) – The type of the target database metadata.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_apptest as apptest target_database_metadata_property = apptest.CfnTestCase.TargetDatabaseMetadataProperty( capture_tool="captureTool", type="type" )
Attributes
- capture_tool
The capture tool of the target database metadata.
- type
The type of the target database metadata.
TestCaseLatestVersionProperty
- class CfnTestCase.TestCaseLatestVersionProperty(*, status, version)
Bases:
object
Specifies the latest version of a test case.
- Parameters:
status (
str
) – The status of the test case latest version.version (
Union
[int
,float
]) – The version of the test case latest version.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_apptest as apptest test_case_latest_version_property = apptest.CfnTestCase.TestCaseLatestVersionProperty( status="status", version=123 )
Attributes
- status
The status of the test case latest version.
- version
The version of the test case latest version.