1. Packages
  2. AWS
  3. API Docs
  4. ssoadmin
  5. getPermissionSet
AWS v6.74.0 published on Wednesday, Mar 26, 2025 by Pulumi

aws.ssoadmin.getPermissionSet

Explore with Pulumi AI

AWS v6.74.0 published on Wednesday, Mar 26, 2025 by Pulumi

Use this data source to get a Single Sign-On (SSO) Permission Set.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = aws.ssoadmin.getInstances({});
const exampleGetPermissionSet = example.then(example => aws.ssoadmin.getPermissionSet({
    instanceArn: example.arns?.[0],
    name: "Example",
}));
export const arn = exampleGetPermissionSet.then(exampleGetPermissionSet => exampleGetPermissionSet.arn);
Copy
import pulumi
import pulumi_aws as aws

example = aws.ssoadmin.get_instances()
example_get_permission_set = aws.ssoadmin.get_permission_set(instance_arn=example.arns[0],
    name="Example")
pulumi.export("arn", example_get_permission_set.arn)
Copy
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/ssoadmin"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := ssoadmin.GetInstances(ctx, map[string]interface{}{}, nil)
		if err != nil {
			return err
		}
		exampleGetPermissionSet, err := ssoadmin.LookupPermissionSet(ctx, &ssoadmin.LookupPermissionSetArgs{
			InstanceArn: example.Arns[0],
			Name:        pulumi.StringRef("Example"),
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("arn", exampleGetPermissionSet.Arn)
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = Aws.SsoAdmin.GetInstances.Invoke();

    var exampleGetPermissionSet = Aws.SsoAdmin.GetPermissionSet.Invoke(new()
    {
        InstanceArn = example.Apply(getInstancesResult => getInstancesResult.Arns[0]),
        Name = "Example",
    });

    return new Dictionary<string, object?>
    {
        ["arn"] = exampleGetPermissionSet.Apply(getPermissionSetResult => getPermissionSetResult.Arn),
    };
});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ssoadmin.SsoadminFunctions;
import com.pulumi.aws.ssoadmin.inputs.GetPermissionSetArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var example = SsoadminFunctions.getInstances();

        final var exampleGetPermissionSet = SsoadminFunctions.getPermissionSet(GetPermissionSetArgs.builder()
            .instanceArn(example.applyValue(getInstancesResult -> getInstancesResult.arns()[0]))
            .name("Example")
            .build());

        ctx.export("arn", exampleGetPermissionSet.applyValue(getPermissionSetResult -> getPermissionSetResult.arn()));
    }
}
Copy
variables:
  example:
    fn::invoke:
      function: aws:ssoadmin:getInstances
      arguments: {}
  exampleGetPermissionSet:
    fn::invoke:
      function: aws:ssoadmin:getPermissionSet
      arguments:
        instanceArn: ${example.arns[0]}
        name: Example
outputs:
  arn: ${exampleGetPermissionSet.arn}
Copy

Using getPermissionSet

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getPermissionSet(args: GetPermissionSetArgs, opts?: InvokeOptions): Promise<GetPermissionSetResult>
function getPermissionSetOutput(args: GetPermissionSetOutputArgs, opts?: InvokeOptions): Output<GetPermissionSetResult>
Copy
def get_permission_set(arn: Optional[str] = None,
                       instance_arn: Optional[str] = None,
                       name: Optional[str] = None,
                       tags: Optional[Mapping[str, str]] = None,
                       opts: Optional[InvokeOptions] = None) -> GetPermissionSetResult
def get_permission_set_output(arn: Optional[pulumi.Input[str]] = None,
                       instance_arn: Optional[pulumi.Input[str]] = None,
                       name: Optional[pulumi.Input[str]] = None,
                       tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetPermissionSetResult]
Copy
func LookupPermissionSet(ctx *Context, args *LookupPermissionSetArgs, opts ...InvokeOption) (*LookupPermissionSetResult, error)
func LookupPermissionSetOutput(ctx *Context, args *LookupPermissionSetOutputArgs, opts ...InvokeOption) LookupPermissionSetResultOutput
Copy

> Note: This function is named LookupPermissionSet in the Go SDK.

public static class GetPermissionSet 
{
    public static Task<GetPermissionSetResult> InvokeAsync(GetPermissionSetArgs args, InvokeOptions? opts = null)
    public static Output<GetPermissionSetResult> Invoke(GetPermissionSetInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetPermissionSetResult> getPermissionSet(GetPermissionSetArgs args, InvokeOptions options)
public static Output<GetPermissionSetResult> getPermissionSet(GetPermissionSetArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: aws:ssoadmin/getPermissionSet:getPermissionSet
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

InstanceArn This property is required. string
ARN of the SSO Instance associated with the permission set.
Arn string
ARN of the permission set.
Name string
Name of the SSO Permission Set.
Tags Dictionary<string, string>
Key-value map of resource tags.
InstanceArn This property is required. string
ARN of the SSO Instance associated with the permission set.
Arn string
ARN of the permission set.
Name string
Name of the SSO Permission Set.
Tags map[string]string
Key-value map of resource tags.
instanceArn This property is required. String
ARN of the SSO Instance associated with the permission set.
arn String
ARN of the permission set.
name String
Name of the SSO Permission Set.
tags Map<String,String>
Key-value map of resource tags.
instanceArn This property is required. string
ARN of the SSO Instance associated with the permission set.
arn string
ARN of the permission set.
name string
Name of the SSO Permission Set.
tags {[key: string]: string}
Key-value map of resource tags.
instance_arn This property is required. str
ARN of the SSO Instance associated with the permission set.
arn str
ARN of the permission set.
name str
Name of the SSO Permission Set.
tags Mapping[str, str]
Key-value map of resource tags.
instanceArn This property is required. String
ARN of the SSO Instance associated with the permission set.
arn String
ARN of the permission set.
name String
Name of the SSO Permission Set.
tags Map<String>
Key-value map of resource tags.

getPermissionSet Result

The following output properties are available:

Arn string
CreatedDate string
Description string
Description of the Permission Set.
Id string
The provider-assigned unique ID for this managed resource.
InstanceArn string
Name string
RelayState string
Relay state URL used to redirect users within the application during the federation authentication process.
SessionDuration string
Length of time that the application user sessions are valid in the ISO-8601 standard.
Tags Dictionary<string, string>
Key-value map of resource tags.
Arn string
CreatedDate string
Description string
Description of the Permission Set.
Id string
The provider-assigned unique ID for this managed resource.
InstanceArn string
Name string
RelayState string
Relay state URL used to redirect users within the application during the federation authentication process.
SessionDuration string
Length of time that the application user sessions are valid in the ISO-8601 standard.
Tags map[string]string
Key-value map of resource tags.
arn String
createdDate String
description String
Description of the Permission Set.
id String
The provider-assigned unique ID for this managed resource.
instanceArn String
name String
relayState String
Relay state URL used to redirect users within the application during the federation authentication process.
sessionDuration String
Length of time that the application user sessions are valid in the ISO-8601 standard.
tags Map<String,String>
Key-value map of resource tags.
arn string
createdDate string
description string
Description of the Permission Set.
id string
The provider-assigned unique ID for this managed resource.
instanceArn string
name string
relayState string
Relay state URL used to redirect users within the application during the federation authentication process.
sessionDuration string
Length of time that the application user sessions are valid in the ISO-8601 standard.
tags {[key: string]: string}
Key-value map of resource tags.
arn str
created_date str
description str
Description of the Permission Set.
id str
The provider-assigned unique ID for this managed resource.
instance_arn str
name str
relay_state str
Relay state URL used to redirect users within the application during the federation authentication process.
session_duration str
Length of time that the application user sessions are valid in the ISO-8601 standard.
tags Mapping[str, str]
Key-value map of resource tags.
arn String
createdDate String
description String
Description of the Permission Set.
id String
The provider-assigned unique ID for this managed resource.
instanceArn String
name String
relayState String
Relay state URL used to redirect users within the application during the federation authentication process.
sessionDuration String
Length of time that the application user sessions are valid in the ISO-8601 standard.
tags Map<String>
Key-value map of resource tags.

Package Details

Repository
AWS Classic pulumi/pulumi-aws
License
Apache-2.0
Notes
This Pulumi package is based on the aws Terraform Provider.
AWS v6.74.0 published on Wednesday, Mar 26, 2025 by Pulumi