[Bug]: Unable to save IgnoreHeaderRows setting in aws_dms_endpoint

[jam2-hey]

Terraform Core Version

1.2.0

AWS Provider Version

4.31.0

Affected Resource(s)

• aws_dms_endpoint

Expected Behavior

Be able to apply IgnoreHeaderRows setting in a s3 DMS endpoint.

Actual Behavior

IgnoreHeaderRows setting did not saved.

Relevant Error/Panic Output Snippet

# aws_dms_endpoint.source_s3_demo_data_source will be updated in-place
  ~ resource "aws_dms_endpoint" "source_s3_demo_data_source" {
        id                          = "source-s3-demo-data-source"
        tags                        = {}
        # (7 unchanged attributes hidden)

      ~ s3_settings {
          ~ ignore_headers_row               = 0 -> 1
            # (30 unchanged attributes hidden)
        }
    }

Terraform Configuration Files

resource "aws_dms_endpoint" "source_s3_demo_data_source" {
  endpoint_id   = "source-s3-demo-data-source"
  endpoint_type = "source"
  engine_name   = "s3"

  s3_settings {
    bucket_name               = "demo-bucket"
    bucket_folder             = ""
    ignore_headers_row        = 1
    compression_type          = "NONE"
    data_format               = "csv"
    csv_delimiter             = ","
    external_table_definition = jsonencode({
      "TableCount" = 0,
      "Tables" = []
    })
    service_access_role_arn   = aws_iam_role.dms_s3_demo_data_source.arn
  }
}

resource "aws_iam_role" "dms_s3_demo_data_source" {
  assume_role_policy = data.aws_iam_policy_document.dms_assume_role.json
  name               = "dms-s3-demo-data-source"
}

data "aws_iam_policy_document" "dms_assume_role" {
  statement {
    actions = ["sts:AssumeRole"]

    principals {
      identifiers = ["dms.amazonaws.com"]
      type        = "Service"
    }
  }
}

Steps to Reproduce

1. Apply the resource
2. Apply the resource, again.
3. Output will always showing ignore_headers_row will be updated. Viewing that endpoint on AWS Console also says that IgnoreHeaderRows is not present.

Debug Output

No response

Panic Output

No response

Important Factoids

I'm pretty sure there's a typo in s3_settings's schema:

terraform-provider-aws/internal/service/dms/endpoint.go

Lines 561 to 566 in 3c691a0

	"ignore_headers_row": {
	Type: schema.TypeInt,
	Optional: true,
	Default: 0,
	ValidateFunc: validation.IntInSlice([]int{0, 1}),
	},

It is supposed to be ignore_header_rows, NOT ignore_headers_row. Code below that all use ignore_header_rows correctly.

"IgnoreHeaderRows" is the correct name for this setting, according to AWS documataions.

References

No response

Would you like to implement a fix?

No response

[github-actions]

Community Note

Voting for Prioritization

• Please vote on this issue by adding a 👍 reaction to the original post to help the community and maintainers prioritize this request.
• Please see our prioritization guide for information on how we prioritize.
• 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.

Volunteering to Work on This Issue

• If you are interested in working on this issue, please leave a comment.
• If this would be your first contribution, please review the contribution guide.

[justinretzolk]

Hey @polyamide 👋 Thank you for taking the time to raise this, and for pointing out that typo; I believe that is indeed the issue here. For whoever picks this up:

• Schema definition -- ("ignore_headers_row")
• expander definition - ("ignore_header_rows")
• flattener definition -- ("ignore_header_rows")

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