Class DeliveryStreamEncryptionConfiguration

java.lang.Object

software.amazon.awssdk.services.firehose.model.DeliveryStreamEncryptionConfiguration

All Implemented Interfaces:

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

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

Contains information about the server-side encryption (SSE) status for the delivery stream, the type customer master key (CMK) in use, if any, and the ARN of the CMK. You can get DeliveryStreamEncryptionConfiguration by invoking the DescribeDeliveryStream operation.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DeliveryStreamEncryptionConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
static DeliveryStreamEncryptionConfiguration.Builder	builder()
final boolean	equals(Object obj)
final boolean	equalsBySdkFields(Object obj)	Indicates whether some other object is "equal to" this one by SDK fields.
final FailureDescription	failureDescription()	Provides details in case one of the following operations fails due to an error related to KMS: CreateDeliveryStream, DeleteDeliveryStream, StartDeliveryStreamEncryption, StopDeliveryStreamEncryption.
final <T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
final int	hashCode()
final String	keyARN()	If KeyType is CUSTOMER_MANAGED_CMK, this field contains the ARN of the customer managed CMK.
final KeyType	keyType()	Indicates the type of customer master key (CMK) that is used for encryption.
final String	keyTypeAsString()	Indicates the type of customer master key (CMK) that is used for encryption.
final Map<String,SdkField<?>>	sdkFieldNameToField()
final List<SdkField<?>>	sdkFields()
static Class<? extends DeliveryStreamEncryptionConfiguration.Builder>	serializableBuilderClass()
final DeliveryStreamEncryptionStatus	status()	This is the server-side encryption (SSE) status for the Firehose stream.
final String	statusAsString()	This is the server-side encryption (SSE) status for the Firehose stream.
DeliveryStreamEncryptionConfiguration.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
final String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Details

keyARN

public final String keyARN()

If KeyType is CUSTOMER_MANAGED_CMK, this field contains the ARN of the customer managed CMK. If KeyType is Amazon Web Services_OWNED_CMK, DeliveryStreamEncryptionConfiguration doesn't contain a value for KeyARN.

Returns:

If KeyType is CUSTOMER_MANAGED_CMK, this field contains the ARN of the customer managed CMK. If KeyType is Amazon Web Services_OWNED_CMK, DeliveryStreamEncryptionConfiguration doesn't contain a value for KeyARN.

keyType

public final KeyType keyType()

Indicates the type of customer master key (CMK) that is used for encryption. The default setting is Amazon Web Services_OWNED_CMK. For more information about CMKs, see Customer Master Keys (CMKs).

If the service returns an enum value that is not available in the current SDK version, keyType will return KeyType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from keyTypeAsString().

Returns:

Indicates the type of customer master key (CMK) that is used for encryption. The default setting is Amazon Web Services_OWNED_CMK. For more information about CMKs, see Customer Master Keys (CMKs).

See Also:

• KeyType

keyTypeAsString

public final String keyTypeAsString()

Indicates the type of customer master key (CMK) that is used for encryption. The default setting is Amazon Web Services_OWNED_CMK. For more information about CMKs, see Customer Master Keys (CMKs).

If the service returns an enum value that is not available in the current SDK version, keyType will return KeyType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from keyTypeAsString().

Returns:

Indicates the type of customer master key (CMK) that is used for encryption. The default setting is Amazon Web Services_OWNED_CMK. For more information about CMKs, see Customer Master Keys (CMKs).

See Also:

• KeyType

status

public final DeliveryStreamEncryptionStatus status()

This is the server-side encryption (SSE) status for the Firehose stream. For a full description of the different values of this status, see StartDeliveryStreamEncryption and StopDeliveryStreamEncryption. If this status is ENABLING_FAILED or DISABLING_FAILED, it is the status of the most recent attempt to enable or disable SSE, respectively.

If the service returns an enum value that is not available in the current SDK version, status will return DeliveryStreamEncryptionStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

This is the server-side encryption (SSE) status for the Firehose stream. For a full description of the different values of this status, see StartDeliveryStreamEncryption and StopDeliveryStreamEncryption. If this status is ENABLING_FAILED or DISABLING_FAILED, it is the status of the most recent attempt to enable or disable SSE, respectively.

See Also:

• DeliveryStreamEncryptionStatus

statusAsString

public final String statusAsString()

This is the server-side encryption (SSE) status for the Firehose stream. For a full description of the different values of this status, see StartDeliveryStreamEncryption and StopDeliveryStreamEncryption. If this status is ENABLING_FAILED or DISABLING_FAILED, it is the status of the most recent attempt to enable or disable SSE, respectively.

If the service returns an enum value that is not available in the current SDK version, status will return DeliveryStreamEncryptionStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

This is the server-side encryption (SSE) status for the Firehose stream. For a full description of the different values of this status, see StartDeliveryStreamEncryption and StopDeliveryStreamEncryption. If this status is ENABLING_FAILED or DISABLING_FAILED, it is the status of the most recent attempt to enable or disable SSE, respectively.

See Also:

• DeliveryStreamEncryptionStatus

failureDescription

public final FailureDescription failureDescription()

Provides details in case one of the following operations fails due to an error related to KMS: CreateDeliveryStream, DeleteDeliveryStream, StartDeliveryStreamEncryption, StopDeliveryStreamEncryption.

Returns:

Provides details in case one of the following operations fails due to an error related to KMS: CreateDeliveryStream, DeleteDeliveryStream, StartDeliveryStreamEncryption, StopDeliveryStreamEncryption.

toBuilder

public DeliveryStreamEncryptionConfiguration.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<DeliveryStreamEncryptionConfiguration.Builder,DeliveryStreamEncryptionConfiguration>

Returns:

a builder for type T

builder

public static DeliveryStreamEncryptionConfiguration.Builder builder()

serializableBuilderClass

public static Class<? extends DeliveryStreamEncryptionConfiguration.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)

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

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

Returns:

List of SdkField in this POJO. May be empty list but should never be null.

sdkFieldNameToField

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

Specified by:

sdkFieldNameToField in interface SdkPojo

Returns:

The mapping between the field name and its corresponding field.