Package software.amazon.awssdk.services.firehose.model

Class SecretsManagerConfiguration

java.lang.Object

software.amazon.awssdk.services.firehose.model.SecretsManagerConfiguration

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<SecretsManagerConfiguration.Builder,SecretsManagerConfiguration>

@Generated("software.amazon.awssdk:codegen")
public final class SecretsManagerConfiguration
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<SecretsManagerConfiguration.Builder,SecretsManagerConfiguration>

The structure that defines how Firehose accesses the secret.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SecretsManagerConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
static SecretsManagerConfiguration.Builder	builder()
Boolean	enabled()	Specifies whether you want to use the secrets manager feature.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	roleARN()	Specifies the role that Firehose assumes when calling the Secrets Manager API operation.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
String	secretARN()	The ARN of the secret that stores your credentials.
static Class<? extends SecretsManagerConfiguration.Builder>	serializableBuilderClass()
SecretsManagerConfiguration.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

secretARN

public final String 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.

Returns:

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.

roleARN

public final String 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.

Returns:

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.

enabled

public final Boolean enabled()

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:

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.

toBuilder

public SecretsManagerConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SecretsManagerConfiguration.Builder,SecretsManagerConfiguration>

builder

public static SecretsManagerConfiguration.Builder builder()

serializableBuilderClass

public static Class<? extends SecretsManagerConfiguration.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo