Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $
You can buy this project and download/modify it how often you want.
com.pulumi.gcp.apigateway.kotlin.ApiIamPolicy.kt Maven / Gradle / Ivy
@file:Suppress("NAME_SHADOWING", "DEPRECATION")
package com.pulumi.gcp.apigateway.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 [ApiIamPolicy].
*/
@PulumiTagMarker
public class ApiIamPolicyResourceBuilder internal constructor() {
public var name: String? = null
public var args: ApiIamPolicyArgs = ApiIamPolicyArgs()
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 ApiIamPolicyArgsBuilder.() -> Unit) {
val builder = ApiIamPolicyArgsBuilder()
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(): ApiIamPolicy {
val builtJavaResource = com.pulumi.gcp.apigateway.ApiIamPolicy(
this.name,
this.args.toJava(),
this.opts.toJava(),
)
return ApiIamPolicy(builtJavaResource)
}
}
/**
* Three different resources help you manage your IAM policy for API Gateway Api. Each of these resources serves a different use case:
* * `gcp.apigateway.ApiIamPolicy`: Authoritative. Sets the IAM policy for the api and replaces any existing policy already attached.
* * `gcp.apigateway.ApiIamBinding`: 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 api are preserved.
* * `gcp.apigateway.ApiIamMember`: Non-authoritative. Updates the IAM policy to grant a role to a new member. Other members for the role for the api are preserved.
* A data source can be used to retrieve policy data in advent you do not need creation
* * `gcp.apigateway.ApiIamPolicy`: Retrieves the IAM policy for the api
* > **Note:** `gcp.apigateway.ApiIamPolicy` **cannot** be used in conjunction with `gcp.apigateway.ApiIamBinding` and `gcp.apigateway.ApiIamMember` or they will fight over what your policy should be.
* > **Note:** `gcp.apigateway.ApiIamBinding` resources **can be** used in conjunction with `gcp.apigateway.ApiIamMember` resources **only if** they do not grant privilege to the same role.
* ## google\_api\_gateway\_api\_iam\_policy
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
* const admin = gcp.organizations.getIAMPolicy({
* bindings: [{
* role: "roles/apigateway.viewer",
* members: ["user:jane@example.com"],
* }],
* });
* const policy = new gcp.apigateway.ApiIamPolicy("policy", {
* project: api.project,
* api: api.apiId,
* policyData: admin.then(admin => admin.policyData),
* });
* ```
* ```python
* import pulumi
* import pulumi_gcp as gcp
* admin = gcp.organizations.get_iam_policy(bindings=[{
* "role": "roles/apigateway.viewer",
* "members": ["user:jane@example.com"],
* }])
* policy = gcp.apigateway.ApiIamPolicy("policy",
* project=api["project"],
* api=api["apiId"],
* 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/apigateway.viewer",
* Members = new[]
* {
* "user:[email protected] ",
* },
* },
* },
* });
* var policy = new Gcp.ApiGateway.ApiIamPolicy("policy", new()
* {
* Project = api.Project,
* Api = api.ApiId,
* PolicyData = admin.Apply(getIAMPolicyResult => getIAMPolicyResult.PolicyData),
* });
* });
* ```
* ```go
* package main
* import (
* "github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/apigateway"
* "github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/organizations"
* "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/apigateway.viewer",
* Members: []string{
* "user:[email protected] ",
* },
* },
* },
* }, nil)
* if err != nil {
* return err
* }
* _, err = apigateway.NewApiIamPolicy(ctx, "policy", &apigateway.ApiIamPolicyArgs{
* Project: pulumi.Any(api.Project),
* Api: pulumi.Any(api.ApiId),
* 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.apigateway.ApiIamPolicy;
* import com.pulumi.gcp.apigateway.ApiIamPolicyArgs;
* 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/apigateway.viewer")
* .members("user:[email protected] ")
* .build())
* .build());
* var policy = new ApiIamPolicy("policy", ApiIamPolicyArgs.builder()
* .project(api.project())
* .api(api.apiId())
* .policyData(admin.applyValue(getIAMPolicyResult -> getIAMPolicyResult.policyData()))
* .build());
* }
* }
* ```
* ```yaml
* resources:
* policy:
* type: gcp:apigateway:ApiIamPolicy
* properties:
* project: ${api.project}
* api: ${api.apiId}
* policyData: ${admin.policyData}
* variables:
* admin:
* fn::invoke:
* Function: gcp:organizations:getIAMPolicy
* Arguments:
* bindings:
* - role: roles/apigateway.viewer
* members:
* - user:[email protected]
* ```
*
* ## gcp.apigateway.ApiIamBinding
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
* const binding = new gcp.apigateway.ApiIamBinding("binding", {
* project: api.project,
* api: api.apiId,
* role: "roles/apigateway.viewer",
* members: ["user:jane@example.com"],
* });
* ```
* ```python
* import pulumi
* import pulumi_gcp as gcp
* binding = gcp.apigateway.ApiIamBinding("binding",
* project=api["project"],
* api=api["apiId"],
* role="roles/apigateway.viewer",
* members=["user:jane@example.com"])
* ```
* ```csharp
* using System.Collections.Generic;
* using System.Linq;
* using Pulumi;
* using Gcp = Pulumi.Gcp;
* return await Deployment.RunAsync(() =>
* {
* var binding = new Gcp.ApiGateway.ApiIamBinding("binding", new()
* {
* Project = api.Project,
* Api = api.ApiId,
* Role = "roles/apigateway.viewer",
* Members = new[]
* {
* "user:[email protected] ",
* },
* });
* });
* ```
* ```go
* package main
* import (
* "github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/apigateway"
* "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
* )
* func main() {
* pulumi.Run(func(ctx *pulumi.Context) error {
* _, err := apigateway.NewApiIamBinding(ctx, "binding", &apigateway.ApiIamBindingArgs{
* Project: pulumi.Any(api.Project),
* Api: pulumi.Any(api.ApiId),
* Role: pulumi.String("roles/apigateway.viewer"),
* 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.apigateway.ApiIamBinding;
* import com.pulumi.gcp.apigateway.ApiIamBindingArgs;
* 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 binding = new ApiIamBinding("binding", ApiIamBindingArgs.builder()
* .project(api.project())
* .api(api.apiId())
* .role("roles/apigateway.viewer")
* .members("user:[email protected] ")
* .build());
* }
* }
* ```
* ```yaml
* resources:
* binding:
* type: gcp:apigateway:ApiIamBinding
* properties:
* project: ${api.project}
* api: ${api.apiId}
* role: roles/apigateway.viewer
* members:
* - user:[email protected]
* ```
*
* ## gcp.apigateway.ApiIamMember
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
* const member = new gcp.apigateway.ApiIamMember("member", {
* project: api.project,
* api: api.apiId,
* role: "roles/apigateway.viewer",
* member: "user:[email protected] ",
* });
* ```
* ```python
* import pulumi
* import pulumi_gcp as gcp
* member = gcp.apigateway.ApiIamMember("member",
* project=api["project"],
* api=api["apiId"],
* role="roles/apigateway.viewer",
* member="user:[email protected] ")
* ```
* ```csharp
* using System.Collections.Generic;
* using System.Linq;
* using Pulumi;
* using Gcp = Pulumi.Gcp;
* return await Deployment.RunAsync(() =>
* {
* var member = new Gcp.ApiGateway.ApiIamMember("member", new()
* {
* Project = api.Project,
* Api = api.ApiId,
* Role = "roles/apigateway.viewer",
* Member = "user:[email protected] ",
* });
* });
* ```
* ```go
* package main
* import (
* "github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/apigateway"
* "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
* )
* func main() {
* pulumi.Run(func(ctx *pulumi.Context) error {
* _, err := apigateway.NewApiIamMember(ctx, "member", &apigateway.ApiIamMemberArgs{
* Project: pulumi.Any(api.Project),
* Api: pulumi.Any(api.ApiId),
* Role: pulumi.String("roles/apigateway.viewer"),
* 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.apigateway.ApiIamMember;
* import com.pulumi.gcp.apigateway.ApiIamMemberArgs;
* 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 member = new ApiIamMember("member", ApiIamMemberArgs.builder()
* .project(api.project())
* .api(api.apiId())
* .role("roles/apigateway.viewer")
* .member("user:[email protected] ")
* .build());
* }
* }
* ```
* ```yaml
* resources:
* member:
* type: gcp:apigateway:ApiIamMember
* properties:
* project: ${api.project}
* api: ${api.apiId}
* role: roles/apigateway.viewer
* member: user:[email protected]
* ```
*
* ## This resource supports User Project Overrides.
* -
* # IAM policy for API Gateway Api
* Three different resources help you manage your IAM policy for API Gateway Api. Each of these resources serves a different use case:
* * `gcp.apigateway.ApiIamPolicy`: Authoritative. Sets the IAM policy for the api and replaces any existing policy already attached.
* * `gcp.apigateway.ApiIamBinding`: 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 api are preserved.
* * `gcp.apigateway.ApiIamMember`: Non-authoritative. Updates the IAM policy to grant a role to a new member. Other members for the role for the api are preserved.
* A data source can be used to retrieve policy data in advent you do not need creation
* * `gcp.apigateway.ApiIamPolicy`: Retrieves the IAM policy for the api
* > **Note:** `gcp.apigateway.ApiIamPolicy` **cannot** be used in conjunction with `gcp.apigateway.ApiIamBinding` and `gcp.apigateway.ApiIamMember` or they will fight over what your policy should be.
* > **Note:** `gcp.apigateway.ApiIamBinding` resources **can be** used in conjunction with `gcp.apigateway.ApiIamMember` resources **only if** they do not grant privilege to the same role.
* ## google\_api\_gateway\_api\_iam\_policy
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
* const admin = gcp.organizations.getIAMPolicy({
* bindings: [{
* role: "roles/apigateway.viewer",
* members: ["user:jane@example.com"],
* }],
* });
* const policy = new gcp.apigateway.ApiIamPolicy("policy", {
* project: api.project,
* api: api.apiId,
* policyData: admin.then(admin => admin.policyData),
* });
* ```
* ```python
* import pulumi
* import pulumi_gcp as gcp
* admin = gcp.organizations.get_iam_policy(bindings=[{
* "role": "roles/apigateway.viewer",
* "members": ["user:jane@example.com"],
* }])
* policy = gcp.apigateway.ApiIamPolicy("policy",
* project=api["project"],
* api=api["apiId"],
* 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/apigateway.viewer",
* Members = new[]
* {
* "user:[email protected] ",
* },
* },
* },
* });
* var policy = new Gcp.ApiGateway.ApiIamPolicy("policy", new()
* {
* Project = api.Project,
* Api = api.ApiId,
* PolicyData = admin.Apply(getIAMPolicyResult => getIAMPolicyResult.PolicyData),
* });
* });
* ```
* ```go
* package main
* import (
* "github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/apigateway"
* "github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/organizations"
* "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/apigateway.viewer",
* Members: []string{
* "user:[email protected] ",
* },
* },
* },
* }, nil)
* if err != nil {
* return err
* }
* _, err = apigateway.NewApiIamPolicy(ctx, "policy", &apigateway.ApiIamPolicyArgs{
* Project: pulumi.Any(api.Project),
* Api: pulumi.Any(api.ApiId),
* 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.apigateway.ApiIamPolicy;
* import com.pulumi.gcp.apigateway.ApiIamPolicyArgs;
* 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/apigateway.viewer")
* .members("user:[email protected] ")
* .build())
* .build());
* var policy = new ApiIamPolicy("policy", ApiIamPolicyArgs.builder()
* .project(api.project())
* .api(api.apiId())
* .policyData(admin.applyValue(getIAMPolicyResult -> getIAMPolicyResult.policyData()))
* .build());
* }
* }
* ```
* ```yaml
* resources:
* policy:
* type: gcp:apigateway:ApiIamPolicy
* properties:
* project: ${api.project}
* api: ${api.apiId}
* policyData: ${admin.policyData}
* variables:
* admin:
* fn::invoke:
* Function: gcp:organizations:getIAMPolicy
* Arguments:
* bindings:
* - role: roles/apigateway.viewer
* members:
* - user:[email protected]
* ```
*
* ## gcp.apigateway.ApiIamBinding
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
* const binding = new gcp.apigateway.ApiIamBinding("binding", {
* project: api.project,
* api: api.apiId,
* role: "roles/apigateway.viewer",
* members: ["user:jane@example.com"],
* });
* ```
* ```python
* import pulumi
* import pulumi_gcp as gcp
* binding = gcp.apigateway.ApiIamBinding("binding",
* project=api["project"],
* api=api["apiId"],
* role="roles/apigateway.viewer",
* members=["user:jane@example.com"])
* ```
* ```csharp
* using System.Collections.Generic;
* using System.Linq;
* using Pulumi;
* using Gcp = Pulumi.Gcp;
* return await Deployment.RunAsync(() =>
* {
* var binding = new Gcp.ApiGateway.ApiIamBinding("binding", new()
* {
* Project = api.Project,
* Api = api.ApiId,
* Role = "roles/apigateway.viewer",
* Members = new[]
* {
* "user:[email protected] ",
* },
* });
* });
* ```
* ```go
* package main
* import (
* "github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/apigateway"
* "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
* )
* func main() {
* pulumi.Run(func(ctx *pulumi.Context) error {
* _, err := apigateway.NewApiIamBinding(ctx, "binding", &apigateway.ApiIamBindingArgs{
* Project: pulumi.Any(api.Project),
* Api: pulumi.Any(api.ApiId),
* Role: pulumi.String("roles/apigateway.viewer"),
* 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.apigateway.ApiIamBinding;
* import com.pulumi.gcp.apigateway.ApiIamBindingArgs;
* 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 binding = new ApiIamBinding("binding", ApiIamBindingArgs.builder()
* .project(api.project())
* .api(api.apiId())
* .role("roles/apigateway.viewer")
* .members("user:[email protected] ")
* .build());
* }
* }
* ```
* ```yaml
* resources:
* binding:
* type: gcp:apigateway:ApiIamBinding
* properties:
* project: ${api.project}
* api: ${api.apiId}
* role: roles/apigateway.viewer
* members:
* - user:[email protected]
* ```
*
* ## gcp.apigateway.ApiIamMember
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
* const member = new gcp.apigateway.ApiIamMember("member", {
* project: api.project,
* api: api.apiId,
* role: "roles/apigateway.viewer",
* member: "user:[email protected] ",
* });
* ```
* ```python
* import pulumi
* import pulumi_gcp as gcp
* member = gcp.apigateway.ApiIamMember("member",
* project=api["project"],
* api=api["apiId"],
* role="roles/apigateway.viewer",
* member="user:[email protected] ")
* ```
* ```csharp
* using System.Collections.Generic;
* using System.Linq;
* using Pulumi;
* using Gcp = Pulumi.Gcp;
* return await Deployment.RunAsync(() =>
* {
* var member = new Gcp.ApiGateway.ApiIamMember("member", new()
* {
* Project = api.Project,
* Api = api.ApiId,
* Role = "roles/apigateway.viewer",
* Member = "user:[email protected] ",
* });
* });
* ```
* ```go
* package main
* import (
* "github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/apigateway"
* "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
* )
* func main() {
* pulumi.Run(func(ctx *pulumi.Context) error {
* _, err := apigateway.NewApiIamMember(ctx, "member", &apigateway.ApiIamMemberArgs{
* Project: pulumi.Any(api.Project),
* Api: pulumi.Any(api.ApiId),
* Role: pulumi.String("roles/apigateway.viewer"),
* 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.apigateway.ApiIamMember;
* import com.pulumi.gcp.apigateway.ApiIamMemberArgs;
* 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 member = new ApiIamMember("member", ApiIamMemberArgs.builder()
* .project(api.project())
* .api(api.apiId())
* .role("roles/apigateway.viewer")
* .member("user:[email protected] ")
* .build());
* }
* }
* ```
* ```yaml
* resources:
* member:
* type: gcp:apigateway:ApiIamMember
* properties:
* project: ${api.project}
* api: ${api.apiId}
* role: roles/apigateway.viewer
* member: user:[email protected]
* ```
*
* ## Import
* For all import syntaxes, the "resource in question" can take any of the following forms:
* * projects/{{project}}/locations/global/apis/{{api}}
* * {{project}}/{{api}}
* * {{api}}
* Any variables not passed in the import command will be taken from the provider configuration.
* API Gateway api IAM resources can be imported using the resource identifiers, role, and member.
* IAM member imports use space-delimited identifiers: the resource in question, the role, and the member identity, e.g.
* ```sh
* $ pulumi import gcp:apigateway/apiIamPolicy:ApiIamPolicy editor "projects/{{project}}/locations/global/apis/{{api}} roles/apigateway.viewer user:[email protected] "
* ```
* IAM binding imports use space-delimited identifiers: the resource in question and the role, e.g.
* ```sh
* $ pulumi import gcp:apigateway/apiIamPolicy:ApiIamPolicy editor "projects/{{project}}/locations/global/apis/{{api}} roles/apigateway.viewer"
* ```
* IAM policy imports use the identifier of the resource in question, e.g.
* ```sh
* $ pulumi import gcp:apigateway/apiIamPolicy:ApiIamPolicy editor projects/{{project}}/locations/global/apis/{{api}}
* ```
* -> **Custom Roles**: If you're importing a IAM resource with a custom role, make sure to use the
* full name of the custom role, e.g. `[projects/my-project|organizations/my-org]/roles/my-custom-role`.
*/
public class ApiIamPolicy internal constructor(
override val javaResource: com.pulumi.gcp.apigateway.ApiIamPolicy,
) : KotlinCustomResource(javaResource, ApiIamPolicyMapper) {
public val api: Output
get() = javaResource.api().applyValue({ args0 -> args0 })
/**
* (Computed) The etag of the IAM policy.
*/
public val etag: Output
get() = javaResource.etag().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 project will be parsed from the identifier of the parent resource. If no project is provided in the parent identifier and no project is specified, the provider project is used.
*/
public val project: Output
get() = javaResource.project().applyValue({ args0 -> args0 })
}
public object ApiIamPolicyMapper : ResourceMapper {
override fun supportsMappingOfType(javaResource: Resource): Boolean =
com.pulumi.gcp.apigateway.ApiIamPolicy::class == javaResource::class
override fun map(javaResource: Resource): ApiIamPolicy = ApiIamPolicy(
javaResource as
com.pulumi.gcp.apigateway.ApiIamPolicy,
)
}
/**
* @see [ApiIamPolicy].
* @param name The _unique_ name of the resulting resource.
* @param block Builder for [ApiIamPolicy].
*/
public suspend fun apiIamPolicy(
name: String,
block: suspend ApiIamPolicyResourceBuilder.() -> Unit,
): ApiIamPolicy {
val builder = ApiIamPolicyResourceBuilder()
builder.name(name)
block(builder)
return builder.build()
}
/**
* @see [ApiIamPolicy].
* @param name The _unique_ name of the resulting resource.
*/
public fun apiIamPolicy(name: String): ApiIamPolicy {
val builder = ApiIamPolicyResourceBuilder()
builder.name(name)
return builder.build()
}
