(aws-redshift): Tables are always created with a suffix

[gkubes]

What is the problem?

When creating a Redshift table using the Table construct the table are always created with a suffix. Looking at the code it appears that this should be an optional behavior.

Reproduction Steps

Create a table

const myTable = new redshift.Table(this, "MyTable", {
    cluster: cluster,
    adminUser: adminSecret,
    databaseName: "MyDb",
    tableName: "s.my_table",
    tableColumns: [
        { name: 'id', dataType: 'numeric(38,0) DISTKEY NOT NULL encode raw' },
        { name: 'request_datetime_utc', dataType: 'timestamp without time zone NULL encode raw' }
    ]
});

and build CDK to generate CFN

"MyTableD7252149": {
  "Type": "Custom::RedshiftDatabaseQuery",
  "Properties": {
    "ServiceToken": {
      "Fn::GetAtt": [
        "MyTableProviderframeworkonEventA4849808",
        "Arn"
      ]
    },
    "handler": "table",
    "clusterName": {
      "Ref": "MyCluster"
    },
    "adminUserArn": {
      "Ref": "AdminSecret"
    },
    "databaseName": "MyDb",
    "tableName": {
      "prefix": "s.my_table",
      "generateSuffix": false
    },
    "tableColumns": [
      {
        "name": "id",
        "dataType": "numeric(38,0) DISTKEY NOT NULL encode raw"
      },
      {
        "name": "request_datetime_utc",
        "dataType": "timestamp without time zone NULL encode raw"
      }
    ]
  },
  "UpdateReplacePolicy": "Retain",
  "DeletionPolicy": "Retain",
  "Metadata": {
    "aws:cdk:path": "MyStack/MyTable/Resource/Resource/Default"
  }
},

Notice that generateSuffix is set to false which would mean that my table should simply have the name s.my_table

What did you expect to happen?

A Redshift table created with the name s.my_table

What actually happened?

A Redshift table created with the name s.my_tabled8a03679

CDK CLI Version

1.126.0

Framework Version

No response

Node.js Version

NodeJS-12.0

OS

Amazon Linux 2012

Language

Typescript

Language Version

No response

Other information

I can see that the generateSuffix: "false" is present in the Lambda Event for the Table creation custom resource

{
    "RequestType": "Create",
    "ServiceToken": "arn:aws:lambda:us-west-2:11111111111111:function:IGTWBRDBInfrastructure-ComplianceDrCidTableProvide-g2VTPfULZtQa",
    "ResponseURL": "https://cloudformation-custom-resource-response-uswest2.s3-us-west-2.amazonaws.com/arn%3Aaws%3Acloudformation%3Aus-west-2%3A1",
    "StackId": "arn:aws:cloudformation:us-west-2:11111111111111:stack/MyStack/9b0abc30-9591-11ea-ba99-067aa3cae1e0",
    "RequestId": "132a420e-5173-4e22-9b96-c04493148172",
    "LogicalResourceId": "MyTableD7252149",
    "ResourceType": "Custom::RedshiftDatabaseQuery",
    "ResourceProperties": {
        "ServiceToken": "arn:aws:lambda:us-west-2:11111111111111:function:MyTableProvide-g2VTPfULZtQa",
        "handler": "table",
        "tableColumns": [
            {
                "dataType": "numeric(38,0) DISTKEY NOT NULL encode raw",
                "name": cid"
            },
            {
                "dataType": "timestamp without time zone NULL encode zstd",
                "name": "request_completed_datetime_utc"
            }
        ],
        "adminUserArn": "arn:aws:secretsmanager:us-west-2:11111111111111:secret:AdminSecret-omYPRk",
        "databaseName": "MyDb",
        "clusterName": "MyCluster",
        "tableName": {
            "prefix": "s.my_table",
            "generateSuffix": "false"
        }
    }
}

however it is a string as opposed to a boolean. As a result props.tableName.generateSuffix ? ${event.RequestId.substring(0, 8)} : '' is evaluated to true instead of false which creates the suffix.

[gkubes]

To work around this I can use an escape hatch to remove the generatePrefix: false attribute

(table.node.findChild("Resource").node.findChild("Resource").node.defaultChild as core.CfnCustomResource).addPropertyDeletionOverride("tableName.generateSuffix");

which results in the following Custom Resource event payload

{
    "RequestType": "Create",
    "ServiceToken": "arn:aws:lambda:us-west-2:11111111111111:function:IGTWBRDBInfrastructure-ComplianceDrCidTableProvide-g2VTPfULZtQa",
    "ResponseURL": "https://cloudformation-custom-resource-response-uswest2.s3-us-west-2.amazonaws.com/arn%3Aaws%3Acloudformation%3Aus-west-2%3A1",
    "StackId": "arn:aws:cloudformation:us-west-2:11111111111111:stack/MyStack/9b0abc30-9591-11ea-ba99-067aa3cae1e0",
    "RequestId": "132a420e-5173-4e22-9b96-c04493148172",
    "LogicalResourceId": "MyTableD7252149",
    "ResourceType": "Custom::RedshiftDatabaseQuery",
    "ResourceProperties": {
        "ServiceToken": "arn:aws:lambda:us-west-2:11111111111111:function:MyTableProvide-g2VTPfULZtQa",
        "handler": "table",
        "tableColumns": [
            {
                "dataType": "numeric(38,0) DISTKEY NOT NULL encode raw",
                "name": cid"
            },
            {
                "dataType": "timestamp without time zone NULL encode zstd",
                "name": "request_completed_datetime_utc"
            }
        ],
        "adminUserArn": "arn:aws:secretsmanager:us-west-2:11111111111111:secret:AdminSecret-omYPRk",
        "databaseName": "MyDb",
        "clusterName": "MyCluster",
        "tableName": {
            "prefix": "s.my_table"
        }
    }
}

Now props.tableName.generateSuffix ? ${event.RequestId.substring(0, 8)} : '' evaluates to ""

[iRoachie]

Is it that properties passed in via a custom resource are always converted to strings?

[njlynch]

Thanks for the detailed bug report!

Agree that the line you linked is the issue in question. Given how this is evaluated, changing the line to check if the generateSuffix is explicitly "true" would probably suffice. Contributions welcome!

[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.