All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.pulumi.gcp.spanner.kotlin.InstanceIAMPolicy.kt Maven / Gradle / Ivy

@file:Suppress("NAME_SHADOWING", "DEPRECATION")

package com.pulumi.gcp.spanner.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.String
import kotlin.Suppress
import kotlin.Unit

/**
 * Builder for [InstanceIAMPolicy].
 */
@PulumiTagMarker
public class InstanceIAMPolicyResourceBuilder internal constructor() {
    public var name: String? = null

    public var args: InstanceIAMPolicyArgs = InstanceIAMPolicyArgs()

    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 InstanceIAMPolicyArgsBuilder.() -> Unit) {
        val builder = InstanceIAMPolicyArgsBuilder()
        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(): InstanceIAMPolicy {
        val builtJavaResource = com.pulumi.gcp.spanner.InstanceIAMPolicy(
            this.name,
            this.args.toJava(),
            this.opts.toJava(),
        )
        return InstanceIAMPolicy(builtJavaResource)
    }
}

/**
 * Three different resources help you manage your IAM policy for a Spanner instance. Each of these resources serves a different use case:
 * * `gcp.spanner.InstanceIAMPolicy`: Authoritative. Sets the IAM policy for the instance and replaces any existing policy already attached.
 * > **Warning:** It's entirely possibly to lock yourself out of your instance using `gcp.spanner.InstanceIAMPolicy`. Any permissions granted by default will be removed unless you include them in your config.
 * * `gcp.spanner.InstanceIAMBinding`: Authoritative for a given role. Updates the IAM policy to grant a role to a list of members. Other roles within the IAM policy for the instance are preserved.
 * * `gcp.spanner.InstanceIAMMember`: Non-authoritative. Updates the IAM policy to grant a role to a new member. Other members for the role for the instance are preserved.
 * > **Note:** `gcp.spanner.InstanceIAMPolicy` **cannot** be used in conjunction with `gcp.spanner.InstanceIAMBinding` and `gcp.spanner.InstanceIAMMember` or they will fight over what your policy should be.
 * > **Note:** `gcp.spanner.InstanceIAMBinding` resources **can be** used in conjunction with `gcp.spanner.InstanceIAMMember` resources **only if** they do not grant privilege to the same role.
 * ## gcp.spanner.InstanceIAMPolicy
 * 
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as gcp from "@pulumi/gcp";
 * const admin = gcp.organizations.getIAMPolicy({
 *     bindings: [{
 *         role: "roles/editor",
 *         members: ["user:jane@example.com"],
 *     }],
 * });
 * const instance = new gcp.spanner.InstanceIAMPolicy("instance", {
 *     instance: "your-instance-name",
 *     policyData: admin.then(admin => admin.policyData),
 * });
 * ```
 * ```python
 * import pulumi
 * import pulumi_gcp as gcp
 * admin = gcp.organizations.get_iam_policy(bindings=[{
 *     "role": "roles/editor",
 *     "members": ["user:jane@example.com"],
 * }])
 * instance = gcp.spanner.InstanceIAMPolicy("instance",
 *     instance="your-instance-name",
 *     policy_data=admin.policy_data)
 * ```
 * ```csharp
 * using System.Collections.Generic;
 * using System.Linq;
 * using Pulumi;
 * using Gcp = Pulumi.Gcp;
 * return await Deployment.RunAsync(() =>
 * {
 *     var admin = Gcp.Organizations.GetIAMPolicy.Invoke(new()
 *     {
 *         Bindings = new[]
 *         {
 *             new Gcp.Organizations.Inputs.GetIAMPolicyBindingInputArgs
 *             {
 *                 Role = "roles/editor",
 *                 Members = new[]
 *                 {
 *                     "user:[email protected]",
 *                 },
 *             },
 *         },
 *     });
 *     var instance = new Gcp.Spanner.InstanceIAMPolicy("instance", new()
 *     {
 *         Instance = "your-instance-name",
 *         PolicyData = admin.Apply(getIAMPolicyResult => getIAMPolicyResult.PolicyData),
 *     });
 * });
 * ```
 * ```go
 * package main
 * import (
 * 	"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/organizations"
 * 	"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/spanner"
 * 	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
 * )
 * func main() {
 * 	pulumi.Run(func(ctx *pulumi.Context) error {
 * 		admin, err := organizations.LookupIAMPolicy(ctx, &organizations.LookupIAMPolicyArgs{
 * 			Bindings: []organizations.GetIAMPolicyBinding{
 * 				{
 * 					Role: "roles/editor",
 * 					Members: []string{
 * 						"user:[email protected]",
 * 					},
 * 				},
 * 			},
 * 		}, nil)
 * 		if err != nil {
 * 			return err
 * 		}
 * 		_, err = spanner.NewInstanceIAMPolicy(ctx, "instance", &spanner.InstanceIAMPolicyArgs{
 * 			Instance:   pulumi.String("your-instance-name"),
 * 			PolicyData: pulumi.String(admin.PolicyData),
 * 		})
 * 		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.gcp.organizations.OrganizationsFunctions;
 * import com.pulumi.gcp.organizations.inputs.GetIAMPolicyArgs;
 * import com.pulumi.gcp.spanner.InstanceIAMPolicy;
 * import com.pulumi.gcp.spanner.InstanceIAMPolicyArgs;
 * 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 admin = OrganizationsFunctions.getIAMPolicy(GetIAMPolicyArgs.builder()
 *             .bindings(GetIAMPolicyBindingArgs.builder()
 *                 .role("roles/editor")
 *                 .members("user:[email protected]")
 *                 .build())
 *             .build());
 *         var instance = new InstanceIAMPolicy("instance", InstanceIAMPolicyArgs.builder()
 *             .instance("your-instance-name")
 *             .policyData(admin.applyValue(getIAMPolicyResult -> getIAMPolicyResult.policyData()))
 *             .build());
 *     }
 * }
 * ```
 * ```yaml
 * resources:
 *   instance:
 *     type: gcp:spanner:InstanceIAMPolicy
 *     properties:
 *       instance: your-instance-name
 *       policyData: ${admin.policyData}
 * variables:
 *   admin:
 *     fn::invoke:
 *       Function: gcp:organizations:getIAMPolicy
 *       Arguments:
 *         bindings:
 *           - role: roles/editor
 *             members:
 *               - user:[email protected]
 * ```
 * 
 * ## gcp.spanner.InstanceIAMBinding
 * 
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as gcp from "@pulumi/gcp";
 * const instance = new gcp.spanner.InstanceIAMBinding("instance", {
 *     instance: "your-instance-name",
 *     role: "roles/spanner.databaseAdmin",
 *     members: ["user:jane@example.com"],
 * });
 * ```
 * ```python
 * import pulumi
 * import pulumi_gcp as gcp
 * instance = gcp.spanner.InstanceIAMBinding("instance",
 *     instance="your-instance-name",
 *     role="roles/spanner.databaseAdmin",
 *     members=["user:jane@example.com"])
 * ```
 * ```csharp
 * using System.Collections.Generic;
 * using System.Linq;
 * using Pulumi;
 * using Gcp = Pulumi.Gcp;
 * return await Deployment.RunAsync(() =>
 * {
 *     var instance = new Gcp.Spanner.InstanceIAMBinding("instance", new()
 *     {
 *         Instance = "your-instance-name",
 *         Role = "roles/spanner.databaseAdmin",
 *         Members = new[]
 *         {
 *             "user:[email protected]",
 *         },
 *     });
 * });
 * ```
 * ```go
 * package main
 * import (
 * 	"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/spanner"
 * 	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
 * )
 * func main() {
 * 	pulumi.Run(func(ctx *pulumi.Context) error {
 * 		_, err := spanner.NewInstanceIAMBinding(ctx, "instance", &spanner.InstanceIAMBindingArgs{
 * 			Instance: pulumi.String("your-instance-name"),
 * 			Role:     pulumi.String("roles/spanner.databaseAdmin"),
 * 			Members: pulumi.StringArray{
 * 				pulumi.String("user:[email protected]"),
 * 			},
 * 		})
 * 		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.gcp.spanner.InstanceIAMBinding;
 * import com.pulumi.gcp.spanner.InstanceIAMBindingArgs;
 * 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 instance = new InstanceIAMBinding("instance", InstanceIAMBindingArgs.builder()
 *             .instance("your-instance-name")
 *             .role("roles/spanner.databaseAdmin")
 *             .members("user:[email protected]")
 *             .build());
 *     }
 * }
 * ```
 * ```yaml
 * resources:
 *   instance:
 *     type: gcp:spanner:InstanceIAMBinding
 *     properties:
 *       instance: your-instance-name
 *       role: roles/spanner.databaseAdmin
 *       members:
 *         - user:[email protected]
 * ```
 * 
 * ## gcp.spanner.InstanceIAMMember
 * 
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as gcp from "@pulumi/gcp";
 * const instance = new gcp.spanner.InstanceIAMMember("instance", {
 *     instance: "your-instance-name",
 *     role: "roles/spanner.databaseAdmin",
 *     member: "user:[email protected]",
 * });
 * ```
 * ```python
 * import pulumi
 * import pulumi_gcp as gcp
 * instance = gcp.spanner.InstanceIAMMember("instance",
 *     instance="your-instance-name",
 *     role="roles/spanner.databaseAdmin",
 *     member="user:[email protected]")
 * ```
 * ```csharp
 * using System.Collections.Generic;
 * using System.Linq;
 * using Pulumi;
 * using Gcp = Pulumi.Gcp;
 * return await Deployment.RunAsync(() =>
 * {
 *     var instance = new Gcp.Spanner.InstanceIAMMember("instance", new()
 *     {
 *         Instance = "your-instance-name",
 *         Role = "roles/spanner.databaseAdmin",
 *         Member = "user:[email protected]",
 *     });
 * });
 * ```
 * ```go
 * package main
 * import (
 * 	"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/spanner"
 * 	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
 * )
 * func main() {
 * 	pulumi.Run(func(ctx *pulumi.Context) error {
 * 		_, err := spanner.NewInstanceIAMMember(ctx, "instance", &spanner.InstanceIAMMemberArgs{
 * 			Instance: pulumi.String("your-instance-name"),
 * 			Role:     pulumi.String("roles/spanner.databaseAdmin"),
 * 			Member:   pulumi.String("user:[email protected]"),
 * 		})
 * 		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.gcp.spanner.InstanceIAMMember;
 * import com.pulumi.gcp.spanner.InstanceIAMMemberArgs;
 * 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 instance = new InstanceIAMMember("instance", InstanceIAMMemberArgs.builder()
 *             .instance("your-instance-name")
 *             .role("roles/spanner.databaseAdmin")
 *             .member("user:[email protected]")
 *             .build());
 *     }
 * }
 * ```
 * ```yaml
 * resources:
 *   instance:
 *     type: gcp:spanner:InstanceIAMMember
 *     properties:
 *       instance: your-instance-name
 *       role: roles/spanner.databaseAdmin
 *       member: user:[email protected]
 * ```
 * 
 * ## gcp.spanner.InstanceIAMBinding
 * 
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as gcp from "@pulumi/gcp";
 * const instance = new gcp.spanner.InstanceIAMBinding("instance", {
 *     instance: "your-instance-name",
 *     role: "roles/spanner.databaseAdmin",
 *     members: ["user:jane@example.com"],
 * });
 * ```
 * ```python
 * import pulumi
 * import pulumi_gcp as gcp
 * instance = gcp.spanner.InstanceIAMBinding("instance",
 *     instance="your-instance-name",
 *     role="roles/spanner.databaseAdmin",
 *     members=["user:jane@example.com"])
 * ```
 * ```csharp
 * using System.Collections.Generic;
 * using System.Linq;
 * using Pulumi;
 * using Gcp = Pulumi.Gcp;
 * return await Deployment.RunAsync(() =>
 * {
 *     var instance = new Gcp.Spanner.InstanceIAMBinding("instance", new()
 *     {
 *         Instance = "your-instance-name",
 *         Role = "roles/spanner.databaseAdmin",
 *         Members = new[]
 *         {
 *             "user:[email protected]",
 *         },
 *     });
 * });
 * ```
 * ```go
 * package main
 * import (
 * 	"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/spanner"
 * 	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
 * )
 * func main() {
 * 	pulumi.Run(func(ctx *pulumi.Context) error {
 * 		_, err := spanner.NewInstanceIAMBinding(ctx, "instance", &spanner.InstanceIAMBindingArgs{
 * 			Instance: pulumi.String("your-instance-name"),
 * 			Role:     pulumi.String("roles/spanner.databaseAdmin"),
 * 			Members: pulumi.StringArray{
 * 				pulumi.String("user:[email protected]"),
 * 			},
 * 		})
 * 		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.gcp.spanner.InstanceIAMBinding;
 * import com.pulumi.gcp.spanner.InstanceIAMBindingArgs;
 * 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 instance = new InstanceIAMBinding("instance", InstanceIAMBindingArgs.builder()
 *             .instance("your-instance-name")
 *             .role("roles/spanner.databaseAdmin")
 *             .members("user:[email protected]")
 *             .build());
 *     }
 * }
 * ```
 * ```yaml
 * resources:
 *   instance:
 *     type: gcp:spanner:InstanceIAMBinding
 *     properties:
 *       instance: your-instance-name
 *       role: roles/spanner.databaseAdmin
 *       members:
 *         - user:[email protected]
 * ```
 * 
 * ## gcp.spanner.InstanceIAMMember
 * 
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as gcp from "@pulumi/gcp";
 * const instance = new gcp.spanner.InstanceIAMMember("instance", {
 *     instance: "your-instance-name",
 *     role: "roles/spanner.databaseAdmin",
 *     member: "user:[email protected]",
 * });
 * ```
 * ```python
 * import pulumi
 * import pulumi_gcp as gcp
 * instance = gcp.spanner.InstanceIAMMember("instance",
 *     instance="your-instance-name",
 *     role="roles/spanner.databaseAdmin",
 *     member="user:[email protected]")
 * ```
 * ```csharp
 * using System.Collections.Generic;
 * using System.Linq;
 * using Pulumi;
 * using Gcp = Pulumi.Gcp;
 * return await Deployment.RunAsync(() =>
 * {
 *     var instance = new Gcp.Spanner.InstanceIAMMember("instance", new()
 *     {
 *         Instance = "your-instance-name",
 *         Role = "roles/spanner.databaseAdmin",
 *         Member = "user:[email protected]",
 *     });
 * });
 * ```
 * ```go
 * package main
 * import (
 * 	"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/spanner"
 * 	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
 * )
 * func main() {
 * 	pulumi.Run(func(ctx *pulumi.Context) error {
 * 		_, err := spanner.NewInstanceIAMMember(ctx, "instance", &spanner.InstanceIAMMemberArgs{
 * 			Instance: pulumi.String("your-instance-name"),
 * 			Role:     pulumi.String("roles/spanner.databaseAdmin"),
 * 			Member:   pulumi.String("user:[email protected]"),
 * 		})
 * 		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.gcp.spanner.InstanceIAMMember;
 * import com.pulumi.gcp.spanner.InstanceIAMMemberArgs;
 * 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 instance = new InstanceIAMMember("instance", InstanceIAMMemberArgs.builder()
 *             .instance("your-instance-name")
 *             .role("roles/spanner.databaseAdmin")
 *             .member("user:[email protected]")
 *             .build());
 *     }
 * }
 * ```
 * ```yaml
 * resources:
 *   instance:
 *     type: gcp:spanner:InstanceIAMMember
 *     properties:
 *       instance: your-instance-name
 *       role: roles/spanner.databaseAdmin
 *       member: user:[email protected]
 * ```
 * 
 * ## Import
 * ### Importing IAM policies
 * IAM policy imports use the identifier of the Spanner Instances resource . For example:
 * * `{{project}}/{{instance}}`
 * An `import` block (Terraform v1.5.0 and later) can be used to import IAM policies:
 * tf
 * import {
 *   id = {{project}}/{{instance}}
 *   to = google_spanner_instance_iam_policy.default
 * }
 * The `pulumi import` command can also be used:
 * ```sh
 * $ pulumi import gcp:spanner/instanceIAMPolicy:InstanceIAMPolicy default {{project}}/{{instance}}
 * ```
 */
public class InstanceIAMPolicy internal constructor(
    override val javaResource: com.pulumi.gcp.spanner.InstanceIAMPolicy,
) : KotlinCustomResource(javaResource, InstanceIAMPolicyMapper) {
    /**
     * (Computed) The etag of the instance's IAM policy.
     */
    public val etag: Output
        get() = javaResource.etag().applyValue({ args0 -> args0 })

    /**
     * The name of the instance.
     */
    public val instance: Output
        get() = javaResource.instance().applyValue({ args0 -> args0 })

    /**
     * The policy data generated by
     * a `gcp.organizations.getIAMPolicy` data source.
     */
    public val policyData: Output
        get() = javaResource.policyData().applyValue({ args0 -> args0 })

    /**
     * The ID of the project in which the resource belongs. If it
     * is not provided, the provider project is used.
     */
    public val project: Output
        get() = javaResource.project().applyValue({ args0 -> args0 })
}

public object InstanceIAMPolicyMapper : ResourceMapper {
    override fun supportsMappingOfType(javaResource: Resource): Boolean =
        com.pulumi.gcp.spanner.InstanceIAMPolicy::class == javaResource::class

    override fun map(javaResource: Resource): InstanceIAMPolicy = InstanceIAMPolicy(
        javaResource as
            com.pulumi.gcp.spanner.InstanceIAMPolicy,
    )
}

/**
 * @see [InstanceIAMPolicy].
 * @param name The _unique_ name of the resulting resource.
 * @param block Builder for [InstanceIAMPolicy].
 */
public suspend fun instanceIAMPolicy(
    name: String,
    block: suspend InstanceIAMPolicyResourceBuilder.() -> Unit,
): InstanceIAMPolicy {
    val builder = InstanceIAMPolicyResourceBuilder()
    builder.name(name)
    block(builder)
    return builder.build()
}

/**
 * @see [InstanceIAMPolicy].
 * @param name The _unique_ name of the resulting resource.
 */
public fun instanceIAMPolicy(name: String): InstanceIAMPolicy {
    val builder = InstanceIAMPolicyResourceBuilder()
    builder.name(name)
    return builder.build()
}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy