Class SseAwsKeyManagementParams

java.lang.Object
software.amazon.awssdk.services.chimesdkmediapipelines.model.SseAwsKeyManagementParams
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<SseAwsKeyManagementParams.Builder,SseAwsKeyManagementParams>
@Generated("software.amazon.awssdk:codegen") public final class SseAwsKeyManagementParams extends Object implements SdkPojo, Serializable, ToCopyableBuilder<SseAwsKeyManagementParams.Builder,SseAwsKeyManagementParams>

Contains server side encryption parameters to be used by media capture pipeline. The parameters can also be used by media concatenation pipeline taking media capture pipeline as a media source.

See Also:

  • Method Details

    • awsKmsKeyId

      public final String awsKmsKeyId()

      The KMS key you want to use to encrypt your media pipeline output. Decryption is required for concatenation pipeline. If using a key located in the current Amazon Web Services account, you can specify your KMS key in one of four ways:

      • Use the KMS key ID itself. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.

      • Use an alias for the KMS key ID. For example, alias/ExampleAlias.

      • Use the Amazon Resource Name (ARN) for the KMS key ID. For example, arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.

      • Use the ARN for the KMS key alias. For example, arn:aws:kms:region:account-ID:alias/ExampleAlias.

      If using a key located in a different Amazon Web Services account than the current Amazon Web Services account, you can specify your KMS key in one of two ways:

      • Use the ARN for the KMS key ID. For example, arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.

      • Use the ARN for the KMS key alias. For example, arn:aws:kms:region:account-ID:alias/ExampleAlias.

      If you don't specify an encryption key, your output is encrypted with the default Amazon S3 key (SSE-S3).

      Note that the role specified in the SinkIamRoleArn request parameter must have permission to use the specified KMS key.

      Returns:
      The KMS key you want to use to encrypt your media pipeline output. Decryption is required for concatenation pipeline. If using a key located in the current Amazon Web Services account, you can specify your KMS key in one of four ways:

      • Use the KMS key ID itself. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.

      • Use an alias for the KMS key ID. For example, alias/ExampleAlias.

      • Use the Amazon Resource Name (ARN) for the KMS key ID. For example, arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.

      • Use the ARN for the KMS key alias. For example, arn:aws:kms:region:account-ID:alias/ExampleAlias.

      If using a key located in a different Amazon Web Services account than the current Amazon Web Services account, you can specify your KMS key in one of two ways:

      • Use the ARN for the KMS key ID. For example, arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.

      • Use the ARN for the KMS key alias. For example, arn:aws:kms:region:account-ID:alias/ExampleAlias.

      If you don't specify an encryption key, your output is encrypted with the default Amazon S3 key (SSE-S3).

      Note that the role specified in the SinkIamRoleArn request parameter must have permission to use the specified KMS key.

    • awsKmsEncryptionContext

      public final String awsKmsEncryptionContext()

      Base64-encoded string of a UTF-8 encoded JSON, which contains the encryption context as non-secret key-value pair known as encryption context pairs, that provides an added layer of security for your data. For more information, see KMS encryption context and Asymmetric keys in KMS in the Key Management Service Developer Guide.

      Returns:
      Base64-encoded string of a UTF-8 encoded JSON, which contains the encryption context as non-secret key-value pair known as encryption context pairs, that provides an added layer of security for your data. For more information, see KMS encryption context and Asymmetric keys in KMS in the Key Management Service Developer Guide.

    • toBuilder

      public SseAwsKeyManagementParams.Builder 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 interface ToCopyableBuilder<SseAwsKeyManagementParams.Builder,SseAwsKeyManagementParams>
      Returns:
      a builder for type T

    • builder

      public static SseAwsKeyManagementParams.Builder builder()

    • serializableBuilderClass

      public static Class<? extends SseAwsKeyManagementParams.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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.