« blib/lib/Paws/KinesisAnalytics/ReferenceDataSource.pm
↑ Summary
blib/lib/Paws/KinesisAnalytics/ReferenceDataSourceUpdate.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::KinesisAnalytics::ReferenceDataSourceDescription; | ||
| 3 | use Moose; | ||
| 4 | has ReferenceId => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has ReferenceSchema => (is => 'ro', isa => 'Paws::KinesisAnalytics::SourceSchema'); | ||
| 6 | has S3ReferenceDataSourceDescription => (is => 'ro', isa => 'Paws::KinesisAnalytics::S3ReferenceDataSourceDescription', required => 1); | ||
| 7 | has TableName => (is => 'ro', isa => 'Str', required => 1); | ||
| 8 | |||
| 9 | 1; | ||
| 10 | |||
| 11 | ### main pod documentation begin ### | ||
| 12 | |||
| 13 | =head1 NAME | ||
| 14 | |||
| 15 | Paws::KinesisAnalytics::ReferenceDataSourceDescription | ||
| 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::KinesisAnalytics::ReferenceDataSourceDescription object: | ||
| 27 | |||
| 28 | $service_obj->Method(Att1 => { ReferenceId => $value, ..., TableName => $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::KinesisAnalytics::ReferenceDataSourceDescription object: | ||
| 33 | |||
| 34 | $result = $service_obj->Method(...); | ||
| 35 | $result->Att1->ReferenceId | ||
| 36 | |||
| 37 | =head1 DESCRIPTION | ||
| 38 | |||
| 39 | Describes the reference data source configured for an application. | ||
| 40 | |||
| 41 | =head1 ATTRIBUTES | ||
| 42 | |||
| 43 | |||
| 44 | =head2 B<REQUIRED> ReferenceId => Str | ||
| 45 | |||
| 46 | ID of the reference data source. This is the ID that Amazon Kinesis | ||
| 47 | Analytics assigns when you add the reference data source to your | ||
| 48 | application using the AddApplicationReferenceDataSource | ||
| 49 | (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_AddApplicationReferenceDataSource.html) | ||
| 50 | operation. | ||
| 51 | |||
| 52 | |||
| 53 | =head2 ReferenceSchema => L<Paws::KinesisAnalytics::SourceSchema> | ||
| 54 | |||
| 55 | Describes the format of the data in the streaming source, and how each | ||
| 56 | data element maps to corresponding columns created in the | ||
| 57 | in-application stream. | ||
| 58 | |||
| 59 | |||
| 60 | =head2 B<REQUIRED> S3ReferenceDataSourceDescription => L<Paws::KinesisAnalytics::S3ReferenceDataSourceDescription> | ||
| 61 | |||
| 62 | Provides the S3 bucket name, the object key name that contains the | ||
| 63 | reference data. It also provides the Amazon Resource Name (ARN) of the | ||
| 64 | IAM role that Amazon Kinesis Analytics can assume to read the Amazon S3 | ||
| 65 | object and populate the in-application reference table. | ||
| 66 | |||
| 67 | |||
| 68 | =head2 B<REQUIRED> TableName => Str | ||
| 69 | |||
| 70 | The in-application table name created by the specific reference data | ||
| 71 | source configuration. | ||
| 72 | |||
| 73 | |||
| 74 | |||
| 75 | =head1 SEE ALSO | ||
| 76 | |||
| 77 | This class forms part of L<Paws>, describing an object used in L<Paws::KinesisAnalytics> | ||
| 78 | |||
| 79 | =head1 BUGS and CONTRIBUTIONS | ||
| 80 | |||
| 81 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 82 | |||
| 83 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 84 | |||
| 85 | =cut | ||
| 86 |