1. Packages
  2. AWS
  3. API Docs
  4. cloudwatch
  5. LogSubscriptionFilter
AWS v6.77.0 published on Wednesday, Apr 9, 2025 by Pulumi

aws.cloudwatch.LogSubscriptionFilter

Explore with Pulumi AI

Provides a CloudWatch Logs subscription filter resource.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const testLambdafunctionLogfilter = new aws.cloudwatch.LogSubscriptionFilter("test_lambdafunction_logfilter", {
    name: "test_lambdafunction_logfilter",
    roleArn: iamForLambda.arn,
    logGroup: "/aws/lambda/example_lambda_name",
    filterPattern: "logtype test",
    destinationArn: testLogstream.arn,
    distribution: "Random",
});
Copy
import pulumi
import pulumi_aws as aws

test_lambdafunction_logfilter = aws.cloudwatch.LogSubscriptionFilter("test_lambdafunction_logfilter",
    name="test_lambdafunction_logfilter",
    role_arn=iam_for_lambda["arn"],
    log_group="/aws/lambda/example_lambda_name",
    filter_pattern="logtype test",
    destination_arn=test_logstream["arn"],
    distribution="Random")
Copy
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/cloudwatch"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := cloudwatch.NewLogSubscriptionFilter(ctx, "test_lambdafunction_logfilter", &cloudwatch.LogSubscriptionFilterArgs{
			Name:           pulumi.String("test_lambdafunction_logfilter"),
			RoleArn:        pulumi.Any(iamForLambda.Arn),
			LogGroup:       pulumi.Any("/aws/lambda/example_lambda_name"),
			FilterPattern:  pulumi.String("logtype test"),
			DestinationArn: pulumi.Any(testLogstream.Arn),
			Distribution:   pulumi.String("Random"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var testLambdafunctionLogfilter = new Aws.CloudWatch.LogSubscriptionFilter("test_lambdafunction_logfilter", new()
    {
        Name = "test_lambdafunction_logfilter",
        RoleArn = iamForLambda.Arn,
        LogGroup = "/aws/lambda/example_lambda_name",
        FilterPattern = "logtype test",
        DestinationArn = testLogstream.Arn,
        Distribution = "Random",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.cloudwatch.LogSubscriptionFilter;
import com.pulumi.aws.cloudwatch.LogSubscriptionFilterArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var testLambdafunctionLogfilter = new LogSubscriptionFilter("testLambdafunctionLogfilter", LogSubscriptionFilterArgs.builder()
            .name("test_lambdafunction_logfilter")
            .roleArn(iamForLambda.arn())
            .logGroup("/aws/lambda/example_lambda_name")
            .filterPattern("logtype test")
            .destinationArn(testLogstream.arn())
            .distribution("Random")
            .build());

    }
}
Copy
resources:
  testLambdafunctionLogfilter:
    type: aws:cloudwatch:LogSubscriptionFilter
    name: test_lambdafunction_logfilter
    properties:
      name: test_lambdafunction_logfilter
      roleArn: ${iamForLambda.arn}
      logGroup: /aws/lambda/example_lambda_name
      filterPattern: logtype test
      destinationArn: ${testLogstream.arn}
      distribution: Random
Copy

Create LogSubscriptionFilter Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new LogSubscriptionFilter(name: string, args: LogSubscriptionFilterArgs, opts?: CustomResourceOptions);
@overload
def LogSubscriptionFilter(resource_name: str,
                          args: LogSubscriptionFilterArgs,
                          opts: Optional[ResourceOptions] = None)

@overload
def LogSubscriptionFilter(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          destination_arn: Optional[str] = None,
                          filter_pattern: Optional[str] = None,
                          log_group: Optional[str] = None,
                          distribution: Optional[str] = None,
                          name: Optional[str] = None,
                          role_arn: Optional[str] = None)
func NewLogSubscriptionFilter(ctx *Context, name string, args LogSubscriptionFilterArgs, opts ...ResourceOption) (*LogSubscriptionFilter, error)
public LogSubscriptionFilter(string name, LogSubscriptionFilterArgs args, CustomResourceOptions? opts = null)
public LogSubscriptionFilter(String name, LogSubscriptionFilterArgs args)
public LogSubscriptionFilter(String name, LogSubscriptionFilterArgs args, CustomResourceOptions options)
type: aws:cloudwatch:LogSubscriptionFilter
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. LogSubscriptionFilterArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. LogSubscriptionFilterArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. LogSubscriptionFilterArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. LogSubscriptionFilterArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. LogSubscriptionFilterArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var logSubscriptionFilterResource = new Aws.CloudWatch.LogSubscriptionFilter("logSubscriptionFilterResource", new()
{
    DestinationArn = "string",
    FilterPattern = "string",
    LogGroup = "string",
    Distribution = "string",
    Name = "string",
    RoleArn = "string",
});
Copy
example, err := cloudwatch.NewLogSubscriptionFilter(ctx, "logSubscriptionFilterResource", &cloudwatch.LogSubscriptionFilterArgs{
	DestinationArn: pulumi.String("string"),
	FilterPattern:  pulumi.String("string"),
	LogGroup:       pulumi.Any("string"),
	Distribution:   pulumi.String("string"),
	Name:           pulumi.String("string"),
	RoleArn:        pulumi.String("string"),
})
Copy
var logSubscriptionFilterResource = new LogSubscriptionFilter("logSubscriptionFilterResource", LogSubscriptionFilterArgs.builder()
    .destinationArn("string")
    .filterPattern("string")
    .logGroup("string")
    .distribution("string")
    .name("string")
    .roleArn("string")
    .build());
Copy
log_subscription_filter_resource = aws.cloudwatch.LogSubscriptionFilter("logSubscriptionFilterResource",
    destination_arn="string",
    filter_pattern="string",
    log_group="string",
    distribution="string",
    name="string",
    role_arn="string")
Copy
const logSubscriptionFilterResource = new aws.cloudwatch.LogSubscriptionFilter("logSubscriptionFilterResource", {
    destinationArn: "string",
    filterPattern: "string",
    logGroup: "string",
    distribution: "string",
    name: "string",
    roleArn: "string",
});
Copy
type: aws:cloudwatch:LogSubscriptionFilter
properties:
    destinationArn: string
    distribution: string
    filterPattern: string
    logGroup: string
    name: string
    roleArn: string
Copy

LogSubscriptionFilter Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The LogSubscriptionFilter resource accepts the following input properties:

DestinationArn
This property is required.
Changes to this property will trigger replacement.
string
The ARN of the destination to deliver matching log events to. Kinesis stream or Lambda function ARN.
FilterPattern This property is required. string
A valid CloudWatch Logs filter pattern for subscribing to a filtered stream of log events. Use empty string "" to match everything. For more information, see the Amazon CloudWatch Logs User Guide.
LogGroup
This property is required.
Changes to this property will trigger replacement.
string | string
The name of the log group to associate the subscription filter with
Distribution string
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" and "ByLogStream".
Name Changes to this property will trigger replacement. string
A name for the subscription filter
RoleArn string
The ARN of an IAM role that grants Amazon CloudWatch Logs permissions to deliver ingested log events to the destination. If you use Lambda as a destination, you should skip this argument and use aws.lambda.Permission resource for granting access from CloudWatch logs to the destination Lambda function.
DestinationArn
This property is required.
Changes to this property will trigger replacement.
string
The ARN of the destination to deliver matching log events to. Kinesis stream or Lambda function ARN.
FilterPattern This property is required. string
A valid CloudWatch Logs filter pattern for subscribing to a filtered stream of log events. Use empty string "" to match everything. For more information, see the Amazon CloudWatch Logs User Guide.
LogGroup
This property is required.
Changes to this property will trigger replacement.
string | string
The name of the log group to associate the subscription filter with
Distribution string
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" and "ByLogStream".
Name Changes to this property will trigger replacement. string
A name for the subscription filter
RoleArn string
The ARN of an IAM role that grants Amazon CloudWatch Logs permissions to deliver ingested log events to the destination. If you use Lambda as a destination, you should skip this argument and use aws.lambda.Permission resource for granting access from CloudWatch logs to the destination Lambda function.
destinationArn
This property is required.
Changes to this property will trigger replacement.
String
The ARN of the destination to deliver matching log events to. Kinesis stream or Lambda function ARN.
filterPattern This property is required. String
A valid CloudWatch Logs filter pattern for subscribing to a filtered stream of log events. Use empty string "" to match everything. For more information, see the Amazon CloudWatch Logs User Guide.
logGroup
This property is required.
Changes to this property will trigger replacement.
String | String
The name of the log group to associate the subscription filter with
distribution String
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" and "ByLogStream".
name Changes to this property will trigger replacement. String
A name for the subscription filter
roleArn String
The ARN of an IAM role that grants Amazon CloudWatch Logs permissions to deliver ingested log events to the destination. If you use Lambda as a destination, you should skip this argument and use aws.lambda.Permission resource for granting access from CloudWatch logs to the destination Lambda function.
destinationArn
This property is required.
Changes to this property will trigger replacement.
string
The ARN of the destination to deliver matching log events to. Kinesis stream or Lambda function ARN.
filterPattern This property is required. string
A valid CloudWatch Logs filter pattern for subscribing to a filtered stream of log events. Use empty string "" to match everything. For more information, see the Amazon CloudWatch Logs User Guide.
logGroup
This property is required.
Changes to this property will trigger replacement.
string | LogGroup
The name of the log group to associate the subscription filter with
distribution string
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" and "ByLogStream".
name Changes to this property will trigger replacement. string
A name for the subscription filter
roleArn string
The ARN of an IAM role that grants Amazon CloudWatch Logs permissions to deliver ingested log events to the destination. If you use Lambda as a destination, you should skip this argument and use aws.lambda.Permission resource for granting access from CloudWatch logs to the destination Lambda function.
destination_arn
This property is required.
Changes to this property will trigger replacement.
str
The ARN of the destination to deliver matching log events to. Kinesis stream or Lambda function ARN.
filter_pattern This property is required. str
A valid CloudWatch Logs filter pattern for subscribing to a filtered stream of log events. Use empty string "" to match everything. For more information, see the Amazon CloudWatch Logs User Guide.
log_group
This property is required.
Changes to this property will trigger replacement.
str | str
The name of the log group to associate the subscription filter with
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" and "ByLogStream".
name Changes to this property will trigger replacement. str
A name for the subscription filter
role_arn str
The ARN of an IAM role that grants Amazon CloudWatch Logs permissions to deliver ingested log events to the destination. If you use Lambda as a destination, you should skip this argument and use aws.lambda.Permission resource for granting access from CloudWatch logs to the destination Lambda function.
destinationArn
This property is required.
Changes to this property will trigger replacement.
String
The ARN of the destination to deliver matching log events to. Kinesis stream or Lambda function ARN.
filterPattern This property is required. String
A valid CloudWatch Logs filter pattern for subscribing to a filtered stream of log events. Use empty string "" to match everything. For more information, see the Amazon CloudWatch Logs User Guide.
logGroup
This property is required.
Changes to this property will trigger replacement.
String |
The name of the log group to associate the subscription filter with
distribution String
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" and "ByLogStream".
name Changes to this property will trigger replacement. String
A name for the subscription filter
roleArn String
The ARN of an IAM role that grants Amazon CloudWatch Logs permissions to deliver ingested log events to the destination. If you use Lambda as a destination, you should skip this argument and use aws.lambda.Permission resource for granting access from CloudWatch logs to the destination Lambda function.

Outputs

All input properties are implicitly available as output properties. Additionally, the LogSubscriptionFilter resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing LogSubscriptionFilter Resource

Get an existing LogSubscriptionFilter resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: LogSubscriptionFilterState, opts?: CustomResourceOptions): LogSubscriptionFilter
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        destination_arn: Optional[str] = None,
        distribution: Optional[str] = None,
        filter_pattern: Optional[str] = None,
        log_group: Optional[str] = None,
        name: Optional[str] = None,
        role_arn: Optional[str] = None) -> LogSubscriptionFilter
func GetLogSubscriptionFilter(ctx *Context, name string, id IDInput, state *LogSubscriptionFilterState, opts ...ResourceOption) (*LogSubscriptionFilter, error)
public static LogSubscriptionFilter Get(string name, Input<string> id, LogSubscriptionFilterState? state, CustomResourceOptions? opts = null)
public static LogSubscriptionFilter get(String name, Output<String> id, LogSubscriptionFilterState state, CustomResourceOptions options)
resources:  _:    type: aws:cloudwatch:LogSubscriptionFilter    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
DestinationArn Changes to this property will trigger replacement. string
The ARN of the destination to deliver matching log events to. Kinesis stream or Lambda function ARN.
Distribution string
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" and "ByLogStream".
FilterPattern string
A valid CloudWatch Logs filter pattern for subscribing to a filtered stream of log events. Use empty string "" to match everything. For more information, see the Amazon CloudWatch Logs User Guide.
LogGroup Changes to this property will trigger replacement. string | string
The name of the log group to associate the subscription filter with
Name Changes to this property will trigger replacement. string
A name for the subscription filter
RoleArn string
The ARN of an IAM role that grants Amazon CloudWatch Logs permissions to deliver ingested log events to the destination. If you use Lambda as a destination, you should skip this argument and use aws.lambda.Permission resource for granting access from CloudWatch logs to the destination Lambda function.
DestinationArn Changes to this property will trigger replacement. string
The ARN of the destination to deliver matching log events to. Kinesis stream or Lambda function ARN.
Distribution string
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" and "ByLogStream".
FilterPattern string
A valid CloudWatch Logs filter pattern for subscribing to a filtered stream of log events. Use empty string "" to match everything. For more information, see the Amazon CloudWatch Logs User Guide.
LogGroup Changes to this property will trigger replacement. string | string
The name of the log group to associate the subscription filter with
Name Changes to this property will trigger replacement. string
A name for the subscription filter
RoleArn string
The ARN of an IAM role that grants Amazon CloudWatch Logs permissions to deliver ingested log events to the destination. If you use Lambda as a destination, you should skip this argument and use aws.lambda.Permission resource for granting access from CloudWatch logs to the destination Lambda function.
destinationArn Changes to this property will trigger replacement. String
The ARN of the destination to deliver matching log events to. Kinesis stream or Lambda function ARN.
distribution String
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" and "ByLogStream".
filterPattern String
A valid CloudWatch Logs filter pattern for subscribing to a filtered stream of log events. Use empty string "" to match everything. For more information, see the Amazon CloudWatch Logs User Guide.
logGroup Changes to this property will trigger replacement. String | String
The name of the log group to associate the subscription filter with
name Changes to this property will trigger replacement. String
A name for the subscription filter
roleArn String
The ARN of an IAM role that grants Amazon CloudWatch Logs permissions to deliver ingested log events to the destination. If you use Lambda as a destination, you should skip this argument and use aws.lambda.Permission resource for granting access from CloudWatch logs to the destination Lambda function.
destinationArn Changes to this property will trigger replacement. string
The ARN of the destination to deliver matching log events to. Kinesis stream or Lambda function ARN.
distribution string
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" and "ByLogStream".
filterPattern string
A valid CloudWatch Logs filter pattern for subscribing to a filtered stream of log events. Use empty string "" to match everything. For more information, see the Amazon CloudWatch Logs User Guide.
logGroup Changes to this property will trigger replacement. string | LogGroup
The name of the log group to associate the subscription filter with
name Changes to this property will trigger replacement. string
A name for the subscription filter
roleArn string
The ARN of an IAM role that grants Amazon CloudWatch Logs permissions to deliver ingested log events to the destination. If you use Lambda as a destination, you should skip this argument and use aws.lambda.Permission resource for granting access from CloudWatch logs to the destination Lambda function.
destination_arn Changes to this property will trigger replacement. str
The ARN of the destination to deliver matching log events to. Kinesis stream or Lambda function ARN.
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" and "ByLogStream".
filter_pattern str
A valid CloudWatch Logs filter pattern for subscribing to a filtered stream of log events. Use empty string "" to match everything. For more information, see the Amazon CloudWatch Logs User Guide.
log_group Changes to this property will trigger replacement. str | str
The name of the log group to associate the subscription filter with
name Changes to this property will trigger replacement. str
A name for the subscription filter
role_arn str
The ARN of an IAM role that grants Amazon CloudWatch Logs permissions to deliver ingested log events to the destination. If you use Lambda as a destination, you should skip this argument and use aws.lambda.Permission resource for granting access from CloudWatch logs to the destination Lambda function.
destinationArn Changes to this property will trigger replacement. String
The ARN of the destination to deliver matching log events to. Kinesis stream or Lambda function ARN.
distribution String
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" and "ByLogStream".
filterPattern String
A valid CloudWatch Logs filter pattern for subscribing to a filtered stream of log events. Use empty string "" to match everything. For more information, see the Amazon CloudWatch Logs User Guide.
logGroup Changes to this property will trigger replacement. String |
The name of the log group to associate the subscription filter with
name Changes to this property will trigger replacement. String
A name for the subscription filter
roleArn String
The ARN of an IAM role that grants Amazon CloudWatch Logs permissions to deliver ingested log events to the destination. If you use Lambda as a destination, you should skip this argument and use aws.lambda.Permission resource for granting access from CloudWatch logs to the destination Lambda function.

Import

Using pulumi import, import CloudWatch Logs subscription filter using the log group name and subscription filter name separated by |. For example:

$ pulumi import aws:cloudwatch/logSubscriptionFilter:LogSubscriptionFilter test_lambdafunction_logfilter "/aws/lambda/example_lambda_name|test_lambdafunction_logfilter"
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
AWS Classic pulumi/pulumi-aws
License
Apache-2.0
Notes
This Pulumi package is based on the aws Terraform Provider.