Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. HashiCorp Vault
  3. API Docs
  4. secrets
  5. SyncConfig
HashiCorp Vault v6.3.0 published on Thursday, Aug 8, 2024 by Pulumi
pulumi/pulumi-vault

vault.secrets.SyncConfig

Explore with Pulumi AI

vault logo
HashiCorp Vault v6.3.0 published on Thursday, Aug 8, 2024 by Pulumi
pulumi/pulumi-vault

    Configures the secret sync global config. The config is global and can only be managed in the root namespace.

    Important The config is global so the vault.secrets.SyncConfig resource must not be defined multiple times for the same Vault server. If multiple definition exists, the last one applied will be effective.

    Example Usage

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

const globalConfig = new vault.secrets.SyncConfig("global_config", {
    disabled: true,
    queueCapacity: 500000,
});

    import pulumi
import pulumi_vault as vault

global_config = vault.secrets.SyncConfig("global_config",
    disabled=True,
    queue_capacity=500000)

    package main

import (
	"github.com/pulumi/pulumi-vault/sdk/v6/go/vault/secrets"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := secrets.NewSyncConfig(ctx, "global_config", &secrets.SyncConfigArgs{
			Disabled:      pulumi.Bool(true),
			QueueCapacity: pulumi.Int(500000),
		})
		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 globalConfig = new Vault.Secrets.SyncConfig("global_config", new()
    {
        Disabled = true,
        QueueCapacity = 500000,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.vault.secrets.SyncConfig;
import com.pulumi.vault.secrets.SyncConfigArgs;
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 globalConfig = new SyncConfig("globalConfig", SyncConfigArgs.builder()
            .disabled(true)
            .queueCapacity(500000)
            .build());

    }
}

    resources:
  globalConfig:
    type: vault:secrets:SyncConfig
    name: global_config
    properties:
      disabled: true
      queueCapacity: 500000

    Create SyncConfig Resource

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

    Constructor syntax

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

@overload
def SyncConfig(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               disabled: Optional[bool] = None,
               namespace: Optional[str] = None,
               queue_capacity: Optional[int] = None)
    func NewSyncConfig(ctx *Context, name string, args *SyncConfigArgs, opts ...ResourceOption) (*SyncConfig, error)
    public SyncConfig(string name, SyncConfigArgs? args = null, CustomResourceOptions? opts = null)
    public SyncConfig(String name, SyncConfigArgs args)
public SyncConfig(String name, SyncConfigArgs args, CustomResourceOptions options)

    type: vault:secrets:SyncConfig
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 SyncConfigArgs
    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 SyncConfigArgs
    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 SyncConfigArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SyncConfigArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SyncConfigArgs
    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 syncConfigResource = new Vault.Secrets.SyncConfig("syncConfigResource", new()
{
    Disabled = false,
    Namespace = "string",
    QueueCapacity = 0,
});

    example, err := secrets.NewSyncConfig(ctx, "syncConfigResource", &secrets.SyncConfigArgs{
	Disabled:      pulumi.Bool(false),
	Namespace:     pulumi.String("string"),
	QueueCapacity: pulumi.Int(0),
})

    var syncConfigResource = new SyncConfig("syncConfigResource", SyncConfigArgs.builder()
    .disabled(false)
    .namespace("string")
    .queueCapacity(0)
    .build());

    sync_config_resource = vault.secrets.SyncConfig("syncConfigResource",
    disabled=False,
    namespace="string",
    queue_capacity=0)

    const syncConfigResource = new vault.secrets.SyncConfig("syncConfigResource", {
    disabled: false,
    namespace: "string",
    queueCapacity: 0,
});

    type: vault:secrets:SyncConfig
properties:
    disabled: false
    namespace: string
    queueCapacity: 0

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

    Disabled bool
    Disables the syncing process between Vault and external destinations. Defaults to false.
    Namespace string
    The namespace to provision the resource in. This resource can only be configured in the root namespace. Available only for Vault Enterprise.
    QueueCapacity int
    Maximum number of pending sync operations allowed on the queue. Defaults to 1000000.
    Disabled bool
    Disables the syncing process between Vault and external destinations. Defaults to false.
    Namespace string
    The namespace to provision the resource in. This resource can only be configured in the root namespace. Available only for Vault Enterprise.
    QueueCapacity int
    Maximum number of pending sync operations allowed on the queue. Defaults to 1000000.
    disabled Boolean
    Disables the syncing process between Vault and external destinations. Defaults to false.
    namespace String
    The namespace to provision the resource in. This resource can only be configured in the root namespace. Available only for Vault Enterprise.
    queueCapacity Integer
    Maximum number of pending sync operations allowed on the queue. Defaults to 1000000.
    disabled boolean
    Disables the syncing process between Vault and external destinations. Defaults to false.
    namespace string
    The namespace to provision the resource in. This resource can only be configured in the root namespace. Available only for Vault Enterprise.
    queueCapacity number
    Maximum number of pending sync operations allowed on the queue. Defaults to 1000000.
    disabled bool
    Disables the syncing process between Vault and external destinations. Defaults to false.
    namespace str
    The namespace to provision the resource in. This resource can only be configured in the root namespace. Available only for Vault Enterprise.
    queue_capacity int
    Maximum number of pending sync operations allowed on the queue. Defaults to 1000000.
    disabled Boolean
    Disables the syncing process between Vault and external destinations. Defaults to false.
    namespace String
    The namespace to provision the resource in. This resource can only be configured in the root namespace. Available only for Vault Enterprise.
    queueCapacity Number
    Maximum number of pending sync operations allowed on the queue. Defaults to 1000000.

    Outputs

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

    Get an existing SyncConfig 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?: SyncConfigState, opts?: CustomResourceOptions): SyncConfig
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        disabled: Optional[bool] = None,
        namespace: Optional[str] = None,
        queue_capacity: Optional[int] = None) -> SyncConfig
    func GetSyncConfig(ctx *Context, name string, id IDInput, state *SyncConfigState, opts ...ResourceOption) (*SyncConfig, error)
    public static SyncConfig Get(string name, Input<string> id, SyncConfigState? state, CustomResourceOptions? opts = null)
    public static SyncConfig get(String name, Output<String> id, SyncConfigState 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:
    Disabled bool
    Disables the syncing process between Vault and external destinations. Defaults to false.
    Namespace string
    The namespace to provision the resource in. This resource can only be configured in the root namespace. Available only for Vault Enterprise.
    QueueCapacity int
    Maximum number of pending sync operations allowed on the queue. Defaults to 1000000.
    Disabled bool
    Disables the syncing process between Vault and external destinations. Defaults to false.
    Namespace string
    The namespace to provision the resource in. This resource can only be configured in the root namespace. Available only for Vault Enterprise.
    QueueCapacity int
    Maximum number of pending sync operations allowed on the queue. Defaults to 1000000.
    disabled Boolean
    Disables the syncing process between Vault and external destinations. Defaults to false.
    namespace String
    The namespace to provision the resource in. This resource can only be configured in the root namespace. Available only for Vault Enterprise.
    queueCapacity Integer
    Maximum number of pending sync operations allowed on the queue. Defaults to 1000000.
    disabled boolean
    Disables the syncing process between Vault and external destinations. Defaults to false.
    namespace string
    The namespace to provision the resource in. This resource can only be configured in the root namespace. Available only for Vault Enterprise.
    queueCapacity number
    Maximum number of pending sync operations allowed on the queue. Defaults to 1000000.
    disabled bool
    Disables the syncing process between Vault and external destinations. Defaults to false.
    namespace str
    The namespace to provision the resource in. This resource can only be configured in the root namespace. Available only for Vault Enterprise.
    queue_capacity int
    Maximum number of pending sync operations allowed on the queue. Defaults to 1000000.
    disabled Boolean
    Disables the syncing process between Vault and external destinations. Defaults to false.
    namespace String
    The namespace to provision the resource in. This resource can only be configured in the root namespace. Available only for Vault Enterprise.
    queueCapacity Number
    Maximum number of pending sync operations allowed on the queue. Defaults to 1000000.

    Import

    $ pulumi import vault:secrets/syncConfig:SyncConfig config global_config

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

    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.3.0 published on Thursday, Aug 8, 2024 by Pulumi
    pulumi/pulumi-vault