mirror of
https://github.com/opentofu/opentofu.git
synced 2024-12-30 10:47:14 -06:00
provider/aws: Add aws_kms_alias datasource (#13669)
This commit is contained in:
parent
ec85f833c7
commit
47d255f943
62
builtin/providers/aws/data_source_aws_kms_alias.go
Normal file
62
builtin/providers/aws/data_source_aws_kms_alias.go
Normal file
@ -0,0 +1,62 @@
|
||||
package aws
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"time"
|
||||
|
||||
"github.com/aws/aws-sdk-go/service/kms"
|
||||
"github.com/hashicorp/errwrap"
|
||||
"github.com/hashicorp/terraform/helper/schema"
|
||||
)
|
||||
|
||||
func dataSourceAwsKmsAlias() *schema.Resource {
|
||||
return &schema.Resource{
|
||||
Read: dataSourceAwsKmsAliasRead,
|
||||
Schema: map[string]*schema.Schema{
|
||||
"name": {
|
||||
Type: schema.TypeString,
|
||||
Required: true,
|
||||
ValidateFunc: validateAwsKmsName,
|
||||
},
|
||||
"arn": {
|
||||
Type: schema.TypeString,
|
||||
Computed: true,
|
||||
},
|
||||
"target_key_id": {
|
||||
Type: schema.TypeString,
|
||||
Computed: true,
|
||||
},
|
||||
},
|
||||
}
|
||||
}
|
||||
|
||||
func dataSourceAwsKmsAliasRead(d *schema.ResourceData, meta interface{}) error {
|
||||
conn := meta.(*AWSClient).kmsconn
|
||||
params := &kms.ListAliasesInput{}
|
||||
|
||||
target := d.Get("name")
|
||||
var alias *kms.AliasListEntry
|
||||
err := conn.ListAliasesPages(params, func(page *kms.ListAliasesOutput, lastPage bool) bool {
|
||||
for _, entity := range page.Aliases {
|
||||
if *entity.AliasName == target {
|
||||
alias = entity
|
||||
return false
|
||||
}
|
||||
}
|
||||
|
||||
return true
|
||||
})
|
||||
if err != nil {
|
||||
return errwrap.Wrapf("Error fetch KMS alias list: {{err}}", err)
|
||||
}
|
||||
|
||||
if alias == nil {
|
||||
return fmt.Errorf("No alias with name %q found in this region.", target)
|
||||
}
|
||||
|
||||
d.SetId(time.Now().UTC().String())
|
||||
d.Set("arn", alias.AliasArn)
|
||||
d.Set("target_key_id", alias.TargetKeyId)
|
||||
|
||||
return nil
|
||||
}
|
77
builtin/providers/aws/data_source_aws_kms_alias_test.go
Normal file
77
builtin/providers/aws/data_source_aws_kms_alias_test.go
Normal file
@ -0,0 +1,77 @@
|
||||
package aws
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"testing"
|
||||
|
||||
"github.com/hashicorp/terraform/helper/acctest"
|
||||
"github.com/hashicorp/terraform/helper/resource"
|
||||
"github.com/hashicorp/terraform/terraform"
|
||||
)
|
||||
|
||||
func TestAccDataSourceAwsKmsAlias(t *testing.T) {
|
||||
rInt := acctest.RandInt()
|
||||
resource.Test(t, resource.TestCase{
|
||||
PreCheck: func() { testAccPreCheck(t) },
|
||||
Providers: testAccProviders,
|
||||
Steps: []resource.TestStep{
|
||||
resource.TestStep{
|
||||
Config: testAccDataSourceAwsKmsAlias(rInt),
|
||||
Check: resource.ComposeTestCheckFunc(
|
||||
testAccDataSourceAwsKmsAliasCheck("data.aws_kms_alias.by_name"),
|
||||
),
|
||||
},
|
||||
},
|
||||
})
|
||||
}
|
||||
|
||||
func testAccDataSourceAwsKmsAliasCheck(name string) resource.TestCheckFunc {
|
||||
return func(s *terraform.State) error {
|
||||
rs, ok := s.RootModule().Resources[name]
|
||||
if !ok {
|
||||
return fmt.Errorf("root module has no resource called %s", name)
|
||||
}
|
||||
|
||||
kmsKeyRs, ok := s.RootModule().Resources["aws_kms_alias.single"]
|
||||
if !ok {
|
||||
return fmt.Errorf("can't find aws_kms_alias.single in state")
|
||||
}
|
||||
|
||||
attr := rs.Primary.Attributes
|
||||
|
||||
if attr["arn"] != kmsKeyRs.Primary.Attributes["arn"] {
|
||||
return fmt.Errorf(
|
||||
"arn is %s; want %s",
|
||||
attr["arn"],
|
||||
kmsKeyRs.Primary.Attributes["arn"],
|
||||
)
|
||||
}
|
||||
|
||||
if attr["target_key_id"] != kmsKeyRs.Primary.Attributes["target_key_id"] {
|
||||
return fmt.Errorf(
|
||||
"target_key_id is %s; want %s",
|
||||
attr["target_key_id"],
|
||||
kmsKeyRs.Primary.Attributes["target_key_id"],
|
||||
)
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
}
|
||||
|
||||
func testAccDataSourceAwsKmsAlias(rInt int) string {
|
||||
return fmt.Sprintf(`
|
||||
resource "aws_kms_key" "one" {
|
||||
description = "Terraform acc test"
|
||||
deletion_window_in_days = 7
|
||||
}
|
||||
|
||||
resource "aws_kms_alias" "single" {
|
||||
name = "alias/tf-acc-key-alias-%d"
|
||||
target_key_id = "${aws_kms_key.one.key_id}"
|
||||
}
|
||||
|
||||
data "aws_kms_alias" "by_name" {
|
||||
name = "${aws_kms_alias.single.name}"
|
||||
}`, rInt)
|
||||
}
|
@ -185,6 +185,7 @@ func Provider() terraform.ResourceProvider {
|
||||
"aws_iam_server_certificate": dataSourceAwsIAMServerCertificate(),
|
||||
"aws_instance": dataSourceAwsInstance(),
|
||||
"aws_ip_ranges": dataSourceAwsIPRanges(),
|
||||
"aws_kms_alias": dataSourceAwsKmsAlias(),
|
||||
"aws_kms_secret": dataSourceAwsKmsSecret(),
|
||||
"aws_partition": dataSourceAwsPartition(),
|
||||
"aws_prefix_list": dataSourceAwsPrefixList(),
|
||||
|
@ -29,14 +29,7 @@ func resourceAwsKmsAlias() *schema.Resource {
|
||||
Optional: true,
|
||||
ForceNew: true,
|
||||
ConflictsWith: []string{"name_prefix"},
|
||||
ValidateFunc: func(v interface{}, k string) (ws []string, es []error) {
|
||||
value := v.(string)
|
||||
if !regexp.MustCompile(`^(alias\/)[a-zA-Z0-9:/_-]+$`).MatchString(value) {
|
||||
es = append(es, fmt.Errorf(
|
||||
"%q must begin with 'alias/' and be comprised of only [a-zA-Z0-9:/_-]", k))
|
||||
}
|
||||
return
|
||||
},
|
||||
ValidateFunc: validateAwsKmsName,
|
||||
},
|
||||
"name_prefix": &schema.Schema{
|
||||
Type: schema.TypeString,
|
||||
|
@ -1209,3 +1209,12 @@ func validateOpenIdURL(v interface{}, k string) (ws []string, errors []error) {
|
||||
}
|
||||
return
|
||||
}
|
||||
|
||||
func validateAwsKmsName(v interface{}, k string) (ws []string, es []error) {
|
||||
value := v.(string)
|
||||
if !regexp.MustCompile(`^(alias\/)[a-zA-Z0-9:/_-]+$`).MatchString(value) {
|
||||
es = append(es, fmt.Errorf(
|
||||
"%q must begin with 'alias/' and be comprised of only [a-zA-Z0-9:/_-]", k))
|
||||
}
|
||||
return
|
||||
}
|
||||
|
@ -1981,3 +1981,35 @@ func TestValidateOpenIdURL(t *testing.T) {
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func TestValidateAwsKmsName(t *testing.T) {
|
||||
cases := []struct {
|
||||
Value string
|
||||
ErrCount int
|
||||
}{
|
||||
{
|
||||
Value: "alias/aws/s3",
|
||||
ErrCount: 0,
|
||||
},
|
||||
{
|
||||
Value: "alias/hashicorp",
|
||||
ErrCount: 0,
|
||||
},
|
||||
{
|
||||
Value: "hashicorp",
|
||||
ErrCount: 1,
|
||||
},
|
||||
{
|
||||
Value: "hashicorp/terraform",
|
||||
ErrCount: 1,
|
||||
},
|
||||
}
|
||||
|
||||
for _, tc := range cases {
|
||||
_, errors := validateAwsKmsName(tc.Value, "name")
|
||||
if len(errors) != tc.ErrCount {
|
||||
t.Fatalf("AWS KMS Alias Name validation failed: %v", errors)
|
||||
}
|
||||
}
|
||||
|
||||
}
|
||||
|
30
website/source/docs/providers/aws/d/kms_alias.html.markdown
Normal file
30
website/source/docs/providers/aws/d/kms_alias.html.markdown
Normal file
@ -0,0 +1,30 @@
|
||||
---
|
||||
layout: "aws"
|
||||
page_title: "AWS: aws_kms_alias"
|
||||
sidebar_current: "docs-aws-datasource-kms-alias"
|
||||
description: |-
|
||||
Get information on a AWS Key Management Service (KMS) Alias
|
||||
---
|
||||
|
||||
# aws\_kms\_alias
|
||||
|
||||
Use this data source to get the ARN of a KMS key alias.
|
||||
By using this data source, you can reference key alias
|
||||
without having to hard code the ARN as input.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```hcl
|
||||
data "aws_kms_alias" "s3" {
|
||||
name = "alias/aws/s3"
|
||||
}
|
||||
```
|
||||
|
||||
## Argument Reference
|
||||
|
||||
* `name` - (Required) The display name of the alias. The name must start with the word "alias" followed by a forward slash (alias/)
|
||||
|
||||
## Attributes Reference
|
||||
|
||||
* `arn` - The Amazon Resource Name(ARN) of the key alias.
|
||||
* `target_key_id` - Key identifier pointed to by the alias.
|
Loading…
Reference in New Issue
Block a user