Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Code Sample Clarity for aws.ec2.getSubnet #5635

Open
jdh313 opened this issue Oct 7, 2024 · 1 comment
Open

Code Sample Clarity for aws.ec2.getSubnet #5635

jdh313 opened this issue Oct 7, 2024 · 1 comment
Labels
area/registry impact/usability Something that impacts users' ability to use the product easily and intuitively kind/enhancement Improvements or new features
Milestone

Comments

@jdh313
Copy link

jdh313 commented Oct 7, 2024

In the following code block:

import pulumi
import pulumi_aws as aws

config = pulumi.Config()
subnet_id = config.require_object("subnetId")
selected = aws.ec2.get_subnet(id=subnet_id)
subnet = aws.ec2.SecurityGroup("subnet",
    vpc_id=selected.vpc_id,
    ingress=[{
        "cidr_blocks": [selected.cidr_block],
        "from_port": 80,
        "to_port": 80,
        "protocol": "tcp",
    }])

the variable name subnet is extremely confusing as it's a security group being created with that function call.

File: themes/default/content//registry/packages/aws/api-docs/ec2/getsubnet

@pulumi-bot pulumi-bot added the needs-triage Needs attention from the triage team label Oct 7, 2024
@thoward
Copy link
Contributor

thoward commented Oct 17, 2024

Thanks for reporting this issue! I completely agree with you here. I went ahead and filed a PR to make that change. Will circle back when it is merged.

Fixed in: hashicorp/terraform-provider-aws#39781

@thoward thoward added kind/enhancement Improvements or new features area/registry impact/usability Something that impacts users' ability to use the product easily and intuitively and removed needs-triage Needs attention from the triage team labels Oct 17, 2024
@thoward thoward added this to the 0.111 milestone Oct 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/registry impact/usability Something that impacts users' ability to use the product easily and intuitively kind/enhancement Improvements or new features
Projects
Status: 💜 Review
Development

No branches or pull requests

3 participants