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

F aws transfer server structured logging destinations #32654

Conversation

CalvinE
Copy link
Contributor

@CalvinE CalvinE commented Jul 24, 2023

Description

This PR adds support for the AWS Transfer Server Structured Logging Destinations property.

The AWS transfer module talks about this property here

Relations

Closes #32653

References

Here is some sample terraform that uses the new property and shows that the changes work, assuming that you are overriding the aws provider with the version built with this PRs code.

terraform {
  required_providers {
    aws = {
      source = "hashicorp/aws"
    }
  }
}

resource "aws_cloudwatch_log_group" "test" {
  name_prefix = "transfer_test_"
}

data "aws_iam_policy_document" "test" {
  statement {
    effect = "Allow"

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

    actions = ["sts:AssumeRole"]
  }
}

resource "aws_iam_role" "test" {
  name_prefix         = "iam_for_transfer_"
  assume_role_policy  = data.aws_iam_policy_document.test.json
  managed_policy_arns = ["arn:aws:iam::aws:policy/service-role/AWSTransferLoggingAccess"]
}

resource "aws_transfer_server" "test" {
  endpoint_type = "PUBLIC"
  logging_role  = aws_iam_role.test.arn
  protocols     = ["SFTP"]
  structured_log_destinations = [
    "${aws_cloudwatch_log_group.test.arn}:*"
  ]
}

Output from Acceptance Testing

The acceptance test is working. Was not sure how to get computed value for testing the value in the structured log destinations, so write a function to test using terraform state. Please let me know if there was a better way to do what I wanted to do.

% make testacc TESTS=TestAccTransfer_serial/Server/StructuredLogDestinations PKG=transfer
==> Checking that code complies with gofmt requirements...
TF_ACC=1 go test ./internal/service/transfer/... -v -count 1 -parallel 20 -run='TestAccTransfer_serial/Server/StructuredLogDestinations'  -timeout 180m
=== RUN   TestAccTransfer_serial
=== PAUSE TestAccTransfer_serial
=== CONT  TestAccTransfer_serial
=== RUN   TestAccTransfer_serial/Server
=== RUN   TestAccTransfer_serial/Server/StructuredLogDestinations
--- PASS: TestAccTransfer_serial (246.13s)
    --- PASS: TestAccTransfer_serial/Server (246.13s)
        --- PASS: TestAccTransfer_serial/Server/StructuredLogDestinations (246.13s)
PASS
ok      github.com/hashicorp/terraform-provider-aws/internal/service/transfer   246.333s
...

@github-actions
Copy link

Community Note

Voting for Prioritization

  • Please vote on this pull request by adding a 👍 reaction to the original post to help the community and maintainers prioritize this pull 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.

For Submitters

  • Review the contribution guide relating to the type of change you are making to ensure all of the necessary steps have been taken.
  • For new resources and data sources, use skaff to generate scaffolding with comments detailing common expectations.
  • Whether or not the branch has been rebased will not impact prioritization, but doing so is always a welcome surprise.

@github-actions github-actions bot added size/L Managed by automation to categorize the size of a PR. documentation Introduces or discusses updates to documentation. tests PRs: expanded test coverage. Issues: expanded coverage, enhancements to test infrastructure. service/transfer Issues and PRs that pertain to the transfer service. needs-triage Waiting for first response or review from a maintainer. labels Jul 24, 2023
@CalvinE
Copy link
Contributor Author

CalvinE commented Jul 24, 2023

Sorry I see I have some lint issues. I will get those resolved and push those changes.

@justinretzolk justinretzolk added enhancement Requests to existing resources that expand the functionality or scope. and removed needs-triage Waiting for first response or review from a maintainer. labels Jul 24, 2023
Copy link
Contributor

@ewbankkit ewbankkit left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 🚀.

% make testacc TESTARGS='-run=TestAccTransfer_serial/Server/^basic$$' PKG=transfer
==> Checking that code complies with gofmt requirements...
TF_ACC=1 go test ./internal/service/transfer/... -v -count 1 -parallel 20  -run=TestAccTransfer_serial/Server/^basic$ -timeout 180m
=== RUN   TestAccTransfer_serial
=== PAUSE TestAccTransfer_serial
=== CONT  TestAccTransfer_serial
=== RUN   TestAccTransfer_serial/Server
=== RUN   TestAccTransfer_serial/Server/basic
--- PASS: TestAccTransfer_serial (208.81s)
    --- PASS: TestAccTransfer_serial/Server (208.81s)
        --- PASS: TestAccTransfer_serial/Server/basic (208.81s)
PASS
ok  	github.com/hashicorp/terraform-provider-aws/internal/service/transfer	214.559s
% make testacc TESTARGS='-run=TestAccTransfer_serial/Server/^DataSourceBasic$$' PKG=transfer
==> Checking that code complies with gofmt requirements...
TF_ACC=1 go test ./internal/service/transfer/... -v -count 1 -parallel 20  -run=TestAccTransfer_serial/Server/^DataSourceBasic$ -timeout 180m
=== RUN   TestAccTransfer_serial
=== PAUSE TestAccTransfer_serial
=== CONT  TestAccTransfer_serial
=== RUN   TestAccTransfer_serial/Server
=== RUN   TestAccTransfer_serial/Server/DataSourceBasic
--- PASS: TestAccTransfer_serial (186.06s)
    --- PASS: TestAccTransfer_serial/Server (186.06s)
        --- PASS: TestAccTransfer_serial/Server/DataSourceBasic (186.06s)
PASS
ok  	github.com/hashicorp/terraform-provider-aws/internal/service/transfer	191.781s
% make testacc TESTARGS='-run=TestAccTransfer_serial/Server/^StructuredLogDestinations$$' PKG=transfer
==> Checking that code complies with gofmt requirements...
TF_ACC=1 go test ./internal/service/transfer/... -v -count 1 -parallel 20  -run=TestAccTransfer_serial/Server/^StructuredLogDestinations$ -timeout 180m
=== RUN   TestAccTransfer_serial
=== PAUSE TestAccTransfer_serial
=== CONT  TestAccTransfer_serial
=== RUN   TestAccTransfer_serial/Server
=== RUN   TestAccTransfer_serial/Server/StructuredLogDestinations
--- PASS: TestAccTransfer_serial (210.04s)
    --- PASS: TestAccTransfer_serial/Server (210.04s)
        --- PASS: TestAccTransfer_serial/Server/StructuredLogDestinations (210.04s)
PASS
ok  	github.com/hashicorp/terraform-provider-aws/internal/service/transfer	215.460s

@ewbankkit
Copy link
Contributor

@CalvinE Thanks for the contribution 🎉 👏.

@CalvinE
Copy link
Contributor Author

CalvinE commented Jul 25, 2023

Happy to help @ewbankkit! I use terraform a lot!

@ewbankkit ewbankkit merged commit a98f3c6 into hashicorp:main Jul 25, 2023
47 checks passed
@github-actions github-actions bot added this to the v5.10.0 milestone Jul 25, 2023
@github-actions
Copy link

This functionality has been released in v5.10.0 of the Terraform AWS Provider. Please see the Terraform documentation on provider versioning or reach out if you need any assistance upgrading.

For further feature requests or bug reports with this functionality, please create a new GitHub issue following the template. Thank you!

@github-actions
Copy link

I'm going to lock this pull request 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 related to this change, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Aug 27, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Introduces or discusses updates to documentation. enhancement Requests to existing resources that expand the functionality or scope. service/transfer Issues and PRs that pertain to the transfer service. size/L Managed by automation to categorize the size of a PR. tests PRs: expanded test coverage. Issues: expanded coverage, enhancements to test infrastructure.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Enhancement]: Add StructuredLogDestinations Support to Transfer Server
3 participants