java.lang.Object
- software.amazon.awssdk.services.mediaconnect.model.Encryption

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<Encryption.Builder,Encryption>

@Generated("software.amazon.awssdk:codegen")
public final class Encryption
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Encryption.Builder,Encryption>

Information about the encryption of the flow.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface Encryption.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Algorithm`	`algorithm()`	The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).
`String`	`algorithmAsString()`	The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).
`static Encryption.Builder`	`builder()`
`String`	`constantInitializationVector()`	A 128-bit, 16-byte hex value represented by a 32-character string, to be used with the key for encrypting content.
`String`	`deviceId()`	The value of one of the devices that you configured with your digital rights management (DRM) platform key provider.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`KeyType`	`keyType()`	The type of key that is used for the encryption.
`String`	`keyTypeAsString()`	The type of key that is used for the encryption.
`String`	`region()`	The AWS Region that the API Gateway proxy endpoint was created in.
`String`	`resourceId()`	An identifier for the content.
`String`	`roleArn()`	The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).
`List<SdkField<?>>`	`sdkFields()`
`String`	`secretArn()`	The ARN of the secret that you created in AWS Secrets Manager to store the encryption key.
`static Class<? extends Encryption.Builder>`	`serializableBuilderClass()`
`Encryption.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`String`	`url()`	The URL from the API Gateway proxy that you set up to talk to your key server.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - algorithm
```
public final Algorithm algorithm()
```
    The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).
    If the service returns an enum value that is not available in the current SDK version, algorithm will return Algorithm.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from algorithmAsString().
    
    Returns:
    
    The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).
    
    See Also:
    
    Algorithm
  - algorithmAsString
```
public final String algorithmAsString()
```
    The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).
    If the service returns an enum value that is not available in the current SDK version, algorithm will return Algorithm.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from algorithmAsString().
    
    Returns:
    
    The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).
    
    See Also:
    
    Algorithm
  - constantInitializationVector
```
public final String constantInitializationVector()
```
    A 128-bit, 16-byte hex value represented by a 32-character string, to be used with the key for encrypting content. This parameter is not valid for static key encryption.
    
    Returns:
    
    A 128-bit, 16-byte hex value represented by a 32-character string, to be used with the key for encrypting content. This parameter is not valid for static key encryption.
  - deviceId
```
public final String deviceId()
```
    The value of one of the devices that you configured with your digital rights management (DRM) platform key provider. This parameter is required for SPEKE encryption and is not valid for static key encryption.
    
    Returns:
    
    The value of one of the devices that you configured with your digital rights management (DRM) platform key provider. This parameter is required for SPEKE encryption and is not valid for static key encryption.
  - keyType
```
public final KeyType keyType()
```
    The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
    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().
    
    Returns:
    
    The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
    
    See Also:
    
    KeyType
  - keyTypeAsString
```
public final String keyTypeAsString()
```
    The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
    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().
    
    Returns:
    
    The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
    
    See Also:
    
    KeyType
  - region
```
public final String region()
```
    The AWS Region that the API Gateway proxy endpoint was created in. This parameter is required for SPEKE encryption and is not valid for static key encryption.
    
    Returns:
    
    The AWS Region that the API Gateway proxy endpoint was created in. This parameter is required for SPEKE encryption and is not valid for static key encryption.
  - resourceId
```
public final String resourceId()
```
    An identifier for the content. The service sends this value to the key server to identify the current endpoint. The resource ID is also known as the content ID. This parameter is required for SPEKE encryption and is not valid for static key encryption.
    
    Returns:
    
    An identifier for the content. The service sends this value to the key server to identify the current endpoint. The resource ID is also known as the content ID. This parameter is required for SPEKE encryption and is not valid for static key encryption.
  - roleArn
```
public final String roleArn()
```
    The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).
    
    Returns:
    
    The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).
  - secretArn
```
public final String secretArn()
```
    The ARN of the secret that you created in AWS Secrets Manager to store the encryption key. This parameter is required for static key encryption and is not valid for SPEKE encryption.
    
    Returns:
    
    The ARN of the secret that you created in AWS Secrets Manager to store the encryption key. This parameter is required for static key encryption and is not valid for SPEKE encryption.
  - url
```
public final String url()
```
    The URL from the API Gateway proxy that you set up to talk to your key server. This parameter is required for SPEKE encryption and is not valid for static key encryption.
    
    Returns:
    
    The URL from the API Gateway proxy that you set up to talk to your key server. This parameter is required for SPEKE encryption and is not valid for static key encryption.
  - toBuilder
```
public Encryption.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<Encryption.Builder,Encryption>
  - builder
```
public static Encryption.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends Encryption.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final 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
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class Encryption

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

algorithm

algorithmAsString

constantInitializationVector

deviceId

keyType

keyTypeAsString

region

resourceId

roleArn

secretArn

url

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields