software.amazon.awscdk.services.logs

Class CfnSubscriptionFilter

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.logs.CfnSubscriptionFilter

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:40.702Z")
 @Stability(value=Stable)
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 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
         .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 class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnSubscriptionFilter(software.constructs.Construct scope, 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
String	getAttrFilterName()
protected Map<String,Object>	getCfnProperties()
String	getDestinationArn() The Amazon Resource Name (ARN) of the destination.
String	getFilterPattern() The filtering expressions that restrict what gets delivered to the destination AWS resource.
String	getLogGroupName() The log group to associate with the subscription filter.
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 Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDestinationArn(String value) The Amazon Resource Name (ARN) of the destination.
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.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

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 Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final 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

@Stability(value=Stable)
public CfnSubscriptionFilter(@NotNull
                                                      software.constructs.Construct scope,
                                                      @NotNull
                                                      String id,
                                                      @NotNull
                                                      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

@Stability(value=Stable)
public void inspect(@NotNull
                                             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

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrFilterName

@Stability(value=Stable)
 @NotNull
public String getAttrFilterName()

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getDestinationArn

@Stability(value=Stable)
 @NotNull
public String getDestinationArn()

The Amazon Resource Name (ARN) of the destination.

setDestinationArn

@Stability(value=Stable)
public void setDestinationArn(@NotNull
                                                       String value)

The Amazon Resource Name (ARN) of the destination.

getFilterPattern

@Stability(value=Stable)
 @NotNull
public 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

@Stability(value=Stable)
public void setFilterPattern(@NotNull
                                                      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

@Stability(value=Stable)
 @NotNull
public 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

@Stability(value=Stable)
public void setLogGroupName(@NotNull
                                                     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.

getRoleArn

@Stability(value=Stable)
 @Nullable
public 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

@Stability(value=Stable)
public void setRoleArn(@Nullable
                                                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.