putSubscriptionFilter method

Future<void> putSubscriptionFilter({ required String destinationArn, required String filterName, required String filterPattern, required String logGroupName, Distribution? distribution, String? roleArn, })

Creates or updates a subscription filter and associates it with the specified log group. Subscription filters allow you to subscribe to a real-time stream of log events ingested through PutLogEvents and have them delivered to a specific destination. When log events are sent to the receiving service, they are Base64 encoded and compressed with the gzip format.

The following destinations are supported for subscription filters:

• An Amazon Kinesis stream belonging to the same account as the subscription filter, for same-account delivery.
• A logical destination that belongs to a different account, for cross-account delivery.
• An Amazon Kinesis Firehose delivery stream that belongs to the same account as the subscription filter, for same-account delivery.
• An AWS Lambda function that belongs to the same account as the subscription filter, for same-account delivery.

There can only be one subscription filter associated with a log group. If you are updating an existing filter, you must specify the correct name in filterName. Otherwise, the call fails because you cannot associate a second filter with a log group.

To perform a PutSubscriptionFilter operation, you must also have the iam:PassRole permission.

May throw InvalidParameterException. May throw ResourceNotFoundException. May throw OperationAbortedException. May throw LimitExceededException. May throw ServiceUnavailableException.

Parameter destinationArn : 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.
• 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.

Parameter filterName : A name for the subscription filter. If you are updating an existing filter, you must specify the correct name in filterName. Otherwise, the call fails because you cannot associate a second filter with a log group. To find the name of the filter currently associated with a log group, use DescribeSubscriptionFilters.

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

Parameter logGroupName : The name of the log group.

Parameter distribution : 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.

Parameter roleArn : 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.

Implementation

Future<void> putSubscriptionFilter({
  required String destinationArn,
  required String filterName,
  required String filterPattern,
  required String logGroupName,
  Distribution? distribution,
  String? roleArn,
}) async {
  ArgumentError.checkNotNull(destinationArn, 'destinationArn');
  _s.validateStringLength(
    'destinationArn',
    destinationArn,
    1,
    1152921504606846976,
    isRequired: true,
  );
  ArgumentError.checkNotNull(filterName, 'filterName');
  _s.validateStringLength(
    'filterName',
    filterName,
    1,
    512,
    isRequired: true,
  );
  ArgumentError.checkNotNull(filterPattern, 'filterPattern');
  _s.validateStringLength(
    'filterPattern',
    filterPattern,
    0,
    1024,
    isRequired: true,
  );
  ArgumentError.checkNotNull(logGroupName, 'logGroupName');
  _s.validateStringLength(
    'logGroupName',
    logGroupName,
    1,
    512,
    isRequired: true,
  );
  _s.validateStringLength(
    'roleArn',
    roleArn,
    1,
    1152921504606846976,
  );
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'Logs_20140328.PutSubscriptionFilter'
  };
  await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'destinationArn': destinationArn,
      'filterName': filterName,
      'filterPattern': filterPattern,
      'logGroupName': logGroupName,
      if (distribution != null) 'distribution': distribution.toValue(),
      if (roleArn != null) 'roleArn': roleArn,
    },
  );
}