Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.CloudWatchLogs.PutSubscriptionFilter

Contents

Creating a Request
Request Lenses
Destructuring the Response

Description

Creates or updates 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 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 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 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.

Synopsis

data PutSubscriptionFilter = PutSubscriptionFilter' {
- distribution :: Maybe Distribution
- roleArn :: Maybe Text
- logGroupName :: Text
- filterName :: Text
- filterPattern :: Text
- destinationArn :: Text
}
newPutSubscriptionFilter :: Text -> Text -> Text -> Text -> PutSubscriptionFilter
putSubscriptionFilter_distribution :: Lens' PutSubscriptionFilter (Maybe Distribution)
putSubscriptionFilter_roleArn :: Lens' PutSubscriptionFilter (Maybe Text)
putSubscriptionFilter_logGroupName :: Lens' PutSubscriptionFilter Text
putSubscriptionFilter_filterName :: Lens' PutSubscriptionFilter Text
putSubscriptionFilter_filterPattern :: Lens' PutSubscriptionFilter Text
putSubscriptionFilter_destinationArn :: Lens' PutSubscriptionFilter Text
data PutSubscriptionFilterResponse = PutSubscriptionFilterResponse' {
}
newPutSubscriptionFilterResponse :: PutSubscriptionFilterResponse

Creating a Request

data PutSubscriptionFilter Source #

See: newPutSubscriptionFilter smart constructor.

Constructors

PutSubscriptionFilter'

Fields

distribution :: Maybe Distribution
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.
roleArn :: Maybe Text
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.
logGroupName :: Text
The name of the log group.
filterName :: Text
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 :: Text
A filter pattern for subscribing to a filtered stream of log events.
destinationArn :: Text
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 are setting up a cross-account subscription, the destination must have an IAM policy associated with it that allows the sender to send logs to the destination. For more information, see PutDestinationPolicy.
- An Amazon Kinesis Firehose delivery stream belonging to the same account as the subscription filter, for same-account delivery.
- A Lambda function belonging to the same account as the subscription filter, for same-account delivery.

Instances

Instances details

Eq PutSubscriptionFilter Source #
Instance details Defined in Amazonka.CloudWatchLogs.PutSubscriptionFilter Methods (==) :: PutSubscriptionFilter -> PutSubscriptionFilter -> Bool # (/=) :: PutSubscriptionFilter -> PutSubscriptionFilter -> Bool #
Read PutSubscriptionFilter Source #
Instance details Defined in Amazonka.CloudWatchLogs.PutSubscriptionFilter Methods readsPrec :: Int -> ReadS PutSubscriptionFilter # readList :: ReadS [PutSubscriptionFilter] # readPrec :: ReadPrec PutSubscriptionFilter # readListPrec :: ReadPrec [PutSubscriptionFilter] #
Show PutSubscriptionFilter Source #
Instance details Defined in Amazonka.CloudWatchLogs.PutSubscriptionFilter Methods showsPrec :: Int -> PutSubscriptionFilter -> ShowS # show :: PutSubscriptionFilter -> String # showList :: [PutSubscriptionFilter] -> ShowS #
Generic PutSubscriptionFilter Source #
Instance details Defined in Amazonka.CloudWatchLogs.PutSubscriptionFilter Associated Types type Rep PutSubscriptionFilter :: Type -> Type # Methods from :: PutSubscriptionFilter -> Rep PutSubscriptionFilter x # to :: Rep PutSubscriptionFilter x -> PutSubscriptionFilter #
NFData PutSubscriptionFilter Source #
Instance details Defined in Amazonka.CloudWatchLogs.PutSubscriptionFilter Methods rnf :: PutSubscriptionFilter -> () #
Hashable PutSubscriptionFilter Source #
Instance details Defined in Amazonka.CloudWatchLogs.PutSubscriptionFilter Methods hashWithSalt :: Int -> PutSubscriptionFilter -> Int # hash :: PutSubscriptionFilter -> Int #
ToJSON PutSubscriptionFilter Source #
Instance details Defined in Amazonka.CloudWatchLogs.PutSubscriptionFilter Methods toJSON :: PutSubscriptionFilter -> Value # toEncoding :: PutSubscriptionFilter -> Encoding # toJSONList :: [PutSubscriptionFilter] -> Value # toEncodingList :: [PutSubscriptionFilter] -> Encoding #
AWSRequest PutSubscriptionFilter Source #
Instance details Defined in Amazonka.CloudWatchLogs.PutSubscriptionFilter Associated Types type AWSResponse PutSubscriptionFilter # Methods request :: PutSubscriptionFilter -> Request PutSubscriptionFilter # response :: MonadResource m => Logger -> Service -> Proxy PutSubscriptionFilter -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse PutSubscriptionFilter))) #
ToHeaders PutSubscriptionFilter Source #
Instance details Defined in Amazonka.CloudWatchLogs.PutSubscriptionFilter Methods toHeaders :: PutSubscriptionFilter -> [Header] #
ToPath PutSubscriptionFilter Source #
Instance details Defined in Amazonka.CloudWatchLogs.PutSubscriptionFilter Methods toPath :: PutSubscriptionFilter -> ByteString #
ToQuery PutSubscriptionFilter Source #
Instance details Defined in Amazonka.CloudWatchLogs.PutSubscriptionFilter Methods toQuery :: PutSubscriptionFilter -> QueryString #
type Rep PutSubscriptionFilter Source #
Instance details Defined in Amazonka.CloudWatchLogs.PutSubscriptionFilter type Rep PutSubscriptionFilter = D1 ('MetaData "PutSubscriptionFilter" "Amazonka.CloudWatchLogs.PutSubscriptionFilter" "libZSservicesZSamazonka-cloudwatch-logsZSamazonka-cloudwatch-logs" 'False) (C1 ('MetaCons "PutSubscriptionFilter'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "distribution") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Distribution)) :: (S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "logGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :: (S1 ('MetaSel ('Just "filterName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "filterPattern") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "destinationArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))
type AWSResponse PutSubscriptionFilter Source #
Instance details Defined in Amazonka.CloudWatchLogs.PutSubscriptionFilter type AWSResponse PutSubscriptionFilter = PutSubscriptionFilterResponse

newPutSubscriptionFilter Source #

Arguments

:: Text	`$sel:logGroupName:PutSubscriptionFilter'`
-> Text	`$sel:filterName:PutSubscriptionFilter'`
-> Text	`$sel:filterPattern:PutSubscriptionFilter'`
-> Text	`$sel:destinationArn:PutSubscriptionFilter'`
-> PutSubscriptionFilter

Create a value of PutSubscriptionFilter with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:distribution:PutSubscriptionFilter', putSubscriptionFilter_distribution - 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.

$sel:roleArn:PutSubscriptionFilter', putSubscriptionFilter_roleArn - 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.

$sel:logGroupName:PutSubscriptionFilter', putSubscriptionFilter_logGroupName - The name of the log group.

$sel:filterName:PutSubscriptionFilter', putSubscriptionFilter_filterName - 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.

$sel:filterPattern:PutSubscriptionFilter', putSubscriptionFilter_filterPattern - A filter pattern for subscribing to a filtered stream of log events.

$sel:destinationArn:PutSubscriptionFilter', putSubscriptionFilter_destinationArn - 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 are setting up a cross-account subscription, the destination must have an IAM policy associated with it that allows the sender to send logs to the destination. For more information, see PutDestinationPolicy.
An Amazon Kinesis Firehose delivery stream belonging to the same account as the subscription filter, for same-account delivery.
A Lambda function belonging to the same account as the subscription filter, for same-account delivery.

Request Lenses

putSubscriptionFilter_distribution :: Lens' PutSubscriptionFilter (Maybe Distribution) Source #

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.

putSubscriptionFilter_roleArn :: Lens' PutSubscriptionFilter (Maybe Text) Source #

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.

putSubscriptionFilter_logGroupName :: Lens' PutSubscriptionFilter Text Source #

The name of the log group.

putSubscriptionFilter_filterName :: Lens' PutSubscriptionFilter Text Source #

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.

putSubscriptionFilter_filterPattern :: Lens' PutSubscriptionFilter Text Source #

A filter pattern for subscribing to a filtered stream of log events.

putSubscriptionFilter_destinationArn :: Lens' PutSubscriptionFilter Text Source #

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 are setting up a cross-account subscription, the destination must have an IAM policy associated with it that allows the sender to send logs to the destination. For more information, see PutDestinationPolicy.
An Amazon Kinesis Firehose delivery stream belonging to the same account as the subscription filter, for same-account delivery.
A Lambda function belonging to the same account as the subscription filter, for same-account delivery.

Destructuring the Response

data PutSubscriptionFilterResponse Source #

See: newPutSubscriptionFilterResponse smart constructor.

Constructors

PutSubscriptionFilterResponse'

Instances

Instances details

Eq PutSubscriptionFilterResponse Source #
Instance details Defined in Amazonka.CloudWatchLogs.PutSubscriptionFilter Methods (==) :: PutSubscriptionFilterResponse -> PutSubscriptionFilterResponse -> Bool # (/=) :: PutSubscriptionFilterResponse -> PutSubscriptionFilterResponse -> Bool #
Read PutSubscriptionFilterResponse Source #
Instance details Defined in Amazonka.CloudWatchLogs.PutSubscriptionFilter Methods readsPrec :: Int -> ReadS PutSubscriptionFilterResponse # readList :: ReadS [PutSubscriptionFilterResponse] # readPrec :: ReadPrec PutSubscriptionFilterResponse # readListPrec :: ReadPrec [PutSubscriptionFilterResponse] #
Show PutSubscriptionFilterResponse Source #
Instance details Defined in Amazonka.CloudWatchLogs.PutSubscriptionFilter Methods showsPrec :: Int -> PutSubscriptionFilterResponse -> ShowS # show :: PutSubscriptionFilterResponse -> String # showList :: [PutSubscriptionFilterResponse] -> ShowS #
Generic PutSubscriptionFilterResponse Source #
Instance details Defined in Amazonka.CloudWatchLogs.PutSubscriptionFilter Associated Types type Rep PutSubscriptionFilterResponse :: Type -> Type # Methods from :: PutSubscriptionFilterResponse -> Rep PutSubscriptionFilterResponse x # to :: Rep PutSubscriptionFilterResponse x -> PutSubscriptionFilterResponse #
NFData PutSubscriptionFilterResponse Source #
Instance details Defined in Amazonka.CloudWatchLogs.PutSubscriptionFilter Methods rnf :: PutSubscriptionFilterResponse -> () #
type Rep PutSubscriptionFilterResponse Source #
Instance details Defined in Amazonka.CloudWatchLogs.PutSubscriptionFilter type Rep PutSubscriptionFilterResponse = D1 ('MetaData "PutSubscriptionFilterResponse" "Amazonka.CloudWatchLogs.PutSubscriptionFilter" "libZSservicesZSamazonka-cloudwatch-logsZSamazonka-cloudwatch-logs" 'False) (C1 ('MetaCons "PutSubscriptionFilterResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newPutSubscriptionFilterResponse :: PutSubscriptionFilterResponse Source #

Create a value of PutSubscriptionFilterResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.