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

d/aws_ssoadmin_principal_application_assignments: new data source #34815

Merged
merged 1 commit into from
Dec 8, 2023
Merged
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/34815.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
```release-note:new-data-source
aws_ssoadmin_principal_application_assignments
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,121 @@
// Copyright (c) HashiCorp, Inc.
// SPDX-License-Identifier: MPL-2.0

package ssoadmin

import (
"context"

"github.com/aws/aws-sdk-go-v2/aws"
"github.com/aws/aws-sdk-go-v2/service/ssoadmin"
awstypes "github.com/aws/aws-sdk-go-v2/service/ssoadmin/types"
"github.com/hashicorp/terraform-plugin-framework/datasource"
"github.com/hashicorp/terraform-plugin-framework/datasource/schema"
"github.com/hashicorp/terraform-plugin-framework/types"
"github.com/hashicorp/terraform-provider-aws/internal/create"
"github.com/hashicorp/terraform-provider-aws/internal/framework"
"github.com/hashicorp/terraform-provider-aws/internal/framework/flex"
fwtypes "github.com/hashicorp/terraform-provider-aws/internal/framework/types"
"github.com/hashicorp/terraform-provider-aws/names"
)

// @FrameworkDataSource(name="Principal Application Assignments")
func newDataSourcePrincipalApplicationAssignments(context.Context) (datasource.DataSourceWithConfigure, error) {
return &dataSourcePrincipalApplicationAssignments{}, nil
}

const (
DSNamePrincipalApplicationAssignments = "Principal Application Assignments Data Source"
)

type dataSourcePrincipalApplicationAssignments struct {
framework.DataSourceWithConfigure
}

func (d *dataSourcePrincipalApplicationAssignments) Metadata(_ context.Context, req datasource.MetadataRequest, resp *datasource.MetadataResponse) { // nosemgrep:ci.meta-in-func-name
resp.TypeName = "aws_ssoadmin_principal_application_assignments"
}

func (d *dataSourcePrincipalApplicationAssignments) Schema(ctx context.Context, req datasource.SchemaRequest, resp *datasource.SchemaResponse) {
resp.Schema = schema.Schema{
Attributes: map[string]schema.Attribute{
"id": framework.IDAttribute(),
"instance_arn": schema.StringAttribute{
CustomType: fwtypes.ARNType,
Required: true,
},
"principal_id": schema.StringAttribute{
Required: true,
},
"principal_type": schema.StringAttribute{
CustomType: fwtypes.StringEnumType[awstypes.PrincipalType](),
Required: true,
},
},
Blocks: map[string]schema.Block{
"application_assignments": schema.ListNestedBlock{
CustomType: fwtypes.NewListNestedObjectTypeOf[applicationAssignmentData](ctx),
NestedObject: schema.NestedBlockObject{
Attributes: map[string]schema.Attribute{
"application_arn": schema.StringAttribute{
Computed: true,
},
"principal_id": schema.StringAttribute{
Computed: true,
},
"principal_type": schema.StringAttribute{
CustomType: fwtypes.StringEnumType[awstypes.PrincipalType](),
Computed: true,
},
},
},
},
},
}
}
func (d *dataSourcePrincipalApplicationAssignments) Read(ctx context.Context, req datasource.ReadRequest, resp *datasource.ReadResponse) {
conn := d.Meta().SSOAdminClient(ctx)

var data dataSourcePrincipalApplicationAssignmentsData
resp.Diagnostics.Append(req.Config.Get(ctx, &data)...)
if resp.Diagnostics.HasError() {
return
}

paginator := ssoadmin.NewListApplicationAssignmentsForPrincipalPaginator(conn, &ssoadmin.ListApplicationAssignmentsForPrincipalInput{
InstanceArn: aws.String(data.InstanceARN.ValueString()),
PrincipalId: aws.String(data.PrincipalID.ValueString()),
PrincipalType: awstypes.PrincipalType(data.PrincipalType.ValueString()),
})

var out ssoadmin.ListApplicationAssignmentsForPrincipalOutput
for paginator.HasMorePages() {
page, err := paginator.NextPage(ctx)
if err != nil {
resp.Diagnostics.AddError(
create.ProblemStandardMessage(names.SSOAdmin, create.ErrActionReading, DSNamePrincipalApplicationAssignments, data.PrincipalID.String(), err),
err.Error(),
)
return
}

if page != nil && len(page.ApplicationAssignments) > 0 {
out.ApplicationAssignments = append(out.ApplicationAssignments, page.ApplicationAssignments...)
}
}

resp.Diagnostics.Append(flex.Flatten(ctx, out, &data)...)
if resp.Diagnostics.HasError() {
return
}

resp.Diagnostics.Append(resp.State.Set(ctx, &data)...)
}

type dataSourcePrincipalApplicationAssignmentsData struct {
InstanceARN fwtypes.ARN `tfsdk:"instance_arn"`
ApplicationAssignments fwtypes.ListNestedObjectValueOf[applicationAssignmentData] `tfsdk:"application_assignments"`
ID types.String `tfsdk:"id"`
PrincipalID types.String `tfsdk:"principal_id"`
PrincipalType fwtypes.StringEnum[awstypes.PrincipalType] `tfsdk:"principal_type"`
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,90 @@
// Copyright (c) HashiCorp, Inc.
// SPDX-License-Identifier: MPL-2.0

package ssoadmin_test

import (
"fmt"
"testing"

sdkacctest "github.com/hashicorp/terraform-plugin-testing/helper/acctest"
"github.com/hashicorp/terraform-plugin-testing/helper/resource"
"github.com/hashicorp/terraform-provider-aws/internal/acctest"
"github.com/hashicorp/terraform-provider-aws/names"
)

func TestAccSSOAdminPrincipalApplicationAssignmentsDataSource_basic(t *testing.T) {
ctx := acctest.Context(t)
rName := sdkacctest.RandomWithPrefix(acctest.ResourcePrefix)
dataSourceName := "data.aws_ssoadmin_principal_application_assignments.test"
applicationResourceName := "aws_ssoadmin_application.test"
userResourceName := "aws_identitystore_user.test"

resource.ParallelTest(t, resource.TestCase{
PreCheck: func() {
acctest.PreCheck(ctx, t)
acctest.PreCheckPartitionHasService(t, names.SSOAdminEndpointID)
acctest.PreCheckSSOAdminInstances(ctx, t)
},
ErrorCheck: acctest.ErrorCheck(t, names.SSOAdminEndpointID),
ProtoV5ProviderFactories: acctest.ProtoV5ProviderFactories,
CheckDestroy: nil,
Steps: []resource.TestStep{
{
Config: testAccPrincipalApplicationAssignmentsDataSourceConfig_basic(rName),
Check: resource.ComposeTestCheckFunc(
resource.TestCheckResourceAttrPair(dataSourceName, "principal_id", userResourceName, "user_id"),
resource.TestCheckResourceAttr(dataSourceName, "principal_type", "USER"),
resource.TestCheckResourceAttr(dataSourceName, "application_assignments.#", "1"),
resource.TestCheckResourceAttrPair(dataSourceName, "application_assignments.0.application_arn", applicationResourceName, "application_arn"),
resource.TestCheckResourceAttrPair(dataSourceName, "application_assignments.0.principal_id", userResourceName, "user_id"),
resource.TestCheckResourceAttr(dataSourceName, "application_assignments.0.principal_type", "USER"),
),
},
},
})
}

func testAccPrincipalApplicationAssignmentsDataSourceConfigBase(rName string) string {
return fmt.Sprintf(`
data "aws_ssoadmin_instances" "test" {}

resource "aws_ssoadmin_application" "test" {
name = %[1]q
application_provider_arn = %[2]q
instance_arn = tolist(data.aws_ssoadmin_instances.test.arns)[0]
}

resource "aws_identitystore_user" "test" {
identity_store_id = tolist(data.aws_ssoadmin_instances.test.identity_store_ids)[0]

display_name = "Acceptance Test"
user_name = %[1]q

name {
family_name = "Doe"
given_name = "John"
}
}

resource "aws_ssoadmin_application_assignment" "test" {
application_arn = aws_ssoadmin_application.test.application_arn
principal_id = aws_identitystore_user.test.user_id
principal_type = "USER"
}
`, rName, testAccApplicationProviderARN)
}

func testAccPrincipalApplicationAssignmentsDataSourceConfig_basic(rName string) string {
return acctest.ConfigCompose(
testAccPrincipalApplicationAssignmentsDataSourceConfigBase(rName),
`
data "aws_ssoadmin_principal_application_assignments" "test" {
depends_on = [aws_ssoadmin_application_assignment.test]

instance_arn = tolist(data.aws_ssoadmin_instances.test.arns)[0]
principal_id = aws_identitystore_user.test.user_id
principal_type = "USER"
}
`)
}
4 changes: 4 additions & 0 deletions internal/service/ssoadmin/service_package_gen.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
---
subcategory: "SSO Admin"
layout: "aws"
page_title: "AWS: aws_ssoadmin_principal_application_assignments"
description: |-
Terraform data source for viewing AWS SSO Admin Principal Application Assignments.
---

# Data Source: aws_ssoadmin_principal_application_assignments

Terraform data source for viewing AWS SSO Admin Principal Application Assignments.

## Example Usage

### Basic Usage

```terraform
data "aws_ssoadmin_principal_application_assignments" "example" {
instance_arn = tolist(data.aws_ssoadmin_instances.test.arns)[0]
principal_id = aws_identitystore_user.test.user_id
principal_type = "USER"
}
```

## Argument Reference

The following arguments are required:

* `instance_arn` - (Required) ARN of the instance of IAM Identity Center.
* `principal_id` - (Required) An identifier for an object in IAM Identity Center, such as a user or group.
* `principal_type` - (Required) Entity type for which the assignment will be created. Valid values are `USER` or `GROUP`.

## Attribute Reference

This data source exports the following attributes in addition to the arguments above:

* `application_assignments` - List of principals assigned to the application. See the [`application_assignments` attribute reference](#application_assignments-attribute-reference) below.

### `application_assignments` Attribute Reference

* `application_arn` - ARN of the application.
* `principal_id` - An identifier for an object in IAM Identity Center, such as a user or group.
* `principal_type` - Entity type for which the assignment will be created. Valid values are `USER` or `GROUP`.
Loading