PermissionSet class
Provides a Single Sign-On (SSO) Permission Set resource
> NOTE: Updating this resource will automatically Provision the Permission Set to apply the corresponding updates to all assigned accounts.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = aws.ssoadmin.getInstances({});
const examplePermissionSet = new aws.ssoadmin.PermissionSet("example", {
name: "Example",
description: "An example",
instanceArn: example.then(example => example.arns?.[0]),
relayState: "https://s3.console.aws.amazon.com/s3/home?region=us-east-1#",
sessionDuration: "PT2H",
});
import pulumi
import pulumi_aws as aws
example = aws.ssoadmin.get_instances()
example_permission_set = aws.ssoadmin.PermissionSet("example",
name="Example",
description="An example",
instance_arn=example.arns[0],
relay_state="https://s3.console.aws.amazon.com/s3/home?region=us-east-1#",
session_duration="PT2H")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = Aws.SsoAdmin.GetInstances.Invoke();
var examplePermissionSet = new Aws.SsoAdmin.PermissionSet("example", new()
{
Name = "Example",
Description = "An example",
InstanceArn = example.Apply(getInstancesResult => getInstancesResult.Arns[0]),
RelayState = "https://s3.console.aws.amazon.com/s3/home?region=us-east-1#",
SessionDuration = "PT2H",
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/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, &ssoadmin.GetInstancesArgs{}, nil)
if err != nil {
return err
}
_, err = ssoadmin.NewPermissionSet(ctx, "example", &ssoadmin.PermissionSetArgs{
Name: pulumi.String("Example"),
Description: pulumi.String("An example"),
InstanceArn: pulumi.String(example.Arns[0]),
RelayState: pulumi.String("https://s3.console.aws.amazon.com/s3/home?region=us-east-1#"),
SessionDuration: pulumi.String("PT2H"),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
data "aws_ssoadmin_getinstances" "example" {
}
resource "aws_ssoadmin_permissionset" "example" {
name = "Example"
description = "An example"
instance_arn = data.aws_ssoadmin_getinstances.example.arns[0]
relay_state = "https://s3.console.aws.amazon.com/s3/home?region=us-east-1#"
session_duration = "PT2H"
}
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.GetInstancesArgs;
import com.pulumi.aws.ssoadmin.PermissionSet;
import com.pulumi.aws.ssoadmin.PermissionSetArgs;
import java.util.ArrayList;
import java.util.Arrays;
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(GetInstancesArgs.builder()
.build());
var examplePermissionSet = new PermissionSet("examplePermissionSet", PermissionSetArgs.builder()
.name("Example")
.description("An example")
.instanceArn(example.arns()[0])
.relayState("https://s3.console.aws.amazon.com/s3/home?region=us-east-1#")
.sessionDuration("PT2H")
.build());
}
}
resources:
examplePermissionSet:
type: aws:ssoadmin:PermissionSet
name: example
properties:
name: Example
description: An example
instanceArn: ${example.arns[0]}
relayState: https://s3.console.aws.amazon.com/s3/home?region=us-east-1#
sessionDuration: PT2H
variables:
example:
fn::invoke:
function: aws:ssoadmin:getInstances
arguments: {}
Import
Using pulumi import, import SSO Permission Sets using the arn and instanceArn separated by a comma (,). For example:
$ pulumi import aws:ssoadmin/permissionSet:PermissionSet example arn:aws:sso:::permissionSet/ssoins-2938j0x8920sbj72/ps-80383020jr9302rk,arn:aws:sso:::instance/ssoins-2938j0x8920sbj72
Constructors
- PermissionSet(String name, {PermissionSetArgs? args, CustomResourceOptions? options})
-
Creates a new PermissionSet.
nameThe Pulumi resource name.argsArguments used to configure this PermissionSet. The set of arguments for PermissionSet.optionsResource options controlling this resource's behavior. - PermissionSet.reference(String urn)
- Creates a typed reference to an existing PermissionSet resource.
Properties
-
arn
↔ Output<
String> -
ARN of the Permission Set.
latefinal
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
createdDate
↔ Output<
String> -
The date the Permission Set was created in RFC3339 format.
latefinal
-
description
↔ Output<
String?> -
The description of the Permission Set.
latefinal
- hashCode → int
-
The hash code for this object.
no setterinherited
-
id
↔ Output<
String> -
getter/setter pairinherited
-
instanceArn
↔ Output<
String> -
ARN of the SSO Instance under which the operation will be executed.
latefinal
- isCustom → bool
-
Returns whether this resource is provider-managed.
no setterinherited
- isProtected → bool
-
Returns whether this resource is protected from deletion.
no setterinherited
- isRemote → bool
-
Whether this resource is registered as remote.
no setterinherited
- isResourceReference → bool
-
Whether this instance represents a resource value returned over RPC.
finalinherited
-
name
↔ Output<
String> -
The name of the Permission Set.
latefinal
-
region
↔ Output<
String> -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
-
relayState
↔ Output<
String?> -
The relay state URL used to redirect users within the application during the federation authentication process.
latefinal
-
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
sessionDuration
↔ Output<
String?> -
The length of time that the application user sessions are valid in the ISO-8601 standard. Default:
PT1H.latefinal -
Key-value map of resource tags. .If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.latefinal -
A map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration block.latefinal -
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
urn
↔ Output<
String> -
latefinalinherited
Methods
-
failId(
Object error) → void -
Completes this resource ID with an error when registration fails.
inherited
-
failOutputs(
Object error) → void -
Completes all output properties with
error.inherited -
failUrn(
Object error) → void -
Completes this resource URN with an error when registration fails.
inherited
-
getProvider(
String moduleMember) → ProviderResource? -
Returns provider for
moduleMember's package, if configured.inherited -
getResourceName(
) → String -
Returns this resource's logical name.
inherited
-
getResourceType(
) → String -
Returns this resource's Pulumi type token.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
registerOutput<
T> (String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output< T> -
Registers a dynamic output property for this resource.
inherited
-
resolveId(
String? value, {required bool isKnown}) → void -
Resolves the provider-assigned ID for this resource.
inherited
-
resolveOutputs(
Struct outputs) → void -
Resolves all output properties from a monitor response payload.
inherited
-
resolveUrn(
String value) → void -
Resolves this resource's URN once assigned by the engine.
inherited
-
serializeProperties(
Map< String, dynamic> properties) → Future<Struct> -
Serializes resource properties for RPC transmission.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
get(
String name, Input< String> id, {PermissionSetState? state, CustomResourceOptions? options}) → PermissionSet -
Gets an existing PermissionSet resource's state with the given
nameandid.