Repository navigation
[Core] support complex types in Fn.conditionIf #8396
Description
I am using the CDK to output a raw CloudFormation template as a final deliverable and am using primarily Cfn* resource constructs. We have a CfnPipeline object where I want to conditionally add a stage depending on a CfnParameter value. I have the following code:
codepipeline = aws_codepipeline.CfnPipeline(
self,
"Pipeline",
artifact_store=aws_codepipeline.CfnPipeline.ArtifactStoreProperty(...),
type="S3"
),
role_arn=codepipeline_role.role_arn,
stages=[
aws_codepipeline.CfnPipeline.StageDeclarationProperty(...),
aws_codepipeline.CfnPipeline.StageDeclarationProperty(...),
aws_codepipeline.CfnPipeline.StageDeclarationProperty(...),
core.Fn.condition_if(
cloudfront_enable_condition.logical_id,
aws_codepipeline.CfnPipeline.StageDeclarationProperty(
name="Finalize",
actions=[
aws_codepipeline.CfnPipeline.ActionDeclarationProperty(
action_type_id=aws_codepipeline.CfnPipeline.ActionTypeIdProperty(
category="Invoke",
owner="AWS",
provider="Lambda",
version="1"
),
configuration={
"FunctionName": cloudfront_invalidation_lambda_function.ref
},
name="CloudFrontInvalidationAction",
role_arn=codepipeline_finalize_stage_role.attr_arn
)
]
),
core.Aws.NO_VALUE
)
]
)Which produces the following output in my CloudFormation template:
{
"Fn::If": [
"CloudFrontEnableCondition",
{
"actions": [
{
"actionTypeId": {
"category": "Invoke",
"owner": "AWS",
"provider": "Lambda",
"version": "1"
},
"name": "CloudFrontInvalidationAction",
"configuration": {
"FunctionName": {
"Ref": "CloudFrontInvalidationLambdaFunction"
}
},
"roleArn": {
"Fn::GetAtt": [
"CodePipelineFinalizeStageRole",
"Arn"
]
}
}
],
"name": "Finalize"
},
{
"Ref": "AWS::NoValue"
}
]
}
]The keys of the CfnPipeline.StageDeclarationProperty and its children (CfnPipeline.ActionDeclarationProperty and CfnPipeline.ActionTypeIdProperty) are printed in camelCase, making for invalid CloudFormation objects on submission. I've also tried by wrapping the conditional statement in core.Token.as_any() with the same result.
I have resorted to using the following code:
codepipeline.add_override(
"Properties.Stages.3",
{
"Fn::If": [
cloudfront_enable_condition.logical_id,
{
"Actions": [
{
"ActionTypeId": {
"Category": "Invoke",
"Owner": "AWS",
"Provider": "Lambda",
"Version": 1
},
"Configuration": {
"FunctionName": cloudfront_invalidation_lambda_function.ref
},
"Name": "CloudFrontInvalidationAction",
"RoleArn": codepipeline_finalize_stage_role.attr_arn
}
],
"Name": "Finalize"
},
core.Aws.NO_VALUE
]
}
)which fixes my issue and proves that my conditional is valid in CloudFormation, but it feels messy and like the Cfn* properties should be supported in conditionals (IResolvable?).
Feels like this is a bug, but might be a feature request -- perhaps something is missing in the translation layer between nodejs and the Python API? If I'm supposed to be using the API differently, please advise.
Reproduction Steps
Run the above code patterns and inspect the cloudformation template in cdk.out
Error Log
CloudFormation complains of invalid object syntax.
Environment
- CLI Version : 1.42.1
- Framework Version:
- Node.js Version: 12.16.2
- OS : Ubuntu
- Language (Version): Python3
Other
This is 🐛 Bug Report
Activity
immmapig commentedon Jun 27, 2020
I am dealing with a similar issue.
Code before the change:
Code after the change:
Template before the change:
Template after the change:
Notice that the template after the change incorrectly uses
readCapacityUnitsandwriteCapacityUnitsas the keys instead ofReadCapacityUnitsandWriteCapacityUnits.[-]CfnPipeline.StageDeclarationProperty does not translate to correct CloudFormation syntax when returned from conditional in Python[/-][+][Core] support complex types in Fn.If conditions [/+][-][Core] support complex types in Fn.If conditions [/-][+][Core] support complex types in Fn. conditionIf [/+][-][Core] support complex types in Fn. conditionIf [/-][+][Core] support complex types in Fn.conditionIf [/+]8 remaining items
aaroncarlucci commentedon Oct 5, 2020
@rix0rrr Thanks for reconsidering. A reminder that the use case presented in the ticket description is using Cfn* resources to generate a CloudFormation template final deliverable and the suggested happy path of doing
ifstatements in TypeScript or Python isn't an option for us.bollig commentedon Feb 14, 2021
+1 for the use-case to generate standalone CFN templates. I had to use the same sort of workaround for conditionals on the FSx Lustre resource configuration block. Red line is desired.
namedgraph commentedon Jun 9, 2021
@bollig what is the workaround mechanism here?
I want to set
NetworkLoadBalancedEc2Service.domainZone()ifHostedZoneis provided, but not sure how to do it withFn.conditionIf()since it provides a string and not an object :/bollig commentedon Jun 9, 2021
drobbins-ancile commentedon Mar 5, 2022
@rix0rrr Any chance of getting this one addressed? We are also using CDK to generate CloudFormation templates to be manually deployed in other environments so using
ifconditions in the language won't work for us.This seems to be a valid use case.
savanbthakkar commentedon Mar 6, 2022
@rix0rrr We are having the same problem with DynamoDB. Depending on the input parameter value, we need to set sse_specification. It generates the cloudformation yaml file, but the output is camelCase yaml attributes, and it errors out.
Here is the yaml output, which is invalid.
drobbins-ancile commentedon Aug 12, 2022
@rix0rrr Can we get an official decision on the validity of this use case? Is using
cdk synthto generate cloudformation templates for deployment in other environments a supported use case? If so, is there any chance this issue will be worked on?madeline-k commentedon Feb 28, 2023
Thank you for submitting this feature request! After closer examination of the issue by CDK product and development team, there are no plans to implement this in the near feature.
I am moving this to a GitHub discussion so the information in this thread can continue to be accessible, and people can find the helpful workaround posted here.