Interface Encryption.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<Encryption.Builder,
,Encryption> SdkBuilder<Encryption.Builder,
,Encryption> SdkPojo
- Enclosing class:
Encryption
-
Method Summary
Modifier and TypeMethodDescriptioncmafExcludeSegmentDrmMetadata
(Boolean cmafExcludeSegmentDrmMetadata) Excludes SEIG and SGPD boxes from segment metadata in CMAF containers.constantInitializationVector
(String constantInitializationVector) A 128-bit, 16-byte hex value represented by a 32-character string, used in conjunction with the key for encrypting content.default Encryption.Builder
encryptionMethod
(Consumer<EncryptionMethod.Builder> encryptionMethod) The encryption method to use.encryptionMethod
(EncryptionMethod encryptionMethod) The encryption method to use.keyRotationIntervalSeconds
(Integer keyRotationIntervalSeconds) The frequency (in seconds) of key changes for live workflows, in which content is streamed real time.default Encryption.Builder
spekeKeyProvider
(Consumer<SpekeKeyProvider.Builder> spekeKeyProvider) The parameters for the SPEKE key provider.spekeKeyProvider
(SpekeKeyProvider spekeKeyProvider) The parameters for the SPEKE key provider.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, sdkFieldNameToField, sdkFields
-
Method Details
-
constantInitializationVector
A 128-bit, 16-byte hex value represented by a 32-character string, used in conjunction with the key for encrypting content. If you don't specify a value, then MediaPackage creates the constant initialization vector (IV).
- Parameters:
constantInitializationVector
- A 128-bit, 16-byte hex value represented by a 32-character string, used in conjunction with the key for encrypting content. If you don't specify a value, then MediaPackage creates the constant initialization vector (IV).- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
encryptionMethod
The encryption method to use.
- Parameters:
encryptionMethod
- The encryption method to use.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
encryptionMethod
The encryption method to use.
This is a convenience method that creates an instance of theEncryptionMethod.Builder
avoiding the need to create one manually viaEncryptionMethod.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toencryptionMethod(EncryptionMethod)
.- Parameters:
encryptionMethod
- a consumer that will call methods onEncryptionMethod.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
keyRotationIntervalSeconds
The frequency (in seconds) of key changes for live workflows, in which content is streamed real time. The service retrieves content keys before the live content begins streaming, and then retrieves them as needed over the lifetime of the workflow. By default, key rotation is set to 300 seconds (5 minutes), the minimum rotation interval, which is equivalent to setting it to 300. If you don't enter an interval, content keys aren't rotated.
The following example setting causes the service to rotate keys every thirty minutes:
1800
- Parameters:
keyRotationIntervalSeconds
- The frequency (in seconds) of key changes for live workflows, in which content is streamed real time. The service retrieves content keys before the live content begins streaming, and then retrieves them as needed over the lifetime of the workflow. By default, key rotation is set to 300 seconds (5 minutes), the minimum rotation interval, which is equivalent to setting it to 300. If you don't enter an interval, content keys aren't rotated.The following example setting causes the service to rotate keys every thirty minutes:
1800
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
cmafExcludeSegmentDrmMetadata
Excludes SEIG and SGPD boxes from segment metadata in CMAF containers.
When set to
true
, MediaPackage omits these DRM metadata boxes from CMAF segments, which can improve compatibility with certain devices and players that don't support these boxes.Important considerations:
-
This setting only affects CMAF container formats
-
Key rotation can still be handled through media playlist signaling
-
PSSH and TENC boxes remain unaffected
-
Default behavior is preserved when this setting is disabled
Valid values:
true
|false
Default:
false
- Parameters:
cmafExcludeSegmentDrmMetadata
- Excludes SEIG and SGPD boxes from segment metadata in CMAF containers.When set to
true
, MediaPackage omits these DRM metadata boxes from CMAF segments, which can improve compatibility with certain devices and players that don't support these boxes.Important considerations:
-
This setting only affects CMAF container formats
-
Key rotation can still be handled through media playlist signaling
-
PSSH and TENC boxes remain unaffected
-
Default behavior is preserved when this setting is disabled
Valid values:
true
|false
Default:
false
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
spekeKeyProvider
The parameters for the SPEKE key provider.
- Parameters:
spekeKeyProvider
- The parameters for the SPEKE key provider.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
spekeKeyProvider
The parameters for the SPEKE key provider.
This is a convenience method that creates an instance of theSpekeKeyProvider.Builder
avoiding the need to create one manually viaSpekeKeyProvider.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tospekeKeyProvider(SpekeKeyProvider)
.- Parameters:
spekeKeyProvider
- a consumer that will call methods onSpekeKeyProvider.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-