firehose/aws.sdk.kotlin.services.firehose.model/SecretsManagerConfiguration

SecretsManagerConfiguration

class SecretsManagerConfiguration

The structure that defines how Firehose accesses the secret.

Types

Builder

class Builder

Companion

object Companion

Properties

enabled

val enabled: Boolean

Specifies whether you want to use the secrets manager feature. When set as True the secrets manager configuration overwrites the existing secrets in the destination configuration. When it's set to False Firehose falls back to the credentials in the destination configuration.

roleArn

val roleArn: String?

Specifies the role that Firehose assumes when calling the Secrets Manager API operation. When you provide the role, it overrides any destination specific role defined in the destination configuration. If you do not provide the then we use the destination specific role. This parameter is required for Splunk.

secretArn

val secretArn: String?

The ARN of the secret that stores your credentials. It must be in the same region as the Firehose stream and the role. The secret ARN can reside in a different account than the Firehose stream and role as Firehose supports cross-account secret access. This parameter is required when Enabled is set to True.

Functions

copy

inline fun copy(block: SecretsManagerConfiguration.Builder.() -> Unit = {}): SecretsManagerConfiguration

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String