1. Packages
  2. Grafana Cloud
  3. API Docs
  4. CloudAccessPolicyToken
Grafana v0.4.1 published on Thursday, Apr 11, 2024 by pulumiverse

grafana.CloudAccessPolicyToken

Explore with Pulumi AI

grafana logo
Grafana v0.4.1 published on Thursday, Apr 11, 2024 by pulumiverse

    Required access policy scopes:

    • accesspolicies:read
    • accesspolicies:write
    • accesspolicies:delete

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as grafana from "@pulumi/grafana";
    import * as grafana from "@pulumiverse/grafana";
    
    const current = grafana.getCloudOrganization({
        slug: "<your org slug>",
    });
    const testCloudAccessPolicy = new grafana.CloudAccessPolicy("testCloudAccessPolicy", {
        region: "us",
        displayName: "My Policy",
        scopes: [
            "metrics:read",
            "logs:read",
        ],
        realms: [{
            type: "org",
            identifier: current.then(current => current.id),
            labelPolicies: [{
                selector: "{namespace=\"default\"}",
            }],
        }],
    });
    const testCloudAccessPolicyToken = new grafana.CloudAccessPolicyToken("testCloudAccessPolicyToken", {
        region: "us",
        accessPolicyId: testCloudAccessPolicy.policyId,
        displayName: "My Policy Token",
        expiresAt: "2023-01-01T00:00:00Z",
    });
    
    import pulumi
    import pulumi_grafana as grafana
    import pulumiverse_grafana as grafana
    
    current = grafana.get_cloud_organization(slug="<your org slug>")
    test_cloud_access_policy = grafana.CloudAccessPolicy("testCloudAccessPolicy",
        region="us",
        display_name="My Policy",
        scopes=[
            "metrics:read",
            "logs:read",
        ],
        realms=[grafana.CloudAccessPolicyRealmArgs(
            type="org",
            identifier=current.id,
            label_policies=[grafana.CloudAccessPolicyRealmLabelPolicyArgs(
                selector="{namespace=\"default\"}",
            )],
        )])
    test_cloud_access_policy_token = grafana.CloudAccessPolicyToken("testCloudAccessPolicyToken",
        region="us",
        access_policy_id=test_cloud_access_policy.policy_id,
        display_name="My Policy Token",
        expires_at="2023-01-01T00:00:00Z")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    	"github.com/pulumiverse/pulumi-grafana/sdk/go/grafana"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		current, err := grafana.GetCloudOrganization(ctx, &grafana.GetCloudOrganizationArgs{
    			Slug: pulumi.StringRef("<your org slug>"),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		testCloudAccessPolicy, err := grafana.NewCloudAccessPolicy(ctx, "testCloudAccessPolicy", &grafana.CloudAccessPolicyArgs{
    			Region:      pulumi.String("us"),
    			DisplayName: pulumi.String("My Policy"),
    			Scopes: pulumi.StringArray{
    				pulumi.String("metrics:read"),
    				pulumi.String("logs:read"),
    			},
    			Realms: grafana.CloudAccessPolicyRealmArray{
    				&grafana.CloudAccessPolicyRealmArgs{
    					Type:       pulumi.String("org"),
    					Identifier: pulumi.String(current.Id),
    					LabelPolicies: grafana.CloudAccessPolicyRealmLabelPolicyArray{
    						&grafana.CloudAccessPolicyRealmLabelPolicyArgs{
    							Selector: pulumi.String("{namespace=\"default\"}"),
    						},
    					},
    				},
    			},
    		})
    		if err != nil {
    			return err
    		}
    		_, err = grafana.NewCloudAccessPolicyToken(ctx, "testCloudAccessPolicyToken", &grafana.CloudAccessPolicyTokenArgs{
    			Region:         pulumi.String("us"),
    			AccessPolicyId: testCloudAccessPolicy.PolicyId,
    			DisplayName:    pulumi.String("My Policy Token"),
    			ExpiresAt:      pulumi.String("2023-01-01T00:00:00Z"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Grafana = Pulumi.Grafana;
    using Grafana = Pulumiverse.Grafana;
    
    return await Deployment.RunAsync(() => 
    {
        var current = Grafana.GetCloudOrganization.Invoke(new()
        {
            Slug = "<your org slug>",
        });
    
        var testCloudAccessPolicy = new Grafana.CloudAccessPolicy("testCloudAccessPolicy", new()
        {
            Region = "us",
            DisplayName = "My Policy",
            Scopes = new[]
            {
                "metrics:read",
                "logs:read",
            },
            Realms = new[]
            {
                new Grafana.Inputs.CloudAccessPolicyRealmArgs
                {
                    Type = "org",
                    Identifier = current.Apply(getCloudOrganizationResult => getCloudOrganizationResult.Id),
                    LabelPolicies = new[]
                    {
                        new Grafana.Inputs.CloudAccessPolicyRealmLabelPolicyArgs
                        {
                            Selector = "{namespace=\"default\"}",
                        },
                    },
                },
            },
        });
    
        var testCloudAccessPolicyToken = new Grafana.CloudAccessPolicyToken("testCloudAccessPolicyToken", new()
        {
            Region = "us",
            AccessPolicyId = testCloudAccessPolicy.PolicyId,
            DisplayName = "My Policy Token",
            ExpiresAt = "2023-01-01T00:00:00Z",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.grafana.GrafanaFunctions;
    import com.pulumi.grafana.inputs.GetCloudOrganizationArgs;
    import com.pulumi.grafana.CloudAccessPolicy;
    import com.pulumi.grafana.CloudAccessPolicyArgs;
    import com.pulumi.grafana.inputs.CloudAccessPolicyRealmArgs;
    import com.pulumi.grafana.CloudAccessPolicyToken;
    import com.pulumi.grafana.CloudAccessPolicyTokenArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            final var current = GrafanaFunctions.getCloudOrganization(GetCloudOrganizationArgs.builder()
                .slug("<your org slug>")
                .build());
    
            var testCloudAccessPolicy = new CloudAccessPolicy("testCloudAccessPolicy", CloudAccessPolicyArgs.builder()        
                .region("us")
                .displayName("My Policy")
                .scopes(            
                    "metrics:read",
                    "logs:read")
                .realms(CloudAccessPolicyRealmArgs.builder()
                    .type("org")
                    .identifier(current.applyValue(getCloudOrganizationResult -> getCloudOrganizationResult.id()))
                    .labelPolicies(CloudAccessPolicyRealmLabelPolicyArgs.builder()
                        .selector("{namespace=\"default\"}")
                        .build())
                    .build())
                .build());
    
            var testCloudAccessPolicyToken = new CloudAccessPolicyToken("testCloudAccessPolicyToken", CloudAccessPolicyTokenArgs.builder()        
                .region("us")
                .accessPolicyId(testCloudAccessPolicy.policyId())
                .displayName("My Policy Token")
                .expiresAt("2023-01-01T00:00:00Z")
                .build());
    
        }
    }
    
    resources:
      testCloudAccessPolicy:
        type: grafana:CloudAccessPolicy
        properties:
          region: us
          displayName: My Policy
          scopes:
            - metrics:read
            - logs:read
          realms:
            - type: org
              identifier: ${current.id}
              labelPolicies:
                - selector: '{namespace="default"}'
      testCloudAccessPolicyToken:
        type: grafana:CloudAccessPolicyToken
        properties:
          region: us
          accessPolicyId: ${testCloudAccessPolicy.policyId}
          displayName: My Policy Token
          expiresAt: 2023-01-01T00:00:00Z
    variables:
      current:
        fn::invoke:
          Function: grafana:getCloudOrganization
          Arguments:
            slug: <your org slug>
    

    Create CloudAccessPolicyToken Resource

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

    Constructor syntax

    new CloudAccessPolicyToken(name: string, args: CloudAccessPolicyTokenArgs, opts?: CustomResourceOptions);
    @overload
    def CloudAccessPolicyToken(resource_name: str,
                               args: CloudAccessPolicyTokenArgs,
                               opts: Optional[ResourceOptions] = None)
    
    @overload
    def CloudAccessPolicyToken(resource_name: str,
                               opts: Optional[ResourceOptions] = None,
                               access_policy_id: Optional[str] = None,
                               region: Optional[str] = None,
                               display_name: Optional[str] = None,
                               expires_at: Optional[str] = None,
                               name: Optional[str] = None)
    func NewCloudAccessPolicyToken(ctx *Context, name string, args CloudAccessPolicyTokenArgs, opts ...ResourceOption) (*CloudAccessPolicyToken, error)
    public CloudAccessPolicyToken(string name, CloudAccessPolicyTokenArgs args, CustomResourceOptions? opts = null)
    public CloudAccessPolicyToken(String name, CloudAccessPolicyTokenArgs args)
    public CloudAccessPolicyToken(String name, CloudAccessPolicyTokenArgs args, CustomResourceOptions options)
    
    type: grafana:CloudAccessPolicyToken
    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 CloudAccessPolicyTokenArgs
    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 CloudAccessPolicyTokenArgs
    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 CloudAccessPolicyTokenArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CloudAccessPolicyTokenArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CloudAccessPolicyTokenArgs
    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 cloudAccessPolicyTokenResource = new Grafana.CloudAccessPolicyToken("cloudAccessPolicyTokenResource", new()
    {
        AccessPolicyId = "string",
        Region = "string",
        DisplayName = "string",
        ExpiresAt = "string",
        Name = "string",
    });
    
    example, err := grafana.NewCloudAccessPolicyToken(ctx, "cloudAccessPolicyTokenResource", &grafana.CloudAccessPolicyTokenArgs{
    	AccessPolicyId: pulumi.String("string"),
    	Region:         pulumi.String("string"),
    	DisplayName:    pulumi.String("string"),
    	ExpiresAt:      pulumi.String("string"),
    	Name:           pulumi.String("string"),
    })
    
    var cloudAccessPolicyTokenResource = new CloudAccessPolicyToken("cloudAccessPolicyTokenResource", CloudAccessPolicyTokenArgs.builder()        
        .accessPolicyId("string")
        .region("string")
        .displayName("string")
        .expiresAt("string")
        .name("string")
        .build());
    
    cloud_access_policy_token_resource = grafana.CloudAccessPolicyToken("cloudAccessPolicyTokenResource",
        access_policy_id="string",
        region="string",
        display_name="string",
        expires_at="string",
        name="string")
    
    const cloudAccessPolicyTokenResource = new grafana.CloudAccessPolicyToken("cloudAccessPolicyTokenResource", {
        accessPolicyId: "string",
        region: "string",
        displayName: "string",
        expiresAt: "string",
        name: "string",
    });
    
    type: grafana:CloudAccessPolicyToken
    properties:
        accessPolicyId: string
        displayName: string
        expiresAt: string
        name: string
        region: string
    

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

    AccessPolicyId string
    ID of the access policy for which to create a token.
    Region string
    Region of the access policy. Should be set to the same region as the access policy. Use the region list API to get the list of available regions: https://grafana.com/docs/grafana-cloud/developer-resources/api-reference/cloud-api/#list-regions.
    DisplayName string
    Display name of the access policy token. Defaults to the name.
    ExpiresAt string
    Expiration date of the access policy token. Does not expire by default.
    Name string
    Name of the access policy token.
    AccessPolicyId string
    ID of the access policy for which to create a token.
    Region string
    Region of the access policy. Should be set to the same region as the access policy. Use the region list API to get the list of available regions: https://grafana.com/docs/grafana-cloud/developer-resources/api-reference/cloud-api/#list-regions.
    DisplayName string
    Display name of the access policy token. Defaults to the name.
    ExpiresAt string
    Expiration date of the access policy token. Does not expire by default.
    Name string
    Name of the access policy token.
    accessPolicyId String
    ID of the access policy for which to create a token.
    region String
    Region of the access policy. Should be set to the same region as the access policy. Use the region list API to get the list of available regions: https://grafana.com/docs/grafana-cloud/developer-resources/api-reference/cloud-api/#list-regions.
    displayName String
    Display name of the access policy token. Defaults to the name.
    expiresAt String
    Expiration date of the access policy token. Does not expire by default.
    name String
    Name of the access policy token.
    accessPolicyId string
    ID of the access policy for which to create a token.
    region string
    Region of the access policy. Should be set to the same region as the access policy. Use the region list API to get the list of available regions: https://grafana.com/docs/grafana-cloud/developer-resources/api-reference/cloud-api/#list-regions.
    displayName string
    Display name of the access policy token. Defaults to the name.
    expiresAt string
    Expiration date of the access policy token. Does not expire by default.
    name string
    Name of the access policy token.
    access_policy_id str
    ID of the access policy for which to create a token.
    region str
    Region of the access policy. Should be set to the same region as the access policy. Use the region list API to get the list of available regions: https://grafana.com/docs/grafana-cloud/developer-resources/api-reference/cloud-api/#list-regions.
    display_name str
    Display name of the access policy token. Defaults to the name.
    expires_at str
    Expiration date of the access policy token. Does not expire by default.
    name str
    Name of the access policy token.
    accessPolicyId String
    ID of the access policy for which to create a token.
    region String
    Region of the access policy. Should be set to the same region as the access policy. Use the region list API to get the list of available regions: https://grafana.com/docs/grafana-cloud/developer-resources/api-reference/cloud-api/#list-regions.
    displayName String
    Display name of the access policy token. Defaults to the name.
    expiresAt String
    Expiration date of the access policy token. Does not expire by default.
    name String
    Name of the access policy token.

    Outputs

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

    CreatedAt string
    Creation date of the access policy token.
    Id string
    The provider-assigned unique ID for this managed resource.
    Token string
    UpdatedAt string
    Last update date of the access policy token.
    CreatedAt string
    Creation date of the access policy token.
    Id string
    The provider-assigned unique ID for this managed resource.
    Token string
    UpdatedAt string
    Last update date of the access policy token.
    createdAt String
    Creation date of the access policy token.
    id String
    The provider-assigned unique ID for this managed resource.
    token String
    updatedAt String
    Last update date of the access policy token.
    createdAt string
    Creation date of the access policy token.
    id string
    The provider-assigned unique ID for this managed resource.
    token string
    updatedAt string
    Last update date of the access policy token.
    created_at str
    Creation date of the access policy token.
    id str
    The provider-assigned unique ID for this managed resource.
    token str
    updated_at str
    Last update date of the access policy token.
    createdAt String
    Creation date of the access policy token.
    id String
    The provider-assigned unique ID for this managed resource.
    token String
    updatedAt String
    Last update date of the access policy token.

    Look up Existing CloudAccessPolicyToken Resource

    Get an existing CloudAccessPolicyToken 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?: CloudAccessPolicyTokenState, opts?: CustomResourceOptions): CloudAccessPolicyToken
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            access_policy_id: Optional[str] = None,
            created_at: Optional[str] = None,
            display_name: Optional[str] = None,
            expires_at: Optional[str] = None,
            name: Optional[str] = None,
            region: Optional[str] = None,
            token: Optional[str] = None,
            updated_at: Optional[str] = None) -> CloudAccessPolicyToken
    func GetCloudAccessPolicyToken(ctx *Context, name string, id IDInput, state *CloudAccessPolicyTokenState, opts ...ResourceOption) (*CloudAccessPolicyToken, error)
    public static CloudAccessPolicyToken Get(string name, Input<string> id, CloudAccessPolicyTokenState? state, CustomResourceOptions? opts = null)
    public static CloudAccessPolicyToken get(String name, Output<String> id, CloudAccessPolicyTokenState 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:
    AccessPolicyId string
    ID of the access policy for which to create a token.
    CreatedAt string
    Creation date of the access policy token.
    DisplayName string
    Display name of the access policy token. Defaults to the name.
    ExpiresAt string
    Expiration date of the access policy token. Does not expire by default.
    Name string
    Name of the access policy token.
    Region string
    Region of the access policy. Should be set to the same region as the access policy. Use the region list API to get the list of available regions: https://grafana.com/docs/grafana-cloud/developer-resources/api-reference/cloud-api/#list-regions.
    Token string
    UpdatedAt string
    Last update date of the access policy token.
    AccessPolicyId string
    ID of the access policy for which to create a token.
    CreatedAt string
    Creation date of the access policy token.
    DisplayName string
    Display name of the access policy token. Defaults to the name.
    ExpiresAt string
    Expiration date of the access policy token. Does not expire by default.
    Name string
    Name of the access policy token.
    Region string
    Region of the access policy. Should be set to the same region as the access policy. Use the region list API to get the list of available regions: https://grafana.com/docs/grafana-cloud/developer-resources/api-reference/cloud-api/#list-regions.
    Token string
    UpdatedAt string
    Last update date of the access policy token.
    accessPolicyId String
    ID of the access policy for which to create a token.
    createdAt String
    Creation date of the access policy token.
    displayName String
    Display name of the access policy token. Defaults to the name.
    expiresAt String
    Expiration date of the access policy token. Does not expire by default.
    name String
    Name of the access policy token.
    region String
    Region of the access policy. Should be set to the same region as the access policy. Use the region list API to get the list of available regions: https://grafana.com/docs/grafana-cloud/developer-resources/api-reference/cloud-api/#list-regions.
    token String
    updatedAt String
    Last update date of the access policy token.
    accessPolicyId string
    ID of the access policy for which to create a token.
    createdAt string
    Creation date of the access policy token.
    displayName string
    Display name of the access policy token. Defaults to the name.
    expiresAt string
    Expiration date of the access policy token. Does not expire by default.
    name string
    Name of the access policy token.
    region string
    Region of the access policy. Should be set to the same region as the access policy. Use the region list API to get the list of available regions: https://grafana.com/docs/grafana-cloud/developer-resources/api-reference/cloud-api/#list-regions.
    token string
    updatedAt string
    Last update date of the access policy token.
    access_policy_id str
    ID of the access policy for which to create a token.
    created_at str
    Creation date of the access policy token.
    display_name str
    Display name of the access policy token. Defaults to the name.
    expires_at str
    Expiration date of the access policy token. Does not expire by default.
    name str
    Name of the access policy token.
    region str
    Region of the access policy. Should be set to the same region as the access policy. Use the region list API to get the list of available regions: https://grafana.com/docs/grafana-cloud/developer-resources/api-reference/cloud-api/#list-regions.
    token str
    updated_at str
    Last update date of the access policy token.
    accessPolicyId String
    ID of the access policy for which to create a token.
    createdAt String
    Creation date of the access policy token.
    displayName String
    Display name of the access policy token. Defaults to the name.
    expiresAt String
    Expiration date of the access policy token. Does not expire by default.
    name String
    Name of the access policy token.
    region String
    Region of the access policy. Should be set to the same region as the access policy. Use the region list API to get the list of available regions: https://grafana.com/docs/grafana-cloud/developer-resources/api-reference/cloud-api/#list-regions.
    token String
    updatedAt String
    Last update date of the access policy token.

    Import

    $ pulumi import grafana:index/cloudAccessPolicyToken:CloudAccessPolicyToken name "{{ region }}:{{ tokenId }}"
    

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

    Package Details

    Repository
    grafana pulumiverse/pulumi-grafana
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the grafana Terraform Provider.
    grafana logo
    Grafana v0.4.1 published on Thursday, Apr 11, 2024 by pulumiverse