com.pulumi.vault.Mount Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of vault Show documentation
Show all versions of vault Show documentation
A Pulumi package for creating and managing HashiCorp Vault cloud resources.
// *** WARNING: this file was generated by pulumi-java-gen. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
package com.pulumi.vault;
import com.pulumi.core.Output;
import com.pulumi.core.annotations.Export;
import com.pulumi.core.annotations.ResourceType;
import com.pulumi.core.internal.Codegen;
import com.pulumi.vault.MountArgs;
import com.pulumi.vault.Utilities;
import com.pulumi.vault.inputs.MountState;
import java.lang.Boolean;
import java.lang.Integer;
import java.lang.String;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import javax.annotation.Nullable;
/**
* This resource enables a new secrets engine at the given path.
*
* ## Example Usage
*
* <!--Start PulumiCodeChooser -->
*
* {@code
* package generated_program;
*
* import com.pulumi.Context;
* import com.pulumi.Pulumi;
* import com.pulumi.core.Output;
* import com.pulumi.vault.Mount;
* import com.pulumi.vault.MountArgs;
* 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 example = new Mount("example", MountArgs.builder()
* .path("dummy")
* .type("generic")
* .description("This is an example mount")
* .build());
*
* }
* }
* }
*
* <!--End PulumiCodeChooser -->
*
* <!--Start PulumiCodeChooser -->
*
* {@code
* package generated_program;
*
* import com.pulumi.Context;
* import com.pulumi.Pulumi;
* import com.pulumi.core.Output;
* import com.pulumi.vault.Mount;
* import com.pulumi.vault.MountArgs;
* 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 kvv2_example = new Mount("kvv2-example", MountArgs.builder()
* .path("version2-example")
* .type("kv-v2")
* .options(Map.ofEntries(
* Map.entry("version", "2"),
* Map.entry("type", "kv-v2")
* ))
* .description("This is an example KV Version 2 secret engine mount")
* .build());
*
* }
* }
* }
*
* <!--End PulumiCodeChooser -->
*
* <!--Start PulumiCodeChooser -->
*
* {@code
* package generated_program;
*
* import com.pulumi.Context;
* import com.pulumi.Pulumi;
* import com.pulumi.core.Output;
* import com.pulumi.vault.Mount;
* import com.pulumi.vault.MountArgs;
* 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 transit_example = new Mount("transit-example", MountArgs.builder()
* .path("transit-example")
* .type("transit")
* .description("This is an example transit secret engine mount")
* .options(Map.of("convergent_encryption", false))
* .build());
*
* }
* }
* }
*
* <!--End PulumiCodeChooser -->
*
* <!--Start PulumiCodeChooser -->
*
* {@code
* package generated_program;
*
* import com.pulumi.Context;
* import com.pulumi.Pulumi;
* import com.pulumi.core.Output;
* import com.pulumi.vault.Mount;
* import com.pulumi.vault.MountArgs;
* 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 pki_example = new Mount("pki-example", MountArgs.builder()
* .path("pki-example")
* .type("pki")
* .description("This is an example PKI mount")
* .defaultLeaseTtlSeconds(3600)
* .maxLeaseTtlSeconds(86400)
* .build());
*
* }
* }
* }
*
* <!--End PulumiCodeChooser -->
*
* ## Import
*
* Mounts can be imported using the `path`, e.g.
*
* ```sh
* $ pulumi import vault:index/mount:Mount example dummy
* ```
*
*/
@ResourceType(type="vault:index/mount:Mount")
public class Mount extends com.pulumi.resources.CustomResource {
/**
* The accessor for this mount.
*
*/
@Export(name="accessor", refs={String.class}, tree="[0]")
private Output accessor;
/**
* @return The accessor for this mount.
*
*/
public Output accessor() {
return this.accessor;
}
/**
* Set of managed key registry entry names that the mount in question is allowed to access
*
*/
@Export(name="allowedManagedKeys", refs={List.class,String.class}, tree="[0,1]")
private Output> allowedManagedKeys;
/**
* @return Set of managed key registry entry names that the mount in question is allowed to access
*
*/
public Output>> allowedManagedKeys() {
return Codegen.optional(this.allowedManagedKeys);
}
/**
* List of headers to allow, allowing a plugin to include
* them in the response.
*
*/
@Export(name="allowedResponseHeaders", refs={List.class,String.class}, tree="[0,1]")
private Output> allowedResponseHeaders;
/**
* @return List of headers to allow, allowing a plugin to include
* them in the response.
*
*/
public Output>> allowedResponseHeaders() {
return Codegen.optional(this.allowedResponseHeaders);
}
/**
* Specifies the list of keys that will not be HMAC'd by audit devices in the request data object.
*
*/
@Export(name="auditNonHmacRequestKeys", refs={List.class,String.class}, tree="[0,1]")
private Output> auditNonHmacRequestKeys;
/**
* @return Specifies the list of keys that will not be HMAC'd by audit devices in the request data object.
*
*/
public Output> auditNonHmacRequestKeys() {
return this.auditNonHmacRequestKeys;
}
/**
* Specifies the list of keys that will not be HMAC'd by audit devices in the response data object.
*
*/
@Export(name="auditNonHmacResponseKeys", refs={List.class,String.class}, tree="[0,1]")
private Output> auditNonHmacResponseKeys;
/**
* @return Specifies the list of keys that will not be HMAC'd by audit devices in the response data object.
*
*/
public Output> auditNonHmacResponseKeys() {
return this.auditNonHmacResponseKeys;
}
/**
* Default lease duration for tokens and secrets in seconds
*
*/
@Export(name="defaultLeaseTtlSeconds", refs={Integer.class}, tree="[0]")
private Output defaultLeaseTtlSeconds;
/**
* @return Default lease duration for tokens and secrets in seconds
*
*/
public Output defaultLeaseTtlSeconds() {
return this.defaultLeaseTtlSeconds;
}
/**
* List of allowed authentication mount accessors the
* backend can request delegated authentication for.
*
*/
@Export(name="delegatedAuthAccessors", refs={List.class,String.class}, tree="[0,1]")
private Output> delegatedAuthAccessors;
/**
* @return List of allowed authentication mount accessors the
* backend can request delegated authentication for.
*
*/
public Output>> delegatedAuthAccessors() {
return Codegen.optional(this.delegatedAuthAccessors);
}
/**
* Human-friendly description of the mount
*
*/
@Export(name="description", refs={String.class}, tree="[0]")
private Output description;
/**
* @return Human-friendly description of the mount
*
*/
public Output> description() {
return Codegen.optional(this.description);
}
/**
* Boolean flag that can be explicitly set to true to enable the secrets engine to access Vault's external entropy source
*
*/
@Export(name="externalEntropyAccess", refs={Boolean.class}, tree="[0]")
private Output externalEntropyAccess;
/**
* @return Boolean flag that can be explicitly set to true to enable the secrets engine to access Vault's external entropy source
*
*/
public Output> externalEntropyAccess() {
return Codegen.optional(this.externalEntropyAccess);
}
/**
* The key to use for signing plugin workload identity tokens. If
* not provided, this will default to Vault's OIDC default key.
*
*/
@Export(name="identityTokenKey", refs={String.class}, tree="[0]")
private Output identityTokenKey;
/**
* @return The key to use for signing plugin workload identity tokens. If
* not provided, this will default to Vault's OIDC default key.
*
*/
public Output> identityTokenKey() {
return Codegen.optional(this.identityTokenKey);
}
/**
* Specifies whether to show this mount in the UI-specific
* listing endpoint. Valid values are `unauth` or `hidden`. If not set, behaves like `hidden`.
*
*/
@Export(name="listingVisibility", refs={String.class}, tree="[0]")
private Output listingVisibility;
/**
* @return Specifies whether to show this mount in the UI-specific
* listing endpoint. Valid values are `unauth` or `hidden`. If not set, behaves like `hidden`.
*
*/
public Output> listingVisibility() {
return Codegen.optional(this.listingVisibility);
}
/**
* Boolean flag that can be explicitly set to true to enforce local mount in HA environment
*
*/
@Export(name="local", refs={Boolean.class}, tree="[0]")
private Output local;
/**
* @return Boolean flag that can be explicitly set to true to enforce local mount in HA environment
*
*/
public Output> local() {
return Codegen.optional(this.local);
}
/**
* Maximum possible lease duration for tokens and secrets in seconds
*
*/
@Export(name="maxLeaseTtlSeconds", refs={Integer.class}, tree="[0]")
private Output maxLeaseTtlSeconds;
/**
* @return Maximum possible lease duration for tokens and secrets in seconds
*
*/
public Output maxLeaseTtlSeconds() {
return this.maxLeaseTtlSeconds;
}
/**
* The namespace to provision the resource in.
* The value should not contain leading or trailing forward slashes.
* The `namespace` is always relative to the provider's configured [namespace](https://www.terraform.io/docs/providers/vault/index.html#namespace).
* *Available only for Vault Enterprise*.
*
*/
@Export(name="namespace", refs={String.class}, tree="[0]")
private Output namespace;
/**
* @return The namespace to provision the resource in.
* The value should not contain leading or trailing forward slashes.
* The `namespace` is always relative to the provider's configured [namespace](https://www.terraform.io/docs/providers/vault/index.html#namespace).
* *Available only for Vault Enterprise*.
*
*/
public Output> namespace() {
return Codegen.optional(this.namespace);
}
/**
* Specifies mount type specific options that are passed to the backend
*
*/
@Export(name="options", refs={Map.class,String.class}, tree="[0,1,1]")
private Output> options;
/**
* @return Specifies mount type specific options that are passed to the backend
*
*/
public Output>> options() {
return Codegen.optional(this.options);
}
/**
* List of headers to allow and pass from the request to
* the plugin.
*
*/
@Export(name="passthroughRequestHeaders", refs={List.class,String.class}, tree="[0,1]")
private Output> passthroughRequestHeaders;
/**
* @return List of headers to allow and pass from the request to
* the plugin.
*
*/
public Output>> passthroughRequestHeaders() {
return Codegen.optional(this.passthroughRequestHeaders);
}
/**
* Where the secret backend will be mounted
*
*/
@Export(name="path", refs={String.class}, tree="[0]")
private Output path;
/**
* @return Where the secret backend will be mounted
*
*/
public Output path() {
return this.path;
}
/**
* Specifies the semantic version of the plugin to use, e.g. "v1.0.0".
* If unspecified, the server will select any matching unversioned plugin that may have been
* registered, the latest versioned plugin registered, or a built-in plugin in that order of precedence.
*
*/
@Export(name="pluginVersion", refs={String.class}, tree="[0]")
private Output pluginVersion;
/**
* @return Specifies the semantic version of the plugin to use, e.g. "v1.0.0".
* If unspecified, the server will select any matching unversioned plugin that may have been
* registered, the latest versioned plugin registered, or a built-in plugin in that order of precedence.
*
*/
public Output> pluginVersion() {
return Codegen.optional(this.pluginVersion);
}
/**
* Boolean flag that can be explicitly set to true to enable seal wrapping for the mount, causing values stored by the mount to be wrapped by the seal's encryption capability
*
*/
@Export(name="sealWrap", refs={Boolean.class}, tree="[0]")
private Output sealWrap;
/**
* @return Boolean flag that can be explicitly set to true to enable seal wrapping for the mount, causing values stored by the mount to be wrapped by the seal's encryption capability
*
*/
public Output sealWrap() {
return this.sealWrap;
}
/**
* Type of the backend, such as "aws"
*
*/
@Export(name="type", refs={String.class}, tree="[0]")
private Output type;
/**
* @return Type of the backend, such as "aws"
*
*/
public Output type() {
return this.type;
}
/**
*
* @param name The _unique_ name of the resulting resource.
*/
public Mount(java.lang.String name) {
this(name, MountArgs.Empty);
}
/**
*
* @param name The _unique_ name of the resulting resource.
* @param args The arguments to use to populate this resource's properties.
*/
public Mount(java.lang.String name, MountArgs args) {
this(name, args, null);
}
/**
*
* @param name The _unique_ name of the resulting resource.
* @param args The arguments to use to populate this resource's properties.
* @param options A bag of options that control this resource's behavior.
*/
public Mount(java.lang.String name, MountArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
super("vault:index/mount:Mount", name, makeArgs(args, options), makeResourceOptions(options, Codegen.empty()), false);
}
private Mount(java.lang.String name, Output id, @Nullable MountState state, @Nullable com.pulumi.resources.CustomResourceOptions options) {
super("vault:index/mount:Mount", name, state, makeResourceOptions(options, id), false);
}
private static MountArgs makeArgs(MountArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
if (options != null && options.getUrn().isPresent()) {
return null;
}
return args == null ? MountArgs.Empty : args;
}
private static com.pulumi.resources.CustomResourceOptions makeResourceOptions(@Nullable com.pulumi.resources.CustomResourceOptions options, @Nullable Output id) {
var defaultOptions = com.pulumi.resources.CustomResourceOptions.builder()
.version(Utilities.getVersion())
.build();
return com.pulumi.resources.CustomResourceOptions.merge(defaultOptions, options, id);
}
/**
* Get an existing Host resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state
* @param options Optional settings to control the behavior of the CustomResource.
*/
public static Mount get(java.lang.String name, Output id, @Nullable MountState state, @Nullable com.pulumi.resources.CustomResourceOptions options) {
return new Mount(name, id, state, options);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy