vault.RaftSnapshotAgentConfig
Explore with Pulumi AI
Import
Raft Snapshot Agent Configurations can be imported using the name
, e.g.
$ pulumi import vault:index/raftSnapshotAgentConfig:RaftSnapshotAgentConfig local local
Example Usage
Local Storage
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Vault = Pulumi.Vault;
return await Deployment.RunAsync(() =>
{
var localBackups = new Vault.RaftSnapshotAgentConfig("localBackups", new()
{
IntervalSeconds = 86400,
LocalMaxSpace = 10000000,
PathPrefix = "/opt/vault/snapshots/",
Retain = 7,
StorageType = "local",
});
});
package main
import (
"github.com/pulumi/pulumi-vault/sdk/v5/go/vault"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := vault.NewRaftSnapshotAgentConfig(ctx, "localBackups", &vault.RaftSnapshotAgentConfigArgs{
IntervalSeconds: pulumi.Int(86400),
LocalMaxSpace: pulumi.Int(10000000),
PathPrefix: pulumi.String("/opt/vault/snapshots/"),
Retain: pulumi.Int(7),
StorageType: pulumi.String("local"),
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.vault.RaftSnapshotAgentConfig;
import com.pulumi.vault.RaftSnapshotAgentConfigArgs;
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 localBackups = new RaftSnapshotAgentConfig("localBackups", RaftSnapshotAgentConfigArgs.builder()
.intervalSeconds(86400)
.localMaxSpace(10000000)
.pathPrefix("/opt/vault/snapshots/")
.retain(7)
.storageType("local")
.build());
}
}
import pulumi
import pulumi_vault as vault
local_backups = vault.RaftSnapshotAgentConfig("localBackups",
interval_seconds=86400,
local_max_space=10000000,
path_prefix="/opt/vault/snapshots/",
retain=7,
storage_type="local")
import * as pulumi from "@pulumi/pulumi";
import * as vault from "@pulumi/vault";
const localBackups = new vault.RaftSnapshotAgentConfig("localBackups", {
intervalSeconds: 86400,
localMaxSpace: 10000000,
pathPrefix: "/opt/vault/snapshots/",
retain: 7,
storageType: "local",
});
resources:
localBackups:
type: vault:RaftSnapshotAgentConfig
properties:
intervalSeconds: 86400
# 24h
# // Storage Type Configuration
localMaxSpace: 1e+07
pathPrefix: /opt/vault/snapshots/
retain: 7
storageType: local
AWS S3
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
using Vault = Pulumi.Vault;
return await Deployment.RunAsync(() =>
{
var config = new Config();
var awsAccessKeyId = config.RequireObject<dynamic>("awsAccessKeyId");
var awsSecretAccessKey = config.RequireObject<dynamic>("awsSecretAccessKey");
var current = Aws.GetRegion.Invoke();
var s3Backups = new Vault.RaftSnapshotAgentConfig("s3Backups", new()
{
IntervalSeconds = 86400,
Retain = 7,
PathPrefix = "/path/in/bucket",
StorageType = "aws-s3",
AwsS3Bucket = "my-bucket",
AwsS3Region = current.Apply(getRegionResult => getRegionResult.Name),
AwsAccessKeyId = awsAccessKeyId,
AwsSecretAccessKey = awsSecretAccessKey,
AwsS3EnableKms = true,
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v5/go/aws"
"github.com/pulumi/pulumi-vault/sdk/v5/go/vault"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
cfg := config.New(ctx, "")
awsAccessKeyId := cfg.RequireObject("awsAccessKeyId")
awsSecretAccessKey := cfg.RequireObject("awsSecretAccessKey")
current, err := aws.GetRegion(ctx, nil, nil)
if err != nil {
return err
}
_, err = vault.NewRaftSnapshotAgentConfig(ctx, "s3Backups", &vault.RaftSnapshotAgentConfigArgs{
IntervalSeconds: pulumi.Int(86400),
Retain: pulumi.Int(7),
PathPrefix: pulumi.String("/path/in/bucket"),
StorageType: pulumi.String("aws-s3"),
AwsS3Bucket: pulumi.String("my-bucket"),
AwsS3Region: *pulumi.String(current.Name),
AwsAccessKeyId: pulumi.Any(awsAccessKeyId),
AwsSecretAccessKey: pulumi.Any(awsSecretAccessKey),
AwsS3EnableKms: pulumi.Bool(true),
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.AwsFunctions;
import com.pulumi.aws.inputs.GetRegionArgs;
import com.pulumi.vault.RaftSnapshotAgentConfig;
import com.pulumi.vault.RaftSnapshotAgentConfigArgs;
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) {
final var config = ctx.config();
final var awsAccessKeyId = config.get("awsAccessKeyId");
final var awsSecretAccessKey = config.get("awsSecretAccessKey");
final var current = AwsFunctions.getRegion();
var s3Backups = new RaftSnapshotAgentConfig("s3Backups", RaftSnapshotAgentConfigArgs.builder()
.intervalSeconds(86400)
.retain(7)
.pathPrefix("/path/in/bucket")
.storageType("aws-s3")
.awsS3Bucket("my-bucket")
.awsS3Region(current.applyValue(getRegionResult -> getRegionResult.name()))
.awsAccessKeyId(awsAccessKeyId)
.awsSecretAccessKey(awsSecretAccessKey)
.awsS3EnableKms(true)
.build());
}
}
import pulumi
import pulumi_aws as aws
import pulumi_vault as vault
config = pulumi.Config()
aws_access_key_id = config.require_object("awsAccessKeyId")
aws_secret_access_key = config.require_object("awsSecretAccessKey")
current = aws.get_region()
s3_backups = vault.RaftSnapshotAgentConfig("s3Backups",
interval_seconds=86400,
retain=7,
path_prefix="/path/in/bucket",
storage_type="aws-s3",
aws_s3_bucket="my-bucket",
aws_s3_region=current.name,
aws_access_key_id=aws_access_key_id,
aws_secret_access_key=aws_secret_access_key,
aws_s3_enable_kms=True)
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
import * as vault from "@pulumi/vault";
const config = new pulumi.Config();
const awsAccessKeyId = config.requireObject("awsAccessKeyId");
const awsSecretAccessKey = config.requireObject("awsSecretAccessKey");
const current = aws.getRegion({});
const s3Backups = new vault.RaftSnapshotAgentConfig("s3Backups", {
intervalSeconds: 86400,
retain: 7,
pathPrefix: "/path/in/bucket",
storageType: "aws-s3",
awsS3Bucket: "my-bucket",
awsS3Region: current.then(current => current.name),
awsAccessKeyId: awsAccessKeyId,
awsSecretAccessKey: awsSecretAccessKey,
awsS3EnableKms: true,
});
configuration:
awsAccessKeyId:
type: dynamic
awsSecretAccessKey:
type: dynamic
resources:
s3Backups:
type: vault:RaftSnapshotAgentConfig
properties:
intervalSeconds: 86400
# 24h
retain: 7
pathPrefix: /path/in/bucket
storageType: aws-s3
# Storage Type Configuration
awsS3Bucket: my-bucket
awsS3Region: ${current.name}
awsAccessKeyId: ${awsAccessKeyId}
awsSecretAccessKey: ${awsSecretAccessKey}
awsS3EnableKms: true
variables:
current:
fn::invoke:
Function: aws:getRegion
Arguments: {}
Azure BLOB
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Vault = Pulumi.Vault;
return await Deployment.RunAsync(() =>
{
var config = new Config();
var azureAccountName = config.RequireObject<dynamic>("azureAccountName");
var azureAccountKey = config.RequireObject<dynamic>("azureAccountKey");
var azureBackups = new Vault.RaftSnapshotAgentConfig("azureBackups", new()
{
IntervalSeconds = 86400,
Retain = 7,
PathPrefix = "/",
StorageType = "azure-blob",
AzureContainerName = "vault-blob",
AzureAccountName = azureAccountName,
AzureAccountKey = azureAccountKey,
});
});
package main
import (
"github.com/pulumi/pulumi-vault/sdk/v5/go/vault"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
cfg := config.New(ctx, "")
azureAccountName := cfg.RequireObject("azureAccountName")
azureAccountKey := cfg.RequireObject("azureAccountKey")
_, err := vault.NewRaftSnapshotAgentConfig(ctx, "azureBackups", &vault.RaftSnapshotAgentConfigArgs{
IntervalSeconds: pulumi.Int(86400),
Retain: pulumi.Int(7),
PathPrefix: pulumi.String("/"),
StorageType: pulumi.String("azure-blob"),
AzureContainerName: pulumi.String("vault-blob"),
AzureAccountName: pulumi.Any(azureAccountName),
AzureAccountKey: pulumi.Any(azureAccountKey),
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.vault.RaftSnapshotAgentConfig;
import com.pulumi.vault.RaftSnapshotAgentConfigArgs;
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) {
final var config = ctx.config();
final var azureAccountName = config.get("azureAccountName");
final var azureAccountKey = config.get("azureAccountKey");
var azureBackups = new RaftSnapshotAgentConfig("azureBackups", RaftSnapshotAgentConfigArgs.builder()
.intervalSeconds(86400)
.retain(7)
.pathPrefix("/")
.storageType("azure-blob")
.azureContainerName("vault-blob")
.azureAccountName(azureAccountName)
.azureAccountKey(azureAccountKey)
.build());
}
}
import pulumi
import pulumi_vault as vault
config = pulumi.Config()
azure_account_name = config.require_object("azureAccountName")
azure_account_key = config.require_object("azureAccountKey")
azure_backups = vault.RaftSnapshotAgentConfig("azureBackups",
interval_seconds=86400,
retain=7,
path_prefix="/",
storage_type="azure-blob",
azure_container_name="vault-blob",
azure_account_name=azure_account_name,
azure_account_key=azure_account_key)
import * as pulumi from "@pulumi/pulumi";
import * as vault from "@pulumi/vault";
const config = new pulumi.Config();
const azureAccountName = config.requireObject("azureAccountName");
const azureAccountKey = config.requireObject("azureAccountKey");
const azureBackups = new vault.RaftSnapshotAgentConfig("azureBackups", {
intervalSeconds: 86400,
retain: 7,
pathPrefix: "/",
storageType: "azure-blob",
azureContainerName: "vault-blob",
azureAccountName: azureAccountName,
azureAccountKey: azureAccountKey,
});
configuration:
azureAccountName:
type: dynamic
azureAccountKey:
type: dynamic
resources:
azureBackups:
type: vault:RaftSnapshotAgentConfig
properties:
intervalSeconds: 86400
# 24h
retain: 7
pathPrefix: /
storageType: azure-blob
# Storage Type Configuration
azureContainerName: vault-blob
azureAccountName: ${azureAccountName}
azureAccountKey: ${azureAccountKey}
Create RaftSnapshotAgentConfig Resource
new RaftSnapshotAgentConfig(name: string, args: RaftSnapshotAgentConfigArgs, opts?: CustomResourceOptions);
@overload
def RaftSnapshotAgentConfig(resource_name: str,
opts: Optional[ResourceOptions] = None,
aws_access_key_id: Optional[str] = None,
aws_s3_bucket: Optional[str] = None,
aws_s3_disable_tls: Optional[bool] = None,
aws_s3_enable_kms: Optional[bool] = None,
aws_s3_endpoint: Optional[str] = None,
aws_s3_force_path_style: Optional[bool] = None,
aws_s3_kms_key: Optional[str] = None,
aws_s3_region: Optional[str] = None,
aws_s3_server_side_encryption: Optional[bool] = None,
aws_secret_access_key: Optional[str] = None,
aws_session_token: Optional[str] = None,
azure_account_key: Optional[str] = None,
azure_account_name: Optional[str] = None,
azure_blob_environment: Optional[str] = None,
azure_container_name: Optional[str] = None,
azure_endpoint: Optional[str] = None,
file_prefix: Optional[str] = None,
google_disable_tls: Optional[bool] = None,
google_endpoint: Optional[str] = None,
google_gcs_bucket: Optional[str] = None,
google_service_account_key: Optional[str] = None,
interval_seconds: Optional[int] = None,
local_max_space: Optional[int] = None,
name: Optional[str] = None,
namespace: Optional[str] = None,
path_prefix: Optional[str] = None,
retain: Optional[int] = None,
storage_type: Optional[str] = None)
@overload
def RaftSnapshotAgentConfig(resource_name: str,
args: RaftSnapshotAgentConfigArgs,
opts: Optional[ResourceOptions] = None)
func NewRaftSnapshotAgentConfig(ctx *Context, name string, args RaftSnapshotAgentConfigArgs, opts ...ResourceOption) (*RaftSnapshotAgentConfig, error)
public RaftSnapshotAgentConfig(string name, RaftSnapshotAgentConfigArgs args, CustomResourceOptions? opts = null)
public RaftSnapshotAgentConfig(String name, RaftSnapshotAgentConfigArgs args)
public RaftSnapshotAgentConfig(String name, RaftSnapshotAgentConfigArgs args, CustomResourceOptions options)
type: vault:RaftSnapshotAgentConfig
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args RaftSnapshotAgentConfigArgs
- 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 RaftSnapshotAgentConfigArgs
- 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 RaftSnapshotAgentConfigArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args RaftSnapshotAgentConfigArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args RaftSnapshotAgentConfigArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
RaftSnapshotAgentConfig 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 RaftSnapshotAgentConfig resource accepts the following input properties:
- Interval
Seconds int <required>
- Time (in seconds) between snapshots.- Path
Prefix string <required>
- Forstorage_type = "local"
, the directory to write the snapshots in. For cloud storage types, the bucket prefix to use. Typesazure-s3
andgoogle-gcs
require a trailing/
(slash). Typeslocal
andaws-s3
the trailing/
is optional.- Storage
Type string <required>
- One of "local", "azure-blob", "aws-s3", or "google-gcs". The remaining parameters described below are all specific to the selectedstorage_type
and prefixed accordingly.- Aws
Access stringKey Id AWS access key ID.
- Aws
S3Bucket string <required>
- S3 bucket to write snapshots to.- Aws
S3Disable boolTls Disable TLS for the S3 endpoint. This should only be used for testing purposes, typically in conjunction with
aws_s3_endpoint
.- Aws
S3Enable boolKms Use KMS to encrypt bucket contents.
- Aws
S3Endpoint string AWS endpoint. This is typically only set when using a non-AWS S3 implementation like Minio.
- Aws
S3Force boolPath Style Use the endpoint/bucket URL style instead of bucket.endpoint. May be needed when setting
aws_s3_endpoint
.- Aws
S3Kms stringKey Use named KMS key, when
aws_s3_enable_kms = true
- Aws
S3Region string <required>
- AWS region bucket is in.- Aws
S3Server boolSide Encryption Use AES256 to encrypt bucket contents.
- Aws
Secret stringAccess Key AWS secret access key.
- Aws
Session stringToken AWS session token.
- Azure
Account stringKey Azure account key.
- Azure
Account stringName Azure account name.
- Azure
Blob stringEnvironment Azure blob environment.
- Azure
Container stringName <required>
- Azure container name to write snapshots to.- Azure
Endpoint string Azure blob storage endpoint. This is typically only set when using a non-Azure implementation like Azurite.
- File
Prefix string Within the directory or bucket prefix given by
path_prefix
, the file or object name of snapshot files will start with this string.- Google
Disable boolTls Disable TLS for the GCS endpoint. This should only be used for testing purposes, typically in conjunction with
google_endpoint
.- Google
Endpoint string GCS endpoint. This is typically only set when using a non-Google GCS implementation like fake-gcs-server.
- Google
Gcs stringBucket <required>
- GCS bucket to write snapshots to.- Google
Service stringAccount Key Google service account key in JSON format. The raw value looks like this:
import * as pulumi from "@pulumi/pulumi";
import pulumi
using System.Collections.Generic; using System.Linq; using Pulumi;
return await Deployment.RunAsync(() => { });
package main import ( "github.com/pulumi/pulumi/sdk/v3/go/pulumi" ) func main() { pulumi.Run(func(ctx *pulumi.Context) error { return nil }) }
package generated_program; import com.pulumi.Context; import com.pulumi.Pulumi; import com.pulumi.core.Output; 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) { } }
{}
- Local
Max intSpace For
storage_type = local
, the maximum space, in bytes, to use for snapshots. Snapshot attempts will fail if there is not enough space left in this allowance.- Name string
<required>
– Name of the configuration to modify.- Namespace string
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. Available only for Vault Enterprise.- Retain int
How many snapshots are to be kept; when writing a snapshot, if there are more snapshots already stored than this number, the oldest ones will be deleted.
- Interval
Seconds int <required>
- Time (in seconds) between snapshots.- Path
Prefix string <required>
- Forstorage_type = "local"
, the directory to write the snapshots in. For cloud storage types, the bucket prefix to use. Typesazure-s3
andgoogle-gcs
require a trailing/
(slash). Typeslocal
andaws-s3
the trailing/
is optional.- Storage
Type string <required>
- One of "local", "azure-blob", "aws-s3", or "google-gcs". The remaining parameters described below are all specific to the selectedstorage_type
and prefixed accordingly.- Aws
Access stringKey Id AWS access key ID.
- Aws
S3Bucket string <required>
- S3 bucket to write snapshots to.- Aws
S3Disable boolTls Disable TLS for the S3 endpoint. This should only be used for testing purposes, typically in conjunction with
aws_s3_endpoint
.- Aws
S3Enable boolKms Use KMS to encrypt bucket contents.
- Aws
S3Endpoint string AWS endpoint. This is typically only set when using a non-AWS S3 implementation like Minio.
- Aws
S3Force boolPath Style Use the endpoint/bucket URL style instead of bucket.endpoint. May be needed when setting
aws_s3_endpoint
.- Aws
S3Kms stringKey Use named KMS key, when
aws_s3_enable_kms = true
- Aws
S3Region string <required>
- AWS region bucket is in.- Aws
S3Server boolSide Encryption Use AES256 to encrypt bucket contents.
- Aws
Secret stringAccess Key AWS secret access key.
- Aws
Session stringToken AWS session token.
- Azure
Account stringKey Azure account key.
- Azure
Account stringName Azure account name.
- Azure
Blob stringEnvironment Azure blob environment.
- Azure
Container stringName <required>
- Azure container name to write snapshots to.- Azure
Endpoint string Azure blob storage endpoint. This is typically only set when using a non-Azure implementation like Azurite.
- File
Prefix string Within the directory or bucket prefix given by
path_prefix
, the file or object name of snapshot files will start with this string.- Google
Disable boolTls Disable TLS for the GCS endpoint. This should only be used for testing purposes, typically in conjunction with
google_endpoint
.- Google
Endpoint string GCS endpoint. This is typically only set when using a non-Google GCS implementation like fake-gcs-server.
- Google
Gcs stringBucket <required>
- GCS bucket to write snapshots to.- Google
Service stringAccount Key Google service account key in JSON format. The raw value looks like this:
import * as pulumi from "@pulumi/pulumi";
import pulumi
using System.Collections.Generic; using System.Linq; using Pulumi;
return await Deployment.RunAsync(() => { });
package main import ( "github.com/pulumi/pulumi/sdk/v3/go/pulumi" ) func main() { pulumi.Run(func(ctx *pulumi.Context) error { return nil }) }
package generated_program; import com.pulumi.Context; import com.pulumi.Pulumi; import com.pulumi.core.Output; 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) { } }
{}
- Local
Max intSpace For
storage_type = local
, the maximum space, in bytes, to use for snapshots. Snapshot attempts will fail if there is not enough space left in this allowance.- Name string
<required>
– Name of the configuration to modify.- Namespace string
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. Available only for Vault Enterprise.- Retain int
How many snapshots are to be kept; when writing a snapshot, if there are more snapshots already stored than this number, the oldest ones will be deleted.
- interval
Seconds Integer <required>
- Time (in seconds) between snapshots.- path
Prefix String <required>
- Forstorage_type = "local"
, the directory to write the snapshots in. For cloud storage types, the bucket prefix to use. Typesazure-s3
andgoogle-gcs
require a trailing/
(slash). Typeslocal
andaws-s3
the trailing/
is optional.- storage
Type String <required>
- One of "local", "azure-blob", "aws-s3", or "google-gcs". The remaining parameters described below are all specific to the selectedstorage_type
and prefixed accordingly.- aws
Access StringKey Id AWS access key ID.
- aws
S3Bucket String <required>
- S3 bucket to write snapshots to.- aws
S3Disable BooleanTls Disable TLS for the S3 endpoint. This should only be used for testing purposes, typically in conjunction with
aws_s3_endpoint
.- aws
S3Enable BooleanKms Use KMS to encrypt bucket contents.
- aws
S3Endpoint String AWS endpoint. This is typically only set when using a non-AWS S3 implementation like Minio.
- aws
S3Force BooleanPath Style Use the endpoint/bucket URL style instead of bucket.endpoint. May be needed when setting
aws_s3_endpoint
.- aws
S3Kms StringKey Use named KMS key, when
aws_s3_enable_kms = true
- aws
S3Region String <required>
- AWS region bucket is in.- aws
S3Server BooleanSide Encryption Use AES256 to encrypt bucket contents.
- aws
Secret StringAccess Key AWS secret access key.
- aws
Session StringToken AWS session token.
- azure
Account StringKey Azure account key.
- azure
Account StringName Azure account name.
- azure
Blob StringEnvironment Azure blob environment.
- azure
Container StringName <required>
- Azure container name to write snapshots to.- azure
Endpoint String Azure blob storage endpoint. This is typically only set when using a non-Azure implementation like Azurite.
- file
Prefix String Within the directory or bucket prefix given by
path_prefix
, the file or object name of snapshot files will start with this string.- google
Disable BooleanTls Disable TLS for the GCS endpoint. This should only be used for testing purposes, typically in conjunction with
google_endpoint
.- google
Endpoint String GCS endpoint. This is typically only set when using a non-Google GCS implementation like fake-gcs-server.
- google
Gcs StringBucket <required>
- GCS bucket to write snapshots to.- google
Service StringAccount Key Google service account key in JSON format. The raw value looks like this:
import * as pulumi from "@pulumi/pulumi";
import pulumi
using System.Collections.Generic; using System.Linq; using Pulumi;
return await Deployment.RunAsync(() => { });
package main import ( "github.com/pulumi/pulumi/sdk/v3/go/pulumi" ) func main() { pulumi.Run(func(ctx *pulumi.Context) error { return nil }) }
package generated_program; import com.pulumi.Context; import com.pulumi.Pulumi; import com.pulumi.core.Output; 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) { } }
{}
- local
Max IntegerSpace For
storage_type = local
, the maximum space, in bytes, to use for snapshots. Snapshot attempts will fail if there is not enough space left in this allowance.- name String
<required>
– Name of the configuration to modify.- namespace String
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. Available only for Vault Enterprise.- retain Integer
How many snapshots are to be kept; when writing a snapshot, if there are more snapshots already stored than this number, the oldest ones will be deleted.
- interval
Seconds number <required>
- Time (in seconds) between snapshots.- path
Prefix string <required>
- Forstorage_type = "local"
, the directory to write the snapshots in. For cloud storage types, the bucket prefix to use. Typesazure-s3
andgoogle-gcs
require a trailing/
(slash). Typeslocal
andaws-s3
the trailing/
is optional.- storage
Type string <required>
- One of "local", "azure-blob", "aws-s3", or "google-gcs". The remaining parameters described below are all specific to the selectedstorage_type
and prefixed accordingly.- aws
Access stringKey Id AWS access key ID.
- aws
S3Bucket string <required>
- S3 bucket to write snapshots to.- aws
S3Disable booleanTls Disable TLS for the S3 endpoint. This should only be used for testing purposes, typically in conjunction with
aws_s3_endpoint
.- aws
S3Enable booleanKms Use KMS to encrypt bucket contents.
- aws
S3Endpoint string AWS endpoint. This is typically only set when using a non-AWS S3 implementation like Minio.
- aws
S3Force booleanPath Style Use the endpoint/bucket URL style instead of bucket.endpoint. May be needed when setting
aws_s3_endpoint
.- aws
S3Kms stringKey Use named KMS key, when
aws_s3_enable_kms = true
- aws
S3Region string <required>
- AWS region bucket is in.- aws
S3Server booleanSide Encryption Use AES256 to encrypt bucket contents.
- aws
Secret stringAccess Key AWS secret access key.
- aws
Session stringToken AWS session token.
- azure
Account stringKey Azure account key.
- azure
Account stringName Azure account name.
- azure
Blob stringEnvironment Azure blob environment.
- azure
Container stringName <required>
- Azure container name to write snapshots to.- azure
Endpoint string Azure blob storage endpoint. This is typically only set when using a non-Azure implementation like Azurite.
- file
Prefix string Within the directory or bucket prefix given by
path_prefix
, the file or object name of snapshot files will start with this string.- google
Disable booleanTls Disable TLS for the GCS endpoint. This should only be used for testing purposes, typically in conjunction with
google_endpoint
.- google
Endpoint string GCS endpoint. This is typically only set when using a non-Google GCS implementation like fake-gcs-server.
- google
Gcs stringBucket <required>
- GCS bucket to write snapshots to.- google
Service stringAccount Key Google service account key in JSON format. The raw value looks like this:
import * as pulumi from "@pulumi/pulumi";
import pulumi
using System.Collections.Generic; using System.Linq; using Pulumi;
return await Deployment.RunAsync(() => { });
package main import ( "github.com/pulumi/pulumi/sdk/v3/go/pulumi" ) func main() { pulumi.Run(func(ctx *pulumi.Context) error { return nil }) }
package generated_program; import com.pulumi.Context; import com.pulumi.Pulumi; import com.pulumi.core.Output; 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) { } }
{}
- local
Max numberSpace For
storage_type = local
, the maximum space, in bytes, to use for snapshots. Snapshot attempts will fail if there is not enough space left in this allowance.- name string
<required>
– Name of the configuration to modify.- namespace string
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. Available only for Vault Enterprise.- retain number
How many snapshots are to be kept; when writing a snapshot, if there are more snapshots already stored than this number, the oldest ones will be deleted.
- interval_
seconds int <required>
- Time (in seconds) between snapshots.- path_
prefix str <required>
- Forstorage_type = "local"
, the directory to write the snapshots in. For cloud storage types, the bucket prefix to use. Typesazure-s3
andgoogle-gcs
require a trailing/
(slash). Typeslocal
andaws-s3
the trailing/
is optional.- storage_
type str <required>
- One of "local", "azure-blob", "aws-s3", or "google-gcs". The remaining parameters described below are all specific to the selectedstorage_type
and prefixed accordingly.- aws_
access_ strkey_ id AWS access key ID.
- aws_
s3_ strbucket <required>
- S3 bucket to write snapshots to.- aws_
s3_ booldisable_ tls Disable TLS for the S3 endpoint. This should only be used for testing purposes, typically in conjunction with
aws_s3_endpoint
.- aws_
s3_ boolenable_ kms Use KMS to encrypt bucket contents.
- aws_
s3_ strendpoint AWS endpoint. This is typically only set when using a non-AWS S3 implementation like Minio.
- aws_
s3_ boolforce_ path_ style Use the endpoint/bucket URL style instead of bucket.endpoint. May be needed when setting
aws_s3_endpoint
.- aws_
s3_ strkms_ key Use named KMS key, when
aws_s3_enable_kms = true
- aws_
s3_ strregion <required>
- AWS region bucket is in.- aws_
s3_ boolserver_ side_ encryption Use AES256 to encrypt bucket contents.
- aws_
secret_ straccess_ key AWS secret access key.
- aws_
session_ strtoken AWS session token.
- azure_
account_ strkey Azure account key.
- azure_
account_ strname Azure account name.
- azure_
blob_ strenvironment Azure blob environment.
- azure_
container_ strname <required>
- Azure container name to write snapshots to.- azure_
endpoint str Azure blob storage endpoint. This is typically only set when using a non-Azure implementation like Azurite.
- file_
prefix str Within the directory or bucket prefix given by
path_prefix
, the file or object name of snapshot files will start with this string.- google_
disable_ booltls Disable TLS for the GCS endpoint. This should only be used for testing purposes, typically in conjunction with
google_endpoint
.- google_
endpoint str GCS endpoint. This is typically only set when using a non-Google GCS implementation like fake-gcs-server.
- google_
gcs_ strbucket <required>
- GCS bucket to write snapshots to.- google_
service_ straccount_ key Google service account key in JSON format. The raw value looks like this:
import * as pulumi from "@pulumi/pulumi";
import pulumi
using System.Collections.Generic; using System.Linq; using Pulumi;
return await Deployment.RunAsync(() => { });
package main import ( "github.com/pulumi/pulumi/sdk/v3/go/pulumi" ) func main() { pulumi.Run(func(ctx *pulumi.Context) error { return nil }) }
package generated_program; import com.pulumi.Context; import com.pulumi.Pulumi; import com.pulumi.core.Output; 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) { } }
{}
- local_
max_ intspace For
storage_type = local
, the maximum space, in bytes, to use for snapshots. Snapshot attempts will fail if there is not enough space left in this allowance.- name str
<required>
– Name of the configuration to modify.- namespace str
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. Available only for Vault Enterprise.- retain int
How many snapshots are to be kept; when writing a snapshot, if there are more snapshots already stored than this number, the oldest ones will be deleted.
- interval
Seconds Number <required>
- Time (in seconds) between snapshots.- path
Prefix String <required>
- Forstorage_type = "local"
, the directory to write the snapshots in. For cloud storage types, the bucket prefix to use. Typesazure-s3
andgoogle-gcs
require a trailing/
(slash). Typeslocal
andaws-s3
the trailing/
is optional.- storage
Type String <required>
- One of "local", "azure-blob", "aws-s3", or "google-gcs". The remaining parameters described below are all specific to the selectedstorage_type
and prefixed accordingly.- aws
Access StringKey Id AWS access key ID.
- aws
S3Bucket String <required>
- S3 bucket to write snapshots to.- aws
S3Disable BooleanTls Disable TLS for the S3 endpoint. This should only be used for testing purposes, typically in conjunction with
aws_s3_endpoint
.- aws
S3Enable BooleanKms Use KMS to encrypt bucket contents.
- aws
S3Endpoint String AWS endpoint. This is typically only set when using a non-AWS S3 implementation like Minio.
- aws
S3Force BooleanPath Style Use the endpoint/bucket URL style instead of bucket.endpoint. May be needed when setting
aws_s3_endpoint
.- aws
S3Kms StringKey Use named KMS key, when
aws_s3_enable_kms = true
- aws
S3Region String <required>
- AWS region bucket is in.- aws
S3Server BooleanSide Encryption Use AES256 to encrypt bucket contents.
- aws
Secret StringAccess Key AWS secret access key.
- aws
Session StringToken AWS session token.
- azure
Account StringKey Azure account key.
- azure
Account StringName Azure account name.
- azure
Blob StringEnvironment Azure blob environment.
- azure
Container StringName <required>
- Azure container name to write snapshots to.- azure
Endpoint String Azure blob storage endpoint. This is typically only set when using a non-Azure implementation like Azurite.
- file
Prefix String Within the directory or bucket prefix given by
path_prefix
, the file or object name of snapshot files will start with this string.- google
Disable BooleanTls Disable TLS for the GCS endpoint. This should only be used for testing purposes, typically in conjunction with
google_endpoint
.- google
Endpoint String GCS endpoint. This is typically only set when using a non-Google GCS implementation like fake-gcs-server.
- google
Gcs StringBucket <required>
- GCS bucket to write snapshots to.- google
Service StringAccount Key Google service account key in JSON format. The raw value looks like this:
import * as pulumi from "@pulumi/pulumi";
import pulumi
using System.Collections.Generic; using System.Linq; using Pulumi;
return await Deployment.RunAsync(() => { });
package main import ( "github.com/pulumi/pulumi/sdk/v3/go/pulumi" ) func main() { pulumi.Run(func(ctx *pulumi.Context) error { return nil }) }
package generated_program; import com.pulumi.Context; import com.pulumi.Pulumi; import com.pulumi.core.Output; 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) { } }
{}
- local
Max NumberSpace For
storage_type = local
, the maximum space, in bytes, to use for snapshots. Snapshot attempts will fail if there is not enough space left in this allowance.- name String
<required>
– Name of the configuration to modify.- namespace String
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. Available only for Vault Enterprise.- retain Number
How many snapshots are to be kept; when writing a snapshot, if there are more snapshots already stored than this number, the oldest ones will be deleted.
Outputs
All input properties are implicitly available as output properties. Additionally, the RaftSnapshotAgentConfig 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 RaftSnapshotAgentConfig Resource
Get an existing RaftSnapshotAgentConfig 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?: RaftSnapshotAgentConfigState, opts?: CustomResourceOptions): RaftSnapshotAgentConfig
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
aws_access_key_id: Optional[str] = None,
aws_s3_bucket: Optional[str] = None,
aws_s3_disable_tls: Optional[bool] = None,
aws_s3_enable_kms: Optional[bool] = None,
aws_s3_endpoint: Optional[str] = None,
aws_s3_force_path_style: Optional[bool] = None,
aws_s3_kms_key: Optional[str] = None,
aws_s3_region: Optional[str] = None,
aws_s3_server_side_encryption: Optional[bool] = None,
aws_secret_access_key: Optional[str] = None,
aws_session_token: Optional[str] = None,
azure_account_key: Optional[str] = None,
azure_account_name: Optional[str] = None,
azure_blob_environment: Optional[str] = None,
azure_container_name: Optional[str] = None,
azure_endpoint: Optional[str] = None,
file_prefix: Optional[str] = None,
google_disable_tls: Optional[bool] = None,
google_endpoint: Optional[str] = None,
google_gcs_bucket: Optional[str] = None,
google_service_account_key: Optional[str] = None,
interval_seconds: Optional[int] = None,
local_max_space: Optional[int] = None,
name: Optional[str] = None,
namespace: Optional[str] = None,
path_prefix: Optional[str] = None,
retain: Optional[int] = None,
storage_type: Optional[str] = None) -> RaftSnapshotAgentConfig
func GetRaftSnapshotAgentConfig(ctx *Context, name string, id IDInput, state *RaftSnapshotAgentConfigState, opts ...ResourceOption) (*RaftSnapshotAgentConfig, error)
public static RaftSnapshotAgentConfig Get(string name, Input<string> id, RaftSnapshotAgentConfigState? state, CustomResourceOptions? opts = null)
public static RaftSnapshotAgentConfig get(String name, Output<String> id, RaftSnapshotAgentConfigState 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.
- Aws
Access stringKey Id AWS access key ID.
- Aws
S3Bucket string <required>
- S3 bucket to write snapshots to.- Aws
S3Disable boolTls Disable TLS for the S3 endpoint. This should only be used for testing purposes, typically in conjunction with
aws_s3_endpoint
.- Aws
S3Enable boolKms Use KMS to encrypt bucket contents.
- Aws
S3Endpoint string AWS endpoint. This is typically only set when using a non-AWS S3 implementation like Minio.
- Aws
S3Force boolPath Style Use the endpoint/bucket URL style instead of bucket.endpoint. May be needed when setting
aws_s3_endpoint
.- Aws
S3Kms stringKey Use named KMS key, when
aws_s3_enable_kms = true
- Aws
S3Region string <required>
- AWS region bucket is in.- Aws
S3Server boolSide Encryption Use AES256 to encrypt bucket contents.
- Aws
Secret stringAccess Key AWS secret access key.
- Aws
Session stringToken AWS session token.
- Azure
Account stringKey Azure account key.
- Azure
Account stringName Azure account name.
- Azure
Blob stringEnvironment Azure blob environment.
- Azure
Container stringName <required>
- Azure container name to write snapshots to.- Azure
Endpoint string Azure blob storage endpoint. This is typically only set when using a non-Azure implementation like Azurite.
- File
Prefix string Within the directory or bucket prefix given by
path_prefix
, the file or object name of snapshot files will start with this string.- Google
Disable boolTls Disable TLS for the GCS endpoint. This should only be used for testing purposes, typically in conjunction with
google_endpoint
.- Google
Endpoint string GCS endpoint. This is typically only set when using a non-Google GCS implementation like fake-gcs-server.
- Google
Gcs stringBucket <required>
- GCS bucket to write snapshots to.- Google
Service stringAccount Key Google service account key in JSON format. The raw value looks like this:
import * as pulumi from "@pulumi/pulumi";
import pulumi
using System.Collections.Generic; using System.Linq; using Pulumi;
return await Deployment.RunAsync(() => { });
package main import ( "github.com/pulumi/pulumi/sdk/v3/go/pulumi" ) func main() { pulumi.Run(func(ctx *pulumi.Context) error { return nil }) }
package generated_program; import com.pulumi.Context; import com.pulumi.Pulumi; import com.pulumi.core.Output; 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) { } }
{}
- Interval
Seconds int <required>
- Time (in seconds) between snapshots.- Local
Max intSpace For
storage_type = local
, the maximum space, in bytes, to use for snapshots. Snapshot attempts will fail if there is not enough space left in this allowance.- Name string
<required>
– Name of the configuration to modify.- Namespace string
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. Available only for Vault Enterprise.- Path
Prefix string <required>
- Forstorage_type = "local"
, the directory to write the snapshots in. For cloud storage types, the bucket prefix to use. Typesazure-s3
andgoogle-gcs
require a trailing/
(slash). Typeslocal
andaws-s3
the trailing/
is optional.- Retain int
How many snapshots are to be kept; when writing a snapshot, if there are more snapshots already stored than this number, the oldest ones will be deleted.
- Storage
Type string <required>
- One of "local", "azure-blob", "aws-s3", or "google-gcs". The remaining parameters described below are all specific to the selectedstorage_type
and prefixed accordingly.
- Aws
Access stringKey Id AWS access key ID.
- Aws
S3Bucket string <required>
- S3 bucket to write snapshots to.- Aws
S3Disable boolTls Disable TLS for the S3 endpoint. This should only be used for testing purposes, typically in conjunction with
aws_s3_endpoint
.- Aws
S3Enable boolKms Use KMS to encrypt bucket contents.
- Aws
S3Endpoint string AWS endpoint. This is typically only set when using a non-AWS S3 implementation like Minio.
- Aws
S3Force boolPath Style Use the endpoint/bucket URL style instead of bucket.endpoint. May be needed when setting
aws_s3_endpoint
.- Aws
S3Kms stringKey Use named KMS key, when
aws_s3_enable_kms = true
- Aws
S3Region string <required>
- AWS region bucket is in.- Aws
S3Server boolSide Encryption Use AES256 to encrypt bucket contents.
- Aws
Secret stringAccess Key AWS secret access key.
- Aws
Session stringToken AWS session token.
- Azure
Account stringKey Azure account key.
- Azure
Account stringName Azure account name.
- Azure
Blob stringEnvironment Azure blob environment.
- Azure
Container stringName <required>
- Azure container name to write snapshots to.- Azure
Endpoint string Azure blob storage endpoint. This is typically only set when using a non-Azure implementation like Azurite.
- File
Prefix string Within the directory or bucket prefix given by
path_prefix
, the file or object name of snapshot files will start with this string.- Google
Disable boolTls Disable TLS for the GCS endpoint. This should only be used for testing purposes, typically in conjunction with
google_endpoint
.- Google
Endpoint string GCS endpoint. This is typically only set when using a non-Google GCS implementation like fake-gcs-server.
- Google
Gcs stringBucket <required>
- GCS bucket to write snapshots to.- Google
Service stringAccount Key Google service account key in JSON format. The raw value looks like this:
import * as pulumi from "@pulumi/pulumi";
import pulumi
using System.Collections.Generic; using System.Linq; using Pulumi;
return await Deployment.RunAsync(() => { });
package main import ( "github.com/pulumi/pulumi/sdk/v3/go/pulumi" ) func main() { pulumi.Run(func(ctx *pulumi.Context) error { return nil }) }
package generated_program; import com.pulumi.Context; import com.pulumi.Pulumi; import com.pulumi.core.Output; 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) { } }
{}
- Interval
Seconds int <required>
- Time (in seconds) between snapshots.- Local
Max intSpace For
storage_type = local
, the maximum space, in bytes, to use for snapshots. Snapshot attempts will fail if there is not enough space left in this allowance.- Name string
<required>
– Name of the configuration to modify.- Namespace string
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. Available only for Vault Enterprise.- Path
Prefix string <required>
- Forstorage_type = "local"
, the directory to write the snapshots in. For cloud storage types, the bucket prefix to use. Typesazure-s3
andgoogle-gcs
require a trailing/
(slash). Typeslocal
andaws-s3
the trailing/
is optional.- Retain int
How many snapshots are to be kept; when writing a snapshot, if there are more snapshots already stored than this number, the oldest ones will be deleted.
- Storage
Type string <required>
- One of "local", "azure-blob", "aws-s3", or "google-gcs". The remaining parameters described below are all specific to the selectedstorage_type
and prefixed accordingly.
- aws
Access StringKey Id AWS access key ID.
- aws
S3Bucket String <required>
- S3 bucket to write snapshots to.- aws
S3Disable BooleanTls Disable TLS for the S3 endpoint. This should only be used for testing purposes, typically in conjunction with
aws_s3_endpoint
.- aws
S3Enable BooleanKms Use KMS to encrypt bucket contents.
- aws
S3Endpoint String AWS endpoint. This is typically only set when using a non-AWS S3 implementation like Minio.
- aws
S3Force BooleanPath Style Use the endpoint/bucket URL style instead of bucket.endpoint. May be needed when setting
aws_s3_endpoint
.- aws
S3Kms StringKey Use named KMS key, when
aws_s3_enable_kms = true
- aws
S3Region String <required>
- AWS region bucket is in.- aws
S3Server BooleanSide Encryption Use AES256 to encrypt bucket contents.
- aws
Secret StringAccess Key AWS secret access key.
- aws
Session StringToken AWS session token.
- azure
Account StringKey Azure account key.
- azure
Account StringName Azure account name.
- azure
Blob StringEnvironment Azure blob environment.
- azure
Container StringName <required>
- Azure container name to write snapshots to.- azure
Endpoint String Azure blob storage endpoint. This is typically only set when using a non-Azure implementation like Azurite.
- file
Prefix String Within the directory or bucket prefix given by
path_prefix
, the file or object name of snapshot files will start with this string.- google
Disable BooleanTls Disable TLS for the GCS endpoint. This should only be used for testing purposes, typically in conjunction with
google_endpoint
.- google
Endpoint String GCS endpoint. This is typically only set when using a non-Google GCS implementation like fake-gcs-server.
- google
Gcs StringBucket <required>
- GCS bucket to write snapshots to.- google
Service StringAccount Key Google service account key in JSON format. The raw value looks like this:
import * as pulumi from "@pulumi/pulumi";
import pulumi
using System.Collections.Generic; using System.Linq; using Pulumi;
return await Deployment.RunAsync(() => { });
package main import ( "github.com/pulumi/pulumi/sdk/v3/go/pulumi" ) func main() { pulumi.Run(func(ctx *pulumi.Context) error { return nil }) }
package generated_program; import com.pulumi.Context; import com.pulumi.Pulumi; import com.pulumi.core.Output; 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) { } }
{}
- interval
Seconds Integer <required>
- Time (in seconds) between snapshots.- local
Max IntegerSpace For
storage_type = local
, the maximum space, in bytes, to use for snapshots. Snapshot attempts will fail if there is not enough space left in this allowance.- name String
<required>
– Name of the configuration to modify.- namespace String
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. Available only for Vault Enterprise.- path
Prefix String <required>
- Forstorage_type = "local"
, the directory to write the snapshots in. For cloud storage types, the bucket prefix to use. Typesazure-s3
andgoogle-gcs
require a trailing/
(slash). Typeslocal
andaws-s3
the trailing/
is optional.- retain Integer
How many snapshots are to be kept; when writing a snapshot, if there are more snapshots already stored than this number, the oldest ones will be deleted.
- storage
Type String <required>
- One of "local", "azure-blob", "aws-s3", or "google-gcs". The remaining parameters described below are all specific to the selectedstorage_type
and prefixed accordingly.
- aws
Access stringKey Id AWS access key ID.
- aws
S3Bucket string <required>
- S3 bucket to write snapshots to.- aws
S3Disable booleanTls Disable TLS for the S3 endpoint. This should only be used for testing purposes, typically in conjunction with
aws_s3_endpoint
.- aws
S3Enable booleanKms Use KMS to encrypt bucket contents.
- aws
S3Endpoint string AWS endpoint. This is typically only set when using a non-AWS S3 implementation like Minio.
- aws
S3Force booleanPath Style Use the endpoint/bucket URL style instead of bucket.endpoint. May be needed when setting
aws_s3_endpoint
.- aws
S3Kms stringKey Use named KMS key, when
aws_s3_enable_kms = true
- aws
S3Region string <required>
- AWS region bucket is in.- aws
S3Server booleanSide Encryption Use AES256 to encrypt bucket contents.
- aws
Secret stringAccess Key AWS secret access key.
- aws
Session stringToken AWS session token.
- azure
Account stringKey Azure account key.
- azure
Account stringName Azure account name.
- azure
Blob stringEnvironment Azure blob environment.
- azure
Container stringName <required>
- Azure container name to write snapshots to.- azure
Endpoint string Azure blob storage endpoint. This is typically only set when using a non-Azure implementation like Azurite.
- file
Prefix string Within the directory or bucket prefix given by
path_prefix
, the file or object name of snapshot files will start with this string.- google
Disable booleanTls Disable TLS for the GCS endpoint. This should only be used for testing purposes, typically in conjunction with
google_endpoint
.- google
Endpoint string GCS endpoint. This is typically only set when using a non-Google GCS implementation like fake-gcs-server.
- google
Gcs stringBucket <required>
- GCS bucket to write snapshots to.- google
Service stringAccount Key Google service account key in JSON format. The raw value looks like this:
import * as pulumi from "@pulumi/pulumi";
import pulumi
using System.Collections.Generic; using System.Linq; using Pulumi;
return await Deployment.RunAsync(() => { });
package main import ( "github.com/pulumi/pulumi/sdk/v3/go/pulumi" ) func main() { pulumi.Run(func(ctx *pulumi.Context) error { return nil }) }
package generated_program; import com.pulumi.Context; import com.pulumi.Pulumi; import com.pulumi.core.Output; 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) { } }
{}
- interval
Seconds number <required>
- Time (in seconds) between snapshots.- local
Max numberSpace For
storage_type = local
, the maximum space, in bytes, to use for snapshots. Snapshot attempts will fail if there is not enough space left in this allowance.- name string
<required>
– Name of the configuration to modify.- namespace string
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. Available only for Vault Enterprise.- path
Prefix string <required>
- Forstorage_type = "local"
, the directory to write the snapshots in. For cloud storage types, the bucket prefix to use. Typesazure-s3
andgoogle-gcs
require a trailing/
(slash). Typeslocal
andaws-s3
the trailing/
is optional.- retain number
How many snapshots are to be kept; when writing a snapshot, if there are more snapshots already stored than this number, the oldest ones will be deleted.
- storage
Type string <required>
- One of "local", "azure-blob", "aws-s3", or "google-gcs". The remaining parameters described below are all specific to the selectedstorage_type
and prefixed accordingly.
- aws_
access_ strkey_ id AWS access key ID.
- aws_
s3_ strbucket <required>
- S3 bucket to write snapshots to.- aws_
s3_ booldisable_ tls Disable TLS for the S3 endpoint. This should only be used for testing purposes, typically in conjunction with
aws_s3_endpoint
.- aws_
s3_ boolenable_ kms Use KMS to encrypt bucket contents.
- aws_
s3_ strendpoint AWS endpoint. This is typically only set when using a non-AWS S3 implementation like Minio.
- aws_
s3_ boolforce_ path_ style Use the endpoint/bucket URL style instead of bucket.endpoint. May be needed when setting
aws_s3_endpoint
.- aws_
s3_ strkms_ key Use named KMS key, when
aws_s3_enable_kms = true
- aws_
s3_ strregion <required>
- AWS region bucket is in.- aws_
s3_ boolserver_ side_ encryption Use AES256 to encrypt bucket contents.
- aws_
secret_ straccess_ key AWS secret access key.
- aws_
session_ strtoken AWS session token.
- azure_
account_ strkey Azure account key.
- azure_
account_ strname Azure account name.
- azure_
blob_ strenvironment Azure blob environment.
- azure_
container_ strname <required>
- Azure container name to write snapshots to.- azure_
endpoint str Azure blob storage endpoint. This is typically only set when using a non-Azure implementation like Azurite.
- file_
prefix str Within the directory or bucket prefix given by
path_prefix
, the file or object name of snapshot files will start with this string.- google_
disable_ booltls Disable TLS for the GCS endpoint. This should only be used for testing purposes, typically in conjunction with
google_endpoint
.- google_
endpoint str GCS endpoint. This is typically only set when using a non-Google GCS implementation like fake-gcs-server.
- google_
gcs_ strbucket <required>
- GCS bucket to write snapshots to.- google_
service_ straccount_ key Google service account key in JSON format. The raw value looks like this:
import * as pulumi from "@pulumi/pulumi";
import pulumi
using System.Collections.Generic; using System.Linq; using Pulumi;
return await Deployment.RunAsync(() => { });
package main import ( "github.com/pulumi/pulumi/sdk/v3/go/pulumi" ) func main() { pulumi.Run(func(ctx *pulumi.Context) error { return nil }) }
package generated_program; import com.pulumi.Context; import com.pulumi.Pulumi; import com.pulumi.core.Output; 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) { } }
{}
- interval_
seconds int <required>
- Time (in seconds) between snapshots.- local_
max_ intspace For
storage_type = local
, the maximum space, in bytes, to use for snapshots. Snapshot attempts will fail if there is not enough space left in this allowance.- name str
<required>
– Name of the configuration to modify.- namespace str
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. Available only for Vault Enterprise.- path_
prefix str <required>
- Forstorage_type = "local"
, the directory to write the snapshots in. For cloud storage types, the bucket prefix to use. Typesazure-s3
andgoogle-gcs
require a trailing/
(slash). Typeslocal
andaws-s3
the trailing/
is optional.- retain int
How many snapshots are to be kept; when writing a snapshot, if there are more snapshots already stored than this number, the oldest ones will be deleted.
- storage_
type str <required>
- One of "local", "azure-blob", "aws-s3", or "google-gcs". The remaining parameters described below are all specific to the selectedstorage_type
and prefixed accordingly.
- aws
Access StringKey Id AWS access key ID.
- aws
S3Bucket String <required>
- S3 bucket to write snapshots to.- aws
S3Disable BooleanTls Disable TLS for the S3 endpoint. This should only be used for testing purposes, typically in conjunction with
aws_s3_endpoint
.- aws
S3Enable BooleanKms Use KMS to encrypt bucket contents.
- aws
S3Endpoint String AWS endpoint. This is typically only set when using a non-AWS S3 implementation like Minio.
- aws
S3Force BooleanPath Style Use the endpoint/bucket URL style instead of bucket.endpoint. May be needed when setting
aws_s3_endpoint
.- aws
S3Kms StringKey Use named KMS key, when
aws_s3_enable_kms = true
- aws
S3Region String <required>
- AWS region bucket is in.- aws
S3Server BooleanSide Encryption Use AES256 to encrypt bucket contents.
- aws
Secret StringAccess Key AWS secret access key.
- aws
Session StringToken AWS session token.
- azure
Account StringKey Azure account key.
- azure
Account StringName Azure account name.
- azure
Blob StringEnvironment Azure blob environment.
- azure
Container StringName <required>
- Azure container name to write snapshots to.- azure
Endpoint String Azure blob storage endpoint. This is typically only set when using a non-Azure implementation like Azurite.
- file
Prefix String Within the directory or bucket prefix given by
path_prefix
, the file or object name of snapshot files will start with this string.- google
Disable BooleanTls Disable TLS for the GCS endpoint. This should only be used for testing purposes, typically in conjunction with
google_endpoint
.- google
Endpoint String GCS endpoint. This is typically only set when using a non-Google GCS implementation like fake-gcs-server.
- google
Gcs StringBucket <required>
- GCS bucket to write snapshots to.- google
Service StringAccount Key Google service account key in JSON format. The raw value looks like this:
import * as pulumi from "@pulumi/pulumi";
import pulumi
using System.Collections.Generic; using System.Linq; using Pulumi;
return await Deployment.RunAsync(() => { });
package main import ( "github.com/pulumi/pulumi/sdk/v3/go/pulumi" ) func main() { pulumi.Run(func(ctx *pulumi.Context) error { return nil }) }
package generated_program; import com.pulumi.Context; import com.pulumi.Pulumi; import com.pulumi.core.Output; 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) { } }
{}
- interval
Seconds Number <required>
- Time (in seconds) between snapshots.- local
Max NumberSpace For
storage_type = local
, the maximum space, in bytes, to use for snapshots. Snapshot attempts will fail if there is not enough space left in this allowance.- name String
<required>
– Name of the configuration to modify.- namespace String
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. Available only for Vault Enterprise.- path
Prefix String <required>
- Forstorage_type = "local"
, the directory to write the snapshots in. For cloud storage types, the bucket prefix to use. Typesazure-s3
andgoogle-gcs
require a trailing/
(slash). Typeslocal
andaws-s3
the trailing/
is optional.- retain Number
How many snapshots are to be kept; when writing a snapshot, if there are more snapshots already stored than this number, the oldest ones will be deleted.
- storage
Type String <required>
- One of "local", "azure-blob", "aws-s3", or "google-gcs". The remaining parameters described below are all specific to the selectedstorage_type
and prefixed accordingly.
Package Details
- Repository
- Vault pulumi/pulumi-vault
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
vault
Terraform Provider.