PutSubscriptionFilterRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/amazon-cloudwatch/json-schema/amazon-cloudwatch-put-subscription-filter-request-schema.json",
  "title": "PutSubscriptionFilterRequest",
  "x-generated": "2026-11-11",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/amazon-cloudwatch-subscription-filter-api-openapi.yml#/components/schemas/PutSubscriptionFilterRequest",
  "type": "object",
  "properties": {
    "logGroupName": {
      "type": "string",
      "description": "The name of the log group."
    },
    "filterName": {
      "type": "string",
      "description": "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."
    },
    "filterPattern": {
      "type": "string",
      "description": "A filter pattern for subscribing to a filtered stream of log events."
    },
    "destinationArn": {
      "type": "string",
      "description": "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're setting up a cross-account subscription, the destination must have an IAM policy associated with it. The IAM policy must allow the sender to send logs to the destination. For more information, see PutDestinationPolicy. A Kinesis Data Firehose delivery stream belongi"
    },
    "roleArn": {
      "type": "string",
      "description": "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."
    },
    "distribution": {
      "type": "string",
      "enum": [
        "Random",
        "ByLogStream"
      ],
      "description": "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 data stream."
    },
    "applyOnTransformedLogs": {
      "type": "boolean",
      "description": "This parameter is valid only for log groups that have an active log transformer. For more information about log transformers, see PutTransformer. If the log group uses either a log-group level or account-level transformer, and you specify true, the subscription filter will be applied on the transformed version of the log events instead of the original ingested log events."
    },
    "fieldSelectionCriteria": {
      "type": "string",
      "description": "A filter expression that specifies which log events should be processed by this subscription filter based on system fields such as source account and source region. Uses selection criteria syntax with operators like =, !=, AND, OR, IN, NOT IN. Example: @aws.region NOT IN [\"cn-north-1\"] or @aws.account = \"123456789012\" AND @aws.region = \"us-east-1\". Maximum length: 2000 characters."
    },
    "emitSystemFields": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "A list of system fields to include in the log events sent to the subscription destination. Valid values are @aws.account, @aws.region, and @source.log. These fields provide source information for centralized log data in the forwarded payload."
    }
  },
  "required": [
    "logGroupName",
    "filterName",
    "filterPattern",
    "destinationArn"
  ]
}