software.amazon.awscdk.services.logs

Class CfnSubscriptionFilter

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.logs.CfnSubscriptionFilter

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:42.016Z")
public class CfnSubscriptionFilter
extends CfnResource
implements IInspectable

A CloudFormation `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 Classes

Modifier and Type	Class and Description
static class	CfnSubscriptionFilter.Builder A fluent builder for CfnSubscriptionFilter.

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnSubscriptionFilter(Construct scope, java.lang.String id, CfnSubscriptionFilterProps props) Create a new `AWS::Logs::SubscriptionFilter`.
protected	CfnSubscriptionFilter(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnSubscriptionFilter(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.String	getDestinationArn() The Amazon Resource Name (ARN) of the destination.
java.lang.String	getDistribution() `AWS::Logs::SubscriptionFilter.Distribution`.
java.lang.String	getFilterName() The name of the subscription filter.
java.lang.String	getFilterPattern() The filtering expressions that restrict what gets delivered to the destination AWS resource.
java.lang.String	getLogGroupName() The log group to associate with the subscription filter.
java.lang.String	getRoleArn() 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.
protected java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setDestinationArn(java.lang.String value) The Amazon Resource Name (ARN) of the destination.
void	setDistribution(java.lang.String value) `AWS::Logs::SubscriptionFilter.Distribution`.
void	setFilterName(java.lang.String value) The name of the subscription filter.
void	setFilterPattern(java.lang.String value) The filtering expressions that restrict what gets delivered to the destination AWS resource.
void	setLogGroupName(java.lang.String value) The log group to associate with the subscription filter.
void	setRoleArn(java.lang.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 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnSubscriptionFilter

protected CfnSubscriptionFilter(software.amazon.jsii.JsiiObjectRef objRef)

CfnSubscriptionFilter

protected CfnSubscriptionFilter(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnSubscriptionFilter

public CfnSubscriptionFilter(Construct scope,
                             java.lang.String id,
                             CfnSubscriptionFilterProps props)

Create a new `AWS::Logs::SubscriptionFilter`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

public void inspect(TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getDestinationArn

public java.lang.String getDestinationArn()

The Amazon Resource Name (ARN) of the destination.

setDestinationArn

public void setDestinationArn(java.lang.String value)

The Amazon Resource Name (ARN) of the destination.

getFilterPattern

public java.lang.String 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

public void setFilterPattern(java.lang.String value)

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

public java.lang.String 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

public void setLogGroupName(java.lang.String value)

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

public java.lang.String getDistribution()

`AWS::Logs::SubscriptionFilter.Distribution`.

setDistribution

public void setDistribution(java.lang.String value)

`AWS::Logs::SubscriptionFilter.Distribution`.

getFilterName

public java.lang.String getFilterName()

The name of the subscription filter.

setFilterName

public void setFilterName(java.lang.String value)

The name of the subscription filter.

getRoleArn

public java.lang.String 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

public void setRoleArn(java.lang.String value)

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.