com.amazonaws.services.mediapackagev2.model.SpekeKeyProvider Maven / Gradle / Ivy
Show all versions of aws-java-sdk-mediapackagev2 Show documentation
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.mediapackagev2.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* The parameters for the SPEKE key provider.
*
*
* @see AWS
* API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class SpekeKeyProvider implements Serializable, Cloneable, StructuredPojo {
/**
*
* 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.
*
*/
private EncryptionContractConfiguration encryptionContractConfiguration;
/**
*
* 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
*
*/
private String resourceId;
/**
*
* The DRM solution provider you're using to protect your content during distribution.
*
*/
private java.util.List drmSystems;
/**
*
* 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
*
*/
private String roleArn;
/**
*
* 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
*
*/
private String url;
/**
*
* 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.
*
*
* @param 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.
*/
public void setEncryptionContractConfiguration(EncryptionContractConfiguration encryptionContractConfiguration) {
this.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.
*
*
* @return 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.
*/
public EncryptionContractConfiguration getEncryptionContractConfiguration() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SpekeKeyProvider withEncryptionContractConfiguration(EncryptionContractConfiguration encryptionContractConfiguration) {
setEncryptionContractConfiguration(encryptionContractConfiguration);
return this;
}
/**
*
* 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
*
*
* @param 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
*/
public void setResourceId(String resourceId) {
this.resourceId = 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
*
*
* @return 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
*/
public String getResourceId() {
return this.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
*
*
* @param 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
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SpekeKeyProvider withResourceId(String resourceId) {
setResourceId(resourceId);
return this;
}
/**
*
* The DRM solution provider you're using to protect your content during distribution.
*
*
* @return The DRM solution provider you're using to protect your content during distribution.
* @see DrmSystem
*/
public java.util.List getDrmSystems() {
return drmSystems;
}
/**
*
* The DRM solution provider you're using to protect your content during distribution.
*
*
* @param drmSystems
* The DRM solution provider you're using to protect your content during distribution.
* @see DrmSystem
*/
public void setDrmSystems(java.util.Collection drmSystems) {
if (drmSystems == null) {
this.drmSystems = null;
return;
}
this.drmSystems = new java.util.ArrayList(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
* {@link #setDrmSystems(java.util.Collection)} or {@link #withDrmSystems(java.util.Collection)} if you want to
* override the existing values.
*
*
* @param drmSystems
* The DRM solution provider you're using to protect your content during distribution.
* @return Returns a reference to this object so that method calls can be chained together.
* @see DrmSystem
*/
public SpekeKeyProvider withDrmSystems(String... drmSystems) {
if (this.drmSystems == null) {
setDrmSystems(new java.util.ArrayList(drmSystems.length));
}
for (String ele : drmSystems) {
this.drmSystems.add(ele);
}
return this;
}
/**
*
* The DRM solution provider you're using to protect your content during distribution.
*
*
* @param drmSystems
* The DRM solution provider you're using to protect your content during distribution.
* @return Returns a reference to this object so that method calls can be chained together.
* @see DrmSystem
*/
public SpekeKeyProvider withDrmSystems(java.util.Collection drmSystems) {
setDrmSystems(drmSystems);
return this;
}
/**
*
* The DRM solution provider you're using to protect your content during distribution.
*
*
* @param drmSystems
* The DRM solution provider you're using to protect your content during distribution.
* @return Returns a reference to this object so that method calls can be chained together.
* @see DrmSystem
*/
public SpekeKeyProvider withDrmSystems(DrmSystem... drmSystems) {
java.util.ArrayList drmSystemsCopy = new java.util.ArrayList(drmSystems.length);
for (DrmSystem value : drmSystems) {
drmSystemsCopy.add(value.toString());
}
if (getDrmSystems() == null) {
setDrmSystems(drmSystemsCopy);
} else {
getDrmSystems().addAll(drmSystemsCopy);
}
return this;
}
/**
*
* 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
*
*
* @param 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
*/
public void setRoleArn(String roleArn) {
this.roleArn = 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
*
*
* @return 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
*/
public String getRoleArn() {
return this.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
*
*
* @param 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
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SpekeKeyProvider withRoleArn(String roleArn) {
setRoleArn(roleArn);
return this;
}
/**
*
* 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
*
*
* @param 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
*/
public void setUrl(String url) {
this.url = 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
*
*
* @return 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
*/
public String getUrl() {
return this.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
*
*
* @param 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
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SpekeKeyProvider withUrl(String url) {
setUrl(url);
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getEncryptionContractConfiguration() != null)
sb.append("EncryptionContractConfiguration: ").append(getEncryptionContractConfiguration()).append(",");
if (getResourceId() != null)
sb.append("ResourceId: ").append(getResourceId()).append(",");
if (getDrmSystems() != null)
sb.append("DrmSystems: ").append(getDrmSystems()).append(",");
if (getRoleArn() != null)
sb.append("RoleArn: ").append(getRoleArn()).append(",");
if (getUrl() != null)
sb.append("Url: ").append(getUrl());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof SpekeKeyProvider == false)
return false;
SpekeKeyProvider other = (SpekeKeyProvider) obj;
if (other.getEncryptionContractConfiguration() == null ^ this.getEncryptionContractConfiguration() == null)
return false;
if (other.getEncryptionContractConfiguration() != null
&& other.getEncryptionContractConfiguration().equals(this.getEncryptionContractConfiguration()) == false)
return false;
if (other.getResourceId() == null ^ this.getResourceId() == null)
return false;
if (other.getResourceId() != null && other.getResourceId().equals(this.getResourceId()) == false)
return false;
if (other.getDrmSystems() == null ^ this.getDrmSystems() == null)
return false;
if (other.getDrmSystems() != null && other.getDrmSystems().equals(this.getDrmSystems()) == false)
return false;
if (other.getRoleArn() == null ^ this.getRoleArn() == null)
return false;
if (other.getRoleArn() != null && other.getRoleArn().equals(this.getRoleArn()) == false)
return false;
if (other.getUrl() == null ^ this.getUrl() == null)
return false;
if (other.getUrl() != null && other.getUrl().equals(this.getUrl()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getEncryptionContractConfiguration() == null) ? 0 : getEncryptionContractConfiguration().hashCode());
hashCode = prime * hashCode + ((getResourceId() == null) ? 0 : getResourceId().hashCode());
hashCode = prime * hashCode + ((getDrmSystems() == null) ? 0 : getDrmSystems().hashCode());
hashCode = prime * hashCode + ((getRoleArn() == null) ? 0 : getRoleArn().hashCode());
hashCode = prime * hashCode + ((getUrl() == null) ? 0 : getUrl().hashCode());
return hashCode;
}
@Override
public SpekeKeyProvider clone() {
try {
return (SpekeKeyProvider) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
@com.amazonaws.annotation.SdkInternalApi
@Override
public void marshall(ProtocolMarshaller protocolMarshaller) {
com.amazonaws.services.mediapackagev2.model.transform.SpekeKeyProviderMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}