aws-ssm: StringParameter Doesn't support data_type=ssm.ParameterType.AWS_EC2_IMAGE_ID

[scottbisker]

What is the problem?

When trying to create a StringParameter of type ssm.ParameterType.AWS_EC2_IMAGE_ID, CDK throws the following error.

1 validation error detected: Value 'AWS::EC2::Image::Id' at 'type' failed to satisfy constraint: Member must satisfy enum value set: [SecureString, StringList, String]. (Service: AmazonSSM; Status Code: 400; Error Code: Validat
ionException; Request ID: 2c97174a-045e-4451-be0a-b61d8f5a2fe8; Proxy: null)

Reproduction Steps

image_parameter = ssm.StringParameter(self, 'ImageBuilderAMI',
type = ssm.ParameterType.AWS_EC2_IMAGE_ID,
parameter_name = '/ec2-imagebuilder/latest',
description = "Latest AMI Image",
string_value = self.node.try_get_context(env_context)["LinuxAmi"]
)

What did you expect to happen?

Since it is StringParameter, there should be an additional value passed in the constructor data_type.

This is a working version using ssm.CfnParameter.

    image_parameter = ssm.CfnParameter(self, "ImageBuilderAMI",
        type = "String",
        data_type = "aws:ec2:image",
        name = "/ec2-imagebuilder/latest",
        description = "Latest AMI Image",
        value = self.node.try_get_context(env_context)["LinuxAmi"] 
        )

What actually happened?

Stack failed to create.

1 validation error detected: Value 'AWS::EC2::Image::Id' at 'type' failed to satisfy constraint: Member must satisfy enum value set: [SecureString, StringList, String]. (Service: AmazonSSM; Status Code: 400; Error Code: Validat
ionException; Request ID: 2c97174a-045e-4451-be0a-b61d8f5a2fe8; Proxy: null)

CDK CLI Version

1.24.0

Framework Version

No response

Node.js Version

14.16.1

OS

MacOS Big Sur

Language

Python

Language Version

3.9

Other information

No response

[peterwoodworth]

Thanks for reporting this! The only accepted values for AWS::SSM::Parameter.Type are String or StringList.

The CDK wants you to use an enum ParameterType to specify the type on the StringParameter construct, but then it will directly use this value for the AWS::SSM::Parameter.Type, which will reject this value at deploy time.

aws-cdk/packages/@aws-cdk/aws-ssm/lib/parameter.ts

Lines 441 to 448 in f004e1a

	const resource = new ssm.CfnParameter(this, 'Resource', {
	allowedPattern: props.allowedPattern,
	description: props.description,
	name: this.physicalName,
	tier: props.tier,
	type: props.type || ParameterType.STRING,
	value: props.stringValue,
	});

[github-actions]

⚠️COMMENT VISIBILITY WARNING⚠️

Comments on closed issues are hard for our team to see.
If you need more assistance, please either tag a team member or open a new issue that references this one.
If you wish to keep having a conversation with other community members under this issue feel free to do so.