r/aws_verifiedaccess_instance_logging_configuration

[GlennChia]

Description

New resource: aws_verifiedaccess_instance_logging_configuration

Relations

Relates #29689

References

• DescribeVerifiedAccessInstanceLoggingConfigurations
• ModifyVerifiedAccessInstanceLoggingConfiguration

Output from Acceptance Testing

% make testacc TESTARGS='-run=TestAccVerifiedAccessInstanceLoggingConfiguration' PKG=ec2 ACCTEST_PARALLELISM=5
==> Checking that code complies with gofmt requirements...
TF_ACC=1 go test ./internal/service/ec2/... -v -count 1 -parallel 5  -run=TestAccVerifiedAccessInstanceLoggingConfiguration -timeout 360m
=== RUN   TestAccVerifiedAccessInstanceLoggingConfiguration_accessLogsIncludeTrustContext
=== PAUSE TestAccVerifiedAccessInstanceLoggingConfiguration_accessLogsIncludeTrustContext
=== RUN   TestAccVerifiedAccessInstanceLoggingConfiguration_accessLogsLogVersion
=== PAUSE TestAccVerifiedAccessInstanceLoggingConfiguration_accessLogsLogVersion
=== RUN   TestAccVerifiedAccessInstanceLoggingConfiguration_accessLogsCloudWatchLogs
=== PAUSE TestAccVerifiedAccessInstanceLoggingConfiguration_accessLogsCloudWatchLogs
=== RUN   TestAccVerifiedAccessInstanceLoggingConfiguration_accessLogsKinesisDataFirehose
=== PAUSE TestAccVerifiedAccessInstanceLoggingConfiguration_accessLogsKinesisDataFirehose
=== RUN   TestAccVerifiedAccessInstanceLoggingConfiguration_accessLogsS3
=== PAUSE TestAccVerifiedAccessInstanceLoggingConfiguration_accessLogsS3
=== RUN   TestAccVerifiedAccessInstanceLoggingConfiguration_accessLogsCloudWatchLogsKinesisDataFirehoseS3
=== PAUSE TestAccVerifiedAccessInstanceLoggingConfiguration_accessLogsCloudWatchLogsKinesisDataFirehoseS3
=== RUN   TestAccVerifiedAccessInstanceLoggingConfiguration_disappears
=== PAUSE TestAccVerifiedAccessInstanceLoggingConfiguration_disappears
=== CONT  TestAccVerifiedAccessInstanceLoggingConfiguration_accessLogsIncludeTrustContext
=== CONT  TestAccVerifiedAccessInstanceLoggingConfiguration_accessLogsS3
=== CONT  TestAccVerifiedAccessInstanceLoggingConfiguration_accessLogsCloudWatchLogs
=== CONT  TestAccVerifiedAccessInstanceLoggingConfiguration_accessLogsKinesisDataFirehose
=== CONT  TestAccVerifiedAccessInstanceLoggingConfiguration_accessLogsLogVersion
--- PASS: TestAccVerifiedAccessInstanceLoggingConfiguration_accessLogsIncludeTrustContext (74.22s)
=== CONT  TestAccVerifiedAccessInstanceLoggingConfiguration_accessLogsCloudWatchLogsKinesisDataFirehoseS3
--- PASS: TestAccVerifiedAccessInstanceLoggingConfiguration_accessLogsLogVersion (75.46s)
=== CONT  TestAccVerifiedAccessInstanceLoggingConfiguration_disappears
--- PASS: TestAccVerifiedAccessInstanceLoggingConfiguration_accessLogsCloudWatchLogs (76.73s)
--- PASS: TestAccVerifiedAccessInstanceLoggingConfiguration_accessLogsS3 (92.69s)
--- PASS: TestAccVerifiedAccessInstanceLoggingConfiguration_disappears (33.08s)
--- PASS: TestAccVerifiedAccessInstanceLoggingConfiguration_accessLogsKinesisDataFirehose (285.04s)
--- PASS: TestAccVerifiedAccessInstanceLoggingConfiguration_accessLogsCloudWatchLogsKinesisDataFirehoseS3 (311.02s)
PASS
ok      github.com/hashicorp/terraform-provider-aws/internal/service/ec2        385.347s

...

Additional information

Default values per Instance

When Verified Access Instances are created, they come with a logging configuration with the following default values

{
    "LoggingConfigurations": [
        {
            "VerifiedAccessInstanceId": "vai-1234567890abcdef0",
            "AccessLogs": {
                "S3": {
                    "Enabled": false
                },
                "CloudWatchLogs": {
                    "Enabled": false
                },
                "KinesisDataFirehose": {
                    "Enabled": false
                },
                "LogVersion": "ocsf-1.0.0-rc.2",
                "IncludeTrustContext": false
            }
        }
    ]
}

Hence, when the aws_verifiedaccess_instance_logging_configuration resource is deleted, it should reset the logging configuration to the above

Value for bucket_owner

When S3 Logging configuration is set without a bucket_owner, the API will compute a value and return it. This presents issues when the S3 block is removed in Terraform. Removing it sets enabled to false but because there is still a bucket_owner value, the API returns an error The parameter AccessLogs.S3.BucketOwner cannot be used when AccessLogs.S3.Enabled is false

Hence, the expands function checks if enabled is first set to true before passing the value of bucket_owner. If enabled is false none of the other values matter and should not be passed to the API.

Value for ClientToken

ClientToken uses uuid, err := uuid.GenerateUUID() and aws.String(uuid) instead of aws.String(id.UniqueId()), because of Regex Validation on ClientToken specifically for the ModifyVerifiedAccessInstanceLoggingConfiguration API.

[github-actions]

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.

[ewbankkit]

LGTM 🚀.

% make testacc TESTARGS='-run=TestAccVerifiedAccessInstanceLoggingConfiguration_' PKG=ec2 ACCTEST_PARALLELISM=2
==> Checking that code complies with gofmt requirements...
TF_ACC=1 go test ./internal/service/ec2/... -v -count 1 -parallel 2  -run=TestAccVerifiedAccessInstanceLoggingConfiguration_ -timeout 360m
=== RUN   TestAccVerifiedAccessInstanceLoggingConfiguration_accessLogsIncludeTrustContext
=== PAUSE TestAccVerifiedAccessInstanceLoggingConfiguration_accessLogsIncludeTrustContext
=== RUN   TestAccVerifiedAccessInstanceLoggingConfiguration_accessLogsLogVersion
=== PAUSE TestAccVerifiedAccessInstanceLoggingConfiguration_accessLogsLogVersion
=== RUN   TestAccVerifiedAccessInstanceLoggingConfiguration_accessLogsCloudWatchLogs
=== PAUSE TestAccVerifiedAccessInstanceLoggingConfiguration_accessLogsCloudWatchLogs
=== RUN   TestAccVerifiedAccessInstanceLoggingConfiguration_accessLogsKinesisDataFirehose
=== PAUSE TestAccVerifiedAccessInstanceLoggingConfiguration_accessLogsKinesisDataFirehose
=== RUN   TestAccVerifiedAccessInstanceLoggingConfiguration_accessLogsS3
=== PAUSE TestAccVerifiedAccessInstanceLoggingConfiguration_accessLogsS3
=== RUN   TestAccVerifiedAccessInstanceLoggingConfiguration_accessLogsCloudWatchLogsKinesisDataFirehoseS3
=== PAUSE TestAccVerifiedAccessInstanceLoggingConfiguration_accessLogsCloudWatchLogsKinesisDataFirehoseS3
=== RUN   TestAccVerifiedAccessInstanceLoggingConfiguration_disappears
=== PAUSE TestAccVerifiedAccessInstanceLoggingConfiguration_disappears
=== CONT  TestAccVerifiedAccessInstanceLoggingConfiguration_accessLogsIncludeTrustContext
=== CONT  TestAccVerifiedAccessInstanceLoggingConfiguration_accessLogsS3
--- PASS: TestAccVerifiedAccessInstanceLoggingConfiguration_accessLogsIncludeTrustContext (51.94s)
=== CONT  TestAccVerifiedAccessInstanceLoggingConfiguration_disappears
--- PASS: TestAccVerifiedAccessInstanceLoggingConfiguration_accessLogsS3 (60.81s)
=== CONT  TestAccVerifiedAccessInstanceLoggingConfiguration_accessLogsCloudWatchLogs
--- PASS: TestAccVerifiedAccessInstanceLoggingConfiguration_disappears (24.77s)
=== CONT  TestAccVerifiedAccessInstanceLoggingConfiguration_accessLogsKinesisDataFirehose
--- PASS: TestAccVerifiedAccessInstanceLoggingConfiguration_accessLogsCloudWatchLogs (45.39s)
=== CONT  TestAccVerifiedAccessInstanceLoggingConfiguration_accessLogsCloudWatchLogsKinesisDataFirehoseS3
--- PASS: TestAccVerifiedAccessInstanceLoggingConfiguration_accessLogsKinesisDataFirehose (151.93s)
=== CONT  TestAccVerifiedAccessInstanceLoggingConfiguration_accessLogsLogVersion
--- PASS: TestAccVerifiedAccessInstanceLoggingConfiguration_accessLogsLogVersion (50.41s)
--- PASS: TestAccVerifiedAccessInstanceLoggingConfiguration_accessLogsCloudWatchLogsKinesisDataFirehoseS3 (211.80s)
PASS
ok  	github.com/hashicorp/terraform-provider-aws/internal/service/ec2	323.603s

[ewbankkit]

@GlennChia Thanks for the contribution 🎉 👏.

[github-actions]

This functionality has been released in v5.21.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]

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.