Improve UX For List Block Types with Max 1 Element

[skorfmann]

Community Note

• Please vote on this issue by adding a 👍 reaction to the original issue to help the community and maintainers prioritize this request
• Please do not leave "+1" or other comments that do not add relevant new information or questions, they generate extra noise for issue followers and do not help prioritize the request
• If you are interested in working on this issue or have submitted a pull request, please leave a comment

Description

There are more then 3000 occasions in the AWS schema where a list type can have at most one element or exactly one element. See this example of t he AwsProvider schema and note the max_items at the bottom:

      "assume_role": {
        "nesting_mode": "list",
        "block": {
          "attributes": {
            "external_id": {
              "type": "string",
              "description": "The external ID to use when assuming the role. If omitted, no external ID is passed to the AssumeRole call.",
              "optional": true
            },
            "policy": {
              "type": "string",
              "description": "The permissions applied when assuming a role. You cannot use, this policy to grant further permissions that are in excess to those of the,  role that is being assumed.",
              "optional": true
            },
            "role_arn": {
              "type": "string",
              "description": "The ARN of an IAM role to assume prior to making API calls.",
              "optional": true
            },
            "session_name": {
              "type": "string",
              "description": "The session name to use when assuming the role. If omitted, no session name is passed to the AssumeRole call.",
              "optional": true
            }
          }
        },
        "max_items": 1
      },

I'm wondering if it makes sense, to not render these schema types as Lists, but as objects.

Rather than:

    new AwsProvider(this, 'aws', {
      region: 'eu-central-1',
      assumeRole: [{
        roleArn: 'abc',
        sessionName: 'foo',
        externalId: 'bar'
      }]
    })

I'd expect this, which also aligns with the Terraform docs

    new AwsProvider(this, 'aws', {
      region: 'eu-central-1',
      assumeRole: {
        roleArn: 'abc',
        sessionName: 'foo',
        externalId: 'bar'
      }
    })

References

#253

[github-actions]

I'm going to lock this issue because it has been closed for 30 days. This helps our maintainers find and focus on the active issues. If you've found a problem that seems similar to this, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.