1. Packages
  2. HashiCorp Vault
  3. API Docs
  4. AuditRequestHeader
HashiCorp Vault v6.2.0 published on Friday, Jun 21, 2024 by Pulumi

vault.AuditRequestHeader

Explore with Pulumi AI

vault logo
HashiCorp Vault v6.2.0 published on Friday, Jun 21, 2024 by Pulumi

    Manages additional request headers that appear in audited requests.

    Note Because of the way the sys/config/auditing/request-headers API is implemented in Vault, this resource will manage existing audited headers with matching names without requiring import.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as vault from "@pulumi/vault";
    
    const xForwardedFor = new vault.AuditRequestHeader("x_forwarded_for", {
        name: "X-Forwarded-For",
        hmac: false,
    });
    
    import pulumi
    import pulumi_vault as vault
    
    x_forwarded_for = vault.AuditRequestHeader("x_forwarded_for",
        name="X-Forwarded-For",
        hmac=False)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-vault/sdk/v6/go/vault"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := vault.NewAuditRequestHeader(ctx, "x_forwarded_for", &vault.AuditRequestHeaderArgs{
    			Name: pulumi.String("X-Forwarded-For"),
    			Hmac: pulumi.Bool(false),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Vault = Pulumi.Vault;
    
    return await Deployment.RunAsync(() => 
    {
        var xForwardedFor = new Vault.AuditRequestHeader("x_forwarded_for", new()
        {
            Name = "X-Forwarded-For",
            Hmac = false,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.vault.AuditRequestHeader;
    import com.pulumi.vault.AuditRequestHeaderArgs;
    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 xForwardedFor = new AuditRequestHeader("xForwardedFor", AuditRequestHeaderArgs.builder()
                .name("X-Forwarded-For")
                .hmac(false)
                .build());
    
        }
    }
    
    resources:
      xForwardedFor:
        type: vault:AuditRequestHeader
        name: x_forwarded_for
        properties:
          name: X-Forwarded-For
          hmac: false
    

    Create AuditRequestHeader Resource

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

    Constructor syntax

    new AuditRequestHeader(name: string, args?: AuditRequestHeaderArgs, opts?: CustomResourceOptions);
    @overload
    def AuditRequestHeader(resource_name: str,
                           args: Optional[AuditRequestHeaderArgs] = None,
                           opts: Optional[ResourceOptions] = None)
    
    @overload
    def AuditRequestHeader(resource_name: str,
                           opts: Optional[ResourceOptions] = None,
                           hmac: Optional[bool] = None,
                           name: Optional[str] = None,
                           namespace: Optional[str] = None)
    func NewAuditRequestHeader(ctx *Context, name string, args *AuditRequestHeaderArgs, opts ...ResourceOption) (*AuditRequestHeader, error)
    public AuditRequestHeader(string name, AuditRequestHeaderArgs? args = null, CustomResourceOptions? opts = null)
    public AuditRequestHeader(String name, AuditRequestHeaderArgs args)
    public AuditRequestHeader(String name, AuditRequestHeaderArgs args, CustomResourceOptions options)
    
    type: vault:AuditRequestHeader
    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 AuditRequestHeaderArgs
    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 AuditRequestHeaderArgs
    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 AuditRequestHeaderArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AuditRequestHeaderArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AuditRequestHeaderArgs
    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 auditRequestHeaderResource = new Vault.AuditRequestHeader("auditRequestHeaderResource", new()
    {
        Hmac = false,
        Name = "string",
        Namespace = "string",
    });
    
    example, err := vault.NewAuditRequestHeader(ctx, "auditRequestHeaderResource", &vault.AuditRequestHeaderArgs{
    	Hmac:      pulumi.Bool(false),
    	Name:      pulumi.String("string"),
    	Namespace: pulumi.String("string"),
    })
    
    var auditRequestHeaderResource = new AuditRequestHeader("auditRequestHeaderResource", AuditRequestHeaderArgs.builder()
        .hmac(false)
        .name("string")
        .namespace("string")
        .build());
    
    audit_request_header_resource = vault.AuditRequestHeader("auditRequestHeaderResource",
        hmac=False,
        name="string",
        namespace="string")
    
    const auditRequestHeaderResource = new vault.AuditRequestHeader("auditRequestHeaderResource", {
        hmac: false,
        name: "string",
        namespace: "string",
    });
    
    type: vault:AuditRequestHeader
    properties:
        hmac: false
        name: string
        namespace: string
    

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

    Hmac bool
    Whether this header's value should be HMAC'd in the audit logs.
    Name string
    The name of the request header to audit.
    Namespace string
    Target namespace. (requires Enterprise)
    Hmac bool
    Whether this header's value should be HMAC'd in the audit logs.
    Name string
    The name of the request header to audit.
    Namespace string
    Target namespace. (requires Enterprise)
    hmac Boolean
    Whether this header's value should be HMAC'd in the audit logs.
    name String
    The name of the request header to audit.
    namespace String
    Target namespace. (requires Enterprise)
    hmac boolean
    Whether this header's value should be HMAC'd in the audit logs.
    name string
    The name of the request header to audit.
    namespace string
    Target namespace. (requires Enterprise)
    hmac bool
    Whether this header's value should be HMAC'd in the audit logs.
    name str
    The name of the request header to audit.
    namespace str
    Target namespace. (requires Enterprise)
    hmac Boolean
    Whether this header's value should be HMAC'd in the audit logs.
    name String
    The name of the request header to audit.
    namespace String
    Target namespace. (requires Enterprise)

    Outputs

    All input properties are implicitly available as output properties. Additionally, the AuditRequestHeader 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 AuditRequestHeader Resource

    Get an existing AuditRequestHeader 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?: AuditRequestHeaderState, opts?: CustomResourceOptions): AuditRequestHeader
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            hmac: Optional[bool] = None,
            name: Optional[str] = None,
            namespace: Optional[str] = None) -> AuditRequestHeader
    func GetAuditRequestHeader(ctx *Context, name string, id IDInput, state *AuditRequestHeaderState, opts ...ResourceOption) (*AuditRequestHeader, error)
    public static AuditRequestHeader Get(string name, Input<string> id, AuditRequestHeaderState? state, CustomResourceOptions? opts = null)
    public static AuditRequestHeader get(String name, Output<String> id, AuditRequestHeaderState 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:
    Hmac bool
    Whether this header's value should be HMAC'd in the audit logs.
    Name string
    The name of the request header to audit.
    Namespace string
    Target namespace. (requires Enterprise)
    Hmac bool
    Whether this header's value should be HMAC'd in the audit logs.
    Name string
    The name of the request header to audit.
    Namespace string
    Target namespace. (requires Enterprise)
    hmac Boolean
    Whether this header's value should be HMAC'd in the audit logs.
    name String
    The name of the request header to audit.
    namespace String
    Target namespace. (requires Enterprise)
    hmac boolean
    Whether this header's value should be HMAC'd in the audit logs.
    name string
    The name of the request header to audit.
    namespace string
    Target namespace. (requires Enterprise)
    hmac bool
    Whether this header's value should be HMAC'd in the audit logs.
    name str
    The name of the request header to audit.
    namespace str
    Target namespace. (requires Enterprise)
    hmac Boolean
    Whether this header's value should be HMAC'd in the audit logs.
    name String
    The name of the request header to audit.
    namespace String
    Target namespace. (requires Enterprise)

    Package Details

    Repository
    Vault pulumi/pulumi-vault
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the vault Terraform Provider.
    vault logo
    HashiCorp Vault v6.2.0 published on Friday, Jun 21, 2024 by Pulumi