@Generated(value="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.
Modifier and Type | Class and Description |
---|---|
static interface |
DeliveryStreamEncryptionConfiguration.Builder |
Modifier and Type | Method and Description |
---|---|
static DeliveryStreamEncryptionConfiguration.Builder |
builder() |
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
FailureDescription |
failureDescription()
Provides details in case one of the following operations fails due to an error related to KMS:
CreateDeliveryStream, DeleteDeliveryStream, StartDeliveryStreamEncryption,
StopDeliveryStreamEncryption.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
String |
keyARN()
If
KeyType is CUSTOMER_MANAGED_CMK , this field contains the ARN of the customer managed
CMK. |
KeyType |
keyType()
Indicates the type of customer master key (CMK) that is used for encryption.
|
String |
keyTypeAsString()
Indicates the type of customer master key (CMK) that is used for encryption.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends DeliveryStreamEncryptionConfiguration.Builder> |
serializableBuilderClass() |
DeliveryStreamEncryptionStatus |
status()
This is the server-side encryption (SSE) status for the delivery stream.
|
String |
statusAsString()
This is the server-side encryption (SSE) status for the delivery stream.
|
DeliveryStreamEncryptionConfiguration.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
copy
public String keyARN()
If KeyType
is CUSTOMER_MANAGED_CMK
, this field contains the ARN of the customer managed
CMK. If KeyType
is AWS_OWNED_CMK
, DeliveryStreamEncryptionConfiguration
doesn't contain a value for KeyARN
.
KeyType
is CUSTOMER_MANAGED_CMK
, this field contains the ARN of the customer
managed CMK. If KeyType
is AWS_OWNED_CMK
,
DeliveryStreamEncryptionConfiguration
doesn't contain a value for KeyARN
.public KeyType keyType()
Indicates the type of customer master key (CMK) that is used for encryption. The default setting is
AWS_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()
.
AWS_OWNED_CMK
. For more information about CMKs, see Customer Master
Keys (CMKs).KeyType
public String keyTypeAsString()
Indicates the type of customer master key (CMK) that is used for encryption. The default setting is
AWS_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()
.
AWS_OWNED_CMK
. For more information about CMKs, see Customer Master
Keys (CMKs).KeyType
public 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.
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()
.
ENABLING_FAILED
or
DISABLING_FAILED
, it is the status of the most recent attempt to enable or disable SSE,
respectively.DeliveryStreamEncryptionStatus
public String statusAsString()
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.
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()
.
ENABLING_FAILED
or
DISABLING_FAILED
, it is the status of the most recent attempt to enable or disable SSE,
respectively.DeliveryStreamEncryptionStatus
public FailureDescription failureDescription()
Provides details in case one of the following operations fails due to an error related to KMS: CreateDeliveryStream, DeleteDeliveryStream, StartDeliveryStreamEncryption, StopDeliveryStreamEncryption.
public DeliveryStreamEncryptionConfiguration.Builder toBuilder()
toBuilder
in interface ToCopyableBuilder<DeliveryStreamEncryptionConfiguration.Builder,DeliveryStreamEncryptionConfiguration>
public static DeliveryStreamEncryptionConfiguration.Builder builder()
public static Class<? extends DeliveryStreamEncryptionConfiguration.Builder> serializableBuilderClass()
public boolean equalsBySdkFields(Object obj)
equalsBySdkFields
in interface SdkPojo
public String toString()
Copyright © 2020. All rights reserved.