com.amazonaws.services.kinesisfirehose.model

Class DeliveryStreamEncryptionConfiguration

java.lang.Object

com.amazonaws.services.kinesisfirehose.model.DeliveryStreamEncryptionConfiguration

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DeliveryStreamEncryptionConfiguration
extends Object
implements Serializable, Cloneable, StructuredPojo

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:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
DeliveryStreamEncryptionConfiguration()

Method Summary

Modifier and Type	Method and Description
DeliveryStreamEncryptionConfiguration	clone()
boolean	equals(Object obj)
FailureDescription	getFailureDescription() Provides details in case one of the following operations fails due to an error related to KMS: CreateDeliveryStream, DeleteDeliveryStream, StartDeliveryStreamEncryption, StopDeliveryStreamEncryption.
String	getKeyARN() If KeyType is CUSTOMER_MANAGED_CMK, this field contains the ARN of the customer managed CMK.
String	getKeyType() Indicates the type of customer master key (CMK) that is used for encryption.
String	getStatus() This is the server-side encryption (SSE) status for the delivery stream.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setFailureDescription(FailureDescription failureDescription) Provides details in case one of the following operations fails due to an error related to KMS: CreateDeliveryStream, DeleteDeliveryStream, StartDeliveryStreamEncryption, StopDeliveryStreamEncryption.
void	setKeyARN(String keyARN) If KeyType is CUSTOMER_MANAGED_CMK, this field contains the ARN of the customer managed CMK.
void	setKeyType(String keyType) Indicates the type of customer master key (CMK) that is used for encryption.
void	setStatus(String status) This is the server-side encryption (SSE) status for the delivery stream.
String	toString() Returns a string representation of this object.
DeliveryStreamEncryptionConfiguration	withFailureDescription(FailureDescription failureDescription) Provides details in case one of the following operations fails due to an error related to KMS: CreateDeliveryStream, DeleteDeliveryStream, StartDeliveryStreamEncryption, StopDeliveryStreamEncryption.
DeliveryStreamEncryptionConfiguration	withKeyARN(String keyARN) If KeyType is CUSTOMER_MANAGED_CMK, this field contains the ARN of the customer managed CMK.
DeliveryStreamEncryptionConfiguration	withKeyType(KeyType keyType) Indicates the type of customer master key (CMK) that is used for encryption.
DeliveryStreamEncryptionConfiguration	withKeyType(String keyType) Indicates the type of customer master key (CMK) that is used for encryption.
DeliveryStreamEncryptionConfiguration	withStatus(DeliveryStreamEncryptionStatus status) This is the server-side encryption (SSE) status for the delivery stream.
DeliveryStreamEncryptionConfiguration	withStatus(String status) This is the server-side encryption (SSE) status for the delivery stream.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DeliveryStreamEncryptionConfiguration

public DeliveryStreamEncryptionConfiguration()

Method Detail

setKeyARN

public void setKeyARN(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.

getKeyARN

public String getKeyARN()

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.

withKeyARN

public DeliveryStreamEncryptionConfiguration withKeyARN(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.

setKeyType

public void setKeyType(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).

See Also:

KeyType

getKeyType

public String getKeyType()

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:

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

withKeyType

public DeliveryStreamEncryptionConfiguration withKeyType(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

withKeyType

public DeliveryStreamEncryptionConfiguration withKeyType(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

setStatus

public void setStatus(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.

See Also:

DeliveryStreamEncryptionStatus

getStatus

public String getStatus()

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:

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.

See Also:

DeliveryStreamEncryptionStatus

withStatus

public DeliveryStreamEncryptionConfiguration withStatus(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

withStatus

public DeliveryStreamEncryptionConfiguration withStatus(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

setFailureDescription

public void setFailureDescription(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.

getFailureDescription

public FailureDescription getFailureDescription()

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.

withFailureDescription

public DeliveryStreamEncryptionConfiguration withFailureDescription(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.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public DeliveryStreamEncryptionConfiguration clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.