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

gcp.iam.PrincipalAccessBoundaryPolicy

Explore with Pulumi AI

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

    Example Usage

    Iam Principal Access Boundary Policy

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

const my_pab_policy = new gcp.iam.PrincipalAccessBoundaryPolicy("my-pab-policy", {
    organization: "123456789",
    location: "global",
    displayName: "test pab policy",
    principalAccessBoundaryPolicyId: "test-pab-policy",
});

    import pulumi
import pulumi_gcp as gcp

my_pab_policy = gcp.iam.PrincipalAccessBoundaryPolicy("my-pab-policy",
    organization="123456789",
    location="global",
    display_name="test pab policy",
    principal_access_boundary_policy_id="test-pab-policy")

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := iam.NewPrincipalAccessBoundaryPolicy(ctx, "my-pab-policy", &iam.PrincipalAccessBoundaryPolicyArgs{
			Organization:                    pulumi.String("123456789"),
			Location:                        pulumi.String("global"),
			DisplayName:                     pulumi.String("test pab policy"),
			PrincipalAccessBoundaryPolicyId: pulumi.String("test-pab-policy"),
		})
		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 my_pab_policy = new Gcp.Iam.PrincipalAccessBoundaryPolicy("my-pab-policy", new()
    {
        Organization = "123456789",
        Location = "global",
        DisplayName = "test pab policy",
        PrincipalAccessBoundaryPolicyId = "test-pab-policy",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.iam.PrincipalAccessBoundaryPolicy;
import com.pulumi.gcp.iam.PrincipalAccessBoundaryPolicyArgs;
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 my_pab_policy = new PrincipalAccessBoundaryPolicy("my-pab-policy", PrincipalAccessBoundaryPolicyArgs.builder()
            .organization("123456789")
            .location("global")
            .displayName("test pab policy")
            .principalAccessBoundaryPolicyId("test-pab-policy")
            .build());

    }
}

    resources:
  my-pab-policy:
    type: gcp:iam:PrincipalAccessBoundaryPolicy
    properties:
      organization: '123456789'
      location: global
      displayName: test pab policy
      principalAccessBoundaryPolicyId: test-pab-policy

    Create PrincipalAccessBoundaryPolicy Resource

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

    Constructor syntax

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

@overload
def PrincipalAccessBoundaryPolicy(resource_name: str,
                                  opts: Optional[ResourceOptions] = None,
                                  location: Optional[str] = None,
                                  organization: Optional[str] = None,
                                  principal_access_boundary_policy_id: Optional[str] = None,
                                  annotations: Optional[Mapping[str, str]] = None,
                                  details: Optional[PrincipalAccessBoundaryPolicyDetailsArgs] = None,
                                  display_name: Optional[str] = None)
    func NewPrincipalAccessBoundaryPolicy(ctx *Context, name string, args PrincipalAccessBoundaryPolicyArgs, opts ...ResourceOption) (*PrincipalAccessBoundaryPolicy, error)
    public PrincipalAccessBoundaryPolicy(string name, PrincipalAccessBoundaryPolicyArgs args, CustomResourceOptions? opts = null)
    public PrincipalAccessBoundaryPolicy(String name, PrincipalAccessBoundaryPolicyArgs args)
public PrincipalAccessBoundaryPolicy(String name, PrincipalAccessBoundaryPolicyArgs args, CustomResourceOptions options)

    type: gcp:iam:PrincipalAccessBoundaryPolicy
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 PrincipalAccessBoundaryPolicyArgs
    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 PrincipalAccessBoundaryPolicyArgs
    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 PrincipalAccessBoundaryPolicyArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PrincipalAccessBoundaryPolicyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PrincipalAccessBoundaryPolicyArgs
    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 principalAccessBoundaryPolicyResource = new Gcp.Iam.PrincipalAccessBoundaryPolicy("principalAccessBoundaryPolicyResource", new()
{
    Location = "string",
    Organization = "string",
    PrincipalAccessBoundaryPolicyId = "string",
    Annotations = 
    {
        { "string", "string" },
    },
    Details = new Gcp.Iam.Inputs.PrincipalAccessBoundaryPolicyDetailsArgs
    {
        Rules = new[]
        {
            new Gcp.Iam.Inputs.PrincipalAccessBoundaryPolicyDetailsRuleArgs
            {
                Effect = "string",
                Resources = new[]
                {
                    "string",
                },
                Description = "string",
            },
        },
        EnforcementVersion = "string",
    },
    DisplayName = "string",
});

    example, err := iam.NewPrincipalAccessBoundaryPolicy(ctx, "principalAccessBoundaryPolicyResource", &iam.PrincipalAccessBoundaryPolicyArgs{
	Location:                        pulumi.String("string"),
	Organization:                    pulumi.String("string"),
	PrincipalAccessBoundaryPolicyId: pulumi.String("string"),
	Annotations: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Details: &iam.PrincipalAccessBoundaryPolicyDetailsArgs{
		Rules: iam.PrincipalAccessBoundaryPolicyDetailsRuleArray{
			&iam.PrincipalAccessBoundaryPolicyDetailsRuleArgs{
				Effect: pulumi.String("string"),
				Resources: pulumi.StringArray{
					pulumi.String("string"),
				},
				Description: pulumi.String("string"),
			},
		},
		EnforcementVersion: pulumi.String("string"),
	},
	DisplayName: pulumi.String("string"),
})

    var principalAccessBoundaryPolicyResource = new PrincipalAccessBoundaryPolicy("principalAccessBoundaryPolicyResource", PrincipalAccessBoundaryPolicyArgs.builder()
    .location("string")
    .organization("string")
    .principalAccessBoundaryPolicyId("string")
    .annotations(Map.of("string", "string"))
    .details(PrincipalAccessBoundaryPolicyDetailsArgs.builder()
        .rules(PrincipalAccessBoundaryPolicyDetailsRuleArgs.builder()
            .effect("string")
            .resources("string")
            .description("string")
            .build())
        .enforcementVersion("string")
        .build())
    .displayName("string")
    .build());

    principal_access_boundary_policy_resource = gcp.iam.PrincipalAccessBoundaryPolicy("principalAccessBoundaryPolicyResource",
    location="string",
    organization="string",
    principal_access_boundary_policy_id="string",
    annotations={
        "string": "string",
    },
    details={
        "rules": [{
            "effect": "string",
            "resources": ["string"],
            "description": "string",
        }],
        "enforcement_version": "string",
    },
    display_name="string")

    const principalAccessBoundaryPolicyResource = new gcp.iam.PrincipalAccessBoundaryPolicy("principalAccessBoundaryPolicyResource", {
    location: "string",
    organization: "string",
    principalAccessBoundaryPolicyId: "string",
    annotations: {
        string: "string",
    },
    details: {
        rules: [{
            effect: "string",
            resources: ["string"],
            description: "string",
        }],
        enforcementVersion: "string",
    },
    displayName: "string",
});

    type: gcp:iam:PrincipalAccessBoundaryPolicy
properties:
    annotations:
        string: string
    details:
        enforcementVersion: string
        rules:
            - description: string
              effect: string
              resources:
                - string
    displayName: string
    location: string
    organization: string
    principalAccessBoundaryPolicyId: string

    PrincipalAccessBoundaryPolicy 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 PrincipalAccessBoundaryPolicy resource accepts the following input properties:

    Location string
    The location the principal access boundary policy is in.
    Organization string
    The parent organization of the principal access boundary policy.
    PrincipalAccessBoundaryPolicyId string
    The ID to use to create the principal access boundary policy. This value must start with a lowercase letter followed by up to 62 lowercase letters, numbers, hyphens, or dots. Pattern, /a-z{2,62}/.

    Annotations Dictionary<string, string>

    User defined annotations. See https://google.aip.dev/148#annotations for more details such as format and size limitations

    Note: This field is non-authoritative, and will only manage the annotations present in your configuration. Please refer to the field effective_annotations for all of the annotations present on the resource.

    Details PrincipalAccessBoundaryPolicyDetails
    Principal access boundary policy details Structure is documented below.
    DisplayName string
    The description of the principal access boundary policy. Must be less than or equal to 63 characters.
    Location string
    The location the principal access boundary policy is in.
    Organization string
    The parent organization of the principal access boundary policy.
    PrincipalAccessBoundaryPolicyId string
    The ID to use to create the principal access boundary policy. This value must start with a lowercase letter followed by up to 62 lowercase letters, numbers, hyphens, or dots. Pattern, /a-z{2,62}/.

    Annotations map[string]string

    User defined annotations. See https://google.aip.dev/148#annotations for more details such as format and size limitations

    Note: This field is non-authoritative, and will only manage the annotations present in your configuration. Please refer to the field effective_annotations for all of the annotations present on the resource.

    Details PrincipalAccessBoundaryPolicyDetailsArgs
    Principal access boundary policy details Structure is documented below.
    DisplayName string
    The description of the principal access boundary policy. Must be less than or equal to 63 characters.
    location String
    The location the principal access boundary policy is in.
    organization String
    The parent organization of the principal access boundary policy.
    principalAccessBoundaryPolicyId String
    The ID to use to create the principal access boundary policy. This value must start with a lowercase letter followed by up to 62 lowercase letters, numbers, hyphens, or dots. Pattern, /a-z{2,62}/.

    annotations Map<String,String>

    User defined annotations. See https://google.aip.dev/148#annotations for more details such as format and size limitations

    Note: This field is non-authoritative, and will only manage the annotations present in your configuration. Please refer to the field effective_annotations for all of the annotations present on the resource.

    details PrincipalAccessBoundaryPolicyDetails
    Principal access boundary policy details Structure is documented below.
    displayName String
    The description of the principal access boundary policy. Must be less than or equal to 63 characters.
    location string
    The location the principal access boundary policy is in.
    organization string
    The parent organization of the principal access boundary policy.
    principalAccessBoundaryPolicyId string
    The ID to use to create the principal access boundary policy. This value must start with a lowercase letter followed by up to 62 lowercase letters, numbers, hyphens, or dots. Pattern, /a-z{2,62}/.

    annotations {[key: string]: string}

    User defined annotations. See https://google.aip.dev/148#annotations for more details such as format and size limitations

    Note: This field is non-authoritative, and will only manage the annotations present in your configuration. Please refer to the field effective_annotations for all of the annotations present on the resource.

    details PrincipalAccessBoundaryPolicyDetails
    Principal access boundary policy details Structure is documented below.
    displayName string
    The description of the principal access boundary policy. Must be less than or equal to 63 characters.
    location str
    The location the principal access boundary policy is in.
    organization str
    The parent organization of the principal access boundary policy.
    principal_access_boundary_policy_id str
    The ID to use to create the principal access boundary policy. This value must start with a lowercase letter followed by up to 62 lowercase letters, numbers, hyphens, or dots. Pattern, /a-z{2,62}/.

    annotations Mapping[str, str]

    User defined annotations. See https://google.aip.dev/148#annotations for more details such as format and size limitations

    Note: This field is non-authoritative, and will only manage the annotations present in your configuration. Please refer to the field effective_annotations for all of the annotations present on the resource.

    details PrincipalAccessBoundaryPolicyDetailsArgs
    Principal access boundary policy details Structure is documented below.
    display_name str
    The description of the principal access boundary policy. Must be less than or equal to 63 characters.
    location String
    The location the principal access boundary policy is in.
    organization String
    The parent organization of the principal access boundary policy.
    principalAccessBoundaryPolicyId String
    The ID to use to create the principal access boundary policy. This value must start with a lowercase letter followed by up to 62 lowercase letters, numbers, hyphens, or dots. Pattern, /a-z{2,62}/.

    annotations Map<String>

    User defined annotations. See https://google.aip.dev/148#annotations for more details such as format and size limitations

    Note: This field is non-authoritative, and will only manage the annotations present in your configuration. Please refer to the field effective_annotations for all of the annotations present on the resource.

    details Property Map
    Principal access boundary policy details Structure is documented below.
    displayName String
    The description of the principal access boundary policy. Must be less than or equal to 63 characters.

    Outputs

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

    CreateTime string
    Output only. The time when the principal access boundary policy was created.
    EffectiveAnnotations Dictionary<string, string>
    Etag string
    The etag for the principal access boundary. If this is provided on update, it must match the server's etag.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    Identifier. The resource name of the principal access boundary policy. The following format is supported: organizations/{organization_id}/locations/{location}/principalAccessBoundaryPolicies/{policy_id}
    Uid string
    Output only. The globally unique ID of the principal access boundary policy.
    UpdateTime string
    Output only. The time when the principal access boundary policy was most recently updated.
    CreateTime string
    Output only. The time when the principal access boundary policy was created.
    EffectiveAnnotations map[string]string
    Etag string
    The etag for the principal access boundary. If this is provided on update, it must match the server's etag.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    Identifier. The resource name of the principal access boundary policy. The following format is supported: organizations/{organization_id}/locations/{location}/principalAccessBoundaryPolicies/{policy_id}
    Uid string
    Output only. The globally unique ID of the principal access boundary policy.
    UpdateTime string
    Output only. The time when the principal access boundary policy was most recently updated.
    createTime String
    Output only. The time when the principal access boundary policy was created.
    effectiveAnnotations Map<String,String>
    etag String
    The etag for the principal access boundary. If this is provided on update, it must match the server's etag.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    Identifier. The resource name of the principal access boundary policy. The following format is supported: organizations/{organization_id}/locations/{location}/principalAccessBoundaryPolicies/{policy_id}
    uid String
    Output only. The globally unique ID of the principal access boundary policy.
    updateTime String
    Output only. The time when the principal access boundary policy was most recently updated.
    createTime string
    Output only. The time when the principal access boundary policy was created.
    effectiveAnnotations {[key: string]: string}
    etag string
    The etag for the principal access boundary. If this is provided on update, it must match the server's etag.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    Identifier. The resource name of the principal access boundary policy. The following format is supported: organizations/{organization_id}/locations/{location}/principalAccessBoundaryPolicies/{policy_id}
    uid string
    Output only. The globally unique ID of the principal access boundary policy.
    updateTime string
    Output only. The time when the principal access boundary policy was most recently updated.
    create_time str
    Output only. The time when the principal access boundary policy was created.
    effective_annotations Mapping[str, str]
    etag str
    The etag for the principal access boundary. If this is provided on update, it must match the server's etag.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    Identifier. The resource name of the principal access boundary policy. The following format is supported: organizations/{organization_id}/locations/{location}/principalAccessBoundaryPolicies/{policy_id}
    uid str
    Output only. The globally unique ID of the principal access boundary policy.
    update_time str
    Output only. The time when the principal access boundary policy was most recently updated.
    createTime String
    Output only. The time when the principal access boundary policy was created.
    effectiveAnnotations Map<String>
    etag String
    The etag for the principal access boundary. If this is provided on update, it must match the server's etag.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    Identifier. The resource name of the principal access boundary policy. The following format is supported: organizations/{organization_id}/locations/{location}/principalAccessBoundaryPolicies/{policy_id}
    uid String
    Output only. The globally unique ID of the principal access boundary policy.
    updateTime String
    Output only. The time when the principal access boundary policy was most recently updated.

    Look up Existing PrincipalAccessBoundaryPolicy Resource

    Get an existing PrincipalAccessBoundaryPolicy 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?: PrincipalAccessBoundaryPolicyState, opts?: CustomResourceOptions): PrincipalAccessBoundaryPolicy
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        annotations: Optional[Mapping[str, str]] = None,
        create_time: Optional[str] = None,
        details: Optional[PrincipalAccessBoundaryPolicyDetailsArgs] = None,
        display_name: Optional[str] = None,
        effective_annotations: Optional[Mapping[str, str]] = None,
        etag: Optional[str] = None,
        location: Optional[str] = None,
        name: Optional[str] = None,
        organization: Optional[str] = None,
        principal_access_boundary_policy_id: Optional[str] = None,
        uid: Optional[str] = None,
        update_time: Optional[str] = None) -> PrincipalAccessBoundaryPolicy
    func GetPrincipalAccessBoundaryPolicy(ctx *Context, name string, id IDInput, state *PrincipalAccessBoundaryPolicyState, opts ...ResourceOption) (*PrincipalAccessBoundaryPolicy, error)
    public static PrincipalAccessBoundaryPolicy Get(string name, Input<string> id, PrincipalAccessBoundaryPolicyState? state, CustomResourceOptions? opts = null)
    public static PrincipalAccessBoundaryPolicy get(String name, Output<String> id, PrincipalAccessBoundaryPolicyState 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:
    Annotations Dictionary<string, string>

    User defined annotations. See https://google.aip.dev/148#annotations for more details such as format and size limitations

    Note: This field is non-authoritative, and will only manage the annotations present in your configuration. Please refer to the field effective_annotations for all of the annotations present on the resource.

    CreateTime string
    Output only. The time when the principal access boundary policy was created.
    Details PrincipalAccessBoundaryPolicyDetails
    Principal access boundary policy details Structure is documented below.
    DisplayName string
    The description of the principal access boundary policy. Must be less than or equal to 63 characters.
    EffectiveAnnotations Dictionary<string, string>
    Etag string
    The etag for the principal access boundary. If this is provided on update, it must match the server's etag.
    Location string
    The location the principal access boundary policy is in.
    Name string
    Identifier. The resource name of the principal access boundary policy. The following format is supported: organizations/{organization_id}/locations/{location}/principalAccessBoundaryPolicies/{policy_id}
    Organization string
    The parent organization of the principal access boundary policy.
    PrincipalAccessBoundaryPolicyId string
    The ID to use to create the principal access boundary policy. This value must start with a lowercase letter followed by up to 62 lowercase letters, numbers, hyphens, or dots. Pattern, /a-z{2,62}/.

    Uid string
    Output only. The globally unique ID of the principal access boundary policy.
    UpdateTime string
    Output only. The time when the principal access boundary policy was most recently updated.
    Annotations map[string]string

    User defined annotations. See https://google.aip.dev/148#annotations for more details such as format and size limitations

    Note: This field is non-authoritative, and will only manage the annotations present in your configuration. Please refer to the field effective_annotations for all of the annotations present on the resource.

    CreateTime string
    Output only. The time when the principal access boundary policy was created.
    Details PrincipalAccessBoundaryPolicyDetailsArgs
    Principal access boundary policy details Structure is documented below.
    DisplayName string
    The description of the principal access boundary policy. Must be less than or equal to 63 characters.
    EffectiveAnnotations map[string]string
    Etag string
    The etag for the principal access boundary. If this is provided on update, it must match the server's etag.
    Location string
    The location the principal access boundary policy is in.
    Name string
    Identifier. The resource name of the principal access boundary policy. The following format is supported: organizations/{organization_id}/locations/{location}/principalAccessBoundaryPolicies/{policy_id}
    Organization string
    The parent organization of the principal access boundary policy.
    PrincipalAccessBoundaryPolicyId string
    The ID to use to create the principal access boundary policy. This value must start with a lowercase letter followed by up to 62 lowercase letters, numbers, hyphens, or dots. Pattern, /a-z{2,62}/.

    Uid string
    Output only. The globally unique ID of the principal access boundary policy.
    UpdateTime string
    Output only. The time when the principal access boundary policy was most recently updated.
    annotations Map<String,String>

    User defined annotations. See https://google.aip.dev/148#annotations for more details such as format and size limitations

    Note: This field is non-authoritative, and will only manage the annotations present in your configuration. Please refer to the field effective_annotations for all of the annotations present on the resource.

    createTime String
    Output only. The time when the principal access boundary policy was created.
    details PrincipalAccessBoundaryPolicyDetails
    Principal access boundary policy details Structure is documented below.
    displayName String
    The description of the principal access boundary policy. Must be less than or equal to 63 characters.
    effectiveAnnotations Map<String,String>
    etag String
    The etag for the principal access boundary. If this is provided on update, it must match the server's etag.
    location String
    The location the principal access boundary policy is in.
    name String
    Identifier. The resource name of the principal access boundary policy. The following format is supported: organizations/{organization_id}/locations/{location}/principalAccessBoundaryPolicies/{policy_id}
    organization String
    The parent organization of the principal access boundary policy.
    principalAccessBoundaryPolicyId String
    The ID to use to create the principal access boundary policy. This value must start with a lowercase letter followed by up to 62 lowercase letters, numbers, hyphens, or dots. Pattern, /a-z{2,62}/.

    uid String
    Output only. The globally unique ID of the principal access boundary policy.
    updateTime String
    Output only. The time when the principal access boundary policy was most recently updated.
    annotations {[key: string]: string}

    User defined annotations. See https://google.aip.dev/148#annotations for more details such as format and size limitations

    Note: This field is non-authoritative, and will only manage the annotations present in your configuration. Please refer to the field effective_annotations for all of the annotations present on the resource.

    createTime string
    Output only. The time when the principal access boundary policy was created.
    details PrincipalAccessBoundaryPolicyDetails
    Principal access boundary policy details Structure is documented below.
    displayName string
    The description of the principal access boundary policy. Must be less than or equal to 63 characters.
    effectiveAnnotations {[key: string]: string}
    etag string
    The etag for the principal access boundary. If this is provided on update, it must match the server's etag.
    location string
    The location the principal access boundary policy is in.
    name string
    Identifier. The resource name of the principal access boundary policy. The following format is supported: organizations/{organization_id}/locations/{location}/principalAccessBoundaryPolicies/{policy_id}
    organization string
    The parent organization of the principal access boundary policy.
    principalAccessBoundaryPolicyId string
    The ID to use to create the principal access boundary policy. This value must start with a lowercase letter followed by up to 62 lowercase letters, numbers, hyphens, or dots. Pattern, /a-z{2,62}/.

    uid string
    Output only. The globally unique ID of the principal access boundary policy.
    updateTime string
    Output only. The time when the principal access boundary policy was most recently updated.
    annotations Mapping[str, str]

    User defined annotations. See https://google.aip.dev/148#annotations for more details such as format and size limitations

    Note: This field is non-authoritative, and will only manage the annotations present in your configuration. Please refer to the field effective_annotations for all of the annotations present on the resource.

    create_time str
    Output only. The time when the principal access boundary policy was created.
    details PrincipalAccessBoundaryPolicyDetailsArgs
    Principal access boundary policy details Structure is documented below.
    display_name str
    The description of the principal access boundary policy. Must be less than or equal to 63 characters.
    effective_annotations Mapping[str, str]
    etag str
    The etag for the principal access boundary. If this is provided on update, it must match the server's etag.
    location str
    The location the principal access boundary policy is in.
    name str
    Identifier. The resource name of the principal access boundary policy. The following format is supported: organizations/{organization_id}/locations/{location}/principalAccessBoundaryPolicies/{policy_id}
    organization str
    The parent organization of the principal access boundary policy.
    principal_access_boundary_policy_id str
    The ID to use to create the principal access boundary policy. This value must start with a lowercase letter followed by up to 62 lowercase letters, numbers, hyphens, or dots. Pattern, /a-z{2,62}/.

    uid str
    Output only. The globally unique ID of the principal access boundary policy.
    update_time str
    Output only. The time when the principal access boundary policy was most recently updated.
    annotations Map<String>

    User defined annotations. See https://google.aip.dev/148#annotations for more details such as format and size limitations

    Note: This field is non-authoritative, and will only manage the annotations present in your configuration. Please refer to the field effective_annotations for all of the annotations present on the resource.

    createTime String
    Output only. The time when the principal access boundary policy was created.
    details Property Map
    Principal access boundary policy details Structure is documented below.
    displayName String
    The description of the principal access boundary policy. Must be less than or equal to 63 characters.
    effectiveAnnotations Map<String>
    etag String
    The etag for the principal access boundary. If this is provided on update, it must match the server's etag.
    location String
    The location the principal access boundary policy is in.
    name String
    Identifier. The resource name of the principal access boundary policy. The following format is supported: organizations/{organization_id}/locations/{location}/principalAccessBoundaryPolicies/{policy_id}
    organization String
    The parent organization of the principal access boundary policy.
    principalAccessBoundaryPolicyId String
    The ID to use to create the principal access boundary policy. This value must start with a lowercase letter followed by up to 62 lowercase letters, numbers, hyphens, or dots. Pattern, /a-z{2,62}/.

    uid String
    Output only. The globally unique ID of the principal access boundary policy.
    updateTime String
    Output only. The time when the principal access boundary policy was most recently updated.

    Supporting Types

    PrincipalAccessBoundaryPolicyDetails, PrincipalAccessBoundaryPolicyDetailsArgs

    Rules List<PrincipalAccessBoundaryPolicyDetailsRule>
    A list of principal access boundary policy rules. The number of rules in a policy is limited to 500. Structure is documented below.
    EnforcementVersion string
    The version number that indicates which Google Cloud services are included in the enforcement (e.g. "latest", "1", ...). If empty, the PAB policy version will be set to the current latest version, and this version won't get updated when new versions are released.
    Rules []PrincipalAccessBoundaryPolicyDetailsRule
    A list of principal access boundary policy rules. The number of rules in a policy is limited to 500. Structure is documented below.
    EnforcementVersion string
    The version number that indicates which Google Cloud services are included in the enforcement (e.g. "latest", "1", ...). If empty, the PAB policy version will be set to the current latest version, and this version won't get updated when new versions are released.
    rules List<PrincipalAccessBoundaryPolicyDetailsRule>
    A list of principal access boundary policy rules. The number of rules in a policy is limited to 500. Structure is documented below.
    enforcementVersion String
    The version number that indicates which Google Cloud services are included in the enforcement (e.g. "latest", "1", ...). If empty, the PAB policy version will be set to the current latest version, and this version won't get updated when new versions are released.
    rules PrincipalAccessBoundaryPolicyDetailsRule[]
    A list of principal access boundary policy rules. The number of rules in a policy is limited to 500. Structure is documented below.
    enforcementVersion string
    The version number that indicates which Google Cloud services are included in the enforcement (e.g. "latest", "1", ...). If empty, the PAB policy version will be set to the current latest version, and this version won't get updated when new versions are released.
    rules Sequence[PrincipalAccessBoundaryPolicyDetailsRule]
    A list of principal access boundary policy rules. The number of rules in a policy is limited to 500. Structure is documented below.
    enforcement_version str
    The version number that indicates which Google Cloud services are included in the enforcement (e.g. "latest", "1", ...). If empty, the PAB policy version will be set to the current latest version, and this version won't get updated when new versions are released.
    rules List<Property Map>
    A list of principal access boundary policy rules. The number of rules in a policy is limited to 500. Structure is documented below.
    enforcementVersion String
    The version number that indicates which Google Cloud services are included in the enforcement (e.g. "latest", "1", ...). If empty, the PAB policy version will be set to the current latest version, and this version won't get updated when new versions are released.

    PrincipalAccessBoundaryPolicyDetailsRule, PrincipalAccessBoundaryPolicyDetailsRuleArgs

    Effect string
    The access relationship of principals to the resources in this rule. Possible values: ALLOW
    Resources List<string>
    A list of Cloud Resource Manager resources. The resource and all the descendants are included. The number of resources in a policy is limited to 500 across all rules. The following resource types are supported:

    • Organizations, such as //cloudresourcemanager.googleapis.com/organizations/123.
    • Folders, such as //cloudresourcemanager.googleapis.com/folders/123.
    • Projects, such as //cloudresourcemanager.googleapis.com/projects/123 or //cloudresourcemanager.googleapis.com/projects/my-project-id.
    Description string
    The description of the principal access boundary policy rule. Must be less than or equal to 256 characters.
    Effect string
    The access relationship of principals to the resources in this rule. Possible values: ALLOW
    Resources []string
    A list of Cloud Resource Manager resources. The resource and all the descendants are included. The number of resources in a policy is limited to 500 across all rules. The following resource types are supported:

    • Organizations, such as //cloudresourcemanager.googleapis.com/organizations/123.
    • Folders, such as //cloudresourcemanager.googleapis.com/folders/123.
    • Projects, such as //cloudresourcemanager.googleapis.com/projects/123 or //cloudresourcemanager.googleapis.com/projects/my-project-id.
    Description string
    The description of the principal access boundary policy rule. Must be less than or equal to 256 characters.
    effect String
    The access relationship of principals to the resources in this rule. Possible values: ALLOW
    resources List<String>
    A list of Cloud Resource Manager resources. The resource and all the descendants are included. The number of resources in a policy is limited to 500 across all rules. The following resource types are supported:

    • Organizations, such as //cloudresourcemanager.googleapis.com/organizations/123.
    • Folders, such as //cloudresourcemanager.googleapis.com/folders/123.
    • Projects, such as //cloudresourcemanager.googleapis.com/projects/123 or //cloudresourcemanager.googleapis.com/projects/my-project-id.
    description String
    The description of the principal access boundary policy rule. Must be less than or equal to 256 characters.
    effect string
    The access relationship of principals to the resources in this rule. Possible values: ALLOW
    resources string[]
    A list of Cloud Resource Manager resources. The resource and all the descendants are included. The number of resources in a policy is limited to 500 across all rules. The following resource types are supported:

    • Organizations, such as //cloudresourcemanager.googleapis.com/organizations/123.
    • Folders, such as //cloudresourcemanager.googleapis.com/folders/123.
    • Projects, such as //cloudresourcemanager.googleapis.com/projects/123 or //cloudresourcemanager.googleapis.com/projects/my-project-id.
    description string
    The description of the principal access boundary policy rule. Must be less than or equal to 256 characters.
    effect str
    The access relationship of principals to the resources in this rule. Possible values: ALLOW
    resources Sequence[str]
    A list of Cloud Resource Manager resources. The resource and all the descendants are included. The number of resources in a policy is limited to 500 across all rules. The following resource types are supported:

    • Organizations, such as //cloudresourcemanager.googleapis.com/organizations/123.
    • Folders, such as //cloudresourcemanager.googleapis.com/folders/123.
    • Projects, such as //cloudresourcemanager.googleapis.com/projects/123 or //cloudresourcemanager.googleapis.com/projects/my-project-id.
    description str
    The description of the principal access boundary policy rule. Must be less than or equal to 256 characters.
    effect String
    The access relationship of principals to the resources in this rule. Possible values: ALLOW
    resources List<String>
    A list of Cloud Resource Manager resources. The resource and all the descendants are included. The number of resources in a policy is limited to 500 across all rules. The following resource types are supported:

    • Organizations, such as //cloudresourcemanager.googleapis.com/organizations/123.
    • Folders, such as //cloudresourcemanager.googleapis.com/folders/123.
    • Projects, such as //cloudresourcemanager.googleapis.com/projects/123 or //cloudresourcemanager.googleapis.com/projects/my-project-id.
    description String
    The description of the principal access boundary policy rule. Must be less than or equal to 256 characters.

    Import

    PrincipalAccessBoundaryPolicy can be imported using any of these accepted formats:

    • organizations/{{organization}}/locations/{{location}}/principalAccessBoundaryPolicies/{{principal_access_boundary_policy_id}}

    • {{organization}}/{{location}}/{{principal_access_boundary_policy_id}}

    When using the pulumi import command, PrincipalAccessBoundaryPolicy can be imported using one of the formats above. For example:

    $ pulumi import gcp:iam/principalAccessBoundaryPolicy:PrincipalAccessBoundaryPolicy default organizations/{{organization}}/locations/{{location}}/principalAccessBoundaryPolicies/{{principal_access_boundary_policy_id}}

    $ pulumi import gcp:iam/principalAccessBoundaryPolicy:PrincipalAccessBoundaryPolicy default {{organization}}/{{location}}/{{principal_access_boundary_policy_id}}

    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