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

LF-Tag support for aws_lakeformation_permissions #24315

Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .changelog/24314.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
```release-note:new-resource
aws_lakeformation_lf_tag
```
4 changes: 4 additions & 0 deletions .changelog/24315.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
```release-note:note:enhancement
resource/aws_lakeformation_permissions: Add LF-tag support
datasource/aws_lakeformation_permissions: Add LF-tag support
```
1 change: 1 addition & 0 deletions internal/provider/provider.go
Original file line number Diff line number Diff line change
Expand Up @@ -1557,6 +1557,7 @@ func Provider() *schema.Provider {
"aws_kms_replica_key": kms.ResourceReplicaKey(),

"aws_lakeformation_data_lake_settings": lakeformation.ResourceDataLakeSettings(),
"aws_lakeformation_lf_tag": lakeformation.ResourceLFTag(),
"aws_lakeformation_permissions": lakeformation.ResourcePermissions(),
"aws_lakeformation_resource": lakeformation.ResourceResource(),

Expand Down
40 changes: 40 additions & 0 deletions internal/service/lakeformation/filter.go
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,14 @@ func FilterPermissions(input *lakeformation.ListPermissionsInput, tableType stri
return FilterDatabasePermissions(input.Principal.DataLakePrincipalIdentifier, allPermissions)
}

if input.Resource.LFTag != nil {
return FilterLFTagPermissions(input.Principal.DataLakePrincipalIdentifier, allPermissions)
}

if input.Resource.LFTagPolicy != nil {
return FilterLFTagPolicyPermissions(input.Principal.DataLakePrincipalIdentifier, allPermissions)
}

if tableType == TableTypeTableWithColumns {
return FilterTableWithColumnsPermissions(input.Principal.DataLakePrincipalIdentifier, input.Resource.Table, columnNames, excludedColumnNames, columnWildcard, allPermissions)
}
Expand Down Expand Up @@ -176,3 +184,35 @@ func FilterDatabasePermissions(principal *string, allPermissions []*lakeformatio

return cleanPermissions
}

func FilterLFTagPermissions(principal *string, allPermissions []*lakeformation.PrincipalResourcePermissions) []*lakeformation.PrincipalResourcePermissions {
var cleanPermissions []*lakeformation.PrincipalResourcePermissions

for _, perm := range allPermissions {
if aws.StringValue(principal) != aws.StringValue(perm.Principal.DataLakePrincipalIdentifier) {
continue
}

if perm.Resource.LFTag != nil {
cleanPermissions = append(cleanPermissions, perm)
}
}

return cleanPermissions
}

func FilterLFTagPolicyPermissions(principal *string, allPermissions []*lakeformation.PrincipalResourcePermissions) []*lakeformation.PrincipalResourcePermissions {
var cleanPermissions []*lakeformation.PrincipalResourcePermissions

for _, perm := range allPermissions {
if aws.StringValue(principal) != aws.StringValue(perm.Principal.DataLakePrincipalIdentifier) {
continue
}

if perm.Resource.LFTagPolicy != nil {
cleanPermissions = append(cleanPermissions, perm)
}
}

return cleanPermissions
}
9 changes: 9 additions & 0 deletions internal/service/lakeformation/lakeformation_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,15 @@ func TestAccLakeFormation_serial(t *testing.T) {
"databaseMultiple": testAccPermissions_databaseMultiple,
"dataLocation": testAccPermissions_dataLocation,
"disappears": testAccPermissions_disappears,
"lfTag": testAccAWSLakeFormationPermissions_lf_tag,
"lfTagPolicy": testAccAWSLakeFormationPermissions_lf_tag_policy,
},
"PermissionsDataSource": {
"basic": testAccPermissionsDataSource_basic,
"database": testAccPermissionsDataSource_database,
"dataLocation": testAccPermissionsDataSource_dataLocation,
"lfTag": testAccPermissionsDataSource_lf_tag,
"lfTagPolicy": testAccPermissionsDataSource_lf_tag_policy,
"table": testAccPermissionsDataSource_table,
"tableWithColumns": testAccPermissionsDataSource_tableWithColumns,
},
Expand All @@ -45,6 +49,11 @@ func TestAccLakeFormation_serial(t *testing.T) {
"wildcardSelectOnly": testAccPermissions_twcWildcardSelectOnly,
"wildcardSelectPlus": testAccPermissions_twcWildcardSelectPlus,
},
"LFTags": {
"basic": testAccLFTag_basic,
"disappears": testAccLFTag_disappears,
"values": testAccLFTag_values,
},
}

for group, m := range testCases {
Expand Down
184 changes: 184 additions & 0 deletions internal/service/lakeformation/lf_tag.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,184 @@
package lakeformation

import (
"fmt"
"github.com/aws/aws-sdk-go/aws"
"github.com/aws/aws-sdk-go/service/lakeformation"
"github.com/hashicorp/aws-sdk-go-base/v2/awsv1shim/v2/tfawserr"
"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
"github.com/hashicorp/terraform-plugin-sdk/v2/helper/validation"
"github.com/hashicorp/terraform-provider-aws/internal/conns"
"github.com/hashicorp/terraform-provider-aws/internal/flex"
"log"
"regexp"
"strings"
)

func ResourceLFTag() *schema.Resource {
return &schema.Resource{
Create: resourceLFTagCreate,
Read: resourceLFTagRead,
Update: resourceLFTagUpdate,
Delete: resourceLFTagDelete,
Importer: &schema.ResourceImporter{
State: schema.ImportStatePassthrough,
},

Schema: map[string]*schema.Schema{
"key": {
Type: schema.TypeString,
Required: true,
ForceNew: true,
ValidateFunc: validation.StringLenBetween(1, 128),
},
"values": {
Type: schema.TypeSet,
Required: true,
MinItems: 1,
MaxItems: 15,
Elem: &schema.Schema{
Type: schema.TypeString,
ValidateFunc: validateLFTagValues(),
},
Set: schema.HashString,
},
"catalog_id": {
Type: schema.TypeString,
ForceNew: true,
Optional: true,
Computed: true,
},
},
}
}

func resourceLFTagCreate(d *schema.ResourceData, meta interface{}) error {
conn := meta.(*conns.AWSClient).LakeFormationConn

tagKey := d.Get("key").(string)
tagValues := d.Get("values").(*schema.Set)

var catalogID string
if v, ok := d.GetOk("catalog_id"); ok {
catalogID = v.(string)
} else {
catalogID = meta.(*conns.AWSClient).AccountID
}

input := &lakeformation.CreateLFTagInput{
CatalogId: aws.String(catalogID),
TagKey: aws.String(tagKey),
TagValues: flex.ExpandStringSet(tagValues),
}

_, err := conn.CreateLFTag(input)
if err != nil {
return fmt.Errorf("Error creating Lake Formation LF-Tag: %w", err)
}

d.SetId(fmt.Sprintf("%s:%s", catalogID, tagKey))

return resourceLFTagRead(d, meta)
}

func resourceLFTagRead(d *schema.ResourceData, meta interface{}) error {
conn := meta.(*conns.AWSClient).LakeFormationConn

catalogID, tagKey, err := ReadLFTagID(d.Id())
if err != nil {
return err
}

input := &lakeformation.GetLFTagInput{
CatalogId: aws.String(catalogID),
TagKey: aws.String(tagKey),
}

output, err := conn.GetLFTag(input)
if err != nil {
if tfawserr.ErrCodeEquals(err, lakeformation.ErrCodeEntityNotFoundException) {
log.Printf("[WARN] Lake Formation LF-Tag (%s) not found, removing from state", d.Id())
d.SetId("")
return nil
}

return fmt.Errorf("Error reading Lake Formation LF-Tag: %s", err.Error())
}

d.Set("key", output.TagKey)
d.Set("values", flex.FlattenStringSet(output.TagValues))
d.Set("catalog_id", output.CatalogId)

return nil
}

func resourceLFTagUpdate(d *schema.ResourceData, meta interface{}) error {
conn := meta.(*conns.AWSClient).LakeFormationConn

catalogID, tagKey, err := ReadLFTagID(d.Id())
if err != nil {
return err
}

o, n := d.GetChange("values")
os := o.(*schema.Set)
ns := n.(*schema.Set)
toAdd := flex.ExpandStringSet(ns.Difference(os))
toDelete := flex.ExpandStringSet(os.Difference(ns))

input := &lakeformation.UpdateLFTagInput{
CatalogId: aws.String(catalogID),
TagKey: aws.String(tagKey),
}

if len(toAdd) > 0 {
input.TagValuesToAdd = toAdd
}

if len(toDelete) > 0 {
input.TagValuesToDelete = toDelete
}

_, err = conn.UpdateLFTag(input)
if err != nil {
return fmt.Errorf("Error updating Lake Formation LF-Tag (%s): %w", d.Id(), err)
}

return resourceLFTagRead(d, meta)
}

func resourceLFTagDelete(d *schema.ResourceData, meta interface{}) error {
conn := meta.(*conns.AWSClient).LakeFormationConn

catalogID, tagKey, err := ReadLFTagID(d.Id())
if err != nil {
return err
}

input := &lakeformation.DeleteLFTagInput{
CatalogId: aws.String(catalogID),
TagKey: aws.String(tagKey),
}

_, err = conn.DeleteLFTag(input)
if err != nil {
return fmt.Errorf("Error deleting Lake Formation LF-Tag (%s): %w", d.Id(), err)
}

return nil
}

func ReadLFTagID(id string) (catalogID string, tagKey string, err error) {
idParts := strings.Split(id, ":")
if len(idParts) != 2 {
return "", "", fmt.Errorf("Unexpected format of ID (%q), expected CATALOG-ID:TAG-KEY", id)
}
return idParts[0], idParts[1], nil
}

func validateLFTagValues() schema.SchemaValidateFunc {
return validation.All(
validation.StringLenBetween(1, 255),
validation.StringMatch(regexp.MustCompile(`^([\p{L}\p{Z}\p{N}_.:\*\/=+\-@%]*)$`), ""),
)
}
Loading