« blib/lib/Paws/KinesisAnalytics/CloudWatchLoggingOptionUpdate.pm
↑ Summary
blib/lib/Paws/KinesisAnalytics/CreateApplicationResponse.pm »
| 1 | |||
| 2 | package Paws::KinesisAnalytics::CreateApplication; | ||
| 3 | use Moose; | ||
| 4 | has ApplicationCode => (is => 'ro', isa => 'Str'); | ||
| 5 | has ApplicationDescription => (is => 'ro', isa => 'Str'); | ||
| 6 | has ApplicationName => (is => 'ro', isa => 'Str', required => 1); | ||
| 7 | has CloudWatchLoggingOptions => (is => 'ro', isa => 'ArrayRef[Paws::KinesisAnalytics::CloudWatchLoggingOption]'); | ||
| 8 | has Inputs => (is => 'ro', isa => 'ArrayRef[Paws::KinesisAnalytics::Input]'); | ||
| 9 | has Outputs => (is => 'ro', isa => 'ArrayRef[Paws::KinesisAnalytics::Output]'); | ||
| 10 | has Tags => (is => 'ro', isa => 'ArrayRef[Paws::KinesisAnalytics::Tag]'); | ||
| 11 | |||
| 12 | use MooseX::ClassAttribute; | ||
| 13 | |||
| 14 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateApplication'); | ||
| 15 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::KinesisAnalytics::CreateApplicationResponse'); | ||
| 16 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 17 | 1; | ||
| 18 | |||
| 19 | ### main pod documentation begin ### | ||
| 20 | |||
| 21 | =head1 NAME | ||
| 22 | |||
| 23 | Paws::KinesisAnalytics::CreateApplication - Arguments for method CreateApplication on L<Paws::KinesisAnalytics> | ||
| 24 | |||
| 25 | =head1 DESCRIPTION | ||
| 26 | |||
| 27 | This class represents the parameters used for calling the method CreateApplication on the | ||
| 28 | L<Amazon Kinesis Analytics|Paws::KinesisAnalytics> service. Use the attributes of this class | ||
| 29 | as arguments to method CreateApplication. | ||
| 30 | |||
| 31 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateApplication. | ||
| 32 | |||
| 33 | =head1 SYNOPSIS | ||
| 34 | |||
| 35 | my $kinesisanalytics = Paws->service('KinesisAnalytics'); | ||
| 36 | my $CreateApplicationResponse = $kinesisanalytics->CreateApplication( | ||
| 37 | ApplicationName => 'MyApplicationName', | ||
| 38 | ApplicationCode => 'MyApplicationCode', # OPTIONAL | ||
| 39 | ApplicationDescription => 'MyApplicationDescription', # OPTIONAL | ||
| 40 | CloudWatchLoggingOptions => [ | ||
| 41 | { | ||
| 42 | LogStreamARN => 'MyLogStreamARN', # min: 1, max: 2048 | ||
| 43 | RoleARN => 'MyRoleARN', # min: 1, max: 2048 | ||
| 44 | |||
| 45 | }, | ||
| 46 | ... | ||
| 47 | ], # OPTIONAL | ||
| 48 | Inputs => [ | ||
| 49 | { | ||
| 50 | InputSchema => { | ||
| 51 | RecordColumns => [ | ||
| 52 | { | ||
| 53 | Name => 'MyRecordColumnName', | ||
| 54 | SqlType => 'MyRecordColumnSqlType', # min: 1 | ||
| 55 | Mapping => 'MyRecordColumnMapping', # OPTIONAL | ||
| 56 | }, | ||
| 57 | ... | ||
| 58 | ], # min: 1, max: 1000 | ||
| 59 | RecordFormat => { | ||
| 60 | RecordFormatType => 'JSON', # values: JSON, CSV | ||
| 61 | MappingParameters => { | ||
| 62 | CSVMappingParameters => { | ||
| 63 | RecordColumnDelimiter => 'MyRecordColumnDelimiter', # min: 1 | ||
| 64 | RecordRowDelimiter => 'MyRecordRowDelimiter', # min: 1 | ||
| 65 | |||
| 66 | }, # OPTIONAL | ||
| 67 | JSONMappingParameters => { | ||
| 68 | RecordRowPath => 'MyRecordRowPath', # min: 1 | ||
| 69 | |||
| 70 | }, # OPTIONAL | ||
| 71 | }, # OPTIONAL | ||
| 72 | }, | ||
| 73 | RecordEncoding => 'MyRecordEncoding', # OPTIONAL | ||
| 74 | }, | ||
| 75 | NamePrefix => 'MyInAppStreamName', # min: 1, max: 32 | ||
| 76 | InputParallelism => { | ||
| 77 | Count => 1, # min: 1, max: 64; OPTIONAL | ||
| 78 | }, # OPTIONAL | ||
| 79 | InputProcessingConfiguration => { | ||
| 80 | InputLambdaProcessor => { | ||
| 81 | ResourceARN => 'MyResourceARN', # min: 1, max: 2048 | ||
| 82 | RoleARN => 'MyRoleARN', # min: 1, max: 2048 | ||
| 83 | |||
| 84 | }, | ||
| 85 | |||
| 86 | }, # OPTIONAL | ||
| 87 | KinesisFirehoseInput => { | ||
| 88 | ResourceARN => 'MyResourceARN', # min: 1, max: 2048 | ||
| 89 | RoleARN => 'MyRoleARN', # min: 1, max: 2048 | ||
| 90 | |||
| 91 | }, # OPTIONAL | ||
| 92 | KinesisStreamsInput => { | ||
| 93 | ResourceARN => 'MyResourceARN', # min: 1, max: 2048 | ||
| 94 | RoleARN => 'MyRoleARN', # min: 1, max: 2048 | ||
| 95 | |||
| 96 | }, # OPTIONAL | ||
| 97 | }, | ||
| 98 | ... | ||
| 99 | ], # OPTIONAL | ||
| 100 | Outputs => [ | ||
| 101 | { | ||
| 102 | DestinationSchema => { | ||
| 103 | RecordFormatType => 'JSON', # values: JSON, CSV | ||
| 104 | |||
| 105 | }, | ||
| 106 | Name => 'MyInAppStreamName', # min: 1, max: 32 | ||
| 107 | KinesisFirehoseOutput => { | ||
| 108 | ResourceARN => 'MyResourceARN', # min: 1, max: 2048 | ||
| 109 | RoleARN => 'MyRoleARN', # min: 1, max: 2048 | ||
| 110 | |||
| 111 | }, # OPTIONAL | ||
| 112 | KinesisStreamsOutput => { | ||
| 113 | ResourceARN => 'MyResourceARN', # min: 1, max: 2048 | ||
| 114 | RoleARN => 'MyRoleARN', # min: 1, max: 2048 | ||
| 115 | |||
| 116 | }, # OPTIONAL | ||
| 117 | LambdaOutput => { | ||
| 118 | ResourceARN => 'MyResourceARN', # min: 1, max: 2048 | ||
| 119 | RoleARN => 'MyRoleARN', # min: 1, max: 2048 | ||
| 120 | |||
| 121 | }, # OPTIONAL | ||
| 122 | }, | ||
| 123 | ... | ||
| 124 | ], # OPTIONAL | ||
| 125 | Tags => [ | ||
| 126 | { | ||
| 127 | Key => 'MyTagKey', # min: 1, max: 128 | ||
| 128 | Value => 'MyTagValue', # max: 256; OPTIONAL | ||
| 129 | }, | ||
| 130 | ... | ||
| 131 | ], # OPTIONAL | ||
| 132 | ); | ||
| 133 | |||
| 134 | # Results: | ||
| 135 | my $ApplicationSummary = $CreateApplicationResponse->ApplicationSummary; | ||
| 136 | |||
| 137 | # Returns a L<Paws::KinesisAnalytics::CreateApplicationResponse> object. | ||
| 138 | |||
| 139 | Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. | ||
| 140 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/kinesisanalytics/CreateApplication> | ||
| 141 | |||
| 142 | =head1 ATTRIBUTES | ||
| 143 | |||
| 144 | |||
| 145 | =head2 ApplicationCode => Str | ||
| 146 | |||
| 147 | One or more SQL statements that read input data, transform it, and | ||
| 148 | generate output. For example, you can write a SQL statement that reads | ||
| 149 | data from one in-application stream, generates a running average of the | ||
| 150 | number of advertisement clicks by vendor, and insert resulting rows in | ||
| 151 | another in-application stream using pumps. For more information about | ||
| 152 | the typical pattern, see Application Code | ||
| 153 | (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-app-code.html). | ||
| 154 | |||
| 155 | You can provide such series of SQL statements, where output of one | ||
| 156 | statement can be used as the input for the next statement. You store | ||
| 157 | intermediate results by creating in-application streams and pumps. | ||
| 158 | |||
| 159 | Note that the application code must create the streams with names | ||
| 160 | specified in the C<Outputs>. For example, if your C<Outputs> defines | ||
| 161 | output streams named C<ExampleOutputStream1> and | ||
| 162 | C<ExampleOutputStream2>, then your application code must create these | ||
| 163 | streams. | ||
| 164 | |||
| 165 | |||
| 166 | |||
| 167 | =head2 ApplicationDescription => Str | ||
| 168 | |||
| 169 | Summary description of the application. | ||
| 170 | |||
| 171 | |||
| 172 | |||
| 173 | =head2 B<REQUIRED> ApplicationName => Str | ||
| 174 | |||
| 175 | Name of your Amazon Kinesis Analytics application (for example, | ||
| 176 | C<sample-app>). | ||
| 177 | |||
| 178 | |||
| 179 | |||
| 180 | =head2 CloudWatchLoggingOptions => ArrayRef[L<Paws::KinesisAnalytics::CloudWatchLoggingOption>] | ||
| 181 | |||
| 182 | Use this parameter to configure a CloudWatch log stream to monitor | ||
| 183 | application configuration errors. For more information, see Working | ||
| 184 | with Amazon CloudWatch Logs | ||
| 185 | (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/cloudwatch-logs.html). | ||
| 186 | |||
| 187 | |||
| 188 | |||
| 189 | =head2 Inputs => ArrayRef[L<Paws::KinesisAnalytics::Input>] | ||
| 190 | |||
| 191 | Use this parameter to configure the application input. | ||
| 192 | |||
| 193 | You can configure your application to receive input from a single | ||
| 194 | streaming source. In this configuration, you map this streaming source | ||
| 195 | to an in-application stream that is created. Your application code can | ||
| 196 | then query the in-application stream like a table (you can think of it | ||
| 197 | as a constantly updating table). | ||
| 198 | |||
| 199 | For the streaming source, you provide its Amazon Resource Name (ARN) | ||
| 200 | and format of data on the stream (for example, JSON, CSV, etc.). You | ||
| 201 | also must provide an IAM role that Amazon Kinesis Analytics can assume | ||
| 202 | to read this stream on your behalf. | ||
| 203 | |||
| 204 | To create the in-application stream, you need to specify a schema to | ||
| 205 | transform your data into a schematized version used in SQL. In the | ||
| 206 | schema, you provide the necessary mapping of the data elements in the | ||
| 207 | streaming source to record columns in the in-app stream. | ||
| 208 | |||
| 209 | |||
| 210 | |||
| 211 | =head2 Outputs => ArrayRef[L<Paws::KinesisAnalytics::Output>] | ||
| 212 | |||
| 213 | You can configure application output to write data from any of the | ||
| 214 | in-application streams to up to three destinations. | ||
| 215 | |||
| 216 | These destinations can be Amazon Kinesis streams, Amazon Kinesis | ||
| 217 | Firehose delivery streams, AWS Lambda destinations, or any combination | ||
| 218 | of the three. | ||
| 219 | |||
| 220 | In the configuration, you specify the in-application stream name, the | ||
| 221 | destination stream or Lambda function Amazon Resource Name (ARN), and | ||
| 222 | the format to use when writing data. You must also provide an IAM role | ||
| 223 | that Amazon Kinesis Analytics can assume to write to the destination | ||
| 224 | stream or Lambda function on your behalf. | ||
| 225 | |||
| 226 | In the output configuration, you also provide the output stream or | ||
| 227 | Lambda function ARN. For stream destinations, you provide the format of | ||
| 228 | data in the stream (for example, JSON, CSV). You also must provide an | ||
| 229 | IAM role that Amazon Kinesis Analytics can assume to write to the | ||
| 230 | stream or Lambda function on your behalf. | ||
| 231 | |||
| 232 | |||
| 233 | |||
| 234 | =head2 Tags => ArrayRef[L<Paws::KinesisAnalytics::Tag>] | ||
| 235 | |||
| 236 | A list of one or more tags to assign to the application. A tag is a | ||
| 237 | key-value pair that identifies an application. Note that the maximum | ||
| 238 | number of application tags includes system tags. The maximum number of | ||
| 239 | user-defined application tags is 50. For more information, see Using | ||
| 240 | Tagging | ||
| 241 | (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-tagging.html). | ||
| 242 | |||
| 243 | |||
| 244 | |||
| 245 | |||
| 246 | =head1 SEE ALSO | ||
| 247 | |||
| 248 | This class forms part of L<Paws>, documenting arguments for method CreateApplication in L<Paws::KinesisAnalytics> | ||
| 249 | |||
| 250 | =head1 BUGS and CONTRIBUTIONS | ||
| 251 | |||
| 252 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 253 | |||
| 254 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 255 | |||
| 256 | =cut | ||
| 257 |