Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. apigateway
  5. ApiConfigIamPolicy
Google Cloud Classic v8.9.3 published on Monday, Nov 18, 2024 by Pulumi
pulumi/pulumi-gcp

gcp.apigateway.ApiConfigIamPolicy

Explore with Pulumi AI

gcp logo
Google Cloud Classic v8.9.3 published on Monday, Nov 18, 2024 by Pulumi
pulumi/pulumi-gcp

    Three different resources help you manage your IAM policy for API Gateway ApiConfig. Each of these resources serves a different use case:

    • gcp.apigateway.ApiConfigIamPolicy: Authoritative. Sets the IAM policy for the apiconfig and replaces any existing policy already attached.
    • gcp.apigateway.ApiConfigIamBinding: 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 apiconfig are preserved.
    • gcp.apigateway.ApiConfigIamMember: Non-authoritative. Updates the IAM policy to grant a role to a new member. Other members for the role for the apiconfig are preserved.

    A data source can be used to retrieve policy data in advent you do not need creation

    • gcp.apigateway.ApiConfigIamPolicy: Retrieves the IAM policy for the apiconfig

    Note: gcp.apigateway.ApiConfigIamPolicy cannot be used in conjunction with gcp.apigateway.ApiConfigIamBinding and gcp.apigateway.ApiConfigIamMember or they will fight over what your policy should be.

    Note: gcp.apigateway.ApiConfigIamBinding resources can be used in conjunction with gcp.apigateway.ApiConfigIamMember resources only if they do not grant privilege to the same role.

    google_api_gateway_api_config_iam_policy

    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.ApiConfigIamPolicy("policy", {
    api: apiCfg.api,
    apiConfig: apiCfg.apiConfigId,
    policyData: admin.then(admin => admin.policyData),
});

    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.ApiConfigIamPolicy("policy",
    api=api_cfg["api"],
    api_config=api_cfg["apiConfigId"],
    policy_data=admin.policy_data)

    package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/apigateway"
	"github.com/pulumi/pulumi-gcp/sdk/v8/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:jane@example.com",
					},
				},
			},
		}, nil)
		if err != nil {
			return err
		}
		_, err = apigateway.NewApiConfigIamPolicy(ctx, "policy", &apigateway.ApiConfigIamPolicyArgs{
			Api:        pulumi.Any(apiCfg.Api),
			ApiConfig:  pulumi.Any(apiCfg.ApiConfigId),
			PolicyData: pulumi.String(admin.PolicyData),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    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:jane@example.com",
                },
            },
        },
    });

    var policy = new Gcp.ApiGateway.ApiConfigIamPolicy("policy", new()
    {
        Api = apiCfg.Api,
        ApiConfig = apiCfg.ApiConfigId,
        PolicyData = admin.Apply(getIAMPolicyResult => getIAMPolicyResult.PolicyData),
    });

});

    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.ApiConfigIamPolicy;
import com.pulumi.gcp.apigateway.ApiConfigIamPolicyArgs;
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:jane@example.com")
                .build())
            .build());

        var policy = new ApiConfigIamPolicy("policy", ApiConfigIamPolicyArgs.builder()
            .api(apiCfg.api())
            .apiConfig(apiCfg.apiConfigId())
            .policyData(admin.applyValue(getIAMPolicyResult -> getIAMPolicyResult.policyData()))
            .build());

    }
}

    resources:
  policy:
    type: gcp:apigateway:ApiConfigIamPolicy
    properties:
      api: ${apiCfg.api}
      apiConfig: ${apiCfg.apiConfigId}
      policyData: ${admin.policyData}
variables:
  admin:
    fn::invoke:
      Function: gcp:organizations:getIAMPolicy
      Arguments:
        bindings:
          - role: roles/apigateway.viewer
            members:
              - user:jane@example.com

    gcp.apigateway.ApiConfigIamBinding

    import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const binding = new gcp.apigateway.ApiConfigIamBinding("binding", {
    api: apiCfg.api,
    apiConfig: apiCfg.apiConfigId,
    role: "roles/apigateway.viewer",
    members: ["user:jane@example.com"],
});

    import pulumi
import pulumi_gcp as gcp

binding = gcp.apigateway.ApiConfigIamBinding("binding",
    api=api_cfg["api"],
    api_config=api_cfg["apiConfigId"],
    role="roles/apigateway.viewer",
    members=["user:jane@example.com"])

    package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/apigateway"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := apigateway.NewApiConfigIamBinding(ctx, "binding", &apigateway.ApiConfigIamBindingArgs{
			Api:       pulumi.Any(apiCfg.Api),
			ApiConfig: pulumi.Any(apiCfg.ApiConfigId),
			Role:      pulumi.String("roles/apigateway.viewer"),
			Members: pulumi.StringArray{
				pulumi.String("user:jane@example.com"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() => 
{
    var binding = new Gcp.ApiGateway.ApiConfigIamBinding("binding", new()
    {
        Api = apiCfg.Api,
        ApiConfig = apiCfg.ApiConfigId,
        Role = "roles/apigateway.viewer",
        Members = new[]
        {
            "user:jane@example.com",
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.apigateway.ApiConfigIamBinding;
import com.pulumi.gcp.apigateway.ApiConfigIamBindingArgs;
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 ApiConfigIamBinding("binding", ApiConfigIamBindingArgs.builder()
            .api(apiCfg.api())
            .apiConfig(apiCfg.apiConfigId())
            .role("roles/apigateway.viewer")
            .members("user:jane@example.com")
            .build());

    }
}

    resources:
  binding:
    type: gcp:apigateway:ApiConfigIamBinding
    properties:
      api: ${apiCfg.api}
      apiConfig: ${apiCfg.apiConfigId}
      role: roles/apigateway.viewer
      members:
        - user:jane@example.com

    gcp.apigateway.ApiConfigIamMember

    import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const member = new gcp.apigateway.ApiConfigIamMember("member", {
    api: apiCfg.api,
    apiConfig: apiCfg.apiConfigId,
    role: "roles/apigateway.viewer",
    member: "user:jane@example.com",
});

    import pulumi
import pulumi_gcp as gcp

member = gcp.apigateway.ApiConfigIamMember("member",
    api=api_cfg["api"],
    api_config=api_cfg["apiConfigId"],
    role="roles/apigateway.viewer",
    member="user:jane@example.com")

    package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/apigateway"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := apigateway.NewApiConfigIamMember(ctx, "member", &apigateway.ApiConfigIamMemberArgs{
			Api:       pulumi.Any(apiCfg.Api),
			ApiConfig: pulumi.Any(apiCfg.ApiConfigId),
			Role:      pulumi.String("roles/apigateway.viewer"),
			Member:    pulumi.String("user:jane@example.com"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() => 
{
    var member = new Gcp.ApiGateway.ApiConfigIamMember("member", new()
    {
        Api = apiCfg.Api,
        ApiConfig = apiCfg.ApiConfigId,
        Role = "roles/apigateway.viewer",
        Member = "user:jane@example.com",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.apigateway.ApiConfigIamMember;
import com.pulumi.gcp.apigateway.ApiConfigIamMemberArgs;
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 ApiConfigIamMember("member", ApiConfigIamMemberArgs.builder()
            .api(apiCfg.api())
            .apiConfig(apiCfg.apiConfigId())
            .role("roles/apigateway.viewer")
            .member("user:jane@example.com")
            .build());

    }
}

    resources:
  member:
    type: gcp:apigateway:ApiConfigIamMember
    properties:
      api: ${apiCfg.api}
      apiConfig: ${apiCfg.apiConfigId}
      role: roles/apigateway.viewer
      member: user:jane@example.com

    This resource supports User Project Overrides.

    IAM policy for API Gateway ApiConfig

    Three different resources help you manage your IAM policy for API Gateway ApiConfig. Each of these resources serves a different use case:

    • gcp.apigateway.ApiConfigIamPolicy: Authoritative. Sets the IAM policy for the apiconfig and replaces any existing policy already attached.
    • gcp.apigateway.ApiConfigIamBinding: 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 apiconfig are preserved.
    • gcp.apigateway.ApiConfigIamMember: Non-authoritative. Updates the IAM policy to grant a role to a new member. Other members for the role for the apiconfig are preserved.

    A data source can be used to retrieve policy data in advent you do not need creation

    • gcp.apigateway.ApiConfigIamPolicy: Retrieves the IAM policy for the apiconfig

    Note: gcp.apigateway.ApiConfigIamPolicy cannot be used in conjunction with gcp.apigateway.ApiConfigIamBinding and gcp.apigateway.ApiConfigIamMember or they will fight over what your policy should be.

    Note: gcp.apigateway.ApiConfigIamBinding resources can be used in conjunction with gcp.apigateway.ApiConfigIamMember resources only if they do not grant privilege to the same role.

    google_api_gateway_api_config_iam_policy

    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.ApiConfigIamPolicy("policy", {
    api: apiCfg.api,
    apiConfig: apiCfg.apiConfigId,
    policyData: admin.then(admin => admin.policyData),
});

    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.ApiConfigIamPolicy("policy",
    api=api_cfg["api"],
    api_config=api_cfg["apiConfigId"],
    policy_data=admin.policy_data)

    package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/apigateway"
	"github.com/pulumi/pulumi-gcp/sdk/v8/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:jane@example.com",
					},
				},
			},
		}, nil)
		if err != nil {
			return err
		}
		_, err = apigateway.NewApiConfigIamPolicy(ctx, "policy", &apigateway.ApiConfigIamPolicyArgs{
			Api:        pulumi.Any(apiCfg.Api),
			ApiConfig:  pulumi.Any(apiCfg.ApiConfigId),
			PolicyData: pulumi.String(admin.PolicyData),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    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:jane@example.com",
                },
            },
        },
    });

    var policy = new Gcp.ApiGateway.ApiConfigIamPolicy("policy", new()
    {
        Api = apiCfg.Api,
        ApiConfig = apiCfg.ApiConfigId,
        PolicyData = admin.Apply(getIAMPolicyResult => getIAMPolicyResult.PolicyData),
    });

});

    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.ApiConfigIamPolicy;
import com.pulumi.gcp.apigateway.ApiConfigIamPolicyArgs;
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:jane@example.com")
                .build())
            .build());

        var policy = new ApiConfigIamPolicy("policy", ApiConfigIamPolicyArgs.builder()
            .api(apiCfg.api())
            .apiConfig(apiCfg.apiConfigId())
            .policyData(admin.applyValue(getIAMPolicyResult -> getIAMPolicyResult.policyData()))
            .build());

    }
}

    resources:
  policy:
    type: gcp:apigateway:ApiConfigIamPolicy
    properties:
      api: ${apiCfg.api}
      apiConfig: ${apiCfg.apiConfigId}
      policyData: ${admin.policyData}
variables:
  admin:
    fn::invoke:
      Function: gcp:organizations:getIAMPolicy
      Arguments:
        bindings:
          - role: roles/apigateway.viewer
            members:
              - user:jane@example.com

    gcp.apigateway.ApiConfigIamBinding

    import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const binding = new gcp.apigateway.ApiConfigIamBinding("binding", {
    api: apiCfg.api,
    apiConfig: apiCfg.apiConfigId,
    role: "roles/apigateway.viewer",
    members: ["user:jane@example.com"],
});

    import pulumi
import pulumi_gcp as gcp

binding = gcp.apigateway.ApiConfigIamBinding("binding",
    api=api_cfg["api"],
    api_config=api_cfg["apiConfigId"],
    role="roles/apigateway.viewer",
    members=["user:jane@example.com"])

    package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/apigateway"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := apigateway.NewApiConfigIamBinding(ctx, "binding", &apigateway.ApiConfigIamBindingArgs{
			Api:       pulumi.Any(apiCfg.Api),
			ApiConfig: pulumi.Any(apiCfg.ApiConfigId),
			Role:      pulumi.String("roles/apigateway.viewer"),
			Members: pulumi.StringArray{
				pulumi.String("user:jane@example.com"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() => 
{
    var binding = new Gcp.ApiGateway.ApiConfigIamBinding("binding", new()
    {
        Api = apiCfg.Api,
        ApiConfig = apiCfg.ApiConfigId,
        Role = "roles/apigateway.viewer",
        Members = new[]
        {
            "user:jane@example.com",
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.apigateway.ApiConfigIamBinding;
import com.pulumi.gcp.apigateway.ApiConfigIamBindingArgs;
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 ApiConfigIamBinding("binding", ApiConfigIamBindingArgs.builder()
            .api(apiCfg.api())
            .apiConfig(apiCfg.apiConfigId())
            .role("roles/apigateway.viewer")
            .members("user:jane@example.com")
            .build());

    }
}

    resources:
  binding:
    type: gcp:apigateway:ApiConfigIamBinding
    properties:
      api: ${apiCfg.api}
      apiConfig: ${apiCfg.apiConfigId}
      role: roles/apigateway.viewer
      members:
        - user:jane@example.com

    gcp.apigateway.ApiConfigIamMember

    import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const member = new gcp.apigateway.ApiConfigIamMember("member", {
    api: apiCfg.api,
    apiConfig: apiCfg.apiConfigId,
    role: "roles/apigateway.viewer",
    member: "user:jane@example.com",
});

    import pulumi
import pulumi_gcp as gcp

member = gcp.apigateway.ApiConfigIamMember("member",
    api=api_cfg["api"],
    api_config=api_cfg["apiConfigId"],
    role="roles/apigateway.viewer",
    member="user:jane@example.com")

    package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/apigateway"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := apigateway.NewApiConfigIamMember(ctx, "member", &apigateway.ApiConfigIamMemberArgs{
			Api:       pulumi.Any(apiCfg.Api),
			ApiConfig: pulumi.Any(apiCfg.ApiConfigId),
			Role:      pulumi.String("roles/apigateway.viewer"),
			Member:    pulumi.String("user:jane@example.com"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() => 
{
    var member = new Gcp.ApiGateway.ApiConfigIamMember("member", new()
    {
        Api = apiCfg.Api,
        ApiConfig = apiCfg.ApiConfigId,
        Role = "roles/apigateway.viewer",
        Member = "user:jane@example.com",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.apigateway.ApiConfigIamMember;
import com.pulumi.gcp.apigateway.ApiConfigIamMemberArgs;
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 ApiConfigIamMember("member", ApiConfigIamMemberArgs.builder()
            .api(apiCfg.api())
            .apiConfig(apiCfg.apiConfigId())
            .role("roles/apigateway.viewer")
            .member("user:jane@example.com")
            .build());

    }
}

    resources:
  member:
    type: gcp:apigateway:ApiConfigIamMember
    properties:
      api: ${apiCfg.api}
      apiConfig: ${apiCfg.apiConfigId}
      role: roles/apigateway.viewer
      member: user:jane@example.com

    Create ApiConfigIamPolicy Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new ApiConfigIamPolicy(name: string, args: ApiConfigIamPolicyArgs, opts?: CustomResourceOptions);
    @overload
def ApiConfigIamPolicy(resource_name: str,
                       args: ApiConfigIamPolicyArgs,
                       opts: Optional[ResourceOptions] = None)

@overload
def ApiConfigIamPolicy(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       api: Optional[str] = None,
                       api_config: Optional[str] = None,
                       policy_data: Optional[str] = None,
                       project: Optional[str] = None)
    func NewApiConfigIamPolicy(ctx *Context, name string, args ApiConfigIamPolicyArgs, opts ...ResourceOption) (*ApiConfigIamPolicy, error)
    public ApiConfigIamPolicy(string name, ApiConfigIamPolicyArgs args, CustomResourceOptions? opts = null)
    public ApiConfigIamPolicy(String name, ApiConfigIamPolicyArgs args)
public ApiConfigIamPolicy(String name, ApiConfigIamPolicyArgs args, CustomResourceOptions options)

    type: gcp:apigateway:ApiConfigIamPolicy
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args ApiConfigIamPolicyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ApiConfigIamPolicyArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ApiConfigIamPolicyArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ApiConfigIamPolicyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ApiConfigIamPolicyArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var apiConfigIamPolicyResource = new Gcp.ApiGateway.ApiConfigIamPolicy("apiConfigIamPolicyResource", new()
{
    Api = "string",
    ApiConfig = "string",
    PolicyData = "string",
    Project = "string",
});

    example, err := apigateway.NewApiConfigIamPolicy(ctx, "apiConfigIamPolicyResource", &apigateway.ApiConfigIamPolicyArgs{
	Api:        pulumi.String("string"),
	ApiConfig:  pulumi.String("string"),
	PolicyData: pulumi.String("string"),
	Project:    pulumi.String("string"),
})

    var apiConfigIamPolicyResource = new ApiConfigIamPolicy("apiConfigIamPolicyResource", ApiConfigIamPolicyArgs.builder()
    .api("string")
    .apiConfig("string")
    .policyData("string")
    .project("string")
    .build());

    api_config_iam_policy_resource = gcp.apigateway.ApiConfigIamPolicy("apiConfigIamPolicyResource",
    api="string",
    api_config="string",
    policy_data="string",
    project="string")

    const apiConfigIamPolicyResource = new gcp.apigateway.ApiConfigIamPolicy("apiConfigIamPolicyResource", {
    api: "string",
    apiConfig: "string",
    policyData: "string",
    project: "string",
});

    type: gcp:apigateway:ApiConfigIamPolicy
properties:
    api: string
    apiConfig: string
    policyData: string
    project: string

    ApiConfigIamPolicy Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The ApiConfigIamPolicy resource accepts the following input properties:

    Api string
    The API to attach the config to. Used to find the parent resource to bind the IAM policy to
    ApiConfig string
    PolicyData string
    The policy data generated by a gcp.organizations.getIAMPolicy data source.
    Project string
    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.
    Api string
    The API to attach the config to. Used to find the parent resource to bind the IAM policy to
    ApiConfig string
    PolicyData string
    The policy data generated by a gcp.organizations.getIAMPolicy data source.
    Project string
    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.
    api String
    The API to attach the config to. Used to find the parent resource to bind the IAM policy to
    apiConfig String
    policyData String
    The policy data generated by a gcp.organizations.getIAMPolicy data source.
    project String
    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.
    api string
    The API to attach the config to. Used to find the parent resource to bind the IAM policy to
    apiConfig string
    policyData string
    The policy data generated by a gcp.organizations.getIAMPolicy data source.
    project string
    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.
    api str
    The API to attach the config to. Used to find the parent resource to bind the IAM policy to
    api_config str
    policy_data str
    The policy data generated by a gcp.organizations.getIAMPolicy data source.
    project str
    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.
    api String
    The API to attach the config to. Used to find the parent resource to bind the IAM policy to
    apiConfig String
    policyData String
    The policy data generated by a gcp.organizations.getIAMPolicy data source.
    project String
    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.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ApiConfigIamPolicy resource produces the following output properties:

    Etag string
    (Computed) The etag of the IAM policy.
    Id string
    The provider-assigned unique ID for this managed resource.
    Etag string
    (Computed) The etag of the IAM policy.
    Id string
    The provider-assigned unique ID for this managed resource.
    etag String
    (Computed) The etag of the IAM policy.
    id String
    The provider-assigned unique ID for this managed resource.
    etag string
    (Computed) The etag of the IAM policy.
    id string
    The provider-assigned unique ID for this managed resource.
    etag str
    (Computed) The etag of the IAM policy.
    id str
    The provider-assigned unique ID for this managed resource.
    etag String
    (Computed) The etag of the IAM policy.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing ApiConfigIamPolicy Resource

    Get an existing ApiConfigIamPolicy resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: ApiConfigIamPolicyState, opts?: CustomResourceOptions): ApiConfigIamPolicy
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        api: Optional[str] = None,
        api_config: Optional[str] = None,
        etag: Optional[str] = None,
        policy_data: Optional[str] = None,
        project: Optional[str] = None) -> ApiConfigIamPolicy
    func GetApiConfigIamPolicy(ctx *Context, name string, id IDInput, state *ApiConfigIamPolicyState, opts ...ResourceOption) (*ApiConfigIamPolicy, error)
    public static ApiConfigIamPolicy Get(string name, Input<string> id, ApiConfigIamPolicyState? state, CustomResourceOptions? opts = null)
    public static ApiConfigIamPolicy get(String name, Output<String> id, ApiConfigIamPolicyState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Api string
    The API to attach the config to. Used to find the parent resource to bind the IAM policy to
    ApiConfig string
    Etag string
    (Computed) The etag of the IAM policy.
    PolicyData string
    The policy data generated by a gcp.organizations.getIAMPolicy data source.
    Project string
    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.
    Api string
    The API to attach the config to. Used to find the parent resource to bind the IAM policy to
    ApiConfig string
    Etag string
    (Computed) The etag of the IAM policy.
    PolicyData string
    The policy data generated by a gcp.organizations.getIAMPolicy data source.
    Project string
    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.
    api String
    The API to attach the config to. Used to find the parent resource to bind the IAM policy to
    apiConfig String
    etag String
    (Computed) The etag of the IAM policy.
    policyData String
    The policy data generated by a gcp.organizations.getIAMPolicy data source.
    project String
    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.
    api string
    The API to attach the config to. Used to find the parent resource to bind the IAM policy to
    apiConfig string
    etag string
    (Computed) The etag of the IAM policy.
    policyData string
    The policy data generated by a gcp.organizations.getIAMPolicy data source.
    project string
    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.
    api str
    The API to attach the config to. Used to find the parent resource to bind the IAM policy to
    api_config str
    etag str
    (Computed) The etag of the IAM policy.
    policy_data str
    The policy data generated by a gcp.organizations.getIAMPolicy data source.
    project str
    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.
    api String
    The API to attach the config to. Used to find the parent resource to bind the IAM policy to
    apiConfig String
    etag String
    (Computed) The etag of the IAM policy.
    policyData String
    The policy data generated by a gcp.organizations.getIAMPolicy data source.
    project String
    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.

    Import

    For all import syntaxes, the “resource in question” can take any of the following forms:

    • projects/{{project}}/locations/global/apis/{{api}}/configs/{{api_config}}

    • {{project}}/{{api}}/{{api_config}}

    • {{api}}/{{api_config}}

    • {{api_config}}

    Any variables not passed in the import command will be taken from the provider configuration.

    API Gateway apiconfig 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.

    $ pulumi import gcp:apigateway/apiConfigIamPolicy:ApiConfigIamPolicy editor "projects/{{project}}/locations/global/apis/{{api}}/configs/{{api_config}} roles/apigateway.viewer user:jane@example.com"

    IAM binding imports use space-delimited identifiers: the resource in question and the role, e.g.

    $ pulumi import gcp:apigateway/apiConfigIamPolicy:ApiConfigIamPolicy editor "projects/{{project}}/locations/global/apis/{{api}}/configs/{{api_config}} roles/apigateway.viewer"

    IAM policy imports use the identifier of the resource in question, e.g.

    $ pulumi import gcp:apigateway/apiConfigIamPolicy:ApiConfigIamPolicy editor projects/{{project}}/locations/global/apis/{{api}}/configs/{{api_config}}

    -> 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.

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Google Cloud (GCP) Classic pulumi/pulumi-gcp
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the google-beta Terraform Provider.
    gcp logo
    Google Cloud Classic v8.9.3 published on Monday, Nov 18, 2024 by Pulumi
    pulumi/pulumi-gcp