SecretBackendArgs

data class SecretBackendArgs(val accessKey: Output<String>? = null, val defaultLeaseTtlSeconds: Output<Int>? = null, val description: Output<String>? = null, val disableAutomatedRotation: Output<Boolean>? = null, val disableRemount: Output<Boolean>? = null, val iamEndpoint: Output<String>? = null, val identityTokenAudience: Output<String>? = null, val identityTokenKey: Output<String>? = null, val identityTokenTtl: Output<Int>? = null, val local: Output<Boolean>? = null, val maxLeaseTtlSeconds: Output<Int>? = null, val namespace: Output<String>? = null, val path: Output<String>? = null, val region: Output<String>? = null, val roleArn: Output<String>? = null, val rotationPeriod: Output<Int>? = null, val rotationSchedule: Output<String>? = null, val rotationWindow: Output<Int>? = null, val secretKey: Output<String>? = null, val stsEndpoint: Output<String>? = null, val stsFallbackEndpoints: Output<List<String>>? = null, val stsFallbackRegions: Output<List<String>>? = null, val stsRegion: Output<String>? = null, val usernameTemplate: Output<String>? = null) : ConvertibleToJava<SecretBackendArgs>

Import

AWS secret backends can be imported using the path, e.g.

$ pulumi import vault:aws/secretBackend:SecretBackend aws aws

Constructors

Link copied to clipboard
constructor(accessKey: Output<String>? = null, defaultLeaseTtlSeconds: Output<Int>? = null, description: Output<String>? = null, disableAutomatedRotation: Output<Boolean>? = null, disableRemount: Output<Boolean>? = null, iamEndpoint: Output<String>? = null, identityTokenAudience: Output<String>? = null, identityTokenKey: Output<String>? = null, identityTokenTtl: Output<Int>? = null, local: Output<Boolean>? = null, maxLeaseTtlSeconds: Output<Int>? = null, namespace: Output<String>? = null, path: Output<String>? = null, region: Output<String>? = null, roleArn: Output<String>? = null, rotationPeriod: Output<Int>? = null, rotationSchedule: Output<String>? = null, rotationWindow: Output<Int>? = null, secretKey: Output<String>? = null, stsEndpoint: Output<String>? = null, stsFallbackEndpoints: Output<List<String>>? = null, stsFallbackRegions: Output<List<String>>? = null, stsRegion: Output<String>? = null, usernameTemplate: Output<String>? = null)

Properties

Link copied to clipboard
val accessKey: Output<String>? = null

The AWS Access Key ID this backend should use to issue new credentials. Vault uses the official AWS SDK to authenticate, and thus can also use standard AWS environment credentials, shared file credentials or IAM role/ECS task credentials.

Link copied to clipboard
val defaultLeaseTtlSeconds: Output<Int>? = null

The default TTL for credentials issued by this backend.

Link copied to clipboard
val description: Output<String>? = null

A human-friendly description for this backend.

Link copied to clipboard
val disableAutomatedRotation: Output<Boolean>? = null

Cancels all upcoming rotations of the root credential until unset. Requires Vault Enterprise 1.19+.

Link copied to clipboard
val disableRemount: Output<Boolean>? = null

If set, opts out of mount migration on path updates. See here for more info on Mount Migration

Link copied to clipboard
val iamEndpoint: Output<String>? = null

Specifies a custom HTTP IAM endpoint to use.

Link copied to clipboard
val identityTokenAudience: Output<String>? = null

The audience claim value. Requires Vault 1.16+.

Link copied to clipboard
val identityTokenKey: Output<String>? = null

The key to use for signing identity tokens. Requires Vault 1.16+.

Link copied to clipboard
val identityTokenTtl: Output<Int>? = null

The TTL of generated identity tokens in seconds. Requires Vault 1.16+.

Link copied to clipboard
val local: Output<Boolean>? = null

Specifies whether the secrets mount will be marked as local. Local mounts are not replicated to performance replicas.

Link copied to clipboard
val maxLeaseTtlSeconds: Output<Int>? = null

The maximum TTL that can be requested for credentials issued by this backend.

Link copied to clipboard
val namespace: Output<String>? = null

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.

Link copied to clipboard
val path: Output<String>? = null

The unique path this backend should be mounted at. Must not begin or end with a /. Defaults to aws.

Link copied to clipboard
val region: Output<String>? = null

The AWS region to make API calls against. Defaults to us-east-1.

Link copied to clipboard
val roleArn: Output<String>? = null

Role ARN to assume for plugin identity token federation. Requires Vault 1.16+.

Link copied to clipboard
val rotationPeriod: Output<Int>? = null

The amount of time in seconds Vault should wait before rotating the root credential. A zero value tells Vault not to rotate the root credential. The minimum rotation period is 10 seconds. Requires Vault Enterprise 1.19+.

Link copied to clipboard
val rotationSchedule: Output<String>? = null

The schedule, in cron-style time format, defining the schedule on which Vault should rotate the root token. Requires Vault Enterprise 1.19+.

Link copied to clipboard
val rotationWindow: Output<Int>? = null

The maximum amount of time in seconds allowed to complete a rotation when a scheduled token rotation occurs. The default rotation window is unbound and the minimum allowable window is 3600. Requires Vault Enterprise 1.19+.

Link copied to clipboard
val secretKey: Output<String>? = null

The AWS Secret Access Key to use when generating new credentials.

Link copied to clipboard
val stsEndpoint: Output<String>? = null

Specifies a custom HTTP STS endpoint to use.

Link copied to clipboard
val stsFallbackEndpoints: Output<List<String>>? = null

Ordered list of sts_endpoints to try if the defined one fails. Requires Vault 1.19+

Link copied to clipboard
val stsFallbackRegions: Output<List<String>>? = null

Ordered list of sts_regions matching the fallback endpoints. Should correspond in order with those endpoints. Requires Vault 1.19+

Link copied to clipboard
val stsRegion: Output<String>? = null

Specifies the region of the STS endpoint. Should be included if sts_endpoint is supplied. Requires Vault 1.19+

Link copied to clipboard
val usernameTemplate: Output<String>? = null

Template describing how dynamic usernames are generated. The username template is used to generate both IAM usernames (capped at 64 characters) and STS usernames (capped at 32 characters). If no template is provided the field defaults to the template:

Functions

Link copied to clipboard
open override fun toJava(): SecretBackendArgs