Skip to content

SecretsManagerConfiguration

Source code in docs_src/capo_firehose/types/secrets_manager_configuration.py 
15
16
17
18
19
20
21
class SecretsManagerConfiguration(TypedDict, closed=True):
    secret_arn: NotRequired["capo_firehose.types.secret_arn.SecretARN"]
    """<p>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 <b>Enabled</b> is set to <code>True</code>.</p>"""
    role_arn: NotRequired["capo_firehose.types.role_arn.RoleARN"]
    """<p> 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. </p>"""
    enabled: "capo_firehose.types.boolean_object.BooleanObject"
    """<p>Specifies whether you want to use the secrets manager feature. When set as <code>True</code> the secrets manager configuration overwrites the existing secrets in the destination configuration. When it's set to <code>False</code> Firehose falls back to the credentials in the destination configuration.</p>"""

enabled instance-attribute 

enabled: BooleanObject

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.

role_arn instance-attribute 

role_arn: NotRequired[RoleARN]

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.

secret_arn instance-attribute 

secret_arn: NotRequired[SecretARN]

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.