Class CfnSubscriptionFilter
- All Implemented Interfaces:
IConstruct
,IDependable
,IInspectable
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
AWS::Logs::SubscriptionFilter
.
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 AWS Lambda 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.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.services.logs.*; CfnSubscriptionFilter cfnSubscriptionFilter = CfnSubscriptionFilter.Builder.create(this, "MyCfnSubscriptionFilter") .destinationArn("destinationArn") .filterPattern("filterPattern") .logGroupName("logGroupName") // the properties below are optional .distribution("distribution") .filterName("filterName") .roleArn("roleArn") .build();
-
Nested Class Summary
Nested ClassesNested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct
IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ConstructorsModifierConstructorDescriptionCfnSubscriptionFilter
(Construct scope, String id, CfnSubscriptionFilterProps props) Create a newAWS::Logs::SubscriptionFilter
.protected
CfnSubscriptionFilter
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnSubscriptionFilter
(software.amazon.jsii.JsiiObjectRef objRef) -
Method Summary
Modifier and TypeMethodDescriptionThe Amazon Resource Name (ARN) of the destination.The method used to distribute log data to the destination, which can be either random or grouped by log stream.The name of the subscription filter.The filtering expressions that restrict what gets delivered to the destination AWS resource.The log group to associate with the subscription filter.The ARN of an IAM role that grants CloudWatch Logs permissions to deliver ingested log events to the destination stream.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties
(Map<String, Object> props) void
setDestinationArn
(String value) The Amazon Resource Name (ARN) of the destination.void
setDistribution
(String value) The method used to distribute log data to the destination, which can be either random or grouped by log stream.void
setFilterName
(String value) The name of the subscription filter.void
setFilterPattern
(String value) The filtering expressions that restrict what gets delivered to the destination AWS resource.void
setLogGroupName
(String value) The log group to associate with the subscription filter.void
setRoleArn
(String value) The ARN of an IAM role that grants CloudWatch Logs permissions to deliver ingested log events to the destination stream.Methods inherited from class software.amazon.awscdk.core.CfnResource
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
Methods inherited from class software.amazon.awscdk.core.CfnRefElement
getRef
Methods inherited from class software.amazon.awscdk.core.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
Methods inherited from class software.amazon.awscdk.core.Construct
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Field Details
-
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
-
-
Constructor Details
-
CfnSubscriptionFilter
protected CfnSubscriptionFilter(software.amazon.jsii.JsiiObjectRef objRef) -
CfnSubscriptionFilter
protected CfnSubscriptionFilter(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
CfnSubscriptionFilter
@Stability(Stable) public CfnSubscriptionFilter(@NotNull Construct scope, @NotNull String id, @NotNull CfnSubscriptionFilterProps props) Create a newAWS::Logs::SubscriptionFilter
.- Parameters:
scope
-- scope in which this resource is defined.
id
-- scoped id of the resource.
props
-- resource properties.
-
-
Method Details
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- Parameters:
inspector
-- tree inspector to collect and process attributes.
-
renderProperties
@Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String, Object> props) - Overrides:
renderProperties
in classCfnResource
- Parameters:
props
- This parameter is required.
-
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getDestinationArn
The Amazon Resource Name (ARN) of the destination. -
setDestinationArn
The Amazon Resource Name (ARN) of the destination. -
getFilterPattern
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 .
-
setFilterPattern
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 .
-
getLogGroupName
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.
-
setLogGroupName
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.
-
getDistribution
The method used to distribute log data to the destination, which can be either random or grouped by log stream. -
setDistribution
The method used to distribute log data to the destination, which can be either random or grouped by log stream. -
getFilterName
The name of the subscription filter. -
setFilterName
The name of the subscription filter. -
getRoleArn
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.
-
setRoleArn
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.
-