aws-cdk-lib 2.186.0__py3-none-any.whl → 2.188.0__py3-none-any.whl

aws_cdk/aws_logs/__init__.py

@@ -159,6 +159,24 @@ logs.SubscriptionFilter(self, "Subscription",
 )
 ```
 
+When you use `FirehoseDestination`, you can choose the method used to
+distribute log data to the destination by setting the `distribution` property.
+
+```python
+import aws_cdk.aws_logs_destinations as destinations
+import aws_cdk.aws_kinesisfirehose as firehose
+
+# delivery_stream: firehose.IDeliveryStream
+# log_group: logs.LogGroup
+
+
+logs.SubscriptionFilter(self, "Subscription",
+    log_group=log_group,
+    destination=destinations.FirehoseDestination(delivery_stream),
+    filter_pattern=logs.FilterPattern.all_events()
+)
+```
+
 ## Metric Filters
 
 CloudWatch Logs can extract and emit metrics based on a textual log stream.

aws_cdk/aws_logs_destinations/__init__.py

@@ -41,6 +41,7 @@ from .._jsii import *
 import constructs as _constructs_77d1e7e8
 from ..aws_iam import IRole as _IRole_235f5d8e
 from ..aws_kinesis import IStream as _IStream_4e2457d2
+from ..aws_kinesisfirehose import IDeliveryStream as _IDeliveryStream_8f118861
 from ..aws_lambda import IFunction as _IFunction_6adb0ab8
 from ..aws_logs import (
     ILogGroup as _ILogGroup_3c4fa718,
@@ -49,6 +50,127 @@ from ..aws_logs import (
 )
 
 
+@jsii.implements(_ILogSubscriptionDestination_99a12804)
+class FirehoseDestination(
+    metaclass=jsii.JSIIMeta,
+    jsii_type="aws-cdk-lib.aws_logs_destinations.FirehoseDestination",
+):
+    '''Use a Data Firehose delivery stream as the destination for a log subscription.
+
+    :exampleMetadata: infused
+
+    Example::
+
+        import aws_cdk.aws_logs_destinations as destinations
+        import aws_cdk.aws_kinesisfirehose as firehose
+        
+        # delivery_stream: firehose.IDeliveryStream
+        # log_group: logs.LogGroup
+        
+        
+        logs.SubscriptionFilter(self, "Subscription",
+            log_group=log_group,
+            destination=destinations.FirehoseDestination(delivery_stream),
+            filter_pattern=logs.FilterPattern.all_events()
+        )
+    '''
+
+    def __init__(
+        self,
+        stream: _IDeliveryStream_8f118861,
+        *,
+        role: typing.Optional[_IRole_235f5d8e] = None,
+    ) -> None:
+        '''
+        :param stream: The Data Firehose delivery stream to use as destination.
+        :param role: The role to assume to write log events to the destination. Default: - A new Role is created
+        '''
+        if __debug__:
+            type_hints = typing.get_type_hints(_typecheckingstub__4cb4e49bfe3a6c7ef67778da7a93e24765ed8e25b0e86da6e92e1d5205457086)
+            check_type(argname="argument stream", value=stream, expected_type=type_hints["stream"])
+        props = FirehoseDestinationProps(role=role)
+
+        jsii.create(self.__class__, self, [stream, props])
+
+    @jsii.member(jsii_name="bind")
+    def bind(
+        self,
+        scope: _constructs_77d1e7e8.Construct,
+        _source_log_group: _ILogGroup_3c4fa718,
+    ) -> _LogSubscriptionDestinationConfig_15877ced:
+        '''Return the properties required to send subscription events to this destination.
+
+        If necessary, the destination can use the properties of the SubscriptionFilter
+        object itself to configure its permissions to allow the subscription to write
+        to it.
+
+        The destination may reconfigure its own permissions in response to this
+        function call.
+
+        :param scope: -
+        :param _source_log_group: -
+        '''
+        if __debug__:
+            type_hints = typing.get_type_hints(_typecheckingstub__b48d2560b01f38d75fb9bf3c773ce107d4b79363d6f0dced504bd870eebb715b)
+            check_type(argname="argument scope", value=scope, expected_type=type_hints["scope"])
+            check_type(argname="argument _source_log_group", value=_source_log_group, expected_type=type_hints["_source_log_group"])
+        return typing.cast(_LogSubscriptionDestinationConfig_15877ced, jsii.invoke(self, "bind", [scope, _source_log_group]))
+
+
+@jsii.data_type(
+    jsii_type="aws-cdk-lib.aws_logs_destinations.FirehoseDestinationProps",
+    jsii_struct_bases=[],
+    name_mapping={"role": "role"},
+)
+class FirehoseDestinationProps:
+    def __init__(self, *, role: typing.Optional[_IRole_235f5d8e] = None) -> None:
+        '''Customize the Amazon Data Firehose Logs Destination.
+
+        :param role: The role to assume to write log events to the destination. Default: - A new Role is created
+
+        :exampleMetadata: fixture=_generated
+
+        Example::
+
+            # The code below shows an example of how to instantiate this type.
+            # The values are placeholders you should change.
+            from aws_cdk import aws_iam as iam
+            from aws_cdk import aws_logs_destinations as logs_destinations
+            
+            # role: iam.Role
+            
+            firehose_destination_props = logs_destinations.FirehoseDestinationProps(
+                role=role
+            )
+        '''
+        if __debug__:
+            type_hints = typing.get_type_hints(_typecheckingstub__b45f72f38e87e36b03e7d6828642750a36a55581864f0124704f80206950b2e6)
+            check_type(argname="argument role", value=role, expected_type=type_hints["role"])
+        self._values: typing.Dict[builtins.str, typing.Any] = {}
+        if role is not None:
+            self._values["role"] = role
+
+    @builtins.property
+    def role(self) -> typing.Optional[_IRole_235f5d8e]:
+        '''The role to assume to write log events to the destination.
+
+        :default: - A new Role is created
+        '''
+        result = self._values.get("role")
+        return typing.cast(typing.Optional[_IRole_235f5d8e], result)
+
+    def __eq__(self, rhs: typing.Any) -> builtins.bool:
+        return isinstance(rhs, self.__class__) and rhs._values == self._values
+
+    def __ne__(self, rhs: typing.Any) -> builtins.bool:
+        return not (rhs == self)
+
+    def __repr__(self) -> str:
+        return "FirehoseDestinationProps(%s)" % ", ".join(
+            k + "=" + repr(v) for k, v in self._values.items()
+        )
+
+
 @jsii.implements(_ILogSubscriptionDestination_99a12804)
 class KinesisDestination(
     metaclass=jsii.JSIIMeta,
@@ -296,6 +418,8 @@ class LambdaDestinationOptions:
 
 
 __all__ = [
+    "FirehoseDestination",
+    "FirehoseDestinationProps",
     "KinesisDestination",
     "KinesisDestinationProps",
     "LambdaDestination",
@@ -304,6 +428,28 @@ __all__ = [
 
 publication.publish()
 
+def _typecheckingstub__4cb4e49bfe3a6c7ef67778da7a93e24765ed8e25b0e86da6e92e1d5205457086(
+    stream: _IDeliveryStream_8f118861,
+    *,
+    role: typing.Optional[_IRole_235f5d8e] = None,
+) -> None:
+    """Type checking stubs"""
+    pass
+
+def _typecheckingstub__b48d2560b01f38d75fb9bf3c773ce107d4b79363d6f0dced504bd870eebb715b(
+    scope: _constructs_77d1e7e8.Construct,
+    _source_log_group: _ILogGroup_3c4fa718,
+) -> None:
+    """Type checking stubs"""
+    pass
+
+def _typecheckingstub__b45f72f38e87e36b03e7d6828642750a36a55581864f0124704f80206950b2e6(
+    *,
+    role: typing.Optional[_IRole_235f5d8e] = None,
+) -> None:
+    """Type checking stubs"""
+    pass
+
 def _typecheckingstub__6f4422231f62d5490fdbb0217f4c6e73134c1c066522144d9488224a6ffe689b(
     stream: _IStream_4e2457d2,
     *,