AWS Classic
LogSubscriptionFilter
Provides a CloudWatch Logs subscription filter resource.
Example Usage
using Pulumi;
using Aws = Pulumi.Aws;
class MyStack : Stack
{
public MyStack()
{
var testLambdafunctionLogfilter = new Aws.CloudWatch.LogSubscriptionFilter("testLambdafunctionLogfilter", new Aws.CloudWatch.LogSubscriptionFilterArgs
{
RoleArn = aws_iam_role.Iam_for_lambda.Arn,
LogGroup = "/aws/lambda/example_lambda_name",
FilterPattern = "logtype test",
DestinationArn = aws_kinesis_stream.Test_logstream.Arn,
Distribution = "Random",
});
}
}
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/cloudwatch"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := cloudwatch.NewLogSubscriptionFilter(ctx, "testLambdafunctionLogfilter", &cloudwatch.LogSubscriptionFilterArgs{
RoleArn: pulumi.Any(aws_iam_role.Iam_for_lambda.Arn),
LogGroup: pulumi.Any("/aws/lambda/example_lambda_name"),
FilterPattern: pulumi.String("logtype test"),
DestinationArn: pulumi.Any(aws_kinesis_stream.Test_logstream.Arn),
Distribution: pulumi.String("Random"),
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;
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()
.roleArn(aws_iam_role.iam_for_lambda().arn())
.logGroup("/aws/lambda/example_lambda_name")
.filterPattern("logtype test")
.destinationArn(aws_kinesis_stream.test_logstream().arn())
.distribution("Random")
.build());
}
}
import pulumi
import pulumi_aws as aws
test_lambdafunction_logfilter = aws.cloudwatch.LogSubscriptionFilter("testLambdafunctionLogfilter",
role_arn=aws_iam_role["iam_for_lambda"]["arn"],
log_group="/aws/lambda/example_lambda_name",
filter_pattern="logtype test",
destination_arn=aws_kinesis_stream["test_logstream"]["arn"],
distribution="Random")
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const testLambdafunctionLogfilter = new aws.cloudwatch.LogSubscriptionFilter("testLambdafunctionLogfilter", {
roleArn: aws_iam_role.iam_for_lambda.arn,
logGroup: "/aws/lambda/example_lambda_name",
filterPattern: "logtype test",
destinationArn: aws_kinesis_stream.test_logstream.arn,
distribution: "Random",
});
resources:
testLambdafunctionLogfilter:
type: aws:cloudwatch:LogSubscriptionFilter
properties:
roleArn: ${aws_iam_role.iam_for_lambda.arn}
logGroup: /aws/lambda/example_lambda_name
filterPattern: logtype test
destinationArn: ${aws_kinesis_stream.test_logstream.arn}
distribution: Random
Create a LogSubscriptionFilter Resource
new LogSubscriptionFilter(name: string, args: LogSubscriptionFilterArgs, opts?: CustomResourceOptions);
@overload
def LogSubscriptionFilter(resource_name: 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)
@overload
def LogSubscriptionFilter(resource_name: str,
args: LogSubscriptionFilterArgs,
opts: Optional[ResourceOptions] = 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.
- name string
- The unique name of the resource.
- args LogSubscriptionFilterArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args 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 string
- The unique name of the resource.
- args LogSubscriptionFilterArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args LogSubscriptionFilterArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args LogSubscriptionFilterArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
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
The LogSubscriptionFilter resource accepts the following input properties:
- Destination
Arn string The ARN of the destination to deliver matching log events to. Kinesis stream or Lambda function ARN.
- Filter
Pattern string A valid CloudWatch Logs filter pattern for subscribing to a filtered stream of log events.
- Log
Group 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 string
A name for the subscription filter
- Role
Arn 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 string The ARN of the destination to deliver matching log events to. Kinesis stream or Lambda function ARN.
- Filter
Pattern string A valid CloudWatch Logs filter pattern for subscribing to a filtered stream of log events.
- Log
Group 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 string
A name for the subscription filter
- Role
Arn 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 String The ARN of the destination to deliver matching log events to. Kinesis stream or Lambda function ARN.
- filter
Pattern String A valid CloudWatch Logs filter pattern for subscribing to a filtered stream of log events.
- log
Group 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 String
A name for the subscription filter
- role
Arn 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 string The ARN of the destination to deliver matching log events to. Kinesis stream or Lambda function ARN.
- filter
Pattern string A valid CloudWatch Logs filter pattern for subscribing to a filtered stream of log events.
- log
Group 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 string
A name for the subscription filter
- role
Arn 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 str The ARN of the destination to deliver matching log events to. Kinesis stream or Lambda function ARN.
- filter_
pattern str A valid CloudWatch Logs filter pattern for subscribing to a filtered stream of log events.
- log_
group 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 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.
- destination
Arn String The ARN of the destination to deliver matching log events to. Kinesis stream or Lambda function ARN.
- filter
Pattern String A valid CloudWatch Logs filter pattern for subscribing to a filtered stream of log events.
- log
Group 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 String
A name for the subscription filter
- role
Arn 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 an 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)
Resource lookup is not supported in YAML
- name
- The unique name of the resulting resource.
- id
- 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
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- 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
- The unique name of the resulting resource.
- id
- 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
- The unique name of the resulting resource.
- id
- 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.
- Destination
Arn 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".
- Filter
Pattern string A valid CloudWatch Logs filter pattern for subscribing to a filtered stream of log events.
- Log
Group string | string The name of the log group to associate the subscription filter with
- Name string
A name for the subscription filter
- Role
Arn 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 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".
- Filter
Pattern string A valid CloudWatch Logs filter pattern for subscribing to a filtered stream of log events.
- Log
Group string | string The name of the log group to associate the subscription filter with
- Name string
A name for the subscription filter
- Role
Arn 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 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".
- filter
Pattern String A valid CloudWatch Logs filter pattern for subscribing to a filtered stream of log events.
- log
Group String | String The name of the log group to associate the subscription filter with
- name String
A name for the subscription filter
- role
Arn 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 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".
- filter
Pattern string A valid CloudWatch Logs filter pattern for subscribing to a filtered stream of log events.
- log
Group string | LogGroup The name of the log group to associate the subscription filter with
- name string
A name for the subscription filter
- role
Arn 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 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.
- log_
group str | str The name of the log group to associate the subscription filter with
- name 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.
- destination
Arn 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".
- filter
Pattern String A valid CloudWatch Logs filter pattern for subscribing to a filtered stream of log events.
- log
Group String | The name of the log group to associate the subscription filter with
- name String
A name for the subscription filter
- role
Arn 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
CloudWatch Logs subscription filter can be imported using the log group name and subscription filter name separated by |
.
$ pulumi import aws:cloudwatch/logSubscriptionFilter:LogSubscriptionFilter test_lambdafunction_logfilter /aws/lambda/example_lambda_name|test_lambdafunction_logfilter
Package Details
- Repository
- https://github.com/pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
aws
Terraform Provider.