« blib/lib/Paws/Kinesis/StopStreamEncryption.pm
↑ Summary
blib/lib/Paws/Kinesis/StreamDescriptionSummary.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Kinesis::StreamDescription; | ||
| 3 | use Moose; | ||
| 4 | has EncryptionType => (is => 'ro', isa => 'Str'); | ||
| 5 | has EnhancedMonitoring => (is => 'ro', isa => 'ArrayRef[Paws::Kinesis::EnhancedMetrics]', required => 1); | ||
| 6 | has HasMoreShards => (is => 'ro', isa => 'Bool', required => 1); | ||
| 7 | has KeyId => (is => 'ro', isa => 'Str'); | ||
| 8 | has RetentionPeriodHours => (is => 'ro', isa => 'Int', required => 1); | ||
| 9 | has Shards => (is => 'ro', isa => 'ArrayRef[Paws::Kinesis::Shard]', required => 1); | ||
| 10 | has StreamARN => (is => 'ro', isa => 'Str', required => 1); | ||
| 11 | has StreamCreationTimestamp => (is => 'ro', isa => 'Str', required => 1); | ||
| 12 | has StreamName => (is => 'ro', isa => 'Str', required => 1); | ||
| 13 | has StreamStatus => (is => 'ro', isa => 'Str', required => 1); | ||
| 14 | |||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::Kinesis::StreamDescription | ||
| 22 | |||
| 23 | =head1 USAGE | ||
| 24 | |||
| 25 | This class represents one of two things: | ||
| 26 | |||
| 27 | =head3 Arguments in a call to a service | ||
| 28 | |||
| 29 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 30 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 31 | |||
| 32 | As an example, if Att1 is expected to be a Paws::Kinesis::StreamDescription object: | ||
| 33 | |||
| 34 | $service_obj->Method(Att1 => { EncryptionType => $value, ..., StreamStatus => $value }); | ||
| 35 | |||
| 36 | =head3 Results returned from an API call | ||
| 37 | |||
| 38 | Use accessors for each attribute. If Att1 is expected to be an Paws::Kinesis::StreamDescription object: | ||
| 39 | |||
| 40 | $result = $service_obj->Method(...); | ||
| 41 | $result->Att1->EncryptionType | ||
| 42 | |||
| 43 | =head1 DESCRIPTION | ||
| 44 | |||
| 45 | Represents the output for DescribeStream. | ||
| 46 | |||
| 47 | =head1 ATTRIBUTES | ||
| 48 | |||
| 49 | |||
| 50 | =head2 EncryptionType => Str | ||
| 51 | |||
| 52 | The server-side encryption type used on the stream. This parameter can | ||
| 53 | be one of the following values: | ||
| 54 | |||
| 55 | =over | ||
| 56 | |||
| 57 | =item * | ||
| 58 | |||
| 59 | C<NONE>: Do not encrypt the records in the stream. | ||
| 60 | |||
| 61 | =item * | ||
| 62 | |||
| 63 | C<KMS>: Use server-side encryption on the records in the stream using a | ||
| 64 | customer-managed AWS KMS key. | ||
| 65 | |||
| 66 | =back | ||
| 67 | |||
| 68 | |||
| 69 | |||
| 70 | =head2 B<REQUIRED> EnhancedMonitoring => ArrayRef[L<Paws::Kinesis::EnhancedMetrics>] | ||
| 71 | |||
| 72 | Represents the current enhanced monitoring settings of the stream. | ||
| 73 | |||
| 74 | |||
| 75 | =head2 B<REQUIRED> HasMoreShards => Bool | ||
| 76 | |||
| 77 | If set to C<true>, more shards in the stream are available to describe. | ||
| 78 | |||
| 79 | |||
| 80 | =head2 KeyId => Str | ||
| 81 | |||
| 82 | The GUID for the customer-managed AWS KMS key to use for encryption. | ||
| 83 | This value can be a globally unique identifier, a fully specified ARN | ||
| 84 | to either an alias or a key, or an alias name prefixed by "alias/".You | ||
| 85 | can also use a master key owned by Kinesis Data Streams by specifying | ||
| 86 | the alias C<aws/kinesis>. | ||
| 87 | |||
| 88 | =over | ||
| 89 | |||
| 90 | =item * | ||
| 91 | |||
| 92 | Key ARN example: | ||
| 93 | C<arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012> | ||
| 94 | |||
| 95 | =item * | ||
| 96 | |||
| 97 | Alias ARN example: | ||
| 98 | C<arn:aws:kms:us-east-1:123456789012:alias/MyAliasName> | ||
| 99 | |||
| 100 | =item * | ||
| 101 | |||
| 102 | Globally unique key ID example: C<12345678-1234-1234-1234-123456789012> | ||
| 103 | |||
| 104 | =item * | ||
| 105 | |||
| 106 | Alias name example: C<alias/MyAliasName> | ||
| 107 | |||
| 108 | =item * | ||
| 109 | |||
| 110 | Master key owned by Kinesis Data Streams: C<alias/aws/kinesis> | ||
| 111 | |||
| 112 | =back | ||
| 113 | |||
| 114 | |||
| 115 | |||
| 116 | =head2 B<REQUIRED> RetentionPeriodHours => Int | ||
| 117 | |||
| 118 | The current retention period, in hours. Minimum value of 24. Maximum | ||
| 119 | value of 168. | ||
| 120 | |||
| 121 | |||
| 122 | =head2 B<REQUIRED> Shards => ArrayRef[L<Paws::Kinesis::Shard>] | ||
| 123 | |||
| 124 | The shards that comprise the stream. | ||
| 125 | |||
| 126 | |||
| 127 | =head2 B<REQUIRED> StreamARN => Str | ||
| 128 | |||
| 129 | The Amazon Resource Name (ARN) for the stream being described. | ||
| 130 | |||
| 131 | |||
| 132 | =head2 B<REQUIRED> StreamCreationTimestamp => Str | ||
| 133 | |||
| 134 | The approximate time that the stream was created. | ||
| 135 | |||
| 136 | |||
| 137 | =head2 B<REQUIRED> StreamName => Str | ||
| 138 | |||
| 139 | The name of the stream being described. | ||
| 140 | |||
| 141 | |||
| 142 | =head2 B<REQUIRED> StreamStatus => Str | ||
| 143 | |||
| 144 | The current status of the stream being described. The stream status is | ||
| 145 | one of the following states: | ||
| 146 | |||
| 147 | =over | ||
| 148 | |||
| 149 | =item * | ||
| 150 | |||
| 151 | C<CREATING> - The stream is being created. Kinesis Data Streams | ||
| 152 | immediately returns and sets C<StreamStatus> to C<CREATING>. | ||
| 153 | |||
| 154 | =item * | ||
| 155 | |||
| 156 | C<DELETING> - The stream is being deleted. The specified stream is in | ||
| 157 | the C<DELETING> state until Kinesis Data Streams completes the | ||
| 158 | deletion. | ||
| 159 | |||
| 160 | =item * | ||
| 161 | |||
| 162 | C<ACTIVE> - The stream exists and is ready for read and write | ||
| 163 | operations or deletion. You should perform read and write operations | ||
| 164 | only on an C<ACTIVE> stream. | ||
| 165 | |||
| 166 | =item * | ||
| 167 | |||
| 168 | C<UPDATING> - Shards in the stream are being merged or split. Read and | ||
| 169 | write operations continue to work while the stream is in the | ||
| 170 | C<UPDATING> state. | ||
| 171 | |||
| 172 | =back | ||
| 173 | |||
| 174 | |||
| 175 | |||
| 176 | |||
| 177 | =head1 SEE ALSO | ||
| 178 | |||
| 179 | This class forms part of L<Paws>, describing an object used in L<Paws::Kinesis> | ||
| 180 | |||
| 181 | =head1 BUGS and CONTRIBUTIONS | ||
| 182 | |||
| 183 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 184 | |||
| 185 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 186 | |||
| 187 | =cut | ||
| 188 |