Skip to content

Latest commit

 

History

History
2046 lines (1294 loc) · 88 KB

raftSnapshotAgentConfig.csharp.md

File metadata and controls

2046 lines (1294 loc) · 88 KB

raftSnapshotAgentConfig Submodule

Constructs

RaftSnapshotAgentConfig

Represents a {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/raft_snapshot_agent_config vault_raft_snapshot_agent_config}.

Initializers

using HashiCorp.Cdktf.Providers.Vault;

new RaftSnapshotAgentConfig(Construct Scope, string Id, RaftSnapshotAgentConfigConfig Config);
Name Type Description
Scope Constructs.Construct The scope in which to define this construct.
Id string The scoped construct ID.
Config RaftSnapshotAgentConfigConfig No description.

ScopeRequired
  • Type: Constructs.Construct

The scope in which to define this construct.


IdRequired
  • Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope


ConfigRequired

Methods

Name Description
ToString Returns a string representation of this construct.
AddOverride No description.
OverrideLogicalId Overrides the auto-generated logical ID with a specific ID.
ResetOverrideLogicalId Resets a previously passed logical Id to use the auto-generated logical id again.
ToHclTerraform No description.
ToMetadata No description.
ToTerraform Adds this resource to the terraform JSON output.
AddMoveTarget Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
GetAnyMapAttribute No description.
GetBooleanAttribute No description.
GetBooleanMapAttribute No description.
GetListAttribute No description.
GetNumberAttribute No description.
GetNumberListAttribute No description.
GetNumberMapAttribute No description.
GetStringAttribute No description.
GetStringMapAttribute No description.
HasResourceMove No description.
ImportFrom No description.
InterpolationForAttribute No description.
MoveFromId Move the resource corresponding to "id" to this resource.
MoveTo Moves this resource to the target resource given by moveTarget.
MoveToId Moves this resource to the resource corresponding to "id".
ResetAwsAccessKeyId No description.
ResetAwsS3Bucket No description.
ResetAwsS3DisableTls No description.
ResetAwsS3EnableKms No description.
ResetAwsS3Endpoint No description.
ResetAwsS3ForcePathStyle No description.
ResetAwsS3KmsKey No description.
ResetAwsS3Region No description.
ResetAwsS3ServerSideEncryption No description.
ResetAwsSecretAccessKey No description.
ResetAwsSessionToken No description.
ResetAzureAccountKey No description.
ResetAzureAccountName No description.
ResetAzureBlobEnvironment No description.
ResetAzureContainerName No description.
ResetAzureEndpoint No description.
ResetFilePrefix No description.
ResetGoogleDisableTls No description.
ResetGoogleEndpoint No description.
ResetGoogleGcsBucket No description.
ResetGoogleServiceAccountKey No description.
ResetId No description.
ResetLocalMaxSpace No description.
ResetNamespace No description.
ResetRetain No description.

ToString
private string ToString()

Returns a string representation of this construct.

AddOverride
private void AddOverride(string Path, object Value)
PathRequired
  • Type: string

ValueRequired
  • Type: object

OverrideLogicalId
private void OverrideLogicalId(string NewLogicalId)

Overrides the auto-generated logical ID with a specific ID.

NewLogicalIdRequired
  • Type: string

The new logical ID to use for this stack element.


ResetOverrideLogicalId
private void ResetOverrideLogicalId()

Resets a previously passed logical Id to use the auto-generated logical id again.

ToHclTerraform
private object ToHclTerraform()
ToMetadata
private object ToMetadata()
ToTerraform
private object ToTerraform()

Adds this resource to the terraform JSON output.

AddMoveTarget
private void AddMoveTarget(string MoveTarget)

Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.

MoveTargetRequired
  • Type: string

The string move target that will correspond to this resource.


GetAnyMapAttribute
private System.Collections.Generic.IDictionary<string, object> GetAnyMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetBooleanAttribute
private IResolvable GetBooleanAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetBooleanMapAttribute
private System.Collections.Generic.IDictionary<string, bool> GetBooleanMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetListAttribute
private string[] GetListAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetNumberAttribute
private double GetNumberAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetNumberListAttribute
private double[] GetNumberListAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetNumberMapAttribute
private System.Collections.Generic.IDictionary<string, double> GetNumberMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetStringAttribute
private string GetStringAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetStringMapAttribute
private System.Collections.Generic.IDictionary<string, string> GetStringMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

HasResourceMove
private object HasResourceMove()
ImportFrom
private void ImportFrom(string Id, TerraformProvider Provider = null)
IdRequired
  • Type: string

ProviderOptional
  • Type: HashiCorp.Cdktf.TerraformProvider

InterpolationForAttribute
private IResolvable InterpolationForAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

MoveFromId
private void MoveFromId(string Id)

Move the resource corresponding to "id" to this resource.

Note that the resource being moved from must be marked as moved using it's instance function.

IdRequired
  • Type: string

Full id of resource being moved from, e.g. "aws_s3_bucket.example".


MoveTo
private void MoveTo(string MoveTarget, object Index = null)

Moves this resource to the target resource given by moveTarget.

MoveTargetRequired
  • Type: string

The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.


IndexOptional
  • Type: object

Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.


MoveToId
private void MoveToId(string Id)

Moves this resource to the resource corresponding to "id".

IdRequired
  • Type: string

Full id of resource to move to, e.g. "aws_s3_bucket.example".


ResetAwsAccessKeyId
private void ResetAwsAccessKeyId()
ResetAwsS3Bucket
private void ResetAwsS3Bucket()
ResetAwsS3DisableTls
private void ResetAwsS3DisableTls()
ResetAwsS3EnableKms
private void ResetAwsS3EnableKms()
ResetAwsS3Endpoint
private void ResetAwsS3Endpoint()
ResetAwsS3ForcePathStyle
private void ResetAwsS3ForcePathStyle()
ResetAwsS3KmsKey
private void ResetAwsS3KmsKey()
ResetAwsS3Region
private void ResetAwsS3Region()
ResetAwsS3ServerSideEncryption
private void ResetAwsS3ServerSideEncryption()
ResetAwsSecretAccessKey
private void ResetAwsSecretAccessKey()
ResetAwsSessionToken
private void ResetAwsSessionToken()
ResetAzureAccountKey
private void ResetAzureAccountKey()
ResetAzureAccountName
private void ResetAzureAccountName()
ResetAzureBlobEnvironment
private void ResetAzureBlobEnvironment()
ResetAzureContainerName
private void ResetAzureContainerName()
ResetAzureEndpoint
private void ResetAzureEndpoint()
ResetFilePrefix
private void ResetFilePrefix()
ResetGoogleDisableTls
private void ResetGoogleDisableTls()
ResetGoogleEndpoint
private void ResetGoogleEndpoint()
ResetGoogleGcsBucket
private void ResetGoogleGcsBucket()
ResetGoogleServiceAccountKey
private void ResetGoogleServiceAccountKey()
ResetId
private void ResetId()
ResetLocalMaxSpace
private void ResetLocalMaxSpace()
ResetNamespace
private void ResetNamespace()
ResetRetain
private void ResetRetain()

Static Functions

Name Description
IsConstruct Checks if x is a construct.
IsTerraformElement No description.
IsTerraformResource No description.
GenerateConfigForImport Generates CDKTF code for importing a RaftSnapshotAgentConfig resource upon running "cdktf plan ".

IsConstruct
using HashiCorp.Cdktf.Providers.Vault;

RaftSnapshotAgentConfig.IsConstruct(object X);

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

XRequired
  • Type: object

Any object.


IsTerraformElement
using HashiCorp.Cdktf.Providers.Vault;

RaftSnapshotAgentConfig.IsTerraformElement(object X);
XRequired
  • Type: object

IsTerraformResource
using HashiCorp.Cdktf.Providers.Vault;

RaftSnapshotAgentConfig.IsTerraformResource(object X);
XRequired
  • Type: object

GenerateConfigForImport
using HashiCorp.Cdktf.Providers.Vault;

RaftSnapshotAgentConfig.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null);

Generates CDKTF code for importing a RaftSnapshotAgentConfig resource upon running "cdktf plan ".

ScopeRequired
  • Type: Constructs.Construct

The scope in which to define this construct.


ImportToIdRequired
  • Type: string

The construct id used in the generated config for the RaftSnapshotAgentConfig to import.


ImportFromIdRequired
  • Type: string

The id of the existing RaftSnapshotAgentConfig that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/raft_snapshot_agent_config#import import section} in the documentation of this resource for the id to use


ProviderOptional
  • Type: HashiCorp.Cdktf.TerraformProvider

? Optional instance of the provider where the RaftSnapshotAgentConfig to import is found.


Properties

Name Type Description
Node Constructs.Node The tree node.
CdktfStack HashiCorp.Cdktf.TerraformStack No description.
Fqn string No description.
FriendlyUniqueId string No description.
TerraformMetaArguments System.Collections.Generic.IDictionary<string, object> No description.
TerraformResourceType string No description.
TerraformGeneratorMetadata HashiCorp.Cdktf.TerraformProviderGeneratorMetadata No description.
Connection object No description.
Count object No description.
DependsOn string[] No description.
ForEach HashiCorp.Cdktf.ITerraformIterator No description.
Lifecycle HashiCorp.Cdktf.TerraformResourceLifecycle No description.
Provider HashiCorp.Cdktf.TerraformProvider No description.
Provisioners object[] No description.
AwsAccessKeyIdInput string No description.
AwsS3BucketInput string No description.
AwsS3DisableTlsInput object No description.
AwsS3EnableKmsInput object No description.
AwsS3EndpointInput string No description.
AwsS3ForcePathStyleInput object No description.
AwsS3KmsKeyInput string No description.
AwsS3RegionInput string No description.
AwsS3ServerSideEncryptionInput object No description.
AwsSecretAccessKeyInput string No description.
AwsSessionTokenInput string No description.
AzureAccountKeyInput string No description.
AzureAccountNameInput string No description.
AzureBlobEnvironmentInput string No description.
AzureContainerNameInput string No description.
AzureEndpointInput string No description.
FilePrefixInput string No description.
GoogleDisableTlsInput object No description.
GoogleEndpointInput string No description.
GoogleGcsBucketInput string No description.
GoogleServiceAccountKeyInput string No description.
IdInput string No description.
IntervalSecondsInput double No description.
LocalMaxSpaceInput double No description.
NameInput string No description.
NamespaceInput string No description.
PathPrefixInput string No description.
RetainInput double No description.
StorageTypeInput string No description.
AwsAccessKeyId string No description.
AwsS3Bucket string No description.
AwsS3DisableTls object No description.
AwsS3EnableKms object No description.
AwsS3Endpoint string No description.
AwsS3ForcePathStyle object No description.
AwsS3KmsKey string No description.
AwsS3Region string No description.
AwsS3ServerSideEncryption object No description.
AwsSecretAccessKey string No description.
AwsSessionToken string No description.
AzureAccountKey string No description.
AzureAccountName string No description.
AzureBlobEnvironment string No description.
AzureContainerName string No description.
AzureEndpoint string No description.
FilePrefix string No description.
GoogleDisableTls object No description.
GoogleEndpoint string No description.
GoogleGcsBucket string No description.
GoogleServiceAccountKey string No description.
Id string No description.
IntervalSeconds double No description.
LocalMaxSpace double No description.
Name string No description.
Namespace string No description.
PathPrefix string No description.
Retain double No description.
StorageType string No description.

NodeRequired
public Node Node { get; }
  • Type: Constructs.Node

The tree node.


CdktfStackRequired
public TerraformStack CdktfStack { get; }
  • Type: HashiCorp.Cdktf.TerraformStack

FqnRequired
public string Fqn { get; }
  • Type: string

FriendlyUniqueIdRequired
public string FriendlyUniqueId { get; }
  • Type: string

TerraformMetaArgumentsRequired
public System.Collections.Generic.IDictionary<string, object> TerraformMetaArguments { get; }
  • Type: System.Collections.Generic.IDictionary<string, object>

TerraformResourceTypeRequired
public string TerraformResourceType { get; }
  • Type: string

TerraformGeneratorMetadataOptional
public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; }
  • Type: HashiCorp.Cdktf.TerraformProviderGeneratorMetadata

ConnectionOptional
public object Connection { get; }
  • Type: object

CountOptional
public object Count { get; }
  • Type: object

DependsOnOptional
public string[] DependsOn { get; }
  • Type: string[]

ForEachOptional
public ITerraformIterator ForEach { get; }
  • Type: HashiCorp.Cdktf.ITerraformIterator

LifecycleOptional
public TerraformResourceLifecycle Lifecycle { get; }
  • Type: HashiCorp.Cdktf.TerraformResourceLifecycle

ProviderOptional
public TerraformProvider Provider { get; }
  • Type: HashiCorp.Cdktf.TerraformProvider

ProvisionersOptional
public object[] Provisioners { get; }
  • Type: object[]

AwsAccessKeyIdInputOptional
public string AwsAccessKeyIdInput { get; }
  • Type: string

AwsS3BucketInputOptional
public string AwsS3BucketInput { get; }
  • Type: string

AwsS3DisableTlsInputOptional
public object AwsS3DisableTlsInput { get; }
  • Type: object

AwsS3EnableKmsInputOptional
public object AwsS3EnableKmsInput { get; }
  • Type: object

AwsS3EndpointInputOptional
public string AwsS3EndpointInput { get; }
  • Type: string

AwsS3ForcePathStyleInputOptional
public object AwsS3ForcePathStyleInput { get; }
  • Type: object

AwsS3KmsKeyInputOptional
public string AwsS3KmsKeyInput { get; }
  • Type: string

AwsS3RegionInputOptional
public string AwsS3RegionInput { get; }
  • Type: string

AwsS3ServerSideEncryptionInputOptional
public object AwsS3ServerSideEncryptionInput { get; }
  • Type: object

AwsSecretAccessKeyInputOptional
public string AwsSecretAccessKeyInput { get; }
  • Type: string

AwsSessionTokenInputOptional
public string AwsSessionTokenInput { get; }
  • Type: string

AzureAccountKeyInputOptional
public string AzureAccountKeyInput { get; }
  • Type: string

AzureAccountNameInputOptional
public string AzureAccountNameInput { get; }
  • Type: string

AzureBlobEnvironmentInputOptional
public string AzureBlobEnvironmentInput { get; }
  • Type: string

AzureContainerNameInputOptional
public string AzureContainerNameInput { get; }
  • Type: string

AzureEndpointInputOptional
public string AzureEndpointInput { get; }
  • Type: string

FilePrefixInputOptional
public string FilePrefixInput { get; }
  • Type: string

GoogleDisableTlsInputOptional
public object GoogleDisableTlsInput { get; }
  • Type: object

GoogleEndpointInputOptional
public string GoogleEndpointInput { get; }
  • Type: string

GoogleGcsBucketInputOptional
public string GoogleGcsBucketInput { get; }
  • Type: string

GoogleServiceAccountKeyInputOptional
public string GoogleServiceAccountKeyInput { get; }
  • Type: string

IdInputOptional
public string IdInput { get; }
  • Type: string

IntervalSecondsInputOptional
public double IntervalSecondsInput { get; }
  • Type: double

LocalMaxSpaceInputOptional
public double LocalMaxSpaceInput { get; }
  • Type: double

NameInputOptional
public string NameInput { get; }
  • Type: string

NamespaceInputOptional
public string NamespaceInput { get; }
  • Type: string

PathPrefixInputOptional
public string PathPrefixInput { get; }
  • Type: string

RetainInputOptional
public double RetainInput { get; }
  • Type: double

StorageTypeInputOptional
public string StorageTypeInput { get; }
  • Type: string

AwsAccessKeyIdRequired
public string AwsAccessKeyId { get; }
  • Type: string

AwsS3BucketRequired
public string AwsS3Bucket { get; }
  • Type: string

AwsS3DisableTlsRequired
public object AwsS3DisableTls { get; }
  • Type: object

AwsS3EnableKmsRequired
public object AwsS3EnableKms { get; }
  • Type: object

AwsS3EndpointRequired
public string AwsS3Endpoint { get; }
  • Type: string

AwsS3ForcePathStyleRequired
public object AwsS3ForcePathStyle { get; }
  • Type: object

AwsS3KmsKeyRequired
public string AwsS3KmsKey { get; }
  • Type: string

AwsS3RegionRequired
public string AwsS3Region { get; }
  • Type: string

AwsS3ServerSideEncryptionRequired
public object AwsS3ServerSideEncryption { get; }
  • Type: object

AwsSecretAccessKeyRequired
public string AwsSecretAccessKey { get; }
  • Type: string

AwsSessionTokenRequired
public string AwsSessionToken { get; }
  • Type: string

AzureAccountKeyRequired
public string AzureAccountKey { get; }
  • Type: string

AzureAccountNameRequired
public string AzureAccountName { get; }
  • Type: string

AzureBlobEnvironmentRequired
public string AzureBlobEnvironment { get; }
  • Type: string

AzureContainerNameRequired
public string AzureContainerName { get; }
  • Type: string

AzureEndpointRequired
public string AzureEndpoint { get; }
  • Type: string

FilePrefixRequired
public string FilePrefix { get; }
  • Type: string

GoogleDisableTlsRequired
public object GoogleDisableTls { get; }
  • Type: object

GoogleEndpointRequired
public string GoogleEndpoint { get; }
  • Type: string

GoogleGcsBucketRequired
public string GoogleGcsBucket { get; }
  • Type: string

GoogleServiceAccountKeyRequired
public string GoogleServiceAccountKey { get; }
  • Type: string

IdRequired
public string Id { get; }
  • Type: string

IntervalSecondsRequired
public double IntervalSeconds { get; }
  • Type: double

LocalMaxSpaceRequired
public double LocalMaxSpace { get; }
  • Type: double

NameRequired
public string Name { get; }
  • Type: string

NamespaceRequired
public string Namespace { get; }
  • Type: string

PathPrefixRequired
public string PathPrefix { get; }
  • Type: string

RetainRequired
public double Retain { get; }
  • Type: double

StorageTypeRequired
public string StorageType { get; }
  • Type: string

Constants

Name Type Description
TfResourceType string No description.

TfResourceTypeRequired
public string TfResourceType { get; }
  • Type: string

Structs

RaftSnapshotAgentConfigConfig

Initializer

using HashiCorp.Cdktf.Providers.Vault;

new RaftSnapshotAgentConfigConfig {
    object Connection = null,
    object Count = null,
    ITerraformDependable[] DependsOn = null,
    ITerraformIterator ForEach = null,
    TerraformResourceLifecycle Lifecycle = null,
    TerraformProvider Provider = null,
    object[] Provisioners = null,
    double IntervalSeconds,
    string Name,
    string PathPrefix,
    string StorageType,
    string AwsAccessKeyId = null,
    string AwsS3Bucket = null,
    object AwsS3DisableTls = null,
    object AwsS3EnableKms = null,
    string AwsS3Endpoint = null,
    object AwsS3ForcePathStyle = null,
    string AwsS3KmsKey = null,
    string AwsS3Region = null,
    object AwsS3ServerSideEncryption = null,
    string AwsSecretAccessKey = null,
    string AwsSessionToken = null,
    string AzureAccountKey = null,
    string AzureAccountName = null,
    string AzureBlobEnvironment = null,
    string AzureContainerName = null,
    string AzureEndpoint = null,
    string FilePrefix = null,
    object GoogleDisableTls = null,
    string GoogleEndpoint = null,
    string GoogleGcsBucket = null,
    string GoogleServiceAccountKey = null,
    string Id = null,
    double LocalMaxSpace = null,
    string Namespace = null,
    double Retain = null
};

Properties

Name Type Description
Connection object No description.
Count object No description.
DependsOn HashiCorp.Cdktf.ITerraformDependable[] No description.
ForEach HashiCorp.Cdktf.ITerraformIterator No description.
Lifecycle HashiCorp.Cdktf.TerraformResourceLifecycle No description.
Provider HashiCorp.Cdktf.TerraformProvider No description.
Provisioners object[] No description.
IntervalSeconds double Number of seconds between snapshots.
Name string Name of the snapshot agent configuration.
PathPrefix string The directory or bucket prefix to to use.
StorageType string What storage service to send snapshots to. One of "local", "azure-blob", "aws-s3", or "google-gcs".
AwsAccessKeyId string AWS access key ID.
AwsS3Bucket string S3 bucket to write snapshots to.
AwsS3DisableTls object Disable TLS for the S3 endpoint. This should only be used for testing purposes.
AwsS3EnableKms object Use KMS to encrypt bucket contents.
AwsS3Endpoint string AWS endpoint. This is typically only set when using a non-AWS S3 implementation like Minio.
AwsS3ForcePathStyle object Use the endpoint/bucket URL style instead of bucket.endpoint.
AwsS3KmsKey string Use named KMS key, when aws_s3_enable_kms=true.
AwsS3Region string AWS region bucket is in.
AwsS3ServerSideEncryption object Use AES256 to encrypt bucket contents.
AwsSecretAccessKey string AWS secret access key.
AwsSessionToken string AWS session token.
AzureAccountKey string Azure account key.
AzureAccountName string Azure account name.
AzureBlobEnvironment string Azure blob environment.
AzureContainerName string Azure container name to write snapshots to.
AzureEndpoint string Azure blob storage endpoint. This is typically only set when using a non-Azure implementation like Azurite.
FilePrefix string The file or object name of snapshot files will start with this string.
GoogleDisableTls object Disable TLS for the GCS endpoint.
GoogleEndpoint string GCS endpoint. This is typically only set when using a non-Google GCS implementation like fake-gcs-server.
GoogleGcsBucket string GCS bucket to write snapshots to.
GoogleServiceAccountKey string Google service account key in JSON format.
Id string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/raft_snapshot_agent_config#id RaftSnapshotAgentConfig#id}.
LocalMaxSpace double The maximum space, in bytes, to use for snapshots.
Namespace string Target namespace. (requires Enterprise).
Retain double How many snapshots are to be kept.

ConnectionOptional
public object Connection { get; set; }
  • Type: object

CountOptional
public object Count { get; set; }
  • Type: object

DependsOnOptional
public ITerraformDependable[] DependsOn { get; set; }
  • Type: HashiCorp.Cdktf.ITerraformDependable[]

ForEachOptional
public ITerraformIterator ForEach { get; set; }
  • Type: HashiCorp.Cdktf.ITerraformIterator

LifecycleOptional
public TerraformResourceLifecycle Lifecycle { get; set; }
  • Type: HashiCorp.Cdktf.TerraformResourceLifecycle

ProviderOptional
public TerraformProvider Provider { get; set; }
  • Type: HashiCorp.Cdktf.TerraformProvider

ProvisionersOptional
public object[] Provisioners { get; set; }
  • Type: object[]

IntervalSecondsRequired
public double IntervalSeconds { get; set; }
  • Type: double

Number of seconds between snapshots.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/raft_snapshot_agent_config#interval_seconds RaftSnapshotAgentConfig#interval_seconds}


NameRequired
public string Name { get; set; }
  • Type: string

Name of the snapshot agent configuration.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/raft_snapshot_agent_config#name RaftSnapshotAgentConfig#name}


PathPrefixRequired
public string PathPrefix { get; set; }
  • Type: string

The directory or bucket prefix to to use.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/raft_snapshot_agent_config#path_prefix RaftSnapshotAgentConfig#path_prefix}


StorageTypeRequired
public string StorageType { get; set; }
  • Type: string

What storage service to send snapshots to. One of "local", "azure-blob", "aws-s3", or "google-gcs".

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/raft_snapshot_agent_config#storage_type RaftSnapshotAgentConfig#storage_type}


AwsAccessKeyIdOptional
public string AwsAccessKeyId { get; set; }
  • Type: string

AWS access key ID.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/raft_snapshot_agent_config#aws_access_key_id RaftSnapshotAgentConfig#aws_access_key_id}


AwsS3BucketOptional
public string AwsS3Bucket { get; set; }
  • Type: string

S3 bucket to write snapshots to.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/raft_snapshot_agent_config#aws_s3_bucket RaftSnapshotAgentConfig#aws_s3_bucket}


AwsS3DisableTlsOptional
public object AwsS3DisableTls { get; set; }
  • Type: object

Disable TLS for the S3 endpoint. This should only be used for testing purposes.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/raft_snapshot_agent_config#aws_s3_disable_tls RaftSnapshotAgentConfig#aws_s3_disable_tls}


AwsS3EnableKmsOptional
public object AwsS3EnableKms { get; set; }
  • Type: object

Use KMS to encrypt bucket contents.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/raft_snapshot_agent_config#aws_s3_enable_kms RaftSnapshotAgentConfig#aws_s3_enable_kms}


AwsS3EndpointOptional
public string AwsS3Endpoint { get; set; }
  • Type: string

AWS endpoint. This is typically only set when using a non-AWS S3 implementation like Minio.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/raft_snapshot_agent_config#aws_s3_endpoint RaftSnapshotAgentConfig#aws_s3_endpoint}


AwsS3ForcePathStyleOptional
public object AwsS3ForcePathStyle { get; set; }
  • Type: object

Use the endpoint/bucket URL style instead of bucket.endpoint.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/raft_snapshot_agent_config#aws_s3_force_path_style RaftSnapshotAgentConfig#aws_s3_force_path_style}


AwsS3KmsKeyOptional
public string AwsS3KmsKey { get; set; }
  • Type: string

Use named KMS key, when aws_s3_enable_kms=true.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/raft_snapshot_agent_config#aws_s3_kms_key RaftSnapshotAgentConfig#aws_s3_kms_key}


AwsS3RegionOptional
public string AwsS3Region { get; set; }
  • Type: string

AWS region bucket is in.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/raft_snapshot_agent_config#aws_s3_region RaftSnapshotAgentConfig#aws_s3_region}


AwsS3ServerSideEncryptionOptional
public object AwsS3ServerSideEncryption { get; set; }
  • Type: object

Use AES256 to encrypt bucket contents.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/raft_snapshot_agent_config#aws_s3_server_side_encryption RaftSnapshotAgentConfig#aws_s3_server_side_encryption}


AwsSecretAccessKeyOptional
public string AwsSecretAccessKey { get; set; }
  • Type: string

AWS secret access key.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/raft_snapshot_agent_config#aws_secret_access_key RaftSnapshotAgentConfig#aws_secret_access_key}


AwsSessionTokenOptional
public string AwsSessionToken { get; set; }
  • Type: string

AWS session token.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/raft_snapshot_agent_config#aws_session_token RaftSnapshotAgentConfig#aws_session_token}


AzureAccountKeyOptional
public string AzureAccountKey { get; set; }
  • Type: string

Azure account key.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/raft_snapshot_agent_config#azure_account_key RaftSnapshotAgentConfig#azure_account_key}


AzureAccountNameOptional
public string AzureAccountName { get; set; }
  • Type: string

Azure account name.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/raft_snapshot_agent_config#azure_account_name RaftSnapshotAgentConfig#azure_account_name}


AzureBlobEnvironmentOptional
public string AzureBlobEnvironment { get; set; }
  • Type: string

Azure blob environment.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/raft_snapshot_agent_config#azure_blob_environment RaftSnapshotAgentConfig#azure_blob_environment}


AzureContainerNameOptional
public string AzureContainerName { get; set; }
  • Type: string

Azure container name to write snapshots to.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/raft_snapshot_agent_config#azure_container_name RaftSnapshotAgentConfig#azure_container_name}


AzureEndpointOptional
public string AzureEndpoint { get; set; }
  • Type: string

Azure blob storage endpoint. This is typically only set when using a non-Azure implementation like Azurite.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/raft_snapshot_agent_config#azure_endpoint RaftSnapshotAgentConfig#azure_endpoint}


FilePrefixOptional
public string FilePrefix { get; set; }
  • Type: string

The file or object name of snapshot files will start with this string.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/raft_snapshot_agent_config#file_prefix RaftSnapshotAgentConfig#file_prefix}


GoogleDisableTlsOptional
public object GoogleDisableTls { get; set; }
  • Type: object

Disable TLS for the GCS endpoint.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/raft_snapshot_agent_config#google_disable_tls RaftSnapshotAgentConfig#google_disable_tls}


GoogleEndpointOptional
public string GoogleEndpoint { get; set; }
  • Type: string

GCS endpoint. This is typically only set when using a non-Google GCS implementation like fake-gcs-server.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/raft_snapshot_agent_config#google_endpoint RaftSnapshotAgentConfig#google_endpoint}


GoogleGcsBucketOptional
public string GoogleGcsBucket { get; set; }
  • Type: string

GCS bucket to write snapshots to.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/raft_snapshot_agent_config#google_gcs_bucket RaftSnapshotAgentConfig#google_gcs_bucket}


GoogleServiceAccountKeyOptional
public string GoogleServiceAccountKey { get; set; }
  • Type: string

Google service account key in JSON format.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/raft_snapshot_agent_config#google_service_account_key RaftSnapshotAgentConfig#google_service_account_key}


IdOptional
public string Id { get; set; }
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/raft_snapshot_agent_config#id RaftSnapshotAgentConfig#id}.

Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.


LocalMaxSpaceOptional
public double LocalMaxSpace { get; set; }
  • Type: double

The maximum space, in bytes, to use for snapshots.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/raft_snapshot_agent_config#local_max_space RaftSnapshotAgentConfig#local_max_space}


NamespaceOptional
public string Namespace { get; set; }
  • Type: string

Target namespace. (requires Enterprise).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/raft_snapshot_agent_config#namespace RaftSnapshotAgentConfig#namespace}


RetainOptional
public double Retain { get; set; }
  • Type: double

How many snapshots are to be kept.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/raft_snapshot_agent_config#retain RaftSnapshotAgentConfig#retain}