Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. Vantage Provider
  4. API Docs
  5. AccessPolicy
Viewing docs for vantage 0.3.21
published on Friday, Sep 18, 2026 by vantage-sh
Schema (JSON)
vantage-sh/terraform-provider-vantage

vantage.AccessPolicy

Viewing docs for vantage 0.3.21
published on Friday, Sep 18, 2026 by vantage-sh
Schema (JSON)
vantage-sh/terraform-provider-vantage

    Manages an Access Policy.

    Example Usage

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

const demoAccessPolicy = new vantage.AccessPolicy("demo_access_policy", {
    title: "Engineering costs",
    description: "Limits cost visibility to the Engineering team.",
    teamTokens: [demoTeam.token],
    policy: {
        apiVersion: "v1",
        filter: "(vantage.provider = 'aws')",
    },
});

    import pulumi
import pulumi_vantage as vantage

demo_access_policy = vantage.AccessPolicy("demo_access_policy",
    title="Engineering costs",
    description="Limits cost visibility to the Engineering team.",
    team_tokens=[demo_team["token"]],
    policy={
        "api_version": "v1",
        "filter": "(vantage.provider = 'aws')",
    })

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/vantage/vantage"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := vantage.NewAccessPolicy(ctx, "demo_access_policy", &vantage.AccessPolicyArgs{
			Title:       pulumi.String("Engineering costs"),
			Description: pulumi.String("Limits cost visibility to the Engineering team."),
			TeamTokens: pulumi.StringArray{
				demoTeam.Token,
			},
			Policy: &vantage.AccessPolicyPolicyArgs{
				ApiVersion: pulumi.String("v1"),
				Filter:     pulumi.String("(vantage.provider = 'aws')"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Vantage = Pulumi.Vantage;

return await Deployment.RunAsync(() => 
{
    var demoAccessPolicy = new Vantage.AccessPolicy("demo_access_policy", new()
    {
        Title = "Engineering costs",
        Description = "Limits cost visibility to the Engineering team.",
        TeamTokens = new[]
        {
            demoTeam.Token,
        },
        Policy = new Vantage.Inputs.AccessPolicyPolicyArgs
        {
            ApiVersion = "v1",
            Filter = "(vantage.provider = 'aws')",
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.vantage.AccessPolicy;
import com.pulumi.vantage.AccessPolicyArgs;
import com.pulumi.vantage.inputs.AccessPolicyPolicyArgs;
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 demoAccessPolicy = new AccessPolicy("demoAccessPolicy", AccessPolicyArgs.builder()
            .title("Engineering costs")
            .description("Limits cost visibility to the Engineering team.")
            .teamTokens(demoTeam.token())
            .policy(AccessPolicyPolicyArgs.builder()
                .apiVersion("v1")
                .filter("(vantage.provider = 'aws')")
                .build())
            .build());

    }
}

    resources:
  demoAccessPolicy:
    type: vantage:AccessPolicy
    name: demo_access_policy
    properties:
      title: Engineering costs
      description: Limits cost visibility to the Engineering team.
      teamTokens:
        - ${demoTeam.token}
      policy:
        apiVersion: v1
        filter: (vantage.provider = 'aws')

    Example coming soon!

    Create AccessPolicy Resource

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

    Constructor syntax

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

@overload
def AccessPolicy(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 policy: Optional[AccessPolicyPolicyArgs] = None,
                 title: Optional[str] = None,
                 description: Optional[str] = None,
                 team_tokens: Optional[Sequence[str]] = None)
    func NewAccessPolicy(ctx *Context, name string, args AccessPolicyArgs, opts ...ResourceOption) (*AccessPolicy, error)
    public AccessPolicy(string name, AccessPolicyArgs args, CustomResourceOptions? opts = null)
    public AccessPolicy(String name, AccessPolicyArgs args)
public AccessPolicy(String name, AccessPolicyArgs args, CustomResourceOptions options)

    type: vantage:AccessPolicy
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "vantage_access_policy" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args AccessPolicyArgs
    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 AccessPolicyArgs
    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 AccessPolicyArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AccessPolicyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AccessPolicyArgs
    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 accessPolicyResource = new Vantage.AccessPolicy("accessPolicyResource", new()
{
    Policy = new Vantage.Inputs.AccessPolicyPolicyArgs
    {
        ApiVersion = "string",
        Filter = "string",
    },
    Title = "string",
    Description = "string",
    TeamTokens = new[]
    {
        "string",
    },
});

    example, err := vantage.NewAccessPolicy(ctx, "accessPolicyResource", &vantage.AccessPolicyArgs{
	Policy: &vantage.AccessPolicyPolicyArgs{
		ApiVersion: pulumi.String("string"),
		Filter:     pulumi.String("string"),
	},
	Title:       pulumi.String("string"),
	Description: pulumi.String("string"),
	TeamTokens: pulumi.StringArray{
		pulumi.String("string"),
	},
})

    resource "vantage_access_policy" "accessPolicyResource" {
  lifecycle {
    create_before_destroy = true
  }
  policy = {
    api_version = "string"
    filter      = "string"
  }
  title       = "string"
  description = "string"
  team_tokens = ["string"]
}

    var accessPolicyResource = new AccessPolicy("accessPolicyResource", AccessPolicyArgs.builder()
    .policy(AccessPolicyPolicyArgs.builder()
        .apiVersion("string")
        .filter("string")
        .build())
    .title("string")
    .description("string")
    .teamTokens("string")
    .build());

    access_policy_resource = vantage.AccessPolicy("accessPolicyResource",
    policy={
        "api_version": "string",
        "filter": "string",
    },
    title="string",
    description="string",
    team_tokens=["string"])

    const accessPolicyResource = new vantage.AccessPolicy("accessPolicyResource", {
    policy: {
        apiVersion: "string",
        filter: "string",
    },
    title: "string",
    description: "string",
    teamTokens: ["string"],
});

    type: vantage:AccessPolicy
properties:
    description: string
    policy:
        apiVersion: string
        filter: string
    teamTokens:
        - string
    title: string

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

    Policy AccessPolicyPolicy
    Access Policy definition using vantage.* VQL.
    Title string
    Title of the Access Policy.
    Description string
    Description of the Access Policy.
    TeamTokens List<string>
    Tokens for Teams this Access Policy is assigned to.
    Policy AccessPolicyPolicyArgs
    Access Policy definition using vantage.* VQL.
    Title string
    Title of the Access Policy.
    Description string
    Description of the Access Policy.
    TeamTokens []string
    Tokens for Teams this Access Policy is assigned to.
    policy object
    Access Policy definition using vantage.* VQL.
    title string
    Title of the Access Policy.
    description string
    Description of the Access Policy.
    team_tokens list(string)
    Tokens for Teams this Access Policy is assigned to.
    policy AccessPolicyPolicy
    Access Policy definition using vantage.* VQL.
    title String
    Title of the Access Policy.
    description String
    Description of the Access Policy.
    teamTokens List<String>
    Tokens for Teams this Access Policy is assigned to.
    policy AccessPolicyPolicy
    Access Policy definition using vantage.* VQL.
    title string
    Title of the Access Policy.
    description string
    Description of the Access Policy.
    teamTokens string[]
    Tokens for Teams this Access Policy is assigned to.
    policy AccessPolicyPolicyArgs
    Access Policy definition using vantage.* VQL.
    title str
    Title of the Access Policy.
    description str
    Description of the Access Policy.
    team_tokens Sequence[str]
    Tokens for Teams this Access Policy is assigned to.
    policy Property Map
    Access Policy definition using vantage.* VQL.
    title String
    Title of the Access Policy.
    description String
    Description of the Access Policy.
    teamTokens List<String>
    Tokens for Teams this Access Policy is assigned to.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Token string
    Unique Access Policy identifier.
    Id string
    The provider-assigned unique ID for this managed resource.
    Token string
    Unique Access Policy identifier.
    id string
    The provider-assigned unique ID for this managed resource.
    token string
    Unique Access Policy identifier.
    id String
    The provider-assigned unique ID for this managed resource.
    token String
    Unique Access Policy identifier.
    id string
    The provider-assigned unique ID for this managed resource.
    token string
    Unique Access Policy identifier.
    id str
    The provider-assigned unique ID for this managed resource.
    token str
    Unique Access Policy identifier.
    id String
    The provider-assigned unique ID for this managed resource.
    token String
    Unique Access Policy identifier.

    Look up Existing AccessPolicy Resource

    Get an existing AccessPolicy 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?: AccessPolicyState, opts?: CustomResourceOptions): AccessPolicy
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        policy: Optional[AccessPolicyPolicyArgs] = None,
        team_tokens: Optional[Sequence[str]] = None,
        title: Optional[str] = None,
        token: Optional[str] = None) -> AccessPolicy
    func GetAccessPolicy(ctx *Context, name string, id IDInput, state *AccessPolicyState, opts ...ResourceOption) (*AccessPolicy, error)
    public static AccessPolicy Get(string name, Input<string> id, AccessPolicyState? state, CustomResourceOptions? opts = null)
    public static AccessPolicy get(String name, Output<String> id, AccessPolicyState state, CustomResourceOptions options)
    resources:  _:    type: vantage:AccessPolicy    get:      id: ${id}
    import {
  to = vantage_access_policy.example
  id = "${id}"
}
    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:
    Description string
    Description of the Access Policy.
    Policy AccessPolicyPolicy
    Access Policy definition using vantage.* VQL.
    TeamTokens List<string>
    Tokens for Teams this Access Policy is assigned to.
    Title string
    Title of the Access Policy.
    Token string
    Unique Access Policy identifier.
    Description string
    Description of the Access Policy.
    Policy AccessPolicyPolicyArgs
    Access Policy definition using vantage.* VQL.
    TeamTokens []string
    Tokens for Teams this Access Policy is assigned to.
    Title string
    Title of the Access Policy.
    Token string
    Unique Access Policy identifier.
    description string
    Description of the Access Policy.
    policy object
    Access Policy definition using vantage.* VQL.
    team_tokens list(string)
    Tokens for Teams this Access Policy is assigned to.
    title string
    Title of the Access Policy.
    token string
    Unique Access Policy identifier.
    description String
    Description of the Access Policy.
    policy AccessPolicyPolicy
    Access Policy definition using vantage.* VQL.
    teamTokens List<String>
    Tokens for Teams this Access Policy is assigned to.
    title String
    Title of the Access Policy.
    token String
    Unique Access Policy identifier.
    description string
    Description of the Access Policy.
    policy AccessPolicyPolicy
    Access Policy definition using vantage.* VQL.
    teamTokens string[]
    Tokens for Teams this Access Policy is assigned to.
    title string
    Title of the Access Policy.
    token string
    Unique Access Policy identifier.
    description str
    Description of the Access Policy.
    policy AccessPolicyPolicyArgs
    Access Policy definition using vantage.* VQL.
    team_tokens Sequence[str]
    Tokens for Teams this Access Policy is assigned to.
    title str
    Title of the Access Policy.
    token str
    Unique Access Policy identifier.
    description String
    Description of the Access Policy.
    policy Property Map
    Access Policy definition using vantage.* VQL.
    teamTokens List<String>
    Tokens for Teams this Access Policy is assigned to.
    title String
    Title of the Access Policy.
    token String
    Unique Access Policy identifier.

    Supporting Types

    AccessPolicyPolicy, AccessPolicyPolicyArgs

    ApiVersion string
    Access Policy document version. Currently only v1 is supported.
    Filter string
    Vantage Query Language (VQL) that controls which costs this Access Policy allows.
    ApiVersion string
    Access Policy document version. Currently only v1 is supported.
    Filter string
    Vantage Query Language (VQL) that controls which costs this Access Policy allows.
    api_version string
    Access Policy document version. Currently only v1 is supported.
    filter string
    Vantage Query Language (VQL) that controls which costs this Access Policy allows.
    apiVersion String
    Access Policy document version. Currently only v1 is supported.
    filter String
    Vantage Query Language (VQL) that controls which costs this Access Policy allows.
    apiVersion string
    Access Policy document version. Currently only v1 is supported.
    filter string
    Vantage Query Language (VQL) that controls which costs this Access Policy allows.
    api_version str
    Access Policy document version. Currently only v1 is supported.
    filter str
    Vantage Query Language (VQL) that controls which costs this Access Policy allows.
    apiVersion String
    Access Policy document version. Currently only v1 is supported.
    filter String
    Vantage Query Language (VQL) that controls which costs this Access Policy allows.

    Package Details

    Repository
    vantage vantage-sh/terraform-provider-vantage
    License
    Notes
    This Pulumi package is based on the vantage Terraform Provider.
    Viewing docs for vantage 0.3.21
    published on Friday, Sep 18, 2026 by vantage-sh
    Schema (JSON)
    vantage-sh/terraform-provider-vantage

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial