grafana.CloudAccessPolicy
Explore with Pulumi AI
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.cloud.getOrganization({
slug: "<your org slug>",
});
const test = new grafana.cloud.AccessPolicy("test", {
region: "us",
name: "my-policy",
displayName: "My Policy",
scopes: [
"metrics:read",
"logs:read",
],
realms: [{
type: "org",
identifier: current.then(current => current.id),
labelPolicies: [{
selector: "{namespace=\"default\"}",
}],
}],
});
const testAccessPolicyToken = new grafana.cloud.AccessPolicyToken("test", {
region: "us",
accessPolicyId: test.policyId,
name: "my-policy-token",
displayName: "My Policy Token",
expiresAt: "2023-01-01T00:00:00Z",
});
import pulumi
import pulumi_grafana as grafana
import pulumiverse_grafana as grafana
current = grafana.cloud.get_organization(slug="<your org slug>")
test = grafana.cloud.AccessPolicy("test",
region="us",
name="my-policy",
display_name="My Policy",
scopes=[
"metrics:read",
"logs:read",
],
realms=[{
"type": "org",
"identifier": current.id,
"label_policies": [{
"selector": "{namespace=\"default\"}",
}],
}])
test_access_policy_token = grafana.cloud.AccessPolicyToken("test",
region="us",
access_policy_id=test.policy_id,
name="my-policy-token",
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/cloud"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
current, err := cloud.GetOrganization(ctx, &cloud.GetOrganizationArgs{
Slug: pulumi.StringRef("<your org slug>"),
}, nil)
if err != nil {
return err
}
test, err := cloud.NewAccessPolicy(ctx, "test", &cloud.AccessPolicyArgs{
Region: pulumi.String("us"),
Name: pulumi.String("my-policy"),
DisplayName: pulumi.String("My Policy"),
Scopes: pulumi.StringArray{
pulumi.String("metrics:read"),
pulumi.String("logs:read"),
},
Realms: cloud.AccessPolicyRealmArray{
&cloud.AccessPolicyRealmArgs{
Type: pulumi.String("org"),
Identifier: pulumi.String(current.Id),
LabelPolicies: cloud.AccessPolicyRealmLabelPolicyArray{
&cloud.AccessPolicyRealmLabelPolicyArgs{
Selector: pulumi.String("{namespace=\"default\"}"),
},
},
},
},
})
if err != nil {
return err
}
_, err = cloud.NewAccessPolicyToken(ctx, "test", &cloud.AccessPolicyTokenArgs{
Region: pulumi.String("us"),
AccessPolicyId: test.PolicyId,
Name: pulumi.String("my-policy-token"),
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.Cloud.GetOrganization.Invoke(new()
{
Slug = "<your org slug>",
});
var test = new Grafana.Cloud.AccessPolicy("test", new()
{
Region = "us",
Name = "my-policy",
DisplayName = "My Policy",
Scopes = new[]
{
"metrics:read",
"logs:read",
},
Realms = new[]
{
new Grafana.Cloud.Inputs.AccessPolicyRealmArgs
{
Type = "org",
Identifier = current.Apply(getOrganizationResult => getOrganizationResult.Id),
LabelPolicies = new[]
{
new Grafana.Cloud.Inputs.AccessPolicyRealmLabelPolicyArgs
{
Selector = "{namespace=\"default\"}",
},
},
},
},
});
var testAccessPolicyToken = new Grafana.Cloud.AccessPolicyToken("test", new()
{
Region = "us",
AccessPolicyId = test.PolicyId,
Name = "my-policy-token",
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.cloud.CloudFunctions;
import com.pulumi.grafana.cloud.inputs.GetOrganizationArgs;
import com.pulumi.grafana.cloud.AccessPolicy;
import com.pulumi.grafana.cloud.AccessPolicyArgs;
import com.pulumi.grafana.cloud.inputs.AccessPolicyRealmArgs;
import com.pulumi.grafana.cloud.AccessPolicyToken;
import com.pulumi.grafana.cloud.AccessPolicyTokenArgs;
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 = CloudFunctions.getOrganization(GetOrganizationArgs.builder()
.slug("<your org slug>")
.build());
var test = new AccessPolicy("test", AccessPolicyArgs.builder()
.region("us")
.name("my-policy")
.displayName("My Policy")
.scopes(
"metrics:read",
"logs:read")
.realms(AccessPolicyRealmArgs.builder()
.type("org")
.identifier(current.applyValue(getOrganizationResult -> getOrganizationResult.id()))
.labelPolicies(AccessPolicyRealmLabelPolicyArgs.builder()
.selector("{namespace=\"default\"}")
.build())
.build())
.build());
var testAccessPolicyToken = new AccessPolicyToken("testAccessPolicyToken", AccessPolicyTokenArgs.builder()
.region("us")
.accessPolicyId(test.policyId())
.name("my-policy-token")
.displayName("My Policy Token")
.expiresAt("2023-01-01T00:00:00Z")
.build());
}
}
resources:
test:
type: grafana:cloud:AccessPolicy
properties:
region: us
name: my-policy
displayName: My Policy
scopes:
- metrics:read
- logs:read
realms:
- type: org
identifier: ${current.id}
labelPolicies:
- selector: '{namespace="default"}'
testAccessPolicyToken:
type: grafana:cloud:AccessPolicyToken
name: test
properties:
region: us
accessPolicyId: ${test.policyId}
name: my-policy-token
displayName: My Policy Token
expiresAt: 2023-01-01T00:00:00Z
variables:
current:
fn::invoke:
function: grafana:cloud:getOrganization
arguments:
slug: <your org slug>
Create CloudAccessPolicy Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new CloudAccessPolicy(name: string, args: CloudAccessPolicyArgs, opts?: CustomResourceOptions);
@overload
def CloudAccessPolicy(resource_name: str,
args: CloudAccessPolicyArgs,
opts: Optional[ResourceOptions] = None)
@overload
def CloudAccessPolicy(resource_name: str,
opts: Optional[ResourceOptions] = None,
display_name: Optional[str] = None,
name: Optional[str] = None,
realms: Optional[Sequence[CloudAccessPolicyRealmArgs]] = None,
region: Optional[str] = None,
scopes: Optional[Sequence[str]] = None)
func NewCloudAccessPolicy(ctx *Context, name string, args CloudAccessPolicyArgs, opts ...ResourceOption) (*CloudAccessPolicy, error)
public CloudAccessPolicy(string name, CloudAccessPolicyArgs args, CustomResourceOptions? opts = null)
public CloudAccessPolicy(String name, CloudAccessPolicyArgs args)
public CloudAccessPolicy(String name, CloudAccessPolicyArgs args, CustomResourceOptions options)
type: grafana:CloudAccessPolicy
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 CloudAccessPolicyArgs
- 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 CloudAccessPolicyArgs
- 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 CloudAccessPolicyArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args CloudAccessPolicyArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args CloudAccessPolicyArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
CloudAccessPolicy 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 CloudAccessPolicy resource accepts the following input properties:
- Realms
List<Pulumiverse.
Grafana. Inputs. Cloud Access Policy Realm> - Region string
- Region where the API is deployed. Generally where the stack is deployed. 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.
- Scopes List<string>
- Scopes of the access policy. See https://grafana.com/docs/grafana-cloud/account-management/authentication-and-permissions/access-policies/#scopes for possible values.
- Display
Name string - Display name of the access policy. Defaults to the name.
- Name string
- Name of the access policy.
- Realms
[]Cloud
Access Policy Realm Args - Region string
- Region where the API is deployed. Generally where the stack is deployed. 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.
- Scopes []string
- Scopes of the access policy. See https://grafana.com/docs/grafana-cloud/account-management/authentication-and-permissions/access-policies/#scopes for possible values.
- Display
Name string - Display name of the access policy. Defaults to the name.
- Name string
- Name of the access policy.
- realms
List<Cloud
Access Policy Realm> - region String
- Region where the API is deployed. Generally where the stack is deployed. 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.
- scopes List<String>
- Scopes of the access policy. See https://grafana.com/docs/grafana-cloud/account-management/authentication-and-permissions/access-policies/#scopes for possible values.
- display
Name String - Display name of the access policy. Defaults to the name.
- name String
- Name of the access policy.
- realms
Cloud
Access Policy Realm[] - region string
- Region where the API is deployed. Generally where the stack is deployed. 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.
- scopes string[]
- Scopes of the access policy. See https://grafana.com/docs/grafana-cloud/account-management/authentication-and-permissions/access-policies/#scopes for possible values.
- display
Name string - Display name of the access policy. Defaults to the name.
- name string
- Name of the access policy.
- realms
Sequence[Cloud
Access Policy Realm Args] - region str
- Region where the API is deployed. Generally where the stack is deployed. 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.
- scopes Sequence[str]
- Scopes of the access policy. See https://grafana.com/docs/grafana-cloud/account-management/authentication-and-permissions/access-policies/#scopes for possible values.
- display_
name str - Display name of the access policy. Defaults to the name.
- name str
- Name of the access policy.
- realms List<Property Map>
- region String
- Region where the API is deployed. Generally where the stack is deployed. 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.
- scopes List<String>
- Scopes of the access policy. See https://grafana.com/docs/grafana-cloud/account-management/authentication-and-permissions/access-policies/#scopes for possible values.
- display
Name String - Display name of the access policy. Defaults to the name.
- name String
- Name of the access policy.
Outputs
All input properties are implicitly available as output properties. Additionally, the CloudAccessPolicy resource produces the following output properties:
- created_
at str - Creation date of the access policy.
- id str
- The provider-assigned unique ID for this managed resource.
- policy_
id str - ID of the access policy.
- updated_
at str - Last update date of the access policy.
Look up Existing CloudAccessPolicy Resource
Get an existing CloudAccessPolicy 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?: CloudAccessPolicyState, opts?: CustomResourceOptions): CloudAccessPolicy
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
created_at: Optional[str] = None,
display_name: Optional[str] = None,
name: Optional[str] = None,
policy_id: Optional[str] = None,
realms: Optional[Sequence[CloudAccessPolicyRealmArgs]] = None,
region: Optional[str] = None,
scopes: Optional[Sequence[str]] = None,
updated_at: Optional[str] = None) -> CloudAccessPolicy
func GetCloudAccessPolicy(ctx *Context, name string, id IDInput, state *CloudAccessPolicyState, opts ...ResourceOption) (*CloudAccessPolicy, error)
public static CloudAccessPolicy Get(string name, Input<string> id, CloudAccessPolicyState? state, CustomResourceOptions? opts = null)
public static CloudAccessPolicy get(String name, Output<String> id, CloudAccessPolicyState 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.
- Created
At string - Creation date of the access policy.
- Display
Name string - Display name of the access policy. Defaults to the name.
- Name string
- Name of the access policy.
- Policy
Id string - ID of the access policy.
- Realms
List<Pulumiverse.
Grafana. Inputs. Cloud Access Policy Realm> - Region string
- Region where the API is deployed. Generally where the stack is deployed. 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.
- Scopes List<string>
- Scopes of the access policy. See https://grafana.com/docs/grafana-cloud/account-management/authentication-and-permissions/access-policies/#scopes for possible values.
- Updated
At string - Last update date of the access policy.
- Created
At string - Creation date of the access policy.
- Display
Name string - Display name of the access policy. Defaults to the name.
- Name string
- Name of the access policy.
- Policy
Id string - ID of the access policy.
- Realms
[]Cloud
Access Policy Realm Args - Region string
- Region where the API is deployed. Generally where the stack is deployed. 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.
- Scopes []string
- Scopes of the access policy. See https://grafana.com/docs/grafana-cloud/account-management/authentication-and-permissions/access-policies/#scopes for possible values.
- Updated
At string - Last update date of the access policy.
- created
At String - Creation date of the access policy.
- display
Name String - Display name of the access policy. Defaults to the name.
- name String
- Name of the access policy.
- policy
Id String - ID of the access policy.
- realms
List<Cloud
Access Policy Realm> - region String
- Region where the API is deployed. Generally where the stack is deployed. 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.
- scopes List<String>
- Scopes of the access policy. See https://grafana.com/docs/grafana-cloud/account-management/authentication-and-permissions/access-policies/#scopes for possible values.
- updated
At String - Last update date of the access policy.
- created
At string - Creation date of the access policy.
- display
Name string - Display name of the access policy. Defaults to the name.
- name string
- Name of the access policy.
- policy
Id string - ID of the access policy.
- realms
Cloud
Access Policy Realm[] - region string
- Region where the API is deployed. Generally where the stack is deployed. 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.
- scopes string[]
- Scopes of the access policy. See https://grafana.com/docs/grafana-cloud/account-management/authentication-and-permissions/access-policies/#scopes for possible values.
- updated
At string - Last update date of the access policy.
- created_
at str - Creation date of the access policy.
- display_
name str - Display name of the access policy. Defaults to the name.
- name str
- Name of the access policy.
- policy_
id str - ID of the access policy.
- realms
Sequence[Cloud
Access Policy Realm Args] - region str
- Region where the API is deployed. Generally where the stack is deployed. 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.
- scopes Sequence[str]
- Scopes of the access policy. See https://grafana.com/docs/grafana-cloud/account-management/authentication-and-permissions/access-policies/#scopes for possible values.
- updated_
at str - Last update date of the access policy.
- created
At String - Creation date of the access policy.
- display
Name String - Display name of the access policy. Defaults to the name.
- name String
- Name of the access policy.
- policy
Id String - ID of the access policy.
- realms List<Property Map>
- region String
- Region where the API is deployed. Generally where the stack is deployed. 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.
- scopes List<String>
- Scopes of the access policy. See https://grafana.com/docs/grafana-cloud/account-management/authentication-and-permissions/access-policies/#scopes for possible values.
- updated
At String - Last update date of the access policy.
Supporting Types
CloudAccessPolicyRealm, CloudAccessPolicyRealmArgs
- Identifier string
- The identifier of the org or stack. For orgs, this is the slug, for stacks, this is the stack ID.
- Type string
- Whether a policy applies to a Cloud org or a specific stack. Should be one of
org
orstack
. - Label
Policies List<Pulumiverse.Grafana. Inputs. Cloud Access Policy Realm Label Policy>
- Identifier string
- The identifier of the org or stack. For orgs, this is the slug, for stacks, this is the stack ID.
- Type string
- Whether a policy applies to a Cloud org or a specific stack. Should be one of
org
orstack
. - Label
Policies []CloudAccess Policy Realm Label Policy
- identifier String
- The identifier of the org or stack. For orgs, this is the slug, for stacks, this is the stack ID.
- type String
- Whether a policy applies to a Cloud org or a specific stack. Should be one of
org
orstack
. - label
Policies List<CloudAccess Policy Realm Label Policy>
- identifier string
- The identifier of the org or stack. For orgs, this is the slug, for stacks, this is the stack ID.
- type string
- Whether a policy applies to a Cloud org or a specific stack. Should be one of
org
orstack
. - label
Policies CloudAccess Policy Realm Label Policy[]
- identifier str
- The identifier of the org or stack. For orgs, this is the slug, for stacks, this is the stack ID.
- type str
- Whether a policy applies to a Cloud org or a specific stack. Should be one of
org
orstack
. - label_
policies Sequence[CloudAccess Policy Realm Label Policy]
- identifier String
- The identifier of the org or stack. For orgs, this is the slug, for stacks, this is the stack ID.
- type String
- Whether a policy applies to a Cloud org or a specific stack. Should be one of
org
orstack
. - label
Policies List<Property Map>
CloudAccessPolicyRealmLabelPolicy, CloudAccessPolicyRealmLabelPolicyArgs
- Selector string
- The label selector to match in metrics or logs query. Should be in PromQL or LogQL format.
- Selector string
- The label selector to match in metrics or logs query. Should be in PromQL or LogQL format.
- selector String
- The label selector to match in metrics or logs query. Should be in PromQL or LogQL format.
- selector string
- The label selector to match in metrics or logs query. Should be in PromQL or LogQL format.
- selector str
- The label selector to match in metrics or logs query. Should be in PromQL or LogQL format.
- selector String
- The label selector to match in metrics or logs query. Should be in PromQL or LogQL format.
Import
$ pulumi import grafana:index/cloudAccessPolicy:CloudAccessPolicy name "{{ region }}:{{ policyId }}"
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.