GetAccessCredentialsPlainArgs

data class GetAccessCredentialsPlainArgs(val backend: String, val environment: String? = null, val maxCredValidationSeconds: Int? = null, val namespace: String? = null, val numSecondsBetweenTests: Int? = null, val numSequentialSuccesses: Int? = null, val role: String, val subscriptionId: String? = null, val tenantId: String? = null, val validateCreds: Boolean? = null) : ConvertibleToJava<GetAccessCredentialsPlainArgs>

A collection of arguments for invoking getAccessCredentials.

Constructors

Link copied to clipboard
constructor(backend: String, environment: String? = null, maxCredValidationSeconds: Int? = null, namespace: String? = null, numSecondsBetweenTests: Int? = null, numSequentialSuccesses: Int? = null, role: String, subscriptionId: String? = null, tenantId: String? = null, validateCreds: Boolean? = null)

Properties

Link copied to clipboard

The path to the Azure secret backend to read credentials from, with no leading or trailing /s.

Link copied to clipboard
val environment: String? = null

The Azure environment to use during credential validation. Defaults to the environment configured in the Vault backend. Some possible values: AzurePublicCloud, AzureGovernmentCloud See the caveats section for more information on this field.

Link copied to clipboard

If 'validate_creds' is true, the number of seconds after which to give up validating credentials. Defaults to 300.

Link copied to clipboard
val namespace: String? = null

The namespace of the target resource. 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

If 'validate_creds' is true, the number of seconds to wait between each test of generated credentials. Defaults to 1.

Link copied to clipboard

If 'validate_creds' is true, the number of sequential successes required to validate generated credentials. Defaults to 8.

Link copied to clipboard

The name of the Azure secret backend role to read credentials from, with no leading or trailing /s.

Link copied to clipboard
val subscriptionId: String? = null

The subscription ID to use during credential validation. Defaults to the subscription ID configured in the Vault backend. See the caveats section for more information on this field.

Link copied to clipboard
val tenantId: String? = null

The tenant ID to use during credential validation. Defaults to the tenant ID configured in the Vault backend. See the caveats section for more information on this field.

Link copied to clipboard
val validateCreds: Boolean? = null

Whether generated credentials should be validated before being returned. Defaults to false, which returns credentials without checking whether they have fully propagated throughout Azure Active Directory. Designating true activates testing.

Functions

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