com.pulumi.vault.identity.kotlin.GroupArgs.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of pulumi-vault-kotlin Show documentation
Show all versions of pulumi-vault-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.vault.identity.kotlin
import com.pulumi.core.Output
import com.pulumi.core.Output.of
import com.pulumi.kotlin.ConvertibleToJava
import com.pulumi.kotlin.PulumiTagMarker
import com.pulumi.vault.identity.GroupArgs.builder
import kotlin.Boolean
import kotlin.Pair
import kotlin.String
import kotlin.Suppress
import kotlin.collections.List
import kotlin.collections.Map
import kotlin.jvm.JvmName
/**
* Creates an Identity Group for Vault. The [Identity secrets engine](https://www.vaultproject.io/docs/secrets/identity/index.html) is the identity management solution for Vault.
* A group can contain multiple entities as its members. A group can also have subgroups. Policies set on the group is granted to all members of the group. During request time, when the token's entity ID is being evaluated for the policies that it has access to; along with the policies on the entity itself, policies that are inherited due to group memberships are also granted.
* ## Example Usage
* ### Internal Group
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as vault from "@pulumi/vault";
* const internal = new vault.identity.Group("internal", {
* name: "internal",
* type: "internal",
* policies: [
* "dev",
* "test",
* ],
* metadata: {
* version: "2",
* },
* });
* ```
* ```python
* import pulumi
* import pulumi_vault as vault
* internal = vault.identity.Group("internal",
* name="internal",
* type="internal",
* policies=[
* "dev",
* "test",
* ],
* metadata={
* "version": "2",
* })
* ```
* ```csharp
* using System.Collections.Generic;
* using System.Linq;
* using Pulumi;
* using Vault = Pulumi.Vault;
* return await Deployment.RunAsync(() =>
* {
* var @internal = new Vault.Identity.Group("internal", new()
* {
* Name = "internal",
* Type = "internal",
* Policies = new[]
* {
* "dev",
* "test",
* },
* Metadata =
* {
* { "version", "2" },
* },
* });
* });
* ```
* ```go
* package main
* import (
* "github.com/pulumi/pulumi-vault/sdk/v6/go/vault/identity"
* "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
* )
* func main() {
* pulumi.Run(func(ctx *pulumi.Context) error {
* _, err := identity.NewGroup(ctx, "internal", &identity.GroupArgs{
* Name: pulumi.String("internal"),
* Type: pulumi.String("internal"),
* Policies: pulumi.StringArray{
* pulumi.String("dev"),
* pulumi.String("test"),
* },
* Metadata: pulumi.StringMap{
* "version": pulumi.String("2"),
* },
* })
* 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.vault.identity.Group;
* import com.pulumi.vault.identity.GroupArgs;
* 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) {
* var internal = new Group("internal", GroupArgs.builder()
* .name("internal")
* .type("internal")
* .policies(
* "dev",
* "test")
* .metadata(Map.of("version", "2"))
* .build());
* }
* }
* ```
* ```yaml
* resources:
* internal:
* type: vault:identity:Group
* properties:
* name: internal
* type: internal
* policies:
* - dev
* - test
* metadata:
* version: '2'
* ```
*
* ### External Group
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as vault from "@pulumi/vault";
* const group = new vault.identity.Group("group", {
* name: "external",
* type: "external",
* policies: ["test"],
* metadata: {
* version: "1",
* },
* });
* ```
* ```python
* import pulumi
* import pulumi_vault as vault
* group = vault.identity.Group("group",
* name="external",
* type="external",
* policies=["test"],
* metadata={
* "version": "1",
* })
* ```
* ```csharp
* using System.Collections.Generic;
* using System.Linq;
* using Pulumi;
* using Vault = Pulumi.Vault;
* return await Deployment.RunAsync(() =>
* {
* var @group = new Vault.Identity.Group("group", new()
* {
* Name = "external",
* Type = "external",
* Policies = new[]
* {
* "test",
* },
* Metadata =
* {
* { "version", "1" },
* },
* });
* });
* ```
* ```go
* package main
* import (
* "github.com/pulumi/pulumi-vault/sdk/v6/go/vault/identity"
* "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
* )
* func main() {
* pulumi.Run(func(ctx *pulumi.Context) error {
* _, err := identity.NewGroup(ctx, "group", &identity.GroupArgs{
* Name: pulumi.String("external"),
* Type: pulumi.String("external"),
* Policies: pulumi.StringArray{
* pulumi.String("test"),
* },
* Metadata: pulumi.StringMap{
* "version": pulumi.String("1"),
* },
* })
* 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.vault.identity.Group;
* import com.pulumi.vault.identity.GroupArgs;
* 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) {
* var group = new Group("group", GroupArgs.builder()
* .name("external")
* .type("external")
* .policies("test")
* .metadata(Map.of("version", "1"))
* .build());
* }
* }
* ```
* ```yaml
* resources:
* group:
* type: vault:identity:Group
* properties:
* name: external
* type: external
* policies:
* - test
* metadata:
* version: '1'
* ```
*
* ## Caveats
* It's important to note that Vault identity groups names are *case-insensitive*. For example the following resources would be equivalent.
* Applying this configuration would result in the provider failing to create one of the identity groups, since the resources share the same `name`.
* This sort of pattern should be avoided:
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as vault from "@pulumi/vault";
* const internal = new vault.identity.Group("internal", {
* name: "internal",
* type: "internal",
* policies: [
* "dev",
* "test",
* ],
* metadata: {
* version: "2",
* },
* });
* const internalGroup = new vault.identity.Group("Internal", {
* name: "Internal",
* type: "internal",
* policies: [
* "dev",
* "test",
* ],
* metadata: {
* version: "2",
* },
* });
* ```
* ```python
* import pulumi
* import pulumi_vault as vault
* internal = vault.identity.Group("internal",
* name="internal",
* type="internal",
* policies=[
* "dev",
* "test",
* ],
* metadata={
* "version": "2",
* })
* internal_group = vault.identity.Group("Internal",
* name="Internal",
* type="internal",
* policies=[
* "dev",
* "test",
* ],
* metadata={
* "version": "2",
* })
* ```
* ```csharp
* using System.Collections.Generic;
* using System.Linq;
* using Pulumi;
* using Vault = Pulumi.Vault;
* return await Deployment.RunAsync(() =>
* {
* var @internal = new Vault.Identity.Group("internal", new()
* {
* Name = "internal",
* Type = "internal",
* Policies = new[]
* {
* "dev",
* "test",
* },
* Metadata =
* {
* { "version", "2" },
* },
* });
* var internalGroup = new Vault.Identity.Group("Internal", new()
* {
* Name = "Internal",
* Type = "internal",
* Policies = new[]
* {
* "dev",
* "test",
* },
* Metadata =
* {
* { "version", "2" },
* },
* });
* });
* ```
* ```go
* package main
* import (
* "github.com/pulumi/pulumi-vault/sdk/v6/go/vault/identity"
* "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
* )
* func main() {
* pulumi.Run(func(ctx *pulumi.Context) error {
* _, err := identity.NewGroup(ctx, "internal", &identity.GroupArgs{
* Name: pulumi.String("internal"),
* Type: pulumi.String("internal"),
* Policies: pulumi.StringArray{
* pulumi.String("dev"),
* pulumi.String("test"),
* },
* Metadata: pulumi.StringMap{
* "version": pulumi.String("2"),
* },
* })
* if err != nil {
* return err
* }
* _, err = identity.NewGroup(ctx, "Internal", &identity.GroupArgs{
* Name: pulumi.String("Internal"),
* Type: pulumi.String("internal"),
* Policies: pulumi.StringArray{
* pulumi.String("dev"),
* pulumi.String("test"),
* },
* Metadata: pulumi.StringMap{
* "version": pulumi.String("2"),
* },
* })
* 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.vault.identity.Group;
* import com.pulumi.vault.identity.GroupArgs;
* 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) {
* var internal = new Group("internal", GroupArgs.builder()
* .name("internal")
* .type("internal")
* .policies(
* "dev",
* "test")
* .metadata(Map.of("version", "2"))
* .build());
* var internalGroup = new Group("internalGroup", GroupArgs.builder()
* .name("Internal")
* .type("internal")
* .policies(
* "dev",
* "test")
* .metadata(Map.of("version", "2"))
* .build());
* }
* }
* ```
* ```yaml
* resources:
* internal:
* type: vault:identity:Group
* properties:
* name: internal
* type: internal
* policies:
* - dev
* - test
* metadata:
* version: '2'
* internalGroup:
* type: vault:identity:Group
* name: Internal
* properties:
* name: Internal
* type: internal
* policies:
* - dev
* - test
* metadata:
* version: '2'
* ```
*
* ## Import
* Identity group can be imported using the `id`, e.g.
* ```sh
* $ pulumi import vault:identity/group:Group test 'fcbf1efb-2b69-4209-bed8-811e3475dad3'
* ```
* @property externalMemberEntityIds `false` by default. If set to `true`, this resource will ignore any Entity IDs
* returned from Vault or specified in the resource. You can use
* `vault.identity.GroupMemberEntityIds` to manage Entity IDs for this group in a
* decoupled manner.
* @property externalMemberGroupIds `false` by default. If set to `true`, this resource will ignore any Group IDs
* returned from Vault or specified in the resource. You can use
* `vault.identity.GroupMemberGroupIds` to manage Group IDs for this group in a
* decoupled manner.
* @property externalPolicies `false` by default. If set to `true`, this resource will ignore any policies returned from
* Vault or specified in the resource. You can use `vault.identity.GroupPolicies` to manage
* policies for this group in a decoupled manner.
* @property memberEntityIds A list of Entity IDs to be assigned as group members. Not allowed on `external` groups.
* @property memberGroupIds A list of Group IDs to be assigned as group members. Not allowed on `external` groups.
* @property metadata A Map of additional metadata to associate with the group.
* @property name Name of the identity group to create.
* @property namespace The namespace to provision the resource in.
* The value should not contain leading or trailing forward slashes.
* The `namespace` is always relative to the provider's configured [namespace](https://www.terraform.io/docs/providers/vault/index.html#namespace).
* *Available only for Vault Enterprise*.
* @property policies A list of policies to apply to the group.
* @property type Type of the group, internal or external. Defaults to `internal`.
*/
public data class GroupArgs(
public val externalMemberEntityIds: Output? = null,
public val externalMemberGroupIds: Output? = null,
public val externalPolicies: Output? = null,
public val memberEntityIds: Output>? = null,
public val memberGroupIds: Output>? = null,
public val metadata: Output>? = null,
public val name: Output? = null,
public val namespace: Output? = null,
public val policies: Output>? = null,
public val type: Output? = null,
) : ConvertibleToJava {
override fun toJava(): com.pulumi.vault.identity.GroupArgs =
com.pulumi.vault.identity.GroupArgs.builder()
.externalMemberEntityIds(externalMemberEntityIds?.applyValue({ args0 -> args0 }))
.externalMemberGroupIds(externalMemberGroupIds?.applyValue({ args0 -> args0 }))
.externalPolicies(externalPolicies?.applyValue({ args0 -> args0 }))
.memberEntityIds(memberEntityIds?.applyValue({ args0 -> args0.map({ args0 -> args0 }) }))
.memberGroupIds(memberGroupIds?.applyValue({ args0 -> args0.map({ args0 -> args0 }) }))
.metadata(
metadata?.applyValue({ args0 ->
args0.map({ args0 ->
args0.key.to(args0.value)
}).toMap()
}),
)
.name(name?.applyValue({ args0 -> args0 }))
.namespace(namespace?.applyValue({ args0 -> args0 }))
.policies(policies?.applyValue({ args0 -> args0.map({ args0 -> args0 }) }))
.type(type?.applyValue({ args0 -> args0 })).build()
}
/**
* Builder for [GroupArgs].
*/
@PulumiTagMarker
public class GroupArgsBuilder internal constructor() {
private var externalMemberEntityIds: Output? = null
private var externalMemberGroupIds: Output? = null
private var externalPolicies: Output? = null
private var memberEntityIds: Output>? = null
private var memberGroupIds: Output>? = null
private var metadata: Output>? = null
private var name: Output? = null
private var namespace: Output? = null
private var policies: Output>? = null
private var type: Output? = null
/**
* @param value `false` by default. If set to `true`, this resource will ignore any Entity IDs
* returned from Vault or specified in the resource. You can use
* `vault.identity.GroupMemberEntityIds` to manage Entity IDs for this group in a
* decoupled manner.
*/
@JvmName("djnrxtrmdxgxqopo")
public suspend fun externalMemberEntityIds(`value`: Output) {
this.externalMemberEntityIds = value
}
/**
* @param value `false` by default. If set to `true`, this resource will ignore any Group IDs
* returned from Vault or specified in the resource. You can use
* `vault.identity.GroupMemberGroupIds` to manage Group IDs for this group in a
* decoupled manner.
*/
@JvmName("viofaqpqmuttfpan")
public suspend fun externalMemberGroupIds(`value`: Output) {
this.externalMemberGroupIds = value
}
/**
* @param value `false` by default. If set to `true`, this resource will ignore any policies returned from
* Vault or specified in the resource. You can use `vault.identity.GroupPolicies` to manage
* policies for this group in a decoupled manner.
*/
@JvmName("eiifwvrlpdhpsbjr")
public suspend fun externalPolicies(`value`: Output) {
this.externalPolicies = value
}
/**
* @param value A list of Entity IDs to be assigned as group members. Not allowed on `external` groups.
*/
@JvmName("najwmehkpnsmddbe")
public suspend fun memberEntityIds(`value`: Output>) {
this.memberEntityIds = value
}
@JvmName("evujpscutstctnnh")
public suspend fun memberEntityIds(vararg values: Output) {
this.memberEntityIds = Output.all(values.asList())
}
/**
* @param values A list of Entity IDs to be assigned as group members. Not allowed on `external` groups.
*/
@JvmName("osukokuwimigrxaa")
public suspend fun memberEntityIds(values: List>) {
this.memberEntityIds = Output.all(values)
}
/**
* @param value A list of Group IDs to be assigned as group members. Not allowed on `external` groups.
*/
@JvmName("xbucqkcxhrrmyxbf")
public suspend fun memberGroupIds(`value`: Output>) {
this.memberGroupIds = value
}
@JvmName("ploohfegquhiemuj")
public suspend fun memberGroupIds(vararg values: Output) {
this.memberGroupIds = Output.all(values.asList())
}
/**
* @param values A list of Group IDs to be assigned as group members. Not allowed on `external` groups.
*/
@JvmName("jylgpfuwjuafhafu")
public suspend fun memberGroupIds(values: List>) {
this.memberGroupIds = Output.all(values)
}
/**
* @param value A Map of additional metadata to associate with the group.
*/
@JvmName("kusobhtlblhhwyop")
public suspend fun metadata(`value`: Output>) {
this.metadata = value
}
/**
* @param value Name of the identity group to create.
*/
@JvmName("apnctajtklrcurnt")
public suspend fun name(`value`: Output) {
this.name = value
}
/**
* @param value The namespace to provision the resource in.
* The value should not contain leading or trailing forward slashes.
* The `namespace` is always relative to the provider's configured [namespace](https://www.terraform.io/docs/providers/vault/index.html#namespace).
* *Available only for Vault Enterprise*.
*/
@JvmName("uiywrksqqnypevhp")
public suspend fun namespace(`value`: Output) {
this.namespace = value
}
/**
* @param value A list of policies to apply to the group.
*/
@JvmName("bqniawwaefjutsrf")
public suspend fun policies(`value`: Output>) {
this.policies = value
}
@JvmName("vkdsrfxxwfvkybap")
public suspend fun policies(vararg values: Output) {
this.policies = Output.all(values.asList())
}
/**
* @param values A list of policies to apply to the group.
*/
@JvmName("ffcvdafqyrhccxcw")
public suspend fun policies(values: List>) {
this.policies = Output.all(values)
}
/**
* @param value Type of the group, internal or external. Defaults to `internal`.
*/
@JvmName("mmbkddhubxtfhaxo")
public suspend fun type(`value`: Output) {
this.type = value
}
/**
* @param value `false` by default. If set to `true`, this resource will ignore any Entity IDs
* returned from Vault or specified in the resource. You can use
* `vault.identity.GroupMemberEntityIds` to manage Entity IDs for this group in a
* decoupled manner.
*/
@JvmName("yqjjrfpfvwjdnwvd")
public suspend fun externalMemberEntityIds(`value`: Boolean?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.externalMemberEntityIds = mapped
}
/**
* @param value `false` by default. If set to `true`, this resource will ignore any Group IDs
* returned from Vault or specified in the resource. You can use
* `vault.identity.GroupMemberGroupIds` to manage Group IDs for this group in a
* decoupled manner.
*/
@JvmName("duervjdhuvlducyu")
public suspend fun externalMemberGroupIds(`value`: Boolean?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.externalMemberGroupIds = mapped
}
/**
* @param value `false` by default. If set to `true`, this resource will ignore any policies returned from
* Vault or specified in the resource. You can use `vault.identity.GroupPolicies` to manage
* policies for this group in a decoupled manner.
*/
@JvmName("anwepjbirctshrvt")
public suspend fun externalPolicies(`value`: Boolean?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.externalPolicies = mapped
}
/**
* @param value A list of Entity IDs to be assigned as group members. Not allowed on `external` groups.
*/
@JvmName("bgioueawtalmavpn")
public suspend fun memberEntityIds(`value`: List?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.memberEntityIds = mapped
}
/**
* @param values A list of Entity IDs to be assigned as group members. Not allowed on `external` groups.
*/
@JvmName("etjqeowffqbptbtx")
public suspend fun memberEntityIds(vararg values: String) {
val toBeMapped = values.toList()
val mapped = toBeMapped.let({ args0 -> of(args0) })
this.memberEntityIds = mapped
}
/**
* @param value A list of Group IDs to be assigned as group members. Not allowed on `external` groups.
*/
@JvmName("qptnqeeojkwtaxqr")
public suspend fun memberGroupIds(`value`: List?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.memberGroupIds = mapped
}
/**
* @param values A list of Group IDs to be assigned as group members. Not allowed on `external` groups.
*/
@JvmName("cwinybqogblomqpm")
public suspend fun memberGroupIds(vararg values: String) {
val toBeMapped = values.toList()
val mapped = toBeMapped.let({ args0 -> of(args0) })
this.memberGroupIds = mapped
}
/**
* @param value A Map of additional metadata to associate with the group.
*/
@JvmName("mvnniqqplufxigel")
public suspend fun metadata(`value`: Map?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.metadata = mapped
}
/**
* @param values A Map of additional metadata to associate with the group.
*/
@JvmName("bbnykvfoagfuujpv")
public fun metadata(vararg values: Pair) {
val toBeMapped = values.toMap()
val mapped = toBeMapped.let({ args0 -> of(args0) })
this.metadata = mapped
}
/**
* @param value Name of the identity group to create.
*/
@JvmName("lgggjhpftwimpycr")
public suspend fun name(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.name = mapped
}
/**
* @param value The namespace to provision the resource in.
* The value should not contain leading or trailing forward slashes.
* The `namespace` is always relative to the provider's configured [namespace](https://www.terraform.io/docs/providers/vault/index.html#namespace).
* *Available only for Vault Enterprise*.
*/
@JvmName("loobpedgmrnqbdya")
public suspend fun namespace(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.namespace = mapped
}
/**
* @param value A list of policies to apply to the group.
*/
@JvmName("wewpefinqsjkwdgn")
public suspend fun policies(`value`: List?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.policies = mapped
}
/**
* @param values A list of policies to apply to the group.
*/
@JvmName("cqmxohewmfryhonh")
public suspend fun policies(vararg values: String) {
val toBeMapped = values.toList()
val mapped = toBeMapped.let({ args0 -> of(args0) })
this.policies = mapped
}
/**
* @param value Type of the group, internal or external. Defaults to `internal`.
*/
@JvmName("eltluydlylsbprar")
public suspend fun type(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.type = mapped
}
internal fun build(): GroupArgs = GroupArgs(
externalMemberEntityIds = externalMemberEntityIds,
externalMemberGroupIds = externalMemberGroupIds,
externalPolicies = externalPolicies,
memberEntityIds = memberEntityIds,
memberGroupIds = memberGroupIds,
metadata = metadata,
name = name,
namespace = namespace,
policies = policies,
type = type,
)
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy