Options
All
  • Public
  • Public/Protected
  • All
Menu

Class PutSubscriptionFilterCommand

Creates or updates a subscription filter and associates it with the specified log group. With subscription filters, you can 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 data 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 Data Firehose delivery stream that belongs to the same account as the subscription filter, for same-account delivery.

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

Each log group can have up to two subscription filters associated with it. If you are updating an existing filter, you must specify the correct name in filterName.

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

example

Use a bare-bones client and the command you need to make an API call.

import { CloudWatchLogsClient, PutSubscriptionFilterCommand } from "@aws-sdk/client-cloudwatch-logs"; // ES Modules import
// const { CloudWatchLogsClient, PutSubscriptionFilterCommand } = require("@aws-sdk/client-cloudwatch-logs"); // CommonJS import
const client = new CloudWatchLogsClient(config);
const command = new PutSubscriptionFilterCommand(input);
const response = await client.send(command);
see

PutSubscriptionFilterCommandInput for command's input shape.

see

PutSubscriptionFilterCommandOutput for command's response shape.

see

config for CloudWatchLogsClient's config shape.

Hierarchy

Implements

Index

Constructors

constructor

Properties

Readonly input

input: PutSubscriptionFilterCommandInput

Readonly middlewareStack

Methods

Static getEndpointParameterInstructions