Package software.amazon.awscdk.services.kinesisfirehose

Interface CfnDeliveryStream.SecretsManagerConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDeliveryStream.SecretsManagerConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnDeliveryStream

@Stability(Stable)
public static interface CfnDeliveryStream.SecretsManagerConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

The structure that defines how Firehose accesses the secret.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.kinesisfirehose.*;
 SecretsManagerConfigurationProperty secretsManagerConfigurationProperty = SecretsManagerConfigurationProperty.builder()
         .enabled(false)
         // the properties below are optional
         .roleArn("roleArn")
         .secretArn("secretArn")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-secretsmanagerconfiguration.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnDeliveryStream.SecretsManagerConfigurationProperty.Builder	A builder for CfnDeliveryStream.SecretsManagerConfigurationProperty
static final class	CfnDeliveryStream.SecretsManagerConfigurationProperty.Jsii$Proxy	An implementation for CfnDeliveryStream.SecretsManagerConfigurationProperty

Method Summary

Modifier and Type	Method	Description
static CfnDeliveryStream.SecretsManagerConfigurationProperty.Builder	builder()
Object	getEnabled()	Specifies whether you want to use the secrets manager feature.
default String	getRoleArn()	Specifies the role that Firehose assumes when calling the Secrets Manager API operation.
default String	getSecretArn()	The ARN of the secret that stores your credentials.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getEnabled

@Stability(Stable)
@NotNull
Object getEnabled()

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.

Returns union: either Boolean or IResolvable

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-secretsmanagerconfiguration.html#cfn-kinesisfirehose-deliverystream-secretsmanagerconfiguration-enabled

getRoleArn

@Stability(Stable)
@Nullable
default String getRoleArn()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-secretsmanagerconfiguration.html#cfn-kinesisfirehose-deliverystream-secretsmanagerconfiguration-rolearn

getSecretArn

@Stability(Stable)
@Nullable
default String getSecretArn()

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-secretsmanagerconfiguration.html#cfn-kinesisfirehose-deliverystream-secretsmanagerconfiguration-secretarn

builder

@Stability(Stable)
static CfnDeliveryStream.SecretsManagerConfigurationProperty.Builder builder()

Returns:

a CfnDeliveryStream.SecretsManagerConfigurationProperty.Builder of CfnDeliveryStream.SecretsManagerConfigurationProperty