1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. accesscontextmanager
  5. ServicePerimeterResource
Google Cloud Classic v7.19.0 published on Thursday, Apr 18, 2024 by Pulumi

gcp.accesscontextmanager.ServicePerimeterResource

Explore with Pulumi AI

gcp logo
Google Cloud Classic v7.19.0 published on Thursday, Apr 18, 2024 by Pulumi

    Allows configuring a single GCP resource that should be inside the status block of a service perimeter. This resource is intended to be used in cases where it is not possible to compile a full list of projects to include in a gcp.accesscontextmanager.ServicePerimeter resource, to enable them to be added separately. If your perimeter is in dry-run mode use gcp.accesscontextmanager.ServicePerimeterDryRunResource instead.

    Note: If this resource is used alongside a gcp.accesscontextmanager.ServicePerimeter resource, the service perimeter resource must have a lifecycle block with ignore_changes = [status[0].resources] so they don’t fight over which resources should be in the policy.

    To get more information about ServicePerimeterResource, see:

    Warning: If you are using User ADCs (Application Default Credentials) with this resource, you must specify a billing_project and set user_project_override to true in the provider configuration. Otherwise the ACM API will return a 403 error. Your account must have the serviceusage.services.use permission on the billing_project you defined.

    Example Usage

    Access Context Manager Service Perimeter Resource Basic

    import * as pulumi from "@pulumi/pulumi";
    import * as gcp from "@pulumi/gcp";
    
    const access_policy = new gcp.accesscontextmanager.AccessPolicy("access-policy", {
        parent: "organizations/123456789",
        title: "my policy",
    });
    const service_perimeter_resourceServicePerimeter = new gcp.accesscontextmanager.ServicePerimeter("service-perimeter-resource", {
        parent: pulumi.interpolate`accessPolicies/${access_policy.name}`,
        name: pulumi.interpolate`accessPolicies/${access_policy.name}/servicePerimeters/restrict_all`,
        title: "restrict_all",
        status: {
            restrictedServices: ["storage.googleapis.com"],
        },
    });
    const service_perimeter_resource = new gcp.accesscontextmanager.ServicePerimeterResource("service-perimeter-resource", {
        perimeterName: service_perimeter_resourceServicePerimeter.name,
        resource: "projects/987654321",
    });
    
    import pulumi
    import pulumi_gcp as gcp
    
    access_policy = gcp.accesscontextmanager.AccessPolicy("access-policy",
        parent="organizations/123456789",
        title="my policy")
    service_perimeter_resource_service_perimeter = gcp.accesscontextmanager.ServicePerimeter("service-perimeter-resource",
        parent=access_policy.name.apply(lambda name: f"accessPolicies/{name}"),
        name=access_policy.name.apply(lambda name: f"accessPolicies/{name}/servicePerimeters/restrict_all"),
        title="restrict_all",
        status=gcp.accesscontextmanager.ServicePerimeterStatusArgs(
            restricted_services=["storage.googleapis.com"],
        ))
    service_perimeter_resource = gcp.accesscontextmanager.ServicePerimeterResource("service-perimeter-resource",
        perimeter_name=service_perimeter_resource_service_perimeter.name,
        resource="projects/987654321")
    
    package main
    
    import (
    	"fmt"
    
    	"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/accesscontextmanager"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := accesscontextmanager.NewAccessPolicy(ctx, "access-policy", &accesscontextmanager.AccessPolicyArgs{
    			Parent: pulumi.String("organizations/123456789"),
    			Title:  pulumi.String("my policy"),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = accesscontextmanager.NewServicePerimeter(ctx, "service-perimeter-resource", &accesscontextmanager.ServicePerimeterArgs{
    			Parent: access_policy.Name.ApplyT(func(name string) (string, error) {
    				return fmt.Sprintf("accessPolicies/%v", name), nil
    			}).(pulumi.StringOutput),
    			Name: access_policy.Name.ApplyT(func(name string) (string, error) {
    				return fmt.Sprintf("accessPolicies/%v/servicePerimeters/restrict_all", name), nil
    			}).(pulumi.StringOutput),
    			Title: pulumi.String("restrict_all"),
    			Status: &accesscontextmanager.ServicePerimeterStatusArgs{
    				RestrictedServices: pulumi.StringArray{
    					pulumi.String("storage.googleapis.com"),
    				},
    			},
    		})
    		if err != nil {
    			return err
    		}
    		_, err = accesscontextmanager.NewServicePerimeterResource(ctx, "service-perimeter-resource", &accesscontextmanager.ServicePerimeterResourceArgs{
    			PerimeterName: service_perimeter_resourceServicePerimeter.Name,
    			Resource:      pulumi.String("projects/987654321"),
    		})
    		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 access_policy = new Gcp.AccessContextManager.AccessPolicy("access-policy", new()
        {
            Parent = "organizations/123456789",
            Title = "my policy",
        });
    
        var service_perimeter_resourceServicePerimeter = new Gcp.AccessContextManager.ServicePerimeter("service-perimeter-resource", new()
        {
            Parent = access_policy.Name.Apply(name => $"accessPolicies/{name}"),
            Name = access_policy.Name.Apply(name => $"accessPolicies/{name}/servicePerimeters/restrict_all"),
            Title = "restrict_all",
            Status = new Gcp.AccessContextManager.Inputs.ServicePerimeterStatusArgs
            {
                RestrictedServices = new[]
                {
                    "storage.googleapis.com",
                },
            },
        });
    
        var service_perimeter_resource = new Gcp.AccessContextManager.ServicePerimeterResource("service-perimeter-resource", new()
        {
            PerimeterName = service_perimeter_resourceServicePerimeter.Name,
            Resource = "projects/987654321",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.gcp.accesscontextmanager.AccessPolicy;
    import com.pulumi.gcp.accesscontextmanager.AccessPolicyArgs;
    import com.pulumi.gcp.accesscontextmanager.ServicePerimeter;
    import com.pulumi.gcp.accesscontextmanager.ServicePerimeterArgs;
    import com.pulumi.gcp.accesscontextmanager.inputs.ServicePerimeterStatusArgs;
    import com.pulumi.gcp.accesscontextmanager.ServicePerimeterResource;
    import com.pulumi.gcp.accesscontextmanager.ServicePerimeterResourceArgs;
    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 access_policy = new AccessPolicy("access-policy", AccessPolicyArgs.builder()        
                .parent("organizations/123456789")
                .title("my policy")
                .build());
    
            var service_perimeter_resourceServicePerimeter = new ServicePerimeter("service-perimeter-resourceServicePerimeter", ServicePerimeterArgs.builder()        
                .parent(access_policy.name().applyValue(name -> String.format("accessPolicies/%s", name)))
                .name(access_policy.name().applyValue(name -> String.format("accessPolicies/%s/servicePerimeters/restrict_all", name)))
                .title("restrict_all")
                .status(ServicePerimeterStatusArgs.builder()
                    .restrictedServices("storage.googleapis.com")
                    .build())
                .build());
    
            var service_perimeter_resource = new ServicePerimeterResource("service-perimeter-resource", ServicePerimeterResourceArgs.builder()        
                .perimeterName(service_perimeter_resourceServicePerimeter.name())
                .resource("projects/987654321")
                .build());
    
        }
    }
    
    resources:
      service-perimeter-resource:
        type: gcp:accesscontextmanager:ServicePerimeterResource
        properties:
          perimeterName: ${["service-perimeter-resourceServicePerimeter"].name}
          resource: projects/987654321
      service-perimeter-resourceServicePerimeter:
        type: gcp:accesscontextmanager:ServicePerimeter
        name: service-perimeter-resource
        properties:
          parent: accessPolicies/${["access-policy"].name}
          name: accessPolicies/${["access-policy"].name}/servicePerimeters/restrict_all
          title: restrict_all
          status:
            restrictedServices:
              - storage.googleapis.com
      access-policy:
        type: gcp:accesscontextmanager:AccessPolicy
        properties:
          parent: organizations/123456789
          title: my policy
    

    Create ServicePerimeterResource Resource

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

    Constructor syntax

    new ServicePerimeterResource(name: string, args: ServicePerimeterResourceArgs, opts?: CustomResourceOptions);
    @overload
    def ServicePerimeterResource(resource_name: str,
                                 args: ServicePerimeterResourceArgs,
                                 opts: Optional[ResourceOptions] = None)
    
    @overload
    def ServicePerimeterResource(resource_name: str,
                                 opts: Optional[ResourceOptions] = None,
                                 perimeter_name: Optional[str] = None,
                                 resource: Optional[str] = None)
    func NewServicePerimeterResource(ctx *Context, name string, args ServicePerimeterResourceArgs, opts ...ResourceOption) (*ServicePerimeterResource, error)
    public ServicePerimeterResource(string name, ServicePerimeterResourceArgs args, CustomResourceOptions? opts = null)
    public ServicePerimeterResource(String name, ServicePerimeterResourceArgs args)
    public ServicePerimeterResource(String name, ServicePerimeterResourceArgs args, CustomResourceOptions options)
    
    type: gcp:accesscontextmanager:ServicePerimeterResource
    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 ServicePerimeterResourceArgs
    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 ServicePerimeterResourceArgs
    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 ServicePerimeterResourceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ServicePerimeterResourceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ServicePerimeterResourceArgs
    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 servicePerimeterResourceResource = new Gcp.AccessContextManager.ServicePerimeterResource("servicePerimeterResourceResource", new()
    {
        PerimeterName = "string",
        Resource = "string",
    });
    
    example, err := accesscontextmanager.NewServicePerimeterResource(ctx, "servicePerimeterResourceResource", &accesscontextmanager.ServicePerimeterResourceArgs{
    	PerimeterName: pulumi.String("string"),
    	Resource:      pulumi.String("string"),
    })
    
    var servicePerimeterResourceResource = new ServicePerimeterResource("servicePerimeterResourceResource", ServicePerimeterResourceArgs.builder()        
        .perimeterName("string")
        .resource("string")
        .build());
    
    service_perimeter_resource_resource = gcp.accesscontextmanager.ServicePerimeterResource("servicePerimeterResourceResource",
        perimeter_name="string",
        resource="string")
    
    const servicePerimeterResourceResource = new gcp.accesscontextmanager.ServicePerimeterResource("servicePerimeterResourceResource", {
        perimeterName: "string",
        resource: "string",
    });
    
    type: gcp:accesscontextmanager:ServicePerimeterResource
    properties:
        perimeterName: string
        resource: string
    

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

    PerimeterName string
    The name of the Service Perimeter to add this resource to.


    Resource string
    A GCP resource that is inside of the service perimeter. Currently only projects are allowed. Format: projects/{project_number}
    PerimeterName string
    The name of the Service Perimeter to add this resource to.


    Resource string
    A GCP resource that is inside of the service perimeter. Currently only projects are allowed. Format: projects/{project_number}
    perimeterName String
    The name of the Service Perimeter to add this resource to.


    resource String
    A GCP resource that is inside of the service perimeter. Currently only projects are allowed. Format: projects/{project_number}
    perimeterName string
    The name of the Service Perimeter to add this resource to.


    resource string
    A GCP resource that is inside of the service perimeter. Currently only projects are allowed. Format: projects/{project_number}
    perimeter_name str
    The name of the Service Perimeter to add this resource to.


    resource str
    A GCP resource that is inside of the service perimeter. Currently only projects are allowed. Format: projects/{project_number}
    perimeterName String
    The name of the Service Perimeter to add this resource to.


    resource String
    A GCP resource that is inside of the service perimeter. Currently only projects are allowed. Format: projects/{project_number}

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing ServicePerimeterResource Resource

    Get an existing ServicePerimeterResource 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?: ServicePerimeterResourceState, opts?: CustomResourceOptions): ServicePerimeterResource
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            perimeter_name: Optional[str] = None,
            resource: Optional[str] = None) -> ServicePerimeterResource
    func GetServicePerimeterResource(ctx *Context, name string, id IDInput, state *ServicePerimeterResourceState, opts ...ResourceOption) (*ServicePerimeterResource, error)
    public static ServicePerimeterResource Get(string name, Input<string> id, ServicePerimeterResourceState? state, CustomResourceOptions? opts = null)
    public static ServicePerimeterResource get(String name, Output<String> id, ServicePerimeterResourceState 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:
    PerimeterName string
    The name of the Service Perimeter to add this resource to.


    Resource string
    A GCP resource that is inside of the service perimeter. Currently only projects are allowed. Format: projects/{project_number}
    PerimeterName string
    The name of the Service Perimeter to add this resource to.


    Resource string
    A GCP resource that is inside of the service perimeter. Currently only projects are allowed. Format: projects/{project_number}
    perimeterName String
    The name of the Service Perimeter to add this resource to.


    resource String
    A GCP resource that is inside of the service perimeter. Currently only projects are allowed. Format: projects/{project_number}
    perimeterName string
    The name of the Service Perimeter to add this resource to.


    resource string
    A GCP resource that is inside of the service perimeter. Currently only projects are allowed. Format: projects/{project_number}
    perimeter_name str
    The name of the Service Perimeter to add this resource to.


    resource str
    A GCP resource that is inside of the service perimeter. Currently only projects are allowed. Format: projects/{project_number}
    perimeterName String
    The name of the Service Perimeter to add this resource to.


    resource String
    A GCP resource that is inside of the service perimeter. Currently only projects are allowed. Format: projects/{project_number}

    Import

    ServicePerimeterResource can be imported using any of these accepted formats:

    • {{perimeter_name}}/{{resource}}

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

    $ pulumi import gcp:accesscontextmanager/servicePerimeterResource:ServicePerimeterResource default {{perimeter_name}}/{{resource}}
    

    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 v7.19.0 published on Thursday, Apr 18, 2024 by Pulumi