The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.
 / 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::CloudWatchLogs::PutSubscriptionFilter

NAME

Paws::CloudWatchLogs::PutSubscriptionFilter - Arguments for method PutSubscriptionFilter on Paws::CloudWatchLogs

DESCRIPTION

This class represents the parameters used for calling the method PutSubscriptionFilter on the Amazon CloudWatch Logs service. Use the attributes of this class as arguments to method PutSubscriptionFilter.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to PutSubscriptionFilter.

SYNOPSIS

    my $logs = Paws->service('CloudWatchLogs');
    $logs->PutSubscriptionFilter(
      DestinationArn => 'MyDestinationArn',
      FilterName     => 'MyFilterName',
      FilterPattern  => 'MyFilterPattern',
      LogGroupName   => 'MyLogGroupName',
      Distribution   => 'Random',             # OPTIONAL
      RoleArn        => 'MyRoleArn',          # OPTIONAL
    );

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. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/logs/PutSubscriptionFilter

ATTRIBUTES

REQUIRED DestinationArn => Str

The ARN of the destination to deliver matching log events to. Currently, the supported destinations are:

  • An Amazon Kinesis stream belonging to the same account as the subscription filter, for same-account delivery.

  • A logical destination (specified using an ARN) belonging to a different account, for cross-account delivery.

    If you are setting up a cross-account subscription, the destination must have an IAM policy associated with it that allows the sender to send logs to the destination. For more information, see PutDestinationPolicy (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDestinationPolicy.html).

  • An Amazon Kinesis Firehose delivery stream belonging to the same account as the subscription filter, for same-account delivery.

  • An AWS Lambda function belonging to the same account as the subscription filter, for same-account delivery.

Distribution => Str

The method used to distribute log data to the destination. By default, log data is grouped by log stream, but the grouping can be set to random for a more even distribution. This property is only applicable when the destination is an Amazon Kinesis stream.

Valid values are: "Random", "ByLogStream"

REQUIRED FilterName => Str

A name for the subscription filter. If you are updating an existing filter, you must specify the correct name in filterName. To find the name of the filter currently associated with a log group, use DescribeSubscriptionFilters (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DescribeSubscriptionFilters.html).

REQUIRED FilterPattern => Str

A filter pattern for subscribing to a filtered stream of log events.

REQUIRED LogGroupName => Str

The name of the log group.

RoleArn => Str

The ARN of an IAM role that grants CloudWatch Logs permissions to deliver ingested log events to the destination stream. You don't need to provide the ARN when you are working with a logical destination for cross-account delivery.

SEE ALSO

This class forms part of Paws, documenting arguments for method PutSubscriptionFilter in Paws::CloudWatchLogs

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues