« blib/lib/Paws/Firehose/DeliveryStreamDescription.pm
↑ Summary
blib/lib/Paws/Firehose/DeliveryStreamEncryptionConfigurationInput.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Firehose::DeliveryStreamEncryptionConfiguration; | ||
| 3 | use Moose; | ||
| 4 | has FailureDescription => (is => 'ro', isa => 'Paws::Firehose::FailureDescription'); | ||
| 5 | has KeyARN => (is => 'ro', isa => 'Str'); | ||
| 6 | has KeyType => (is => 'ro', isa => 'Str'); | ||
| 7 | has Status => (is => 'ro', isa => 'Str'); | ||
| 8 | |||
| 9 | 1; | ||
| 10 | |||
| 11 | ### main pod documentation begin ### | ||
| 12 | |||
| 13 | =head1 NAME | ||
| 14 | |||
| 15 | Paws::Firehose::DeliveryStreamEncryptionConfiguration | ||
| 16 | |||
| 17 | =head1 USAGE | ||
| 18 | |||
| 19 | This class represents one of two things: | ||
| 20 | |||
| 21 | =head3 Arguments in a call to a service | ||
| 22 | |||
| 23 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 24 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 25 | |||
| 26 | As an example, if Att1 is expected to be a Paws::Firehose::DeliveryStreamEncryptionConfiguration object: | ||
| 27 | |||
| 28 | $service_obj->Method(Att1 => { FailureDescription => $value, ..., Status => $value }); | ||
| 29 | |||
| 30 | =head3 Results returned from an API call | ||
| 31 | |||
| 32 | Use accessors for each attribute. If Att1 is expected to be an Paws::Firehose::DeliveryStreamEncryptionConfiguration object: | ||
| 33 | |||
| 34 | $result = $service_obj->Method(...); | ||
| 35 | $result->Att1->FailureDescription | ||
| 36 | |||
| 37 | =head1 DESCRIPTION | ||
| 38 | |||
| 39 | Contains information about the server-side encryption (SSE) status for | ||
| 40 | the delivery stream, the type customer master key (CMK) in use, if any, | ||
| 41 | and the ARN of the CMK. You can get | ||
| 42 | C<DeliveryStreamEncryptionConfiguration> by invoking the | ||
| 43 | DescribeDeliveryStream operation. | ||
| 44 | |||
| 45 | =head1 ATTRIBUTES | ||
| 46 | |||
| 47 | |||
| 48 | =head2 FailureDescription => L<Paws::Firehose::FailureDescription> | ||
| 49 | |||
| 50 | Provides details in case one of the following operations fails due to | ||
| 51 | an error related to KMS: CreateDeliveryStream, DeleteDeliveryStream, | ||
| 52 | StartDeliveryStreamEncryption, StopDeliveryStreamEncryption. | ||
| 53 | |||
| 54 | |||
| 55 | =head2 KeyARN => Str | ||
| 56 | |||
| 57 | If C<KeyType> is C<CUSTOMER_MANAGED_CMK>, this field contains the ARN | ||
| 58 | of the customer managed CMK. If C<KeyType> is C<AWS_OWNED_CMK>, | ||
| 59 | C<DeliveryStreamEncryptionConfiguration> doesn't contain a value for | ||
| 60 | C<KeyARN>. | ||
| 61 | |||
| 62 | |||
| 63 | =head2 KeyType => Str | ||
| 64 | |||
| 65 | Indicates the type of customer master key (CMK) that is used for | ||
| 66 | encryption. The default setting is C<AWS_OWNED_CMK>. For more | ||
| 67 | information about CMKs, see Customer Master Keys (CMKs) | ||
| 68 | (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#master_keys). | ||
| 69 | |||
| 70 | |||
| 71 | =head2 Status => Str | ||
| 72 | |||
| 73 | This is the server-side encryption (SSE) status for the delivery | ||
| 74 | stream. For a full description of the different values of this status, | ||
| 75 | see StartDeliveryStreamEncryption and StopDeliveryStreamEncryption. If | ||
| 76 | this status is C<ENABLING_FAILED> or C<DISABLING_FAILED>, it is the | ||
| 77 | status of the most recent attempt to enable or disable SSE, | ||
| 78 | respectively. | ||
| 79 | |||
| 80 | |||
| 81 | |||
| 82 | =head1 SEE ALSO | ||
| 83 | |||
| 84 | This class forms part of L<Paws>, describing an object used in L<Paws::Firehose> | ||
| 85 | |||
| 86 | =head1 BUGS and CONTRIBUTIONS | ||
| 87 | |||
| 88 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 89 | |||
| 90 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 91 | |||
| 92 | =cut | ||
| 93 |