Ready to level-up your engineering skills? Join a Pulumi Workshop. Register Now
  1. Docs
  2. Reference
  3. API
  4. Vault
  5. EgpPolicy

EgpPolicy

Provides a resource to manage Endpoint Governing Policy (EGP) via Sentinel.

Note this feature is available only with Vault Enterprise.

Example Usage

using Pulumi;
using Vault = Pulumi.Vault;

class MyStack : Stack
{
    public MyStack()
    {
        var allow_all = new Vault.EgpPolicy("allow-all", new Vault.EgpPolicyArgs
        {
            EnforcementLevel = "soft-mandatory",
            Paths = 
            {
                "*",
            },
            Policy = @"main = rule {
  true
}

",
        });
    }

}

package main

import (
    "fmt"

    "github.com/pulumi/pulumi-vault/sdk/v3/go/vault"
    "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        _, err := vault.NewEgpPolicy(ctx, "allow_all", &vault.EgpPolicyArgs{
            EnforcementLevel: pulumi.String("soft-mandatory"),
            Paths: pulumi.StringArray{
                pulumi.String("*"),
            },
            Policy: pulumi.String(fmt.Sprintf("%v%v%v%v", "main = rule {\n", "  true\n", "}\n", "\n")),
        })
        if err != nil {
            return err
        }
        return nil
    })
}
import pulumi
import pulumi_vault as vault

allow_all = vault.EgpPolicy("allow-all",
    enforcement_level="soft-mandatory",
    paths=["*"],
    policy="""main = rule {
  true
}

""")
import * as pulumi from "@pulumi/pulumi";
import * as vault from "@pulumi/vault";

const allow_all = new vault.EgpPolicy("allow-all", {
    enforcementLevel: "soft-mandatory",
    paths: ["*"],
    policy: `main = rule {
  true
}
`,
});

Create a EgpPolicy Resource

new EgpPolicy(name: string, args: EgpPolicyArgs, opts?: CustomResourceOptions);
def EgpPolicy(resource_name: str, opts: Optional[ResourceOptions] = None, enforcement_level: Optional[str] = None, name: Optional[str] = None, paths: Optional[Sequence[str]] = None, policy: Optional[str] = None)
func NewEgpPolicy(ctx *Context, name string, args EgpPolicyArgs, opts ...ResourceOption) (*EgpPolicy, error)
public EgpPolicy(string name, EgpPolicyArgs args, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args EgpPolicyArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
opts ResourceOptions
A bag of options that control this resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args EgpPolicyArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args EgpPolicyArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

EgpPolicy Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The EgpPolicy resource accepts the following input properties:

EnforcementLevel string

Enforcement level of Sentinel policy. Can be either advisory or soft-mandatory or hard-mandatory

Paths List<string>

List of paths to which the policy will be applied to

Policy string

String containing a Sentinel policy

Name string

The name of the policy

EnforcementLevel string

Enforcement level of Sentinel policy. Can be either advisory or soft-mandatory or hard-mandatory

Paths []string

List of paths to which the policy will be applied to

Policy string

String containing a Sentinel policy

Name string

The name of the policy

enforcementLevel string

Enforcement level of Sentinel policy. Can be either advisory or soft-mandatory or hard-mandatory

paths string[]

List of paths to which the policy will be applied to

policy string

String containing a Sentinel policy

name string

The name of the policy

enforcement_level str

Enforcement level of Sentinel policy. Can be either advisory or soft-mandatory or hard-mandatory

paths Sequence[str]

List of paths to which the policy will be applied to

policy str

String containing a Sentinel policy

name str

The name of the policy

Outputs

All input properties are implicitly available as output properties. Additionally, the EgpPolicy 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 str
The provider-assigned unique ID for this managed resource.

Look up an Existing EgpPolicy Resource

Get an existing EgpPolicy 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?: EgpPolicyState, opts?: CustomResourceOptions): EgpPolicy
@staticmethod
def get(resource_name: str, id: str, opts: Optional[ResourceOptions] = None, enforcement_level: Optional[str] = None, name: Optional[str] = None, paths: Optional[Sequence[str]] = None, policy: Optional[str] = None) -> EgpPolicy
func GetEgpPolicy(ctx *Context, name string, id IDInput, state *EgpPolicyState, opts ...ResourceOption) (*EgpPolicy, error)
public static EgpPolicy Get(string name, Input<string> id, EgpPolicyState? state, CustomResourceOptions? opts = null)
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.

The following state arguments are supported:

EnforcementLevel string

Enforcement level of Sentinel policy. Can be either advisory or soft-mandatory or hard-mandatory

Name string

The name of the policy

Paths List<string>

List of paths to which the policy will be applied to

Policy string

String containing a Sentinel policy

EnforcementLevel string

Enforcement level of Sentinel policy. Can be either advisory or soft-mandatory or hard-mandatory

Name string

The name of the policy

Paths []string

List of paths to which the policy will be applied to

Policy string

String containing a Sentinel policy

enforcementLevel string

Enforcement level of Sentinel policy. Can be either advisory or soft-mandatory or hard-mandatory

name string

The name of the policy

paths string[]

List of paths to which the policy will be applied to

policy string

String containing a Sentinel policy

enforcement_level str

Enforcement level of Sentinel policy. Can be either advisory or soft-mandatory or hard-mandatory

name str

The name of the policy

paths Sequence[str]

List of paths to which the policy will be applied to

policy str

String containing a Sentinel policy

Package Details

Repository
https://github.com/pulumi/pulumi-vault
License
Apache-2.0
Notes
This Pulumi package is based on the vault Terraform Provider.