Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. logs
  5. getSubscriptionFilter

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.logs.getSubscriptionFilter

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
pulumi/pulumi-aws-native

    The AWS::Logs::SubscriptionFilter resource specifies 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 and have them delivered to a specific destination. Currently, the supported destinations are:

    • 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 Firehose delivery stream that belongs to the same account as the subscription filter, for same-account delivery.
    • An LAMlong function that belongs to the same account as the subscription filter, for same-account delivery.

    There can be as many as two subscription filters associated with a log group.

    Using getSubscriptionFilter

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getSubscriptionFilter(args: GetSubscriptionFilterArgs, opts?: InvokeOptions): Promise<GetSubscriptionFilterResult>
function getSubscriptionFilterOutput(args: GetSubscriptionFilterOutputArgs, opts?: InvokeOptions): Output<GetSubscriptionFilterResult>
    def get_subscription_filter(filter_name: Optional[str] = None,
                            log_group_name: Optional[str] = None,
                            opts: Optional[InvokeOptions] = None) -> GetSubscriptionFilterResult
def get_subscription_filter_output(filter_name: Optional[pulumi.Input[str]] = None,
                            log_group_name: Optional[pulumi.Input[str]] = None,
                            opts: Optional[InvokeOptions] = None) -> Output[GetSubscriptionFilterResult]
    func LookupSubscriptionFilter(ctx *Context, args *LookupSubscriptionFilterArgs, opts ...InvokeOption) (*LookupSubscriptionFilterResult, error)
func LookupSubscriptionFilterOutput(ctx *Context, args *LookupSubscriptionFilterOutputArgs, opts ...InvokeOption) LookupSubscriptionFilterResultOutput

    > Note: This function is named LookupSubscriptionFilter in the Go SDK.

    public static class GetSubscriptionFilter 
{
    public static Task<GetSubscriptionFilterResult> InvokeAsync(GetSubscriptionFilterArgs args, InvokeOptions? opts = null)
    public static Output<GetSubscriptionFilterResult> Invoke(GetSubscriptionFilterInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetSubscriptionFilterResult> getSubscriptionFilter(GetSubscriptionFilterArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: aws-native:logs:getSubscriptionFilter
  arguments:
    # arguments dictionary

    The following arguments are supported:

    FilterName string
    The name of the subscription filter.
    LogGroupName string
    The log group to associate with the subscription filter. All log events that are uploaded to this log group are filtered and delivered to the specified AWS resource if the filter pattern matches the log events.
    FilterName string
    The name of the subscription filter.
    LogGroupName string
    The log group to associate with the subscription filter. All log events that are uploaded to this log group are filtered and delivered to the specified AWS resource if the filter pattern matches the log events.
    filterName String
    The name of the subscription filter.
    logGroupName String
    The log group to associate with the subscription filter. All log events that are uploaded to this log group are filtered and delivered to the specified AWS resource if the filter pattern matches the log events.
    filterName string
    The name of the subscription filter.
    logGroupName string
    The log group to associate with the subscription filter. All log events that are uploaded to this log group are filtered and delivered to the specified AWS resource if the filter pattern matches the log events.
    filter_name str
    The name of the subscription filter.
    log_group_name str
    The log group to associate with the subscription filter. All log events that are uploaded to this log group are filtered and delivered to the specified AWS resource if the filter pattern matches the log events.
    filterName String
    The name of the subscription filter.
    logGroupName String
    The log group to associate with the subscription filter. All log events that are uploaded to this log group are filtered and delivered to the specified AWS resource if the filter pattern matches the log events.

    getSubscriptionFilter Result

    The following output properties are available:

    DestinationArn string
    The Amazon Resource Name (ARN) of the destination.
    Distribution Pulumi.AwsNative.Logs.SubscriptionFilterDistribution
    The method used to distribute log data to the destination, which can be either random or grouped by log stream.
    FilterPattern string
    The filtering expressions that restrict what gets delivered to the destination AWS resource. For more information about the filter pattern syntax, see Filter and Pattern Syntax.
    RoleArn string
    The ARN of an IAM role that grants CWL 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.
    DestinationArn string
    The Amazon Resource Name (ARN) of the destination.
    Distribution SubscriptionFilterDistribution
    The method used to distribute log data to the destination, which can be either random or grouped by log stream.
    FilterPattern string
    The filtering expressions that restrict what gets delivered to the destination AWS resource. For more information about the filter pattern syntax, see Filter and Pattern Syntax.
    RoleArn string
    The ARN of an IAM role that grants CWL 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.
    destinationArn String
    The Amazon Resource Name (ARN) of the destination.
    distribution SubscriptionFilterDistribution
    The method used to distribute log data to the destination, which can be either random or grouped by log stream.
    filterPattern String
    The filtering expressions that restrict what gets delivered to the destination AWS resource. For more information about the filter pattern syntax, see Filter and Pattern Syntax.
    roleArn String
    The ARN of an IAM role that grants CWL 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.
    destinationArn string
    The Amazon Resource Name (ARN) of the destination.
    distribution SubscriptionFilterDistribution
    The method used to distribute log data to the destination, which can be either random or grouped by log stream.
    filterPattern string
    The filtering expressions that restrict what gets delivered to the destination AWS resource. For more information about the filter pattern syntax, see Filter and Pattern Syntax.
    roleArn string
    The ARN of an IAM role that grants CWL 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.
    destination_arn str
    The Amazon Resource Name (ARN) of the destination.
    distribution SubscriptionFilterDistribution
    The method used to distribute log data to the destination, which can be either random or grouped by log stream.
    filter_pattern str
    The filtering expressions that restrict what gets delivered to the destination AWS resource. For more information about the filter pattern syntax, see Filter and Pattern Syntax.
    role_arn str
    The ARN of an IAM role that grants CWL 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.
    destinationArn String
    The Amazon Resource Name (ARN) of the destination.
    distribution "Random" | "ByLogStream"
    The method used to distribute log data to the destination, which can be either random or grouped by log stream.
    filterPattern String
    The filtering expressions that restrict what gets delivered to the destination AWS resource. For more information about the filter pattern syntax, see Filter and Pattern Syntax.
    roleArn String
    The ARN of an IAM role that grants CWL 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.

    Supporting Types

    SubscriptionFilterDistribution

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
    pulumi/pulumi-aws-native