1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. runtimeconfig
  5. ConfigIamPolicy
Google Cloud Classic v7.18.0 published on Wednesday, Apr 10, 2024 by Pulumi

gcp.runtimeconfig.ConfigIamPolicy

Explore with Pulumi AI

gcp logo
Google Cloud Classic v7.18.0 published on Wednesday, Apr 10, 2024 by Pulumi

    Import

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

    • projects/{{project}}/configs/{{config}}

    • {{project}}/{{config}}

    • {{config}}

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

    Runtime Configurator config 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:runtimeconfig/configIamPolicy:ConfigIamPolicy editor "projects/{{project}}/configs/{{config}} roles/viewer user:jane@example.com"
    

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

    $ pulumi import gcp:runtimeconfig/configIamPolicy:ConfigIamPolicy editor "projects/{{project}}/configs/{{config}} roles/viewer"
    

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

    $ pulumi import gcp:runtimeconfig/configIamPolicy:ConfigIamPolicy editor projects/{{project}}/configs/{{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.

    Create ConfigIamPolicy Resource

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

    Constructor syntax

    new ConfigIamPolicy(name: string, args: ConfigIamPolicyArgs, opts?: CustomResourceOptions);
    @overload
    def ConfigIamPolicy(resource_name: str,
                        args: ConfigIamPolicyArgs,
                        opts: Optional[ResourceOptions] = None)
    
    @overload
    def ConfigIamPolicy(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        config: Optional[str] = None,
                        policy_data: Optional[str] = None,
                        project: Optional[str] = None)
    func NewConfigIamPolicy(ctx *Context, name string, args ConfigIamPolicyArgs, opts ...ResourceOption) (*ConfigIamPolicy, error)
    public ConfigIamPolicy(string name, ConfigIamPolicyArgs args, CustomResourceOptions? opts = null)
    public ConfigIamPolicy(String name, ConfigIamPolicyArgs args)
    public ConfigIamPolicy(String name, ConfigIamPolicyArgs args, CustomResourceOptions options)
    
    type: gcp:runtimeconfig:ConfigIamPolicy
    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 ConfigIamPolicyArgs
    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 ConfigIamPolicyArgs
    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 ConfigIamPolicyArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ConfigIamPolicyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ConfigIamPolicyArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

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

    var configIamPolicyResource = new Gcp.RuntimeConfig.ConfigIamPolicy("configIamPolicyResource", new()
    {
        Config = "string",
        PolicyData = "string",
        Project = "string",
    });
    
    example, err := runtimeconfig.NewConfigIamPolicy(ctx, "configIamPolicyResource", &runtimeconfig.ConfigIamPolicyArgs{
    	Config:     pulumi.String("string"),
    	PolicyData: pulumi.String("string"),
    	Project:    pulumi.String("string"),
    })
    
    var configIamPolicyResource = new ConfigIamPolicy("configIamPolicyResource", ConfigIamPolicyArgs.builder()        
        .config("string")
        .policyData("string")
        .project("string")
        .build());
    
    config_iam_policy_resource = gcp.runtimeconfig.ConfigIamPolicy("configIamPolicyResource",
        config="string",
        policy_data="string",
        project="string")
    
    const configIamPolicyResource = new gcp.runtimeconfig.ConfigIamPolicy("configIamPolicyResource", {
        config: "string",
        policyData: "string",
        project: "string",
    });
    
    type: gcp:runtimeconfig:ConfigIamPolicy
    properties:
        config: string
        policyData: string
        project: string
    

    ConfigIamPolicy Resource Properties

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

    Inputs

    The ConfigIamPolicy resource accepts the following input properties:

    Config string
    Used to find the parent resource to bind the IAM policy to
    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.

    • member/members - (Required) Identities that will be granted the privilege in role. Each entry can have one of the following values:
    • allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.
    • allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account.
    • user:{emailid}: An email address that represents a specific Google account. For example, alice@gmail.com or joe@example.com.
    • serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.
    • group:{emailid}: An email address that represents a Google group. For example, admins@example.com.
    • domain:{domain}: A G Suite domain (primary, instead of alias) name that represents all the users of that domain. For example, google.com or example.com.
    • projectOwner:projectid: Owners of the given project. For example, "projectOwner:my-example-project"
    • projectEditor:projectid: Editors of the given project. For example, "projectEditor:my-example-project"
    • projectViewer:projectid: Viewers of the given project. For example, "projectViewer:my-example-project"
    Config string
    Used to find the parent resource to bind the IAM policy to
    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.

    • member/members - (Required) Identities that will be granted the privilege in role. Each entry can have one of the following values:
    • allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.
    • allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account.
    • user:{emailid}: An email address that represents a specific Google account. For example, alice@gmail.com or joe@example.com.
    • serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.
    • group:{emailid}: An email address that represents a Google group. For example, admins@example.com.
    • domain:{domain}: A G Suite domain (primary, instead of alias) name that represents all the users of that domain. For example, google.com or example.com.
    • projectOwner:projectid: Owners of the given project. For example, "projectOwner:my-example-project"
    • projectEditor:projectid: Editors of the given project. For example, "projectEditor:my-example-project"
    • projectViewer:projectid: Viewers of the given project. For example, "projectViewer:my-example-project"
    config String
    Used to find the parent resource to bind the IAM policy to
    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.

    • member/members - (Required) Identities that will be granted the privilege in role. Each entry can have one of the following values:
    • allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.
    • allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account.
    • user:{emailid}: An email address that represents a specific Google account. For example, alice@gmail.com or joe@example.com.
    • serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.
    • group:{emailid}: An email address that represents a Google group. For example, admins@example.com.
    • domain:{domain}: A G Suite domain (primary, instead of alias) name that represents all the users of that domain. For example, google.com or example.com.
    • projectOwner:projectid: Owners of the given project. For example, "projectOwner:my-example-project"
    • projectEditor:projectid: Editors of the given project. For example, "projectEditor:my-example-project"
    • projectViewer:projectid: Viewers of the given project. For example, "projectViewer:my-example-project"
    config string
    Used to find the parent resource to bind the IAM policy to
    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.

    • member/members - (Required) Identities that will be granted the privilege in role. Each entry can have one of the following values:
    • allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.
    • allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account.
    • user:{emailid}: An email address that represents a specific Google account. For example, alice@gmail.com or joe@example.com.
    • serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.
    • group:{emailid}: An email address that represents a Google group. For example, admins@example.com.
    • domain:{domain}: A G Suite domain (primary, instead of alias) name that represents all the users of that domain. For example, google.com or example.com.
    • projectOwner:projectid: Owners of the given project. For example, "projectOwner:my-example-project"
    • projectEditor:projectid: Editors of the given project. For example, "projectEditor:my-example-project"
    • projectViewer:projectid: Viewers of the given project. For example, "projectViewer:my-example-project"
    config str
    Used to find the parent resource to bind the IAM policy to
    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.

    • member/members - (Required) Identities that will be granted the privilege in role. Each entry can have one of the following values:
    • allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.
    • allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account.
    • user:{emailid}: An email address that represents a specific Google account. For example, alice@gmail.com or joe@example.com.
    • serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.
    • group:{emailid}: An email address that represents a Google group. For example, admins@example.com.
    • domain:{domain}: A G Suite domain (primary, instead of alias) name that represents all the users of that domain. For example, google.com or example.com.
    • projectOwner:projectid: Owners of the given project. For example, "projectOwner:my-example-project"
    • projectEditor:projectid: Editors of the given project. For example, "projectEditor:my-example-project"
    • projectViewer:projectid: Viewers of the given project. For example, "projectViewer:my-example-project"
    config String
    Used to find the parent resource to bind the IAM policy to
    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.

    • member/members - (Required) Identities that will be granted the privilege in role. Each entry can have one of the following values:
    • allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.
    • allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account.
    • user:{emailid}: An email address that represents a specific Google account. For example, alice@gmail.com or joe@example.com.
    • serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.
    • group:{emailid}: An email address that represents a Google group. For example, admins@example.com.
    • domain:{domain}: A G Suite domain (primary, instead of alias) name that represents all the users of that domain. For example, google.com or example.com.
    • projectOwner:projectid: Owners of the given project. For example, "projectOwner:my-example-project"
    • projectEditor:projectid: Editors of the given project. For example, "projectEditor:my-example-project"
    • projectViewer:projectid: Viewers of the given project. For example, "projectViewer:my-example-project"

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ConfigIamPolicy 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 ConfigIamPolicy Resource

    Get an existing ConfigIamPolicy 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?: ConfigIamPolicyState, opts?: CustomResourceOptions): ConfigIamPolicy
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            config: Optional[str] = None,
            etag: Optional[str] = None,
            policy_data: Optional[str] = None,
            project: Optional[str] = None) -> ConfigIamPolicy
    func GetConfigIamPolicy(ctx *Context, name string, id IDInput, state *ConfigIamPolicyState, opts ...ResourceOption) (*ConfigIamPolicy, error)
    public static ConfigIamPolicy Get(string name, Input<string> id, ConfigIamPolicyState? state, CustomResourceOptions? opts = null)
    public static ConfigIamPolicy get(String name, Output<String> id, ConfigIamPolicyState 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:
    Config string
    Used to find the parent resource to bind the IAM policy to
    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.

    • member/members - (Required) Identities that will be granted the privilege in role. Each entry can have one of the following values:
    • allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.
    • allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account.
    • user:{emailid}: An email address that represents a specific Google account. For example, alice@gmail.com or joe@example.com.
    • serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.
    • group:{emailid}: An email address that represents a Google group. For example, admins@example.com.
    • domain:{domain}: A G Suite domain (primary, instead of alias) name that represents all the users of that domain. For example, google.com or example.com.
    • projectOwner:projectid: Owners of the given project. For example, "projectOwner:my-example-project"
    • projectEditor:projectid: Editors of the given project. For example, "projectEditor:my-example-project"
    • projectViewer:projectid: Viewers of the given project. For example, "projectViewer:my-example-project"
    Config string
    Used to find the parent resource to bind the IAM policy to
    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.

    • member/members - (Required) Identities that will be granted the privilege in role. Each entry can have one of the following values:
    • allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.
    • allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account.
    • user:{emailid}: An email address that represents a specific Google account. For example, alice@gmail.com or joe@example.com.
    • serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.
    • group:{emailid}: An email address that represents a Google group. For example, admins@example.com.
    • domain:{domain}: A G Suite domain (primary, instead of alias) name that represents all the users of that domain. For example, google.com or example.com.
    • projectOwner:projectid: Owners of the given project. For example, "projectOwner:my-example-project"
    • projectEditor:projectid: Editors of the given project. For example, "projectEditor:my-example-project"
    • projectViewer:projectid: Viewers of the given project. For example, "projectViewer:my-example-project"
    config String
    Used to find the parent resource to bind the IAM policy to
    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.

    • member/members - (Required) Identities that will be granted the privilege in role. Each entry can have one of the following values:
    • allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.
    • allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account.
    • user:{emailid}: An email address that represents a specific Google account. For example, alice@gmail.com or joe@example.com.
    • serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.
    • group:{emailid}: An email address that represents a Google group. For example, admins@example.com.
    • domain:{domain}: A G Suite domain (primary, instead of alias) name that represents all the users of that domain. For example, google.com or example.com.
    • projectOwner:projectid: Owners of the given project. For example, "projectOwner:my-example-project"
    • projectEditor:projectid: Editors of the given project. For example, "projectEditor:my-example-project"
    • projectViewer:projectid: Viewers of the given project. For example, "projectViewer:my-example-project"
    config string
    Used to find the parent resource to bind the IAM policy to
    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.

    • member/members - (Required) Identities that will be granted the privilege in role. Each entry can have one of the following values:
    • allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.
    • allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account.
    • user:{emailid}: An email address that represents a specific Google account. For example, alice@gmail.com or joe@example.com.
    • serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.
    • group:{emailid}: An email address that represents a Google group. For example, admins@example.com.
    • domain:{domain}: A G Suite domain (primary, instead of alias) name that represents all the users of that domain. For example, google.com or example.com.
    • projectOwner:projectid: Owners of the given project. For example, "projectOwner:my-example-project"
    • projectEditor:projectid: Editors of the given project. For example, "projectEditor:my-example-project"
    • projectViewer:projectid: Viewers of the given project. For example, "projectViewer:my-example-project"
    config str
    Used to find the parent resource to bind the IAM policy to
    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.

    • member/members - (Required) Identities that will be granted the privilege in role. Each entry can have one of the following values:
    • allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.
    • allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account.
    • user:{emailid}: An email address that represents a specific Google account. For example, alice@gmail.com or joe@example.com.
    • serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.
    • group:{emailid}: An email address that represents a Google group. For example, admins@example.com.
    • domain:{domain}: A G Suite domain (primary, instead of alias) name that represents all the users of that domain. For example, google.com or example.com.
    • projectOwner:projectid: Owners of the given project. For example, "projectOwner:my-example-project"
    • projectEditor:projectid: Editors of the given project. For example, "projectEditor:my-example-project"
    • projectViewer:projectid: Viewers of the given project. For example, "projectViewer:my-example-project"
    config String
    Used to find the parent resource to bind the IAM policy to
    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.

    • member/members - (Required) Identities that will be granted the privilege in role. Each entry can have one of the following values:
    • allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.
    • allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account.
    • user:{emailid}: An email address that represents a specific Google account. For example, alice@gmail.com or joe@example.com.
    • serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.
    • group:{emailid}: An email address that represents a Google group. For example, admins@example.com.
    • domain:{domain}: A G Suite domain (primary, instead of alias) name that represents all the users of that domain. For example, google.com or example.com.
    • projectOwner:projectid: Owners of the given project. For example, "projectOwner:my-example-project"
    • projectEditor:projectid: Editors of the given project. For example, "projectEditor:my-example-project"
    • projectViewer:projectid: Viewers of the given project. For example, "projectViewer:my-example-project"

    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 v7.18.0 published on Wednesday, Apr 10, 2024 by Pulumi