com.pulumi.aws.ssoadmin.kotlin.PermissionSet.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of pulumi-aws-kotlin Show documentation
Show all versions of pulumi-aws-kotlin Show documentation
Build cloud applications and infrastructure by combining the safety and reliability of infrastructure as code with the power of the Kotlin programming language.
@file:Suppress("NAME_SHADOWING", "DEPRECATION")
package com.pulumi.aws.ssoadmin.kotlin
import com.pulumi.core.Output
import com.pulumi.kotlin.KotlinCustomResource
import com.pulumi.kotlin.PulumiTagMarker
import com.pulumi.kotlin.ResourceMapper
import com.pulumi.kotlin.options.CustomResourceOptions
import com.pulumi.kotlin.options.CustomResourceOptionsBuilder
import com.pulumi.resources.Resource
import kotlin.Boolean
import kotlin.Deprecated
import kotlin.String
import kotlin.Suppress
import kotlin.Unit
import kotlin.collections.Map
/**
* Builder for [PermissionSet].
*/
@PulumiTagMarker
public class PermissionSetResourceBuilder internal constructor() {
public var name: String? = null
public var args: PermissionSetArgs = PermissionSetArgs()
public var opts: CustomResourceOptions = CustomResourceOptions()
/**
* @param name The _unique_ name of the resulting resource.
*/
public fun name(`value`: String) {
this.name = value
}
/**
* @param block The arguments to use to populate this resource's properties.
*/
public suspend fun args(block: suspend PermissionSetArgsBuilder.() -> Unit) {
val builder = PermissionSetArgsBuilder()
block(builder)
this.args = builder.build()
}
/**
* @param block A bag of options that control this resource's behavior.
*/
public suspend fun opts(block: suspend CustomResourceOptionsBuilder.() -> Unit) {
this.opts = com.pulumi.kotlin.options.CustomResourceOptions.opts(block)
}
internal fun build(): PermissionSet {
val builtJavaResource = com.pulumi.aws.ssoadmin.PermissionSet(
this.name,
this.args.toJava(),
this.opts.toJava(),
)
return PermissionSet(builtJavaResource)
}
}
/**
* Provides a Single Sign-On (SSO) Permission Set resource
* > **NOTE:** Updating this resource will automatically [Provision the Permission Set](https://docs.aws.amazon.com/singlesignon/latest/APIReference/API_ProvisionPermissionSet.html) to apply the corresponding updates to all assigned accounts.
* ## Example Usage
*
* ```typescript
* 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",
* });
* ```
* ```python
* 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")
* ```
* ```csharp
* 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",
* });
* });
* ```
* ```go
* 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
* }
* _, 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
* })
* }
* ```
* ```java
* 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.PermissionSet;
* import com.pulumi.aws.ssoadmin.PermissionSetArgs;
* 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();
* var examplePermissionSet = new PermissionSet("examplePermissionSet", PermissionSetArgs.builder()
* .name("Example")
* .description("An example")
* .instanceArn(example.applyValue(getInstancesResult -> getInstancesResult.arns()[0]))
* .relayState("https://s3.console.aws.amazon.com/s3/home?region=us-east-1#")
* .sessionDuration("PT2H")
* .build());
* }
* }
* ```
* ```yaml
* 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 `instance_arn` separated by a comma (`,`). For example:
* ```sh
* $ pulumi import aws:ssoadmin/permissionSet:PermissionSet example arn:aws:sso:::permissionSet/ssoins-2938j0x8920sbj72/ps-80383020jr9302rk,arn:aws:sso:::instance/ssoins-2938j0x8920sbj72
* ```
*/
public class PermissionSet internal constructor(
override val javaResource: com.pulumi.aws.ssoadmin.PermissionSet,
) : KotlinCustomResource(javaResource, PermissionSetMapper) {
/**
* The Amazon Resource Name (ARN) of the Permission Set.
*/
public val arn: Output
get() = javaResource.arn().applyValue({ args0 -> args0 })
/**
* The date the Permission Set was created in [RFC3339 format](https://tools.ietf.org/html/rfc3339#section-5.8).
*/
public val createdDate: Output
get() = javaResource.createdDate().applyValue({ args0 -> args0 })
/**
* The description of the Permission Set.
*/
public val description: Output?
get() = javaResource.description().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* The Amazon Resource Name (ARN) of the SSO Instance under which the operation will be executed.
*/
public val instanceArn: Output
get() = javaResource.instanceArn().applyValue({ args0 -> args0 })
/**
* The name of the Permission Set.
*/
public val name: Output
get() = javaResource.name().applyValue({ args0 -> args0 })
/**
* The relay state URL used to redirect users within the application during the federation authentication process.
*/
public val relayState: Output?
get() = javaResource.relayState().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* The length of time that the application user sessions are valid in the ISO-8601 standard. Default: `PT1H`.
*/
public val sessionDuration: Output?
get() = javaResource.sessionDuration().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* Key-value map of resource tags. .If configured with a provider `default_tags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*/
public val tags: Output>?
get() = javaResource.tags().applyValue({ args0 ->
args0.map({ args0 ->
args0.map({ args0 ->
args0.key.to(args0.value)
}).toMap()
}).orElse(null)
})
/**
* A map of tags assigned to the resource, including those inherited from the provider `default_tags` configuration block.
*/
@Deprecated(
message = """
Please use `tags` instead.
""",
)
public val tagsAll: Output>
get() = javaResource.tagsAll().applyValue({ args0 ->
args0.map({ args0 ->
args0.key.to(args0.value)
}).toMap()
})
}
public object PermissionSetMapper : ResourceMapper {
override fun supportsMappingOfType(javaResource: Resource): Boolean =
com.pulumi.aws.ssoadmin.PermissionSet::class == javaResource::class
override fun map(javaResource: Resource): PermissionSet = PermissionSet(
javaResource as
com.pulumi.aws.ssoadmin.PermissionSet,
)
}
/**
* @see [PermissionSet].
* @param name The _unique_ name of the resulting resource.
* @param block Builder for [PermissionSet].
*/
public suspend fun permissionSet(
name: String,
block: suspend PermissionSetResourceBuilder.() -> Unit,
): PermissionSet {
val builder = PermissionSetResourceBuilder()
builder.name(name)
block(builder)
return builder.build()
}
/**
* @see [PermissionSet].
* @param name The _unique_ name of the resulting resource.
*/
public fun permissionSet(name: String): PermissionSet {
val builder = PermissionSetResourceBuilder()
builder.name(name)
return builder.build()
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy