« blib/lib/Paws/Firehose/DeleteDeliveryStreamOutput.pm
↑ Summary
blib/lib/Paws/Firehose/DeliveryStreamEncryptionConfiguration.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Firehose::DeliveryStreamDescription; | ||
| 3 | use Moose; | ||
| 4 | has CreateTimestamp => (is => 'ro', isa => 'Str'); | ||
| 5 | has DeliveryStreamARN => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has DeliveryStreamEncryptionConfiguration => (is => 'ro', isa => 'Paws::Firehose::DeliveryStreamEncryptionConfiguration'); | ||
| 7 | has DeliveryStreamName => (is => 'ro', isa => 'Str', required => 1); | ||
| 8 | has DeliveryStreamStatus => (is => 'ro', isa => 'Str', required => 1); | ||
| 9 | has DeliveryStreamType => (is => 'ro', isa => 'Str', required => 1); | ||
| 10 | has Destinations => (is => 'ro', isa => 'ArrayRef[Paws::Firehose::DestinationDescription]', required => 1); | ||
| 11 | has FailureDescription => (is => 'ro', isa => 'Paws::Firehose::FailureDescription'); | ||
| 12 | has HasMoreDestinations => (is => 'ro', isa => 'Bool', required => 1); | ||
| 13 | has LastUpdateTimestamp => (is => 'ro', isa => 'Str'); | ||
| 14 | has Source => (is => 'ro', isa => 'Paws::Firehose::SourceDescription'); | ||
| 15 | has VersionId => (is => 'ro', isa => 'Str', required => 1); | ||
| 16 | |||
| 17 | 1; | ||
| 18 | |||
| 19 | ### main pod documentation begin ### | ||
| 20 | |||
| 21 | =head1 NAME | ||
| 22 | |||
| 23 | Paws::Firehose::DeliveryStreamDescription | ||
| 24 | |||
| 25 | =head1 USAGE | ||
| 26 | |||
| 27 | This class represents one of two things: | ||
| 28 | |||
| 29 | =head3 Arguments in a call to a service | ||
| 30 | |||
| 31 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 32 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 33 | |||
| 34 | As an example, if Att1 is expected to be a Paws::Firehose::DeliveryStreamDescription object: | ||
| 35 | |||
| 36 | $service_obj->Method(Att1 => { CreateTimestamp => $value, ..., VersionId => $value }); | ||
| 37 | |||
| 38 | =head3 Results returned from an API call | ||
| 39 | |||
| 40 | Use accessors for each attribute. If Att1 is expected to be an Paws::Firehose::DeliveryStreamDescription object: | ||
| 41 | |||
| 42 | $result = $service_obj->Method(...); | ||
| 43 | $result->Att1->CreateTimestamp | ||
| 44 | |||
| 45 | =head1 DESCRIPTION | ||
| 46 | |||
| 47 | Contains information about a delivery stream. | ||
| 48 | |||
| 49 | =head1 ATTRIBUTES | ||
| 50 | |||
| 51 | |||
| 52 | =head2 CreateTimestamp => Str | ||
| 53 | |||
| 54 | The date and time that the delivery stream was created. | ||
| 55 | |||
| 56 | |||
| 57 | =head2 B<REQUIRED> DeliveryStreamARN => Str | ||
| 58 | |||
| 59 | The Amazon Resource Name (ARN) of the delivery stream. For more | ||
| 60 | information, see Amazon Resource Names (ARNs) and AWS Service | ||
| 61 | Namespaces | ||
| 62 | (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html). | ||
| 63 | |||
| 64 | |||
| 65 | =head2 DeliveryStreamEncryptionConfiguration => L<Paws::Firehose::DeliveryStreamEncryptionConfiguration> | ||
| 66 | |||
| 67 | Indicates the server-side encryption (SSE) status for the delivery | ||
| 68 | stream. | ||
| 69 | |||
| 70 | |||
| 71 | =head2 B<REQUIRED> DeliveryStreamName => Str | ||
| 72 | |||
| 73 | The name of the delivery stream. | ||
| 74 | |||
| 75 | |||
| 76 | =head2 B<REQUIRED> DeliveryStreamStatus => Str | ||
| 77 | |||
| 78 | The status of the delivery stream. If the status of a delivery stream | ||
| 79 | is C<CREATING_FAILED>, this status doesn't change, and you can't invoke | ||
| 80 | C<CreateDeliveryStream> again on it. However, you can invoke the | ||
| 81 | DeleteDeliveryStream operation to delete it. | ||
| 82 | |||
| 83 | |||
| 84 | =head2 B<REQUIRED> DeliveryStreamType => Str | ||
| 85 | |||
| 86 | The delivery stream type. This can be one of the following values: | ||
| 87 | |||
| 88 | =over | ||
| 89 | |||
| 90 | =item * | ||
| 91 | |||
| 92 | C<DirectPut>: Provider applications access the delivery stream | ||
| 93 | directly. | ||
| 94 | |||
| 95 | =item * | ||
| 96 | |||
| 97 | C<KinesisStreamAsSource>: The delivery stream uses a Kinesis data | ||
| 98 | stream as a source. | ||
| 99 | |||
| 100 | =back | ||
| 101 | |||
| 102 | |||
| 103 | |||
| 104 | =head2 B<REQUIRED> Destinations => ArrayRef[L<Paws::Firehose::DestinationDescription>] | ||
| 105 | |||
| 106 | The destinations. | ||
| 107 | |||
| 108 | |||
| 109 | =head2 FailureDescription => L<Paws::Firehose::FailureDescription> | ||
| 110 | |||
| 111 | Provides details in case one of the following operations fails due to | ||
| 112 | an error related to KMS: CreateDeliveryStream, DeleteDeliveryStream, | ||
| 113 | StartDeliveryStreamEncryption, StopDeliveryStreamEncryption. | ||
| 114 | |||
| 115 | |||
| 116 | =head2 B<REQUIRED> HasMoreDestinations => Bool | ||
| 117 | |||
| 118 | Indicates whether there are more destinations available to list. | ||
| 119 | |||
| 120 | |||
| 121 | =head2 LastUpdateTimestamp => Str | ||
| 122 | |||
| 123 | The date and time that the delivery stream was last updated. | ||
| 124 | |||
| 125 | |||
| 126 | =head2 Source => L<Paws::Firehose::SourceDescription> | ||
| 127 | |||
| 128 | If the C<DeliveryStreamType> parameter is C<KinesisStreamAsSource>, a | ||
| 129 | SourceDescription object describing the source Kinesis data stream. | ||
| 130 | |||
| 131 | |||
| 132 | =head2 B<REQUIRED> VersionId => Str | ||
| 133 | |||
| 134 | Each time the destination is updated for a delivery stream, the version | ||
| 135 | ID is changed, and the current version ID is required when updating the | ||
| 136 | destination. This is so that the service knows it is applying the | ||
| 137 | changes to the correct version of the delivery stream. | ||
| 138 | |||
| 139 | |||
| 140 | |||
| 141 | =head1 SEE ALSO | ||
| 142 | |||
| 143 | This class forms part of L<Paws>, describing an object used in L<Paws::Firehose> | ||
| 144 | |||
| 145 | =head1 BUGS and CONTRIBUTIONS | ||
| 146 | |||
| 147 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 148 | |||
| 149 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 150 | |||
| 151 | =cut | ||
| 152 |