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

[Docs]: Outdated documentation for aws_emr_cluster step and hadoop_jar_step variables #735

Open
jlieow opened this issue Apr 23, 2024 · 0 comments · May be fixed by #736
Open

[Docs]: Outdated documentation for aws_emr_cluster step and hadoop_jar_step variables #735

jlieow opened this issue Apr 23, 2024 · 0 comments · May be fixed by #736
Labels
documentation Improvements or additions to documentation

Comments

@jlieow
Copy link

jlieow commented Apr 23, 2024

Documentation Link

https://registry.terraform.io/providers/figma/aws-4-49-0/latest/docs/resources/emr_cluster#enable-debug-logging

Description

Under the section [Enable Debug Logging(https://registry.terraform.io/providers/figma/aws-4-49-0/latest/docs/resources/emr_cluster#enable-debug-logging), step and hadoop_jar_step requires a list instead of a map.

It should be updated from:

resource "aws_emr_cluster" "example" {
  # ... other configuration ...

  step {
    action_on_failure = "TERMINATE_CLUSTER"
    name              = "Setup Hadoop Debugging"

    hadoop_jar_step {
      jar  = "command-runner.jar"
      args = ["state-pusher-script"]
    }
  }

  # Optional: ignore outside changes to running cluster steps
  lifecycle {
    ignore_changes = [step]
  }
}

To the following:

resource "aws_emr_cluster" "example" {
  # ... other configuration ...

  step = [{
    action_on_failure = "TERMINATE_CLUSTER"
    name              = "Setup Hadoop Debugging"

    hadoop_jar_step = [{
      jar  = "command-runner.jar"
      args = ["state-pusher-script"]
    }]
  }]

  # Optional: ignore outside changes to running cluster steps
  lifecycle {
    ignore_changes = [step]
  }
}

For step, this is also supported by the aws emr create-cluster documentation where --step requires a list of steps to be executed by the cluster.

Error received when a map is submitted to the step variable:
step_error

Error received when a map is submitted to the hadoop_jar_step variable:
hadoop_jar_step_error

References

https://docs.aws.amazon.com/cli/latest/reference/emr/create-cluster.html

Would you like to implement a fix?

Yes

@jlieow jlieow added the documentation Improvements or additions to documentation label Apr 23, 2024
@jlieow jlieow linked a pull request Apr 23, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant