Class DeliveryStreamEncryptionConfiguration
- All Implemented Interfaces:
Serializable
,SdkPojo
,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:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final 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()
IfKeyType
isCUSTOMER_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
Indicates the type of customer master key (CMK) that is used for encryption.static Class
<? extends DeliveryStreamEncryptionConfiguration.Builder> status()
This is the server-side encryption (SSE) status for the delivery stream.final String
This is the server-side encryption (SSE) status for the delivery stream.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 interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
keyARN
If
KeyType
isCUSTOMER_MANAGED_CMK
, this field contains the ARN of the customer managed CMK. IfKeyType
isAmazon Web Services_OWNED_CMK
,DeliveryStreamEncryptionConfiguration
doesn't contain a value forKeyARN
.- Returns:
- If
KeyType
isCUSTOMER_MANAGED_CMK
, this field contains the ARN of the customer managed CMK. IfKeyType
isAmazon Web Services_OWNED_CMK
,DeliveryStreamEncryptionConfiguration
doesn't contain a value forKeyARN
.
-
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 returnKeyType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromkeyTypeAsString()
.- 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:
-
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 returnKeyType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromkeyTypeAsString()
.- 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:
-
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
orDISABLING_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 returnDeliveryStreamEncryptionStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- 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
orDISABLING_FAILED
, it is the status of the most recent attempt to enable or disable SSE, respectively. - See Also:
-
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
orDISABLING_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 returnDeliveryStreamEncryptionStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- 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
orDISABLING_FAILED
, it is the status of the most recent attempt to enable or disable SSE, respectively. - See Also:
-
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
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 interfaceToCopyableBuilder<DeliveryStreamEncryptionConfiguration.Builder,
DeliveryStreamEncryptionConfiguration> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
public static Class<? extends DeliveryStreamEncryptionConfiguration.Builder> serializableBuilderClass() -
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-