SpekeKeyProvider (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.mediapackagev2.model.SpekeKeyProvider

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

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

The parameters for the SPEKE key provider.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

SpekeKeyProvider()

Constructors
Constructor and Description
`SpekeKeyProvider()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SpekeKeyProvider`	`clone()`
`boolean`	`equals(Object obj)`
`List<String>`	`getDrmSystems()` The DRM solution provider you're using to protect your content during distribution.
`EncryptionContractConfiguration`	`getEncryptionContractConfiguration()` Configure one or more content encryption keys for your endpoints that use SPEKE Version 2.0.
`String`	`getResourceId()` The unique identifier for the content.
`String`	`getRoleArn()` The ARN for the IAM role granted by the key provider that provides access to the key provider API.
`String`	`getUrl()` The URL of the API Gateway proxy that you set up to talk to your key server.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setDrmSystems(Collection<String> drmSystems)` The DRM solution provider you're using to protect your content during distribution.
`void`	`setEncryptionContractConfiguration(EncryptionContractConfiguration encryptionContractConfiguration)` Configure one or more content encryption keys for your endpoints that use SPEKE Version 2.0.
`void`	`setResourceId(String resourceId)` The unique identifier for the content.
`void`	`setRoleArn(String roleArn)` The ARN for the IAM role granted by the key provider that provides access to the key provider API.
`void`	`setUrl(String url)` The URL of the API Gateway proxy that you set up to talk to your key server.
`String`	`toString()` Returns a string representation of this object.
`SpekeKeyProvider`	`withDrmSystems(Collection<String> drmSystems)` The DRM solution provider you're using to protect your content during distribution.
`SpekeKeyProvider`	`withDrmSystems(DrmSystem... drmSystems)` The DRM solution provider you're using to protect your content during distribution.
`SpekeKeyProvider`	`withDrmSystems(String... drmSystems)` The DRM solution provider you're using to protect your content during distribution.
`SpekeKeyProvider`	`withEncryptionContractConfiguration(EncryptionContractConfiguration encryptionContractConfiguration)` Configure one or more content encryption keys for your endpoints that use SPEKE Version 2.0.
`SpekeKeyProvider`	`withResourceId(String resourceId)` The unique identifier for the content.
`SpekeKeyProvider`	`withRoleArn(String roleArn)` The ARN for the IAM role granted by the key provider that provides access to the key provider API.
`SpekeKeyProvider`	`withUrl(String url)` The URL of the API Gateway proxy that you set up to talk to your key server.

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

- Constructor Detail
  - SpekeKeyProvider
```
public SpekeKeyProvider()
```
- Method Detail
  - setEncryptionContractConfiguration
```
public void setEncryptionContractConfiguration(EncryptionContractConfiguration encryptionContractConfiguration)
```
    Configure one or more content encryption keys for your endpoints that use SPEKE Version 2.0. The encryption contract defines which content keys are used to encrypt the audio and video tracks in your stream. To configure the encryption contract, specify which audio and video encryption presets to use.
    
    Parameters:
    
    encryptionContractConfiguration - Configure one or more content encryption keys for your endpoints that use SPEKE Version 2.0. The encryption contract defines which content keys are used to encrypt the audio and video tracks in your stream. To configure the encryption contract, specify which audio and video encryption presets to use.
  - getEncryptionContractConfiguration
```
public EncryptionContractConfiguration getEncryptionContractConfiguration()
```
    Configure one or more content encryption keys for your endpoints that use SPEKE Version 2.0. The encryption contract defines which content keys are used to encrypt the audio and video tracks in your stream. To configure the encryption contract, specify which audio and video encryption presets to use.
    
    Returns:
    
    Configure one or more content encryption keys for your endpoints that use SPEKE Version 2.0. The encryption contract defines which content keys are used to encrypt the audio and video tracks in your stream. To configure the encryption contract, specify which audio and video encryption presets to use.
  - withEncryptionContractConfiguration
```
public SpekeKeyProvider withEncryptionContractConfiguration(EncryptionContractConfiguration encryptionContractConfiguration)
```
    Configure one or more content encryption keys for your endpoints that use SPEKE Version 2.0. The encryption contract defines which content keys are used to encrypt the audio and video tracks in your stream. To configure the encryption contract, specify which audio and video encryption presets to use.
    
    Parameters:
    
    encryptionContractConfiguration - Configure one or more content encryption keys for your endpoints that use SPEKE Version 2.0. The encryption contract defines which content keys are used to encrypt the audio and video tracks in your stream. To configure the encryption contract, specify which audio and video encryption presets to use.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setResourceId
```
public void setResourceId(String resourceId)
```
    The unique identifier for the content. The service sends this to the key server to identify the current endpoint. How unique you make this depends on how fine-grained you want access controls to be. The service does not permit you to use the same ID for two simultaneous encryption processes. The resource ID is also known as the content ID.
    
    The following example shows a resource ID: MovieNight20171126093045
    
    Parameters:
    
    resourceId - The unique identifier for the content. The service sends this to the key server to identify the current endpoint. How unique you make this depends on how fine-grained you want access controls to be. The service does not permit you to use the same ID for two simultaneous encryption processes. The resource ID is also known as the content ID.
    
    The following example shows a resource ID: MovieNight20171126093045
  - getResourceId
```
public String getResourceId()
```
    The unique identifier for the content. The service sends this to the key server to identify the current endpoint. How unique you make this depends on how fine-grained you want access controls to be. The service does not permit you to use the same ID for two simultaneous encryption processes. The resource ID is also known as the content ID.
    
    The following example shows a resource ID: MovieNight20171126093045
    
    Returns:
    
    The unique identifier for the content. The service sends this to the key server to identify the current endpoint. How unique you make this depends on how fine-grained you want access controls to be. The service does not permit you to use the same ID for two simultaneous encryption processes. The resource ID is also known as the content ID.
    
    The following example shows a resource ID: MovieNight20171126093045
  - withResourceId
```
public SpekeKeyProvider withResourceId(String resourceId)
```
    The unique identifier for the content. The service sends this to the key server to identify the current endpoint. How unique you make this depends on how fine-grained you want access controls to be. The service does not permit you to use the same ID for two simultaneous encryption processes. The resource ID is also known as the content ID.
    
    The following example shows a resource ID: MovieNight20171126093045
    
    Parameters:
    
    resourceId - The unique identifier for the content. The service sends this to the key server to identify the current endpoint. How unique you make this depends on how fine-grained you want access controls to be. The service does not permit you to use the same ID for two simultaneous encryption processes. The resource ID is also known as the content ID.
    
    The following example shows a resource ID: MovieNight20171126093045
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getDrmSystems
```
public List<String> getDrmSystems()
```
    The DRM solution provider you're using to protect your content during distribution.
    
    Returns:
    
    The DRM solution provider you're using to protect your content during distribution.
    
    See Also:
    
    DrmSystem
  - setDrmSystems
```
public void setDrmSystems(Collection<String> drmSystems)
```
    The DRM solution provider you're using to protect your content during distribution.
    
    Parameters:
    
    drmSystems - The DRM solution provider you're using to protect your content during distribution.
    
    See Also:
    
    DrmSystem
  - withDrmSystems
```
public SpekeKeyProvider withDrmSystems(String... drmSystems)
```
    The DRM solution provider you're using to protect your content during distribution.
    
    NOTE: This method appends the values to the existing list (if any). Use setDrmSystems(java.util.Collection) or withDrmSystems(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    drmSystems - The DRM solution provider you're using to protect your content during distribution.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    DrmSystem
  - withDrmSystems
```
public SpekeKeyProvider withDrmSystems(Collection<String> drmSystems)
```
    The DRM solution provider you're using to protect your content during distribution.
    
    Parameters:
    
    drmSystems - The DRM solution provider you're using to protect your content during distribution.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    DrmSystem
  - withDrmSystems
```
public SpekeKeyProvider withDrmSystems(DrmSystem... drmSystems)
```
    The DRM solution provider you're using to protect your content during distribution.
    
    Parameters:
    
    drmSystems - The DRM solution provider you're using to protect your content during distribution.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    DrmSystem
  - setRoleArn
```
public void setRoleArn(String roleArn)
```
    The ARN for the IAM role granted by the key provider that provides access to the key provider API. This role must have a trust policy that allows MediaPackage to assume the role, and it must have a sufficient permissions policy to allow access to the specific key retrieval URL. Get this from your DRM solution provider.
    
    Valid format: arn:aws:iam::{accountID}:role/{name}. The following example shows a role ARN: arn:aws:iam::444455556666:role/SpekeAccess
    
    Parameters:
    
    roleArn - The ARN for the IAM role granted by the key provider that provides access to the key provider API. This role must have a trust policy that allows MediaPackage to assume the role, and it must have a sufficient permissions policy to allow access to the specific key retrieval URL. Get this from your DRM solution provider.
    
    Valid format: arn:aws:iam::{accountID}:role/{name}. The following example shows a role ARN: arn:aws:iam::444455556666:role/SpekeAccess
  - getRoleArn
```
public String getRoleArn()
```
    The ARN for the IAM role granted by the key provider that provides access to the key provider API. This role must have a trust policy that allows MediaPackage to assume the role, and it must have a sufficient permissions policy to allow access to the specific key retrieval URL. Get this from your DRM solution provider.
    
    Valid format: arn:aws:iam::{accountID}:role/{name}. The following example shows a role ARN: arn:aws:iam::444455556666:role/SpekeAccess
    
    Returns:
    
    The ARN for the IAM role granted by the key provider that provides access to the key provider API. This role must have a trust policy that allows MediaPackage to assume the role, and it must have a sufficient permissions policy to allow access to the specific key retrieval URL. Get this from your DRM solution provider.
    
    Valid format: arn:aws:iam::{accountID}:role/{name}. The following example shows a role ARN: arn:aws:iam::444455556666:role/SpekeAccess
  - withRoleArn
```
public SpekeKeyProvider withRoleArn(String roleArn)
```
    The ARN for the IAM role granted by the key provider that provides access to the key provider API. This role must have a trust policy that allows MediaPackage to assume the role, and it must have a sufficient permissions policy to allow access to the specific key retrieval URL. Get this from your DRM solution provider.
    
    Valid format: arn:aws:iam::{accountID}:role/{name}. The following example shows a role ARN: arn:aws:iam::444455556666:role/SpekeAccess
    
    Parameters:
    
    roleArn - The ARN for the IAM role granted by the key provider that provides access to the key provider API. This role must have a trust policy that allows MediaPackage to assume the role, and it must have a sufficient permissions policy to allow access to the specific key retrieval URL. Get this from your DRM solution provider.
    
    Valid format: arn:aws:iam::{accountID}:role/{name}. The following example shows a role ARN: arn:aws:iam::444455556666:role/SpekeAccess
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setUrl
```
public void setUrl(String url)
```
    The URL of the API Gateway proxy that you set up to talk to your key server. The API Gateway proxy must reside in the same AWS Region as MediaPackage and must start with https://.
    
    The following example shows a URL: https://1wm2dx1f33.execute-api.us-west-2.amazonaws.com/SpekeSample/copyProtection
    
    Parameters:
    
    url - The URL of the API Gateway proxy that you set up to talk to your key server. The API Gateway proxy must reside in the same AWS Region as MediaPackage and must start with https://.
    
    The following example shows a URL: https://1wm2dx1f33.execute-api.us-west-2.amazonaws.com/SpekeSample/copyProtection
  - getUrl
```
public String getUrl()
```
    The URL of the API Gateway proxy that you set up to talk to your key server. The API Gateway proxy must reside in the same AWS Region as MediaPackage and must start with https://.
    
    The following example shows a URL: https://1wm2dx1f33.execute-api.us-west-2.amazonaws.com/SpekeSample/copyProtection
    
    Returns:
    
    The URL of the API Gateway proxy that you set up to talk to your key server. The API Gateway proxy must reside in the same AWS Region as MediaPackage and must start with https://.
    
    The following example shows a URL: https://1wm2dx1f33.execute-api.us-west-2.amazonaws.com/SpekeSample/copyProtection
  - withUrl
```
public SpekeKeyProvider withUrl(String url)
```
    The URL of the API Gateway proxy that you set up to talk to your key server. The API Gateway proxy must reside in the same AWS Region as MediaPackage and must start with https://.
    
    The following example shows a URL: https://1wm2dx1f33.execute-api.us-west-2.amazonaws.com/SpekeSample/copyProtection
    
    Parameters:
    
    url - The URL of the API Gateway proxy that you set up to talk to your key server. The API Gateway proxy must reside in the same AWS Region as MediaPackage and must start with https://.
    
    The following example shows a URL: https://1wm2dx1f33.execute-api.us-west-2.amazonaws.com/SpekeSample/copyProtection
    
    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 SpekeKeyProvider 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.

AWS SDK for Java 1.x API Reference - 1.12.782

Class SpekeKeyProvider

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SpekeKeyProvider

Method Detail

setEncryptionContractConfiguration

getEncryptionContractConfiguration

withEncryptionContractConfiguration

setResourceId

getResourceId

withResourceId

getDrmSystems

setDrmSystems

withDrmSystems

withDrmSystems

withDrmSystems

setRoleArn

getRoleArn

withRoleArn

setUrl

getUrl

withUrl

toString

equals

hashCode

clone

marshall