Network.AWS.CloudWatchLogs.PutSubscriptionFilter

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. 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 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 AWS Lambda function that belongs to the same account as the subscription filter, for same-account delivery.

There can only be one subscription filter associated with a log group. If you are updating an existing filter, you must specify the correct name in filterName . Otherwise, the call fails because you cannot associate a second filter with a log group.

Creating a Request

putSubscriptionFilter

Arguments

:: Text

psfLogGroupName

-> Text

psfFilterName

-> Text

psfFilterPattern

-> Text

psfDestinationARN

-> PutSubscriptionFilter

Creates a value of PutSubscriptionFilter with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• psfDistribution - 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.
• psfRoleARN - 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.
• psfLogGroupName - The name of the log group.
• psfFilterName - A name for the subscription filter. If you are updating an existing filter, you must specify the correct name in filterName . Otherwise, the call fails because you cannot associate a second filter with a log group. To find the name of the filter currently associated with a log group, use DescribeSubscriptionFilters .
• psfFilterPattern - A filter pattern for subscribing to a filtered stream of log events.
• psfDestinationARN - 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. * An Amazon Kinesis Firehose delivery stream belonging to the same account as the subscription filter, for same-account delivery. * An AWS Lambda function belonging to the same account as the subscription filter, for same-account delivery.

data PutSubscriptionFilter

See: putSubscriptionFilter smart constructor.

Instances

Eq PutSubscriptionFilter

Defined in Network.AWS.CloudWatchLogs.PutSubscriptionFilter

Methods

(==) :: PutSubscriptionFilter -> PutSubscriptionFilter -> Bool

(/=) :: PutSubscriptionFilter -> PutSubscriptionFilter -> Bool

Data PutSubscriptionFilter

Defined in Network.AWS.CloudWatchLogs.PutSubscriptionFilter

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> PutSubscriptionFilter -> c PutSubscriptionFilter

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c PutSubscriptionFilter

toConstr :: PutSubscriptionFilter -> Constr

dataTypeOf :: PutSubscriptionFilter -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c PutSubscriptionFilter)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c PutSubscriptionFilter)

gmapT :: (forall b. Data b => b -> b) -> PutSubscriptionFilter -> PutSubscriptionFilter

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> PutSubscriptionFilter -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> PutSubscriptionFilter -> r

gmapQ :: (forall d. Data d => d -> u) -> PutSubscriptionFilter -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> PutSubscriptionFilter -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> PutSubscriptionFilter -> m PutSubscriptionFilter

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> PutSubscriptionFilter -> m PutSubscriptionFilter

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> PutSubscriptionFilter -> m PutSubscriptionFilter

Read PutSubscriptionFilter

Defined in Network.AWS.CloudWatchLogs.PutSubscriptionFilter

Methods

readsPrec :: Int -> ReadS PutSubscriptionFilter

readList :: ReadS [PutSubscriptionFilter]

readPrec :: ReadPrec PutSubscriptionFilter

readListPrec :: ReadPrec [PutSubscriptionFilter]

Show PutSubscriptionFilter

Defined in Network.AWS.CloudWatchLogs.PutSubscriptionFilter

Methods

showsPrec :: Int -> PutSubscriptionFilter -> ShowS

show :: PutSubscriptionFilter -> String

showList :: [PutSubscriptionFilter] -> ShowS

Generic PutSubscriptionFilter

Defined in Network.AWS.CloudWatchLogs.PutSubscriptionFilter

Associated Types

type Rep PutSubscriptionFilter :: Type -> Type

Methods

from :: PutSubscriptionFilter -> Rep PutSubscriptionFilter x

to :: Rep PutSubscriptionFilter x -> PutSubscriptionFilter

Hashable PutSubscriptionFilter

Defined in Network.AWS.CloudWatchLogs.PutSubscriptionFilter

Methods

hashWithSalt :: Int -> PutSubscriptionFilter -> Int

hash :: PutSubscriptionFilter -> Int

ToJSON PutSubscriptionFilter

Defined in Network.AWS.CloudWatchLogs.PutSubscriptionFilter

Methods

toJSON :: PutSubscriptionFilter -> Value

toEncoding :: PutSubscriptionFilter -> Encoding

toJSONList :: [PutSubscriptionFilter] -> Value

toEncodingList :: [PutSubscriptionFilter] -> Encoding

AWSRequest PutSubscriptionFilter

Defined in Network.AWS.CloudWatchLogs.PutSubscriptionFilter

Associated Types

type Rs PutSubscriptionFilter :: Type

Methods

request :: PutSubscriptionFilter -> Request PutSubscriptionFilter

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy PutSubscriptionFilter -> ClientResponse -> m (Response PutSubscriptionFilter)

ToHeaders PutSubscriptionFilter

Defined in Network.AWS.CloudWatchLogs.PutSubscriptionFilter

Methods

toHeaders :: PutSubscriptionFilter -> [Header]

ToPath PutSubscriptionFilter

Defined in Network.AWS.CloudWatchLogs.PutSubscriptionFilter

Methods

toPath :: PutSubscriptionFilter -> ByteString

ToQuery PutSubscriptionFilter

Defined in Network.AWS.CloudWatchLogs.PutSubscriptionFilter

Methods

toQuery :: PutSubscriptionFilter -> QueryString

NFData PutSubscriptionFilter

Defined in Network.AWS.CloudWatchLogs.PutSubscriptionFilter

Methods

rnf :: PutSubscriptionFilter -> ()

type Rep PutSubscriptionFilter

Defined in Network.AWS.CloudWatchLogs.PutSubscriptionFilter

type Rep PutSubscriptionFilter = D1 (MetaData "PutSubscriptionFilter" "Network.AWS.CloudWatchLogs.PutSubscriptionFilter" "amazonka-cloudwatch-logs-1.6.1-3MDuvRaDmjeBjiAkGx8qXs" False) (C1 (MetaCons "PutSubscriptionFilter'" PrefixI True) ((S1 (MetaSel (Just "_psfDistribution") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Distribution)) :*: (S1 (MetaSel (Just "_psfRoleARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_psfLogGroupName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))) :*: (S1 (MetaSel (Just "_psfFilterName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: (S1 (MetaSel (Just "_psfFilterPattern") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_psfDestinationARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))))

type Rs PutSubscriptionFilter

Defined in Network.AWS.CloudWatchLogs.PutSubscriptionFilter

type Rs PutSubscriptionFilter = PutSubscriptionFilterResponse

Request Lenses

psfDistribution :: Lens' PutSubscriptionFilter (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.

psfRoleARN :: Lens' PutSubscriptionFilter (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.

psfLogGroupName :: Lens' PutSubscriptionFilter Text

The name of the log group.

psfFilterName :: Lens' PutSubscriptionFilter Text

A name for the subscription filter. If you are updating an existing filter, you must specify the correct name in filterName . Otherwise, the call fails because you cannot associate a second filter with a log group. To find the name of the filter currently associated with a log group, use DescribeSubscriptionFilters .

psfFilterPattern :: Lens' PutSubscriptionFilter Text

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

psfDestinationARN :: Lens' PutSubscriptionFilter 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. * An Amazon Kinesis Firehose delivery stream belonging to the same account as the subscription filter, for same-account delivery. * An AWS Lambda function belonging to the same account as the subscription filter, for same-account delivery.

Destructuring the Response

putSubscriptionFilterResponse :: PutSubscriptionFilterResponse

Creates a value of PutSubscriptionFilterResponse with the minimum fields required to make a request.

data PutSubscriptionFilterResponse

See: putSubscriptionFilterResponse smart constructor.

Instances

Eq PutSubscriptionFilterResponse

Defined in Network.AWS.CloudWatchLogs.PutSubscriptionFilter

Methods

(==) :: PutSubscriptionFilterResponse -> PutSubscriptionFilterResponse -> Bool

(/=) :: PutSubscriptionFilterResponse -> PutSubscriptionFilterResponse -> Bool

Data PutSubscriptionFilterResponse

Defined in Network.AWS.CloudWatchLogs.PutSubscriptionFilter

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> PutSubscriptionFilterResponse -> c PutSubscriptionFilterResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c PutSubscriptionFilterResponse

toConstr :: PutSubscriptionFilterResponse -> Constr

dataTypeOf :: PutSubscriptionFilterResponse -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c PutSubscriptionFilterResponse)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c PutSubscriptionFilterResponse)

gmapT :: (forall b. Data b => b -> b) -> PutSubscriptionFilterResponse -> PutSubscriptionFilterResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> PutSubscriptionFilterResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> PutSubscriptionFilterResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> PutSubscriptionFilterResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> PutSubscriptionFilterResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> PutSubscriptionFilterResponse -> m PutSubscriptionFilterResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> PutSubscriptionFilterResponse -> m PutSubscriptionFilterResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> PutSubscriptionFilterResponse -> m PutSubscriptionFilterResponse

Read PutSubscriptionFilterResponse

Defined in Network.AWS.CloudWatchLogs.PutSubscriptionFilter

Methods

readsPrec :: Int -> ReadS PutSubscriptionFilterResponse

readList :: ReadS [PutSubscriptionFilterResponse]

readPrec :: ReadPrec PutSubscriptionFilterResponse

readListPrec :: ReadPrec [PutSubscriptionFilterResponse]

Show PutSubscriptionFilterResponse

Defined in Network.AWS.CloudWatchLogs.PutSubscriptionFilter

Methods

showsPrec :: Int -> PutSubscriptionFilterResponse -> ShowS

show :: PutSubscriptionFilterResponse -> String

showList :: [PutSubscriptionFilterResponse] -> ShowS

Generic PutSubscriptionFilterResponse

Defined in Network.AWS.CloudWatchLogs.PutSubscriptionFilter

Associated Types

type Rep PutSubscriptionFilterResponse :: Type -> Type

Methods

from :: PutSubscriptionFilterResponse -> Rep PutSubscriptionFilterResponse x

to :: Rep PutSubscriptionFilterResponse x -> PutSubscriptionFilterResponse

NFData PutSubscriptionFilterResponse

Defined in Network.AWS.CloudWatchLogs.PutSubscriptionFilter

Methods

rnf :: PutSubscriptionFilterResponse -> ()

type Rep PutSubscriptionFilterResponse

Defined in Network.AWS.CloudWatchLogs.PutSubscriptionFilter

type Rep PutSubscriptionFilterResponse = D1 (MetaData "PutSubscriptionFilterResponse" "Network.AWS.CloudWatchLogs.PutSubscriptionFilter" "amazonka-cloudwatch-logs-1.6.1-3MDuvRaDmjeBjiAkGx8qXs" False) (C1 (MetaCons "PutSubscriptionFilterResponse'" PrefixI False) (U1 :: Type -> Type))