Adds a data source for aws_cloudwatch_log_groups

.changelog/17151.txt

@@ -0,0 +1,3 @@
+```release-note:new-data-source
+aws_cloudwatch_log_groups
+```

aws/data_source_aws_cloudwatch_log_groups.go

@@ -0,0 +1,71 @@
+package aws
+
+import (
+	"fmt"
+
+	"github.com/aws/aws-sdk-go/aws"
+	"github.com/aws/aws-sdk-go/service/cloudwatchlogs"
+	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
+	tfcloudwatchlogs "github.com/terraform-providers/terraform-provider-aws/aws/internal/service/cloudwatchlogs"
+)
+
+func dataSourceAwsCloudwatchLogGroups() *schema.Resource {
+	return &schema.Resource{
+		Read: dataSourceAwsCloudwatchLogGroupsRead,
+
+		Schema: map[string]*schema.Schema{
+			"arns": {
+				Type:     schema.TypeSet,
+				Computed: true,
+				Elem:     &schema.Schema{Type: schema.TypeString},
+			},
+			"log_group_name_prefix": {
+				Type:     schema.TypeString,
+				Required: true,
+			},
+			"log_group_names": {
+				Type:     schema.TypeSet,
+				Computed: true,
+				Elem:     &schema.Schema{Type: schema.TypeString},
+			},
+		},
+	}
+}
+
+func dataSourceAwsCloudwatchLogGroupsRead(d *schema.ResourceData, meta interface{}) error {
+	conn := meta.(*AWSClient).cloudwatchlogsconn
+
+	input := &cloudwatchlogs.DescribeLogGroupsInput{
+		LogGroupNamePrefix: aws.String(d.Get("log_group_name_prefix").(string)),
+	}
+
+	var results []*cloudwatchlogs.LogGroup
+
+	err := conn.DescribeLogGroupsPages(input, func(page *cloudwatchlogs.DescribeLogGroupsOutput, lastPage bool) bool {
+		if page == nil {
+			return !lastPage
+		}
+
+		results = append(results, page.LogGroups...)
+
+		return !lastPage
+	})
+
+	if err != nil {
+		return fmt.Errorf("error reading CloudWatch Log Groups: %w", err)
+	}
+
+	d.SetId(meta.(*AWSClient).region)
+
+	var arns, logGroupNames []string
+
+	for _, r := range results {
+		arns = append(arns, tfcloudwatchlogs.TrimLogGroupARNWildcardSuffix(aws.StringValue(r.Arn)))
+		logGroupNames = append(logGroupNames, aws.StringValue(r.LogGroupName))
+	}
+
+	d.Set("arns", arns)
+	d.Set("log_group_names", logGroupNames)
+
+	return nil
+}

aws/data_source_aws_cloudwatch_log_groups_test.go

@@ -0,0 +1,52 @@
+package aws
+
+import (
+	"fmt"
+	"testing"
+
+	"github.com/aws/aws-sdk-go/service/cloudwatchlogs"
+	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/acctest"
+	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/resource"
+)
+
+func TestAccAWSCloudwatchLogGroupsDataSource_basic(t *testing.T) {
+	rName := acctest.RandomWithPrefix("tf-acc-test")
+	resourceName := "data.aws_cloudwatch_log_groups.test"
+
+	resource.ParallelTest(t, resource.TestCase{
+		PreCheck:   func() { testAccPreCheck(t) },
+		ErrorCheck: testAccErrorCheck(t, cloudwatchlogs.EndpointsID),
+		Providers:  testAccProviders,
+		Steps: []resource.TestStep{
+			{
+				Config: testAccCheckAWSCloudwatchLogGroupsDataSourceConfig(rName),
+				Check: resource.ComposeTestCheckFunc(
+					resource.TestCheckResourceAttr(resourceName, "arns.#", "2"),
+					resource.TestCheckTypeSetElemAttrPair(resourceName, "arns.*", "aws_cloudwatch_log_group.test1", "arn"),
+					resource.TestCheckTypeSetElemAttrPair(resourceName, "arns.*", "aws_cloudwatch_log_group.test2", "arn"),
+					resource.TestCheckResourceAttr(resourceName, "log_group_names.#", "2"),
+					resource.TestCheckTypeSetElemAttrPair(resourceName, "log_group_names.*", "aws_cloudwatch_log_group.test1", "name"),
+					resource.TestCheckTypeSetElemAttrPair(resourceName, "log_group_names.*", "aws_cloudwatch_log_group.test2", "name"),
+				),
+			},
+		},
+	})
+}
+
+func testAccCheckAWSCloudwatchLogGroupsDataSourceConfig(rName string) string {
+	return fmt.Sprintf(`
+resource aws_cloudwatch_log_group "test1" {
+  name = "%[1]s/1"
+}
+
+resource aws_cloudwatch_log_group "test2" {
+  name = "%[1]s/2"
+}
+
+data aws_cloudwatch_log_groups "test" {
+  log_group_name_prefix = %[1]q
+
+  depends_on = [aws_cloudwatch_log_group.test1,aws_cloudwatch_log_group.test2]
+}
+`, rName)
+}

aws/internal/service/cloudwatchlogs/arn.go

@@ -0,0 +1,14 @@
+package cloudwatchlogs
+
+import (
+	"strings"
+)
+
+const (
+	logGroupARNWildcardSuffix = ":*"
+)
+
+// TrimLogGroupARNWildcardSuffix trims any wilcard suffix from a Log Group ARN.
+func TrimLogGroupARNWildcardSuffix(arn string) string {
+	return strings.TrimSuffix(arn, logGroupARNWildcardSuffix)
+}

aws/internal/service/cloudwatchlogs/arn_test.go

@@ -0,0 +1,39 @@
+package cloudwatchlogs_test
+
+import (
+	"testing"
+
+	tfcloudwatchlogs "github.com/terraform-providers/terraform-provider-aws/aws/internal/service/cloudwatchlogs"
+)
+
+func TestTrimLogGroupARNWildcardSuffix(t *testing.T) {
+	testCases := []struct {
+		TestName    string
+		InputARN    string
+		ExpectedARN string
+	}{
+		{
+			TestName: "Empty string",
+		},
+		{
+			TestName:    "No suffix",
+			InputARN:    "arn:aws-us-gov:logs:us-gov-west-1:123456789012:log-group:tf-acc-test-6899758375212691725/1",
+			ExpectedARN: "arn:aws-us-gov:logs:us-gov-west-1:123456789012:log-group:tf-acc-test-6899758375212691725/1",
+		},
+		{
+			TestName:    "With suffix",
+			InputARN:    "arn:aws-us-gov:logs:us-gov-west-1:123456789012:log-group:tf-acc-test-6899758375212691725/1:*",
+			ExpectedARN: "arn:aws-us-gov:logs:us-gov-west-1:123456789012:log-group:tf-acc-test-6899758375212691725/1",
+		},
+	}
+
+	for _, testCase := range testCases {
+		t.Run(testCase.TestName, func(t *testing.T) {
+			got := tfcloudwatchlogs.TrimLogGroupARNWildcardSuffix(testCase.InputARN)
+
+			if got != testCase.ExpectedARN {
+				t.Errorf("got %s, expected %s", got, testCase.ExpectedARN)
+			}
+		})
+	}
+}

aws/provider.go

@@ -223,6 +223,7 @@ func Provider() *schema.Provider {
 			"aws_cloudwatch_event_connection":                dataSourceAwsCloudwatchEventConnection(),
 			"aws_cloudwatch_event_source":                    dataSourceAwsCloudWatchEventSource(),
 			"aws_cloudwatch_log_group":                       dataSourceAwsCloudwatchLogGroup(),
+			"aws_cloudwatch_log_groups":                      dataSourceAwsCloudwatchLogGroups(),
 			"aws_codeartifact_authorization_token":           dataSourceAwsCodeArtifactAuthorizationToken(),
 			"aws_codeartifact_repository_endpoint":           dataSourceAwsCodeArtifactRepositoryEndpoint(),
 			"aws_cognito_user_pools":                         dataSourceAwsCognitoUserPools(),

aws/resource_aws_cloudwatch_log_group.go

@@ -3,7 +3,6 @@ package aws
 import (
 	"fmt"
 	"log"
-	"strings"
 
 	"github.com/aws/aws-sdk-go/aws"
 	"github.com/aws/aws-sdk-go/aws/awserr"
@@ -12,6 +11,7 @@ import (
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/validation"
 	"github.com/terraform-providers/terraform-provider-aws/aws/internal/keyvaluetags"
+	tfcloudwatchlogs "github.com/terraform-providers/terraform-provider-aws/aws/internal/service/cloudwatchlogs"
 )
 
 func resourceAwsCloudWatchLogGroup() *schema.Resource {
@@ -138,7 +138,7 @@ func resourceAwsCloudWatchLogGroupRead(d *schema.ResourceData, meta interface{})
 		return nil
 	}
 
-	d.Set("arn", strings.TrimSuffix(aws.StringValue(lg.Arn), ":*"))
+	d.Set("arn", tfcloudwatchlogs.TrimLogGroupARNWildcardSuffix(aws.StringValue(lg.Arn)))
 	d.Set("name", lg.LogGroupName)
 	d.Set("kms_key_id", lg.KmsKeyId)
 	d.Set("retention_in_days", lg.RetentionInDays)

website/docs/d/cloudwatch_log_groups.html.markdown

@@ -0,0 +1,32 @@
+---
+subcategory: "CloudWatch"
+layout: "aws"
+page_title: "AWS: aws_cloudwatch_log_groups"
+description: |-
+  Get list of Cloudwatch Log Groups.
+---
+
+# Data Source: aws_cloudwatch_log_groups
+
+Use this data source to get a list of AWS Cloudwatch Log Groups
+
+## Example Usage
+
+```terraform
+data "aws_cloudwatch_log_groups" "example" {
+  log_group_prefix = "/MyImportantLogs"
+}
+```
+
+## Argument Reference
+
+The following arguments are supported:
+
+* `log_group_name_prefix` - (Required) The group prefix of the Cloudwatch log groups to list
+
+## Attributes Reference
+
+In addition to all arguments above, the following attributes are exported:
+
+* `arns` - Set of ARNs of the Cloudwatch log groups
+* `log_group_names` - Set of names of the Cloudwatch log groups