« blib/lib/Paws/Firehose/DeliveryStreamEncryptionConfiguration.pm
↑ Summary
blib/lib/Paws/Firehose/DescribeDeliveryStream.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Firehose::DeliveryStreamEncryptionConfigurationInput; | ||
| 3 | use Moose; | ||
| 4 | has KeyARN => (is => 'ro', isa => 'Str'); | ||
| 5 | has KeyType => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | |||
| 7 | 1; | ||
| 8 | |||
| 9 | ### main pod documentation begin ### | ||
| 10 | |||
| 11 | =head1 NAME | ||
| 12 | |||
| 13 | Paws::Firehose::DeliveryStreamEncryptionConfigurationInput | ||
| 14 | |||
| 15 | =head1 USAGE | ||
| 16 | |||
| 17 | This class represents one of two things: | ||
| 18 | |||
| 19 | =head3 Arguments in a call to a service | ||
| 20 | |||
| 21 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 22 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 23 | |||
| 24 | As an example, if Att1 is expected to be a Paws::Firehose::DeliveryStreamEncryptionConfigurationInput object: | ||
| 25 | |||
| 26 | $service_obj->Method(Att1 => { KeyARN => $value, ..., KeyType => $value }); | ||
| 27 | |||
| 28 | =head3 Results returned from an API call | ||
| 29 | |||
| 30 | Use accessors for each attribute. If Att1 is expected to be an Paws::Firehose::DeliveryStreamEncryptionConfigurationInput object: | ||
| 31 | |||
| 32 | $result = $service_obj->Method(...); | ||
| 33 | $result->Att1->KeyARN | ||
| 34 | |||
| 35 | =head1 DESCRIPTION | ||
| 36 | |||
| 37 | Specifies the type and Amazon Resource Name (ARN) of the CMK to use for | ||
| 38 | Server-Side Encryption (SSE). | ||
| 39 | |||
| 40 | =head1 ATTRIBUTES | ||
| 41 | |||
| 42 | |||
| 43 | =head2 KeyARN => Str | ||
| 44 | |||
| 45 | If you set C<KeyType> to C<CUSTOMER_MANAGED_CMK>, you must specify the | ||
| 46 | Amazon Resource Name (ARN) of the CMK. If you set C<KeyType> to | ||
| 47 | C<AWS_OWNED_CMK>, Kinesis Data Firehose uses a service-account CMK. | ||
| 48 | |||
| 49 | |||
| 50 | =head2 B<REQUIRED> KeyType => Str | ||
| 51 | |||
| 52 | Indicates the type of customer master key (CMK) to use for encryption. | ||
| 53 | The default setting is C<AWS_OWNED_CMK>. For more information about | ||
| 54 | CMKs, see Customer Master Keys (CMKs) | ||
| 55 | (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#master_keys). | ||
| 56 | When you invoke CreateDeliveryStream or StartDeliveryStreamEncryption | ||
| 57 | with C<KeyType> set to CUSTOMER_MANAGED_CMK, Kinesis Data Firehose | ||
| 58 | invokes the Amazon KMS operation CreateGrant | ||
| 59 | (https://docs.aws.amazon.com/kms/latest/APIReference/API_CreateGrant.html) | ||
| 60 | to create a grant that allows the Kinesis Data Firehose service to use | ||
| 61 | the customer managed CMK to perform encryption and decryption. Kinesis | ||
| 62 | Data Firehose manages that grant. | ||
| 63 | |||
| 64 | When you invoke StartDeliveryStreamEncryption to change the CMK for a | ||
| 65 | delivery stream that is encrypted with a customer managed CMK, Kinesis | ||
| 66 | Data Firehose schedules the grant it had on the old CMK for retirement. | ||
| 67 | |||
| 68 | You can use a CMK of type CUSTOMER_MANAGED_CMK to encrypt up to 500 | ||
| 69 | delivery streams. If a CreateDeliveryStream or | ||
| 70 | StartDeliveryStreamEncryption operation exceeds this limit, Kinesis | ||
| 71 | Data Firehose throws a C<LimitExceededException>. | ||
| 72 | |||
| 73 | To encrypt your delivery stream, use symmetric CMKs. Kinesis Data | ||
| 74 | Firehose doesn't support asymmetric CMKs. For information about | ||
| 75 | symmetric and asymmetric CMKs, see About Symmetric and Asymmetric CMKs | ||
| 76 | (https://docs.aws.amazon.com/kms/latest/developerguide/symm-asymm-concepts.html) | ||
| 77 | in the AWS Key Management Service developer guide. | ||
| 78 | |||
| 79 | |||
| 80 | |||
| 81 | =head1 SEE ALSO | ||
| 82 | |||
| 83 | This class forms part of L<Paws>, describing an object used in L<Paws::Firehose> | ||
| 84 | |||
| 85 | =head1 BUGS and CONTRIBUTIONS | ||
| 86 | |||
| 87 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 88 | |||
| 89 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 90 | |||
| 91 | =cut | ||
| 92 |