« blib/lib/Paws/CloudWatchLogs/PutRetentionPolicy.pm
↑ Summary
blib/lib/Paws/CloudWatchLogs/QueryCompileError.pm »
| 1 | |||
| 2 | package Paws::CloudWatchLogs::PutSubscriptionFilter; | ||
| 3 | use Moose; | ||
| 4 | has DestinationArn => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'destinationArn' , required => 1); | ||
| 5 | has Distribution => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'distribution' ); | ||
| 6 | has FilterName => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'filterName' , required => 1); | ||
| 7 | has FilterPattern => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'filterPattern' , required => 1); | ||
| 8 | has LogGroupName => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'logGroupName' , required => 1); | ||
| 9 | has RoleArn => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'roleArn' ); | ||
| 10 | |||
| 11 | use MooseX::ClassAttribute; | ||
| 12 | |||
| 13 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'PutSubscriptionFilter'); | ||
| 14 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::API::Response'); | ||
| 15 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 16 | 1; | ||
| 17 | |||
| 18 | ### main pod documentation begin ### | ||
| 19 | |||
| 20 | =head1 NAME | ||
| 21 | |||
| 22 | Paws::CloudWatchLogs::PutSubscriptionFilter - Arguments for method PutSubscriptionFilter on L<Paws::CloudWatchLogs> | ||
| 23 | |||
| 24 | =head1 DESCRIPTION | ||
| 25 | |||
| 26 | This class represents the parameters used for calling the method PutSubscriptionFilter on the | ||
| 27 | L<Amazon CloudWatch Logs|Paws::CloudWatchLogs> service. Use the attributes of this class | ||
| 28 | as arguments to method PutSubscriptionFilter. | ||
| 29 | |||
| 30 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to PutSubscriptionFilter. | ||
| 31 | |||
| 32 | =head1 SYNOPSIS | ||
| 33 | |||
| 34 | my $logs = Paws->service('CloudWatchLogs'); | ||
| 35 | $logs->PutSubscriptionFilter( | ||
| 36 | DestinationArn => 'MyDestinationArn', | ||
| 37 | FilterName => 'MyFilterName', | ||
| 38 | FilterPattern => 'MyFilterPattern', | ||
| 39 | LogGroupName => 'MyLogGroupName', | ||
| 40 | Distribution => 'Random', # OPTIONAL | ||
| 41 | RoleArn => 'MyRoleArn', # OPTIONAL | ||
| 42 | ); | ||
| 43 | |||
| 44 | 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. | ||
| 45 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/logs/PutSubscriptionFilter> | ||
| 46 | |||
| 47 | =head1 ATTRIBUTES | ||
| 48 | |||
| 49 | |||
| 50 | =head2 B<REQUIRED> DestinationArn => Str | ||
| 51 | |||
| 52 | The ARN of the destination to deliver matching log events to. | ||
| 53 | Currently, the supported destinations are: | ||
| 54 | |||
| 55 | =over | ||
| 56 | |||
| 57 | =item * | ||
| 58 | |||
| 59 | An Amazon Kinesis stream belonging to the same account as the | ||
| 60 | subscription filter, for same-account delivery. | ||
| 61 | |||
| 62 | =item * | ||
| 63 | |||
| 64 | A logical destination (specified using an ARN) belonging to a different | ||
| 65 | account, for cross-account delivery. | ||
| 66 | |||
| 67 | If you are setting up a cross-account subscription, the destination | ||
| 68 | must have an IAM policy associated with it that allows the sender to | ||
| 69 | send logs to the destination. For more information, see | ||
| 70 | PutDestinationPolicy | ||
| 71 | (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDestinationPolicy.html). | ||
| 72 | |||
| 73 | =item * | ||
| 74 | |||
| 75 | An Amazon Kinesis Firehose delivery stream belonging to the same | ||
| 76 | account as the subscription filter, for same-account delivery. | ||
| 77 | |||
| 78 | =item * | ||
| 79 | |||
| 80 | An AWS Lambda function belonging to the same account as the | ||
| 81 | subscription filter, for same-account delivery. | ||
| 82 | |||
| 83 | =back | ||
| 84 | |||
| 85 | |||
| 86 | |||
| 87 | |||
| 88 | =head2 Distribution => Str | ||
| 89 | |||
| 90 | The method used to distribute log data to the destination. By default, | ||
| 91 | log data is grouped by log stream, but the grouping can be set to | ||
| 92 | random for a more even distribution. This property is only applicable | ||
| 93 | when the destination is an Amazon Kinesis stream. | ||
| 94 | |||
| 95 | Valid values are: C<"Random">, C<"ByLogStream"> | ||
| 96 | |||
| 97 | =head2 B<REQUIRED> FilterName => Str | ||
| 98 | |||
| 99 | A name for the subscription filter. If you are updating an existing | ||
| 100 | filter, you must specify the correct name in C<filterName>. To find the | ||
| 101 | name of the filter currently associated with a log group, use | ||
| 102 | DescribeSubscriptionFilters | ||
| 103 | (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DescribeSubscriptionFilters.html). | ||
| 104 | |||
| 105 | |||
| 106 | |||
| 107 | =head2 B<REQUIRED> FilterPattern => Str | ||
| 108 | |||
| 109 | A filter pattern for subscribing to a filtered stream of log events. | ||
| 110 | |||
| 111 | |||
| 112 | |||
| 113 | =head2 B<REQUIRED> LogGroupName => Str | ||
| 114 | |||
| 115 | The name of the log group. | ||
| 116 | |||
| 117 | |||
| 118 | |||
| 119 | =head2 RoleArn => Str | ||
| 120 | |||
| 121 | The ARN of an IAM role that grants CloudWatch Logs permissions to | ||
| 122 | deliver ingested log events to the destination stream. You don't need | ||
| 123 | to provide the ARN when you are working with a logical destination for | ||
| 124 | cross-account delivery. | ||
| 125 | |||
| 126 | |||
| 127 | |||
| 128 | |||
| 129 | =head1 SEE ALSO | ||
| 130 | |||
| 131 | This class forms part of L<Paws>, documenting arguments for method PutSubscriptionFilter in L<Paws::CloudWatchLogs> | ||
| 132 | |||
| 133 | =head1 BUGS and CONTRIBUTIONS | ||
| 134 | |||
| 135 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 136 | |||
| 137 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 138 | |||
| 139 | =cut | ||
| 140 |