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.

Sign up for GitHub

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

Jump to bottom

Update emr_cluster.html.markdown #736

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update emr_cluster.html.markdown #736

wants to merge 1 commit into from

Conversation

jlieow
Copy link

@jlieow jlieow commented Apr 23, 2024 •
edited
Loading

Description

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

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

No CHANGELOG.md update as it is a documentation update.

Relations

Closes #735

References

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

Output from Acceptance Testing

Does not affect tests as it is a documentation update.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[Docs]: Outdated documentation for aws_emr_cluster step and hadoop_jar_step variables
1 participant
@jlieow