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

Interface DeliveryStreamEncryptionConfiguration.Builder

All Superinterfaces:

Buildable, CopyableBuilder<DeliveryStreamEncryptionConfiguration.Builder,DeliveryStreamEncryptionConfiguration>, SdkBuilder<DeliveryStreamEncryptionConfiguration.Builder,DeliveryStreamEncryptionConfiguration>, SdkPojo

Enclosing class:

DeliveryStreamEncryptionConfiguration

public static interface DeliveryStreamEncryptionConfiguration.Builder
extends SdkPojo, CopyableBuilder<DeliveryStreamEncryptionConfiguration.Builder,DeliveryStreamEncryptionConfiguration>

Method Summary

Modifier and Type	Method	Description
default DeliveryStreamEncryptionConfiguration.Builder	failureDescription(Consumer<FailureDescription.Builder> failureDescription)	Provides details in case one of the following operations fails due to an error related to KMS: CreateDeliveryStream, DeleteDeliveryStream, StartDeliveryStreamEncryption, StopDeliveryStreamEncryption.
DeliveryStreamEncryptionConfiguration.Builder	failureDescription(FailureDescription failureDescription)	Provides details in case one of the following operations fails due to an error related to KMS: CreateDeliveryStream, DeleteDeliveryStream, StartDeliveryStreamEncryption, StopDeliveryStreamEncryption.
DeliveryStreamEncryptionConfiguration.Builder	keyARN(String keyARN)	If KeyType is CUSTOMER_MANAGED_CMK, this field contains the ARN of the customer managed CMK.
DeliveryStreamEncryptionConfiguration.Builder	keyType(String keyType)	Indicates the type of customer master key (CMK) that is used for encryption.
DeliveryStreamEncryptionConfiguration.Builder	keyType(KeyType keyType)	Indicates the type of customer master key (CMK) that is used for encryption.
DeliveryStreamEncryptionConfiguration.Builder	status(String status)	This is the server-side encryption (SSE) status for the delivery stream.
DeliveryStreamEncryptionConfiguration.Builder	status(DeliveryStreamEncryptionStatus status)	This is the server-side encryption (SSE) status for the delivery stream.

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

copy

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

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Method Details

keyARN

DeliveryStreamEncryptionConfiguration.Builder keyARN(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

keyType

DeliveryStreamEncryptionConfiguration.Builder keyType(String 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).

Parameters:

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).

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• KeyType
• KeyType

keyType

DeliveryStreamEncryptionConfiguration.Builder keyType(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).

Parameters:

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).

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• KeyType
• KeyType

status

DeliveryStreamEncryptionConfiguration.Builder status(String status)

This is the server-side encryption (SSE) status for the delivery 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.

Parameters:

status - This is the server-side encryption (SSE) status for the delivery 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• DeliveryStreamEncryptionStatus
• DeliveryStreamEncryptionStatus

status

DeliveryStreamEncryptionConfiguration.Builder status(DeliveryStreamEncryptionStatus status)

This is the server-side encryption (SSE) status for the delivery 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.

Parameters:

status - This is the server-side encryption (SSE) status for the delivery 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• DeliveryStreamEncryptionStatus
• DeliveryStreamEncryptionStatus

failureDescription

DeliveryStreamEncryptionConfiguration.Builder failureDescription(FailureDescription failureDescription)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

failureDescription

default DeliveryStreamEncryptionConfiguration.Builder failureDescription(Consumer<FailureDescription.Builder> failureDescription)

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

This is a convenience method that creates an instance of the FailureDescription.Builder avoiding the need to create one manually via FailureDescription.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to failureDescription(FailureDescription).

Parameters:

failureDescription - a consumer that will call methods on FailureDescription.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• failureDescription(FailureDescription)