Codepipeline: Error thrown when adding custom action

[charles-hay]

Describe the bug

I get the following error when trying to add a custom action to a stage in a pipeline

jsii.errors.JSIIError: Expected object reference, got {"$jsii.struct":{"fqn":"aws-cdk-lib.aws_codepipeline.CfnPipeline.ActionDeclarationProperty","data":{"actionTypeId":{"$jsii.struct":{"fqn":"aws-cdk-lib.aws_codepipeline.CfnPipeline.ActionTypeIdProperty","data":{"category":"Test","owner":"Custom","provider":"DeviceFarm","version":"1.0.0"}}},"name":"DeviceFarmAction","configuration":null,"inputArtifacts":null,"namespace":null,"outputArtifacts":null,"region":null,"roleArn":null,"runOrder":3}}}

The code is as follows:

 self.cfn_device_project = CfnResource(
            self,
            "cfn_device_project",
            type="AWS::DeviceFarm::Project",
            properties={
                "Name": project_name,
            }
        )
        self.cfn_device_pool = CfnResource(
            self,
            "cfn_device_pool",
            type="AWS::DeviceFarm::DevicePool",
            properties={
              "Description" : "Device pool for testing. Created by application pipeline",
              "Name" : project_name,
              "ProjectArn" : self.cfn_device_project.get_att('resource.arn'),
            }
        )
        self.action_config_device_pool_arn = codepipeline.CfnCustomActionType.ConfigurationPropertiesProperty(
            key=False,
            name="DevicePoolArn",
            required=True,
            secret=False,
            description="The AWS Device Farm device pool ARN.",
            queryable=True,
            type="String"
        )
        self.action_config_project_id = codepipeline.CfnCustomActionType.ConfigurationPropertiesProperty(
            key=False,
            name="ProjectId",
            required=True,
            secret=False,
            description="The AWS Device Farm project ID.",
            type="String",
        )
        self.action_config_app_type = codepipeline.CfnCustomActionType.ConfigurationPropertiesProperty(
            key=False,
            name="AppType",
            required=True,
            secret=False,
            description="The type of application to test.",
            type="String",
        )
        self.action_config_test_type = codepipeline.CfnCustomActionType.ConfigurationPropertiesProperty(
            key=False,
            name="TestType",
            required=True,
            secret=False,
            description="The type of test to run during the AWS Device Farm test step. If you're using one of the "
                        "built-in Device Farm tests, choose the type of test configured in your Device Farm project. "
                        "If you aren't using one of the Device Farm built-in tests, in the Test file path, enter the "
                        "path of the test definition file. The path is relative to the root of the input artifact for "
                        "your test.",
            type="String",
        )
        self.action_config_app = codepipeline.CfnCustomActionType.ConfigurationPropertiesProperty(
            key=False,
            name="App",
            required=True,
            secret=False,
            description="The path of the compiled app package. "
                        "The path is relative to the root of the input artifact for your test.",
            type="String"
        )
        self.configuration_properties=[
                self.action_config_device_pool_arn,
                self.action_config_project_id,
                self.action_config_app_type,
                self.action_config_test_type,
                self.action_config_app,
            ]
        self.device_farm_action_type = codepipeline.CfnCustomActionType(
            self,
            "CustomDeviceFarmAction",
            category="Test",
            provider="DeviceFarm",
            version="1.0.0",
            input_artifact_details=codepipeline.CfnCustomActionType.ArtifactDetailsProperty(
                maximum_count=1,
                minimum_count=1
            ),
            output_artifact_details=codepipeline.CfnCustomActionType.ArtifactDetailsProperty(
                maximum_count=5,
                minimum_count=0,
            ),
            configuration_properties=self.configuration_properties
        )
        self.device_farm_action = codepipeline.CfnPipeline.ActionDeclarationProperty(
            action_type_id=codepipeline.CfnPipeline.ActionTypeIdProperty(
                category="Test",
                owner="Custom",
                provider="DeviceFarm",
                version="1.0.0"
            ),
            name="DeviceFarmAction",
            run_order=3,
            configuration={
                "DevicePoolArn": self.cfn_device_pool.get_att('resource.arn'),
                "ProjectId": self.cfn_device_project.get_att('id'),
                "AppType": "",
                "TestType": ""
            }
        )
        if qa_stage is None and qa_deployment_group is None:
            raise Exception("Either qa_stage or qa_deployment_group must be present")
        self.qa_stage = qa_stage or codepipeline.StageProps(
            stage_name="QA",
            actions=[
                codepipeline_actions.CodeDeployEcsDeployAction(
                    deployment_group=qa_deployment_group,  # type: ignore
                    app_spec_template_input=self._source_artifact,
                    action_name="Deploy",
                    task_definition_template_file=ArtifactPath(
                        self._source_artifact, "codedeploy/appspec.yml"
                    ),
                    run_order=1,
                ),
                codepipeline_actions.CodeBuildAction(
                    input=self._source_artifact,
                    project=codebuild.PipelineProject(
                        self,
                        "QAFunctionalTestProject",
                        build_spec=codebuild.BuildSpec.from_source_filename(
                            "codebuild/functional.buildspec.yml"
                        ),
                    ),
                    type=codepipeline_actions.CodeBuildActionType.TEST,
                    action_name="FunctionalTest",
                    run_order=2,
                ),
                codepipeline_actions.CodeBuildAction(
                    input=self._source_artifact,
                    project=codebuild.PipelineProject(
                        self,
                        "QAApiTestProject",
                        build_spec=codebuild.BuildSpec.from_source_filename(
                            "codebuild/api.buildspec.yml"
                        ),
                    ),
                    type=codepipeline_actions.CodeBuildActionType.TEST,
                    action_name="ApiTest",
                    run_order=2,
                ),
                self.device_farm_action,
            ],
        )

Expected Behavior

Successful addition of custom action to pipeline

Current Behavior

Error mentioned above thrown

Reproduction Steps

Run the code above in custom pipeline

Possible Solution

No response

Additional Information/Context

No response

CDK CLI Version

2.20.0 (build 738ef49)

Framework Version

No response

Node.js Version

v16.14.2

OS

MacOs

Language

Python

Language Version

No response

Other information

No response

[skinny85]

Hi @charles-hay,

thanks for opening the issue. The problem is that you're mixing two levels of resources that CDK supports.

The Cfn* classes that you're using are what CDK calls Layer 1 constructs. While the Stage and other classes without the Cfn* prefix that you're using are Layer 2 constructs. You can't really mix and match the two this way - you have to use one, or the other.

If you want to write a custom implementation of the IAction interface (which represents an Action in Layer 2), see this issue: #2516 (comment) for help.

Thanks,
Adam

[github-actions]

This issue has not received a response in a while. If you want to keep this issue open, please leave a comment below and auto-close will be canceled.