« blib/lib/Paws/MediaConnect/EncodingParametersRequest.pm
↑ Summary
blib/lib/Paws/MediaConnect/Entitlement.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::MediaConnect::Encryption; | ||
| 3 | use Moose; | ||
| 4 | has Algorithm => (is => 'ro', isa => 'Str', request_name => 'algorithm', traits => ['NameInRequest']); | ||
| 5 | has ConstantInitializationVector => (is => 'ro', isa => 'Str', request_name => 'constantInitializationVector', traits => ['NameInRequest']); | ||
| 6 | has DeviceId => (is => 'ro', isa => 'Str', request_name => 'deviceId', traits => ['NameInRequest']); | ||
| 7 | has KeyType => (is => 'ro', isa => 'Str', request_name => 'keyType', traits => ['NameInRequest']); | ||
| 8 | has Region => (is => 'ro', isa => 'Str', request_name => 'region', traits => ['NameInRequest']); | ||
| 9 | has ResourceId => (is => 'ro', isa => 'Str', request_name => 'resourceId', traits => ['NameInRequest']); | ||
| 10 | has RoleArn => (is => 'ro', isa => 'Str', request_name => 'roleArn', traits => ['NameInRequest'], required => 1); | ||
| 11 | has SecretArn => (is => 'ro', isa => 'Str', request_name => 'secretArn', traits => ['NameInRequest']); | ||
| 12 | has Url => (is => 'ro', isa => 'Str', request_name => 'url', traits => ['NameInRequest']); | ||
| 13 | |||
| 14 | 1; | ||
| 15 | |||
| 16 | ### main pod documentation begin ### | ||
| 17 | |||
| 18 | =head1 NAME | ||
| 19 | |||
| 20 | Paws::MediaConnect::Encryption | ||
| 21 | |||
| 22 | =head1 USAGE | ||
| 23 | |||
| 24 | This class represents one of two things: | ||
| 25 | |||
| 26 | =head3 Arguments in a call to a service | ||
| 27 | |||
| 28 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 29 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 30 | |||
| 31 | As an example, if Att1 is expected to be a Paws::MediaConnect::Encryption object: | ||
| 32 | |||
| 33 | $service_obj->Method(Att1 => { Algorithm => $value, ..., Url => $value }); | ||
| 34 | |||
| 35 | =head3 Results returned from an API call | ||
| 36 | |||
| 37 | Use accessors for each attribute. If Att1 is expected to be an Paws::MediaConnect::Encryption object: | ||
| 38 | |||
| 39 | $result = $service_obj->Method(...); | ||
| 40 | $result->Att1->Algorithm | ||
| 41 | |||
| 42 | =head1 DESCRIPTION | ||
| 43 | |||
| 44 | Information about the encryption of the flow. | ||
| 45 | |||
| 46 | =head1 ATTRIBUTES | ||
| 47 | |||
| 48 | |||
| 49 | =head2 Algorithm => Str | ||
| 50 | |||
| 51 | The type of algorithm that is used for the encryption (such as aes128, | ||
| 52 | aes192, or aes256). | ||
| 53 | |||
| 54 | |||
| 55 | =head2 ConstantInitializationVector => Str | ||
| 56 | |||
| 57 | A 128-bit, 16-byte hex value represented by a 32-character string, to | ||
| 58 | be used with the key for encrypting content. This parameter is not | ||
| 59 | valid for static key encryption. | ||
| 60 | |||
| 61 | |||
| 62 | =head2 DeviceId => Str | ||
| 63 | |||
| 64 | The value of one of the devices that you configured with your digital | ||
| 65 | rights management (DRM) platform key provider. This parameter is | ||
| 66 | required for SPEKE encryption and is not valid for static key | ||
| 67 | encryption. | ||
| 68 | |||
| 69 | |||
| 70 | =head2 KeyType => Str | ||
| 71 | |||
| 72 | The type of key that is used for the encryption. If no keyType is | ||
| 73 | provided, the service will use the default setting (static-key). | ||
| 74 | |||
| 75 | |||
| 76 | =head2 Region => Str | ||
| 77 | |||
| 78 | The AWS Region that the API Gateway proxy endpoint was created in. This | ||
| 79 | parameter is required for SPEKE encryption and is not valid for static | ||
| 80 | key encryption. | ||
| 81 | |||
| 82 | |||
| 83 | =head2 ResourceId => Str | ||
| 84 | |||
| 85 | An identifier for the content. The service sends this value to the key | ||
| 86 | server to identify the current endpoint. The resource ID is also known | ||
| 87 | as the content ID. This parameter is required for SPEKE encryption and | ||
| 88 | is not valid for static key encryption. | ||
| 89 | |||
| 90 | |||
| 91 | =head2 B<REQUIRED> RoleArn => Str | ||
| 92 | |||
| 93 | The ARN of the role that you created during setup (when you set up AWS | ||
| 94 | Elemental MediaConnect as a trusted entity). | ||
| 95 | |||
| 96 | |||
| 97 | =head2 SecretArn => Str | ||
| 98 | |||
| 99 | The ARN of the secret that you created in AWS Secrets Manager to store | ||
| 100 | the encryption key. This parameter is required for static key | ||
| 101 | encryption and is not valid for SPEKE encryption. | ||
| 102 | |||
| 103 | |||
| 104 | =head2 Url => Str | ||
| 105 | |||
| 106 | The URL from the API Gateway proxy that you set up to talk to your key | ||
| 107 | server. This parameter is required for SPEKE encryption and is not | ||
| 108 | valid for static key encryption. | ||
| 109 | |||
| 110 | |||
| 111 | |||
| 112 | =head1 SEE ALSO | ||
| 113 | |||
| 114 | This class forms part of L<Paws>, describing an object used in L<Paws::MediaConnect> | ||
| 115 | |||
| 116 | =head1 BUGS and CONTRIBUTIONS | ||
| 117 | |||
| 118 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 119 | |||
| 120 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 121 | |||
| 122 | =cut | ||
| 123 |