如何在 CloudWatch 仪表板模板中使用参数

Question

我正在尝试创建一个CloudFormation 模板来创建一个CloudWatch 仪表板。以下是模板代码-

Parameters:
    MyEnvironment:
        Type: String
        Default: "do"
        Description: "Specifies the environment of the platform."
Resources:
    MyServiceDashboard:
        Type: AWS::CloudWatch::Dashboard
        Properties:
            DashboardName: "Test-My-Dashboard"
            DashboardBody: >
                {
                    "widgets": [
                        {
                            "type": "metric",
                            "x": 15,
                            "y": 18,
                            "width": 6,
                            "height": 6,
                            "properties": {
                                "view": "timeSeries",
                                "stacked": false,
                                "metrics": [
                                    [ "AWS/Kinesis", "GetRecords.IteratorAgeMilliseconds", "StreamName", 
"${MyEnvironment}-my-data-out"
                                    ]...

我正在尝试使用MyEnvironment 参数，当我实际使用此模板创建堆栈时将提供该参数。

问题是 stack/dashbaord 是使用它创建的，但参数值没有在 Dashboard 指标中使用，而是使用值作为 "${MyEnvironment}-my-data-out" 而不是 "Dev-my-data-out" 假设我提供了 "MyEnvironment" 值作为 "Dev"

我尝试了此链接中指定的方法 - Use Pseudo Variables in Cloudwatch Dashboard Template (Cloudformation)，但 CloudFormation 在使用 Sub >- 关键字时显示无效模板。

Answer 1

尝试了各种方案后，找到了解决方案，重要 要点是使用!Sub函数，否则JSON字符串中的参数值不会被替换。

        DashboardName: "Test-My-Dashboard"
        DashboardBody: !Sub '{
                "widgets": [

注意DashboardBody 属性中的!Sub 函数。之后，您可以使用${PARAMETER_NAME} 格式引用参数值。

!Sub function documentation

Answer 2

“MyEnvironment”不是伪变量。它仅适用于 AWS 变量，例如区域。 如果要参数化，则需要使用 'Ref'。

    Parameters:
MyEnvironment:
    Type: String
    Default: "do"
    Description: "Specifies the environment of the platform."
    Resources:
MyServiceDashboard:
    Type: AWS::CloudWatch::Dashboard
    Properties:
        DashboardName: "Test-My-Dashboard"
        DashboardBody: >
            {
                "widgets": [
                    {
                        "type": "metric",
                        "x": 15,
                        "y": 18,
                        "width": 6,
                        "height": 6,
                        "properties": {
                            "view": "timeSeries",
                            "stacked": false,
                            "metrics": [
                                [ "AWS/Kinesis", "GetRecords.IteratorAgeMilliseconds", "StreamName",  {"Ref" : "MyEnvironment"}

                              ]... 

直接在 MyEnvironment 参数中传递“Dev-my-data-out”以避免复杂化。