@aws-cdk/aws-logs

constructor

constructor(scope: cdk.Construct, id: string, props: CfnDestinationProps);

• Create a new AWS::Logs::Destination.

  Parameter scope

  scope in which this resource is defined

  Parameter id

  scoped id of the resource

  Parameter props

  resource properties

property attrArn

readonly attrArn: string;

• The ARN of the CloudWatch Logs destination, such as arn:aws:logs:us-west-1:123456789012:destination:MyDestination . Arn

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;

• The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

property destinationName

destinationName: string;

• The name of the destination.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-destination.html#cfn-logs-destination-destinationname

property destinationPolicy

destinationPolicy: string;

• An IAM policy document that governs which AWS accounts can create subscription filters against this destination.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-destination.html#cfn-logs-destination-destinationpolicy

property roleArn

roleArn: string;

• The ARN of an IAM role that permits CloudWatch Logs to send data to the specified AWS resource.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-destination.html#cfn-logs-destination-rolearn

property targetArn

targetArn: string;

• The Amazon Resource Name (ARN) of the physical target where the log events are delivered (for example, a Kinesis stream).

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-destination.html#cfn-logs-destination-targetarn

method inspect

inspect: (inspector: cdk.TreeInspector) => void;

• Examines the CloudFormation resource and discloses attributes.

  Parameter inspector

  tree inspector to collect and process attributes

method renderProperties

protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
};

constructor

constructor(scope: cdk.Construct, id: string, props?: CfnLogGroupProps);

• Create a new AWS::Logs::LogGroup.

  Parameter scope

  scope in which this resource is defined

  Parameter id

  scoped id of the resource

  Parameter props

  resource properties

property attrArn

readonly attrArn: string;

• The ARN of the log group, such as arn:aws:logs:us-west-1:123456789012:log-group:/mystack-testgroup-12ABC1AB12A1:* Arn

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;

• The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

property dataProtectionPolicy

dataProtectionPolicy: any;

• Creates a data protection policy and assigns it to the log group. A data protection policy can help safeguard sensitive data that's ingested by the log group by auditing and masking the sensitive log data. When a user who does not have permission to view masked data views a log event that includes masked data, the sensitive data is replaced by asterisks.

  For more information, including a list of types of data that can be audited and masked, see [Protect sensitive log data with masking](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/mask-sensitive-log-data.html) .

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loggroup.html#cfn-logs-loggroup-dataprotectionpolicy

property kmsKeyId

kmsKeyId: string;

• The Amazon Resource Name (ARN) of the AWS KMS key to use when encrypting log data.

  To associate an AWS KMS key with the log group, specify the ARN of that KMS key here. If you do so, ingested data is encrypted using this key. This association is stored as long as the data encrypted with the KMS key is still within CloudWatch Logs . This enables CloudWatch Logs to decrypt this data whenever it is requested.

  If you attempt to associate a KMS key with the log group but the KMS key doesn't exist or is deactivated, you will receive an InvalidParameterException error.

  Log group data is always encrypted in CloudWatch Logs . If you omit this key, the encryption does not use AWS KMS . For more information, see [Encrypt log data in CloudWatch Logs using AWS Key Management Service](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/encrypt-log-data-kms.html)

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loggroup.html#cfn-logs-loggroup-kmskeyid

property logGroupName

logGroupName: string;

• The name of the log group. If you don't specify a name, AWS CloudFormation generates a unique ID for the log group.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loggroup.html#cfn-logs-loggroup-loggroupname

property retentionInDays

retentionInDays: number;

• The number of days to retain the log events in the specified log group. Possible values are: 1, 3, 5, 7, 14, 30, 60, 90, 120, 150, 180, 365, 400, 545, 731, 1096, 1827, 2192, 2557, 2922, 3288, and 3653.

  To set a log group so that its log events do not expire, use [DeleteRetentionPolicy](https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DeleteRetentionPolicy.html) .

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loggroup.html#cfn-logs-loggroup-retentionindays

property tags

readonly tags: cdk.TagManager;

• An array of key-value pairs to apply to the log group.

  For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loggroup.html#cfn-logs-loggroup-tags

method inspect

inspect: (inspector: cdk.TreeInspector) => void;

• Examines the CloudFormation resource and discloses attributes.

  Parameter inspector

  tree inspector to collect and process attributes

method renderProperties

protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
};

constructor

constructor(scope: cdk.Construct, id: string, props: CfnLogStreamProps);

• Create a new AWS::Logs::LogStream.

  Parameter scope

  scope in which this resource is defined

  Parameter id

  scoped id of the resource

  Parameter props

  resource properties

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;

• The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

property logGroupName

logGroupName: string;

• The name of the log group where the log stream is created.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-logstream.html#cfn-logs-logstream-loggroupname

property logStreamName

logStreamName: string;

• The name of the log stream. The name must be unique within the log group.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-logstream.html#cfn-logs-logstream-logstreamname

method inspect

inspect: (inspector: cdk.TreeInspector) => void;

• Examines the CloudFormation resource and discloses attributes.

  Parameter inspector

  tree inspector to collect and process attributes

method renderProperties

protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
};

constructor

constructor(scope: cdk.Construct, id: string, props: CfnMetricFilterProps);

• Create a new AWS::Logs::MetricFilter.

  Parameter scope

  scope in which this resource is defined

  Parameter id

  scoped id of the resource

  Parameter props

  resource properties

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;

• The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

property filterName

filterName: string;

• The name of the metric filter.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-metricfilter.html#cfn-logs-metricfilter-filtername

property filterPattern

filterPattern: string;

• A filter pattern for extracting metric data out of ingested log events. For more information, see [Filter and Pattern Syntax](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html) .

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-metricfilter.html#cfn-logs-metricfilter-filterpattern

property logGroupName

logGroupName: string;

• The name of an existing log group that you want to associate with this metric filter.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-metricfilter.html#cfn-logs-metricfilter-loggroupname

property metricTransformations

metricTransformations: any;

• The metric transformations.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-metricfilter.html#cfn-logs-metricfilter-metrictransformations

method inspect

inspect: (inspector: cdk.TreeInspector) => void;

• Examines the CloudFormation resource and discloses attributes.

  Parameter inspector

  tree inspector to collect and process attributes

method renderProperties

protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
};

constructor

constructor(scope: cdk.Construct, id: string, props: CfnQueryDefinitionProps);

• Create a new AWS::Logs::QueryDefinition.

  Parameter scope

  scope in which this resource is defined

  Parameter id

  scoped id of the resource

  Parameter props

  resource properties

property attrQueryDefinitionId

readonly attrQueryDefinitionId: string;

• The ID of the query definition. QueryDefinitionId

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;

• The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

property logGroupNames

logGroupNames: string[];

• Use this parameter if you want the query to query only certain log groups.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-querydefinition.html#cfn-logs-querydefinition-loggroupnames

property name

name: string;

• A name for the query definition.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-querydefinition.html#cfn-logs-querydefinition-name

property queryString

queryString: string;

• The query string to use for this query definition. For more information, see [CloudWatch Logs Insights Query Syntax](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CWL_QuerySyntax.html) .

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-querydefinition.html#cfn-logs-querydefinition-querystring

method inspect

inspect: (inspector: cdk.TreeInspector) => void;

• Examines the CloudFormation resource and discloses attributes.

  Parameter inspector

  tree inspector to collect and process attributes

method renderProperties

protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
};

constructor

constructor(scope: cdk.Construct, id: string, props: CfnResourcePolicyProps);

• Create a new AWS::Logs::ResourcePolicy.

  Parameter scope

  scope in which this resource is defined

  Parameter id

  scoped id of the resource

  Parameter props

  resource properties

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;

• The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

property policyDocument

policyDocument: string;

• The details of the policy. It must be formatted in JSON, and you must use backslashes to escape characters that need to be escaped in JSON strings, such as double quote marks.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-resourcepolicy.html#cfn-logs-resourcepolicy-policydocument

property policyName

policyName: string;

• The name of the resource policy.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-resourcepolicy.html#cfn-logs-resourcepolicy-policyname

method inspect

inspect: (inspector: cdk.TreeInspector) => void;

• Examines the CloudFormation resource and discloses attributes.

  Parameter inspector

  tree inspector to collect and process attributes

method renderProperties

protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
};

constructor

constructor(scope: cdk.Construct, id: string, props: CfnSubscriptionFilterProps);

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

  Parameter scope

  scope in which this resource is defined

  Parameter id

  scoped id of the resource

  Parameter props

  resource properties

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;

• The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

property destinationArn

destinationArn: string;

• The Amazon Resource Name (ARN) of the destination.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-subscriptionfilter.html#cfn-logs-subscriptionfilter-destinationarn

property distribution

distribution: string;

• The method used to distribute log data to the destination, which can be either random or grouped by log stream.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-subscriptionfilter.html#cfn-logs-subscriptionfilter-distribution

property filterName

filterName: string;

• The name of the subscription filter.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-subscriptionfilter.html#cfn-logs-subscriptionfilter-filtername

property filterPattern

filterPattern: string;

• 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](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html) .

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-subscriptionfilter.html#cfn-logs-subscriptionfilter-filterpattern

property logGroupName

logGroupName: string;

• 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.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-subscriptionfilter.html#cfn-logs-subscriptionfilter-loggroupname

property roleArn

roleArn: string;

• 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.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-subscriptionfilter.html#cfn-logs-subscriptionfilter-rolearn

method inspect

inspect: (inspector: cdk.TreeInspector) => void;

• Examines the CloudFormation resource and discloses attributes.

  Parameter inspector

  tree inspector to collect and process attributes

method renderProperties

protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
};

constructor

constructor(scope: Construct, id: string, props: CrossAccountDestinationProps);

property destinationArn

readonly destinationArn: string;

• The ARN of this CrossAccountDestination object

property destinationName

readonly destinationName: string;

• The name of this CrossAccountDestination object

property policyDocument

readonly policyDocument: iam.PolicyDocument;

• Policy object of this CrossAccountDestination object

method addToPolicy

addToPolicy: (statement: iam.PolicyStatement) => void;

method bind

bind: (
    _scope: CoreConstruct,
    _sourceLogGroup: ILogGroup
) => LogSubscriptionDestinationConfig;

method all

static all: (...patterns: JsonPattern[]) => JsonPattern;

• A JSON log pattern that matches if all given JSON log patterns match

method allEvents

static allEvents: () => IFilterPattern;

• A log pattern that matches all events.

method allTerms

static allTerms: (...terms: string[]) => IFilterPattern;

• A log pattern that matches if all the strings given appear in the event.

  Parameter terms

  The words to search for. All terms must match.

method any

static any: (...patterns: JsonPattern[]) => JsonPattern;

• A JSON log pattern that matches if any of the given JSON log patterns match

method anyTerm

static anyTerm: (...terms: string[]) => IFilterPattern;

• A log pattern that matches if any of the strings given appear in the event.

  Parameter terms

  The words to search for. Any terms must match.

method anyTermGroup

static anyTermGroup: (...termGroups: string[][]) => IFilterPattern;

• A log pattern that matches if any of the given term groups matches the event.

  A term group matches an event if all the terms in it appear in the event string.

  Parameter termGroups

  A list of term groups to search for. Any one of the clauses must match.

method booleanValue

static booleanValue: (jsonField: string, value: boolean) => JsonPattern;

• A JSON log pattern that matches if the field exists and equals the boolean value.

  Parameter jsonField

  Field inside JSON. Example: "$.myField"

  Parameter value

  The value to match

method exists

static exists: (jsonField: string) => JsonPattern;

• A JSON log patter that matches if the field exists.

  This is a readable convenience wrapper over 'field = *'

  Parameter jsonField

  Field inside JSON. Example: "$.myField"

method isNull

static isNull: (jsonField: string) => JsonPattern;

• A JSON log pattern that matches if the field exists and has the special value 'null'.

  Parameter jsonField

  Field inside JSON. Example: "$.myField"

method literal

static literal: (logPatternString: string) => IFilterPattern;

• Use the given string as log pattern.

  See https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html for information on writing log patterns.

  Parameter logPatternString

  The pattern string to use.

method notExists

static notExists: (jsonField: string) => JsonPattern;

• A JSON log pattern that matches if the field does not exist.

  Parameter jsonField

  Field inside JSON. Example: "$.myField"

method numberValue

static numberValue: (
    jsonField: string,
    comparison: string,
    value: number
) => JsonPattern;

• A JSON log pattern that compares numerical values.

  This pattern only matches if the event is a JSON event, and the indicated field inside compares with the value in the indicated way.

  Use '$' to indicate the root of the JSON structure. The comparison operator can only compare equality or inequality. The '*' wildcard may appear in the value may at the start or at the end.

  For more information, see:

  https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html

  Parameter jsonField

  Field inside JSON. Example: "$.myField"

  Parameter comparison

  Comparison to carry out. One of =, !=, <, <=, >, >=.

  Parameter value

  The numerical value to compare to

method spaceDelimited

static spaceDelimited: (...columns: string[]) => SpaceDelimitedTextPattern;

• A space delimited log pattern matcher.

  The log event is divided into space-delimited columns (optionally enclosed by "" or [] to capture spaces into column values), and names are given to each column.

  '...' may be specified once to match any number of columns.

  Afterwards, conditions may be added to individual columns.

  Parameter columns

  The columns in the space-delimited log stream.

method stringValue

static stringValue: (
    jsonField: string,
    comparison: string,
    value: string
) => JsonPattern;

• A JSON log pattern that compares string values.

  This pattern only matches if the event is a JSON event, and the indicated field inside compares with the string value.

  Use '$' to indicate the root of the JSON structure. The comparison operator can only compare equality or inequality. The '*' wildcard may appear in the value may at the start or at the end.

  For more information, see:

  https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html

  Parameter jsonField

  Field inside JSON. Example: "$.myField"

  Parameter comparison

  Comparison to carry out. Either = or !=.

  Parameter value

  The string value to compare to. May use '*' as wildcard at start or end of string.

constructor

constructor(jsonPatternString: string);

property jsonPatternString

readonly jsonPatternString: string;

property logPatternString

readonly logPatternString: string;

constructor

constructor(scope: Construct, id: string, props?: LogGroupProps);

property logGroupArn

readonly logGroupArn: string;

• The ARN of this log group

property logGroupName

readonly logGroupName: string;

• The name of this log group

method fromLogGroupArn

static fromLogGroupArn: (
    scope: Construct,
    id: string,
    logGroupArn: string
) => ILogGroup;

• Import an existing LogGroup given its ARN

method fromLogGroupName

static fromLogGroupName: (
    scope: Construct,
    id: string,
    logGroupName: string
) => ILogGroup;

• Import an existing LogGroup given its name

constructor

constructor(scope: Construct, id: string, props: LogRetentionProps);

property logGroupArn

readonly logGroupArn: string;

• The ARN of the LogGroup.

constructor

constructor(scope: Construct, id: string, props: LogStreamProps);

property logStreamName

readonly logStreamName: string;

• The name of this log stream

method fromLogStreamName

static fromLogStreamName: (
    scope: Construct,
    id: string,
    logStreamName: string
) => ILogStream;

• Import an existing LogGroup

constructor

constructor(scope: Construct, id: string, props: MetricFilterProps);

method metric

metric: (props?: MetricOptions) => Metric;

• Return the given named metric for this Metric Filter

  avg over 5 minutes

constructor

constructor(scope: Construct, id: string, props: QueryDefinitionProps);

property queryDefinitionId

readonly queryDefinitionId: string;

• The ID of the query definition.

constructor

constructor(props?: QueryStringProps);

method toString

toString: () => string;

• String representation of this QueryString.

constructor

constructor(scope: Construct, id: string, props?: ResourcePolicyProps);

property document

readonly document: PolicyDocument;

• The IAM policy document for this resource policy.

constructor

protected constructor(columns: string[], restrictions: RestrictionMap);

property logPatternString

readonly logPatternString: string;

method construct

static construct: (columns: string[]) => SpaceDelimitedTextPattern;

• Construct a new instance of a space delimited text pattern

  Since this class must be public, we can't rely on the user only creating it through the LogPattern.spaceDelimited() factory function. We must therefore validate the argument in the constructor. Since we're returning a copy on every mutation, and we don't want to re-validate the same things on every construction, we provide a limited set of mutator functions and only validate the new data every time.

method whereNumber

whereNumber: (
    columnName: string,
    comparison: string,
    value: number
) => SpaceDelimitedTextPattern;

• Restrict where the pattern applies

method whereString

whereString: (
    columnName: string,
    comparison: string,
    value: string
) => SpaceDelimitedTextPattern;

• Restrict where the pattern applies

constructor

constructor(scope: Construct, id: string, props: SubscriptionFilterProps);

property destinationName

readonly destinationName: string;

• The name of the destination.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-destination.html#cfn-logs-destination-destinationname

property destinationPolicy

readonly destinationPolicy?: string;

• An IAM policy document that governs which AWS accounts can create subscription filters against this destination.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-destination.html#cfn-logs-destination-destinationpolicy

property roleArn

readonly roleArn: string;

• The ARN of an IAM role that permits CloudWatch Logs to send data to the specified AWS resource.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-destination.html#cfn-logs-destination-rolearn

property targetArn

readonly targetArn: string;

• The Amazon Resource Name (ARN) of the physical target where the log events are delivered (for example, a Kinesis stream).

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-destination.html#cfn-logs-destination-targetarn

property dataProtectionPolicy

readonly dataProtectionPolicy?: any | cdk.IResolvable;

• Creates a data protection policy and assigns it to the log group. A data protection policy can help safeguard sensitive data that's ingested by the log group by auditing and masking the sensitive log data. When a user who does not have permission to view masked data views a log event that includes masked data, the sensitive data is replaced by asterisks.

  For more information, including a list of types of data that can be audited and masked, see [Protect sensitive log data with masking](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/mask-sensitive-log-data.html) .

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loggroup.html#cfn-logs-loggroup-dataprotectionpolicy

property kmsKeyId

readonly kmsKeyId?: string;

• The Amazon Resource Name (ARN) of the AWS KMS key to use when encrypting log data.

  To associate an AWS KMS key with the log group, specify the ARN of that KMS key here. If you do so, ingested data is encrypted using this key. This association is stored as long as the data encrypted with the KMS key is still within CloudWatch Logs . This enables CloudWatch Logs to decrypt this data whenever it is requested.

  If you attempt to associate a KMS key with the log group but the KMS key doesn't exist or is deactivated, you will receive an InvalidParameterException error.

  Log group data is always encrypted in CloudWatch Logs . If you omit this key, the encryption does not use AWS KMS . For more information, see [Encrypt log data in CloudWatch Logs using AWS Key Management Service](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/encrypt-log-data-kms.html)

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loggroup.html#cfn-logs-loggroup-kmskeyid

property logGroupName

readonly logGroupName?: string;

• The name of the log group. If you don't specify a name, AWS CloudFormation generates a unique ID for the log group.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loggroup.html#cfn-logs-loggroup-loggroupname

property retentionInDays

readonly retentionInDays?: number;

• The number of days to retain the log events in the specified log group. Possible values are: 1, 3, 5, 7, 14, 30, 60, 90, 120, 150, 180, 365, 400, 545, 731, 1096, 1827, 2192, 2557, 2922, 3288, and 3653.

  To set a log group so that its log events do not expire, use [DeleteRetentionPolicy](https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DeleteRetentionPolicy.html) .

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loggroup.html#cfn-logs-loggroup-retentionindays

property tags

readonly tags?: cdk.CfnTag[];

• An array of key-value pairs to apply to the log group.

  For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loggroup.html#cfn-logs-loggroup-tags

property logGroupName

readonly logGroupName: string;

• The name of the log group where the log stream is created.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-logstream.html#cfn-logs-logstream-loggroupname

property logStreamName

readonly logStreamName?: string;

• The name of the log stream. The name must be unique within the log group.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-logstream.html#cfn-logs-logstream-logstreamname

property filterName

readonly filterName?: string;

• The name of the metric filter.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-metricfilter.html#cfn-logs-metricfilter-filtername

property filterPattern

readonly filterPattern: string;

• A filter pattern for extracting metric data out of ingested log events. For more information, see [Filter and Pattern Syntax](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html) .

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-metricfilter.html#cfn-logs-metricfilter-filterpattern

property logGroupName

readonly logGroupName: string;

• The name of an existing log group that you want to associate with this metric filter.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-metricfilter.html#cfn-logs-metricfilter-loggroupname

property metricTransformations

readonly metricTransformations:
    | Array<CfnMetricFilter.MetricTransformationProperty | cdk.IResolvable>
    | cdk.IResolvable;

• The metric transformations.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-metricfilter.html#cfn-logs-metricfilter-metrictransformations

property logGroupNames

readonly logGroupNames?: string[];

• Use this parameter if you want the query to query only certain log groups.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-querydefinition.html#cfn-logs-querydefinition-loggroupnames

property name

readonly name: string;

• A name for the query definition.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-querydefinition.html#cfn-logs-querydefinition-name

property queryString

readonly queryString: string;

• The query string to use for this query definition. For more information, see [CloudWatch Logs Insights Query Syntax](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CWL_QuerySyntax.html) .

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-querydefinition.html#cfn-logs-querydefinition-querystring

property policyDocument

readonly policyDocument: string;

• The details of the policy. It must be formatted in JSON, and you must use backslashes to escape characters that need to be escaped in JSON strings, such as double quote marks.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-resourcepolicy.html#cfn-logs-resourcepolicy-policydocument

property policyName

readonly policyName: string;

• The name of the resource policy.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-resourcepolicy.html#cfn-logs-resourcepolicy-policyname

property destinationArn

readonly destinationArn: string;

• The Amazon Resource Name (ARN) of the destination.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-subscriptionfilter.html#cfn-logs-subscriptionfilter-destinationarn

property distribution

readonly distribution?: string;

• The method used to distribute log data to the destination, which can be either random or grouped by log stream.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-subscriptionfilter.html#cfn-logs-subscriptionfilter-distribution

property filterName

readonly filterName?: string;

• The name of the subscription filter.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-subscriptionfilter.html#cfn-logs-subscriptionfilter-filtername

property filterPattern

readonly filterPattern: string;

• 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](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html) .

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-subscriptionfilter.html#cfn-logs-subscriptionfilter-filterpattern

property logGroupName

readonly logGroupName: string;

• 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.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-subscriptionfilter.html#cfn-logs-subscriptionfilter-loggroupname

property roleArn

readonly roleArn?: string;

• 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.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-subscriptionfilter.html#cfn-logs-subscriptionfilter-rolearn

property comparison

readonly comparison: string;

• Comparison operator to use

property numberValue

readonly numberValue?: number;

• Number value to compare to

  Exactly one of 'stringValue' and 'numberValue' must be set.

property stringValue

readonly stringValue?: string;

• String value to compare to

  Exactly one of 'stringValue' and 'numberValue' must be set.

property destinationName

readonly destinationName?: string;

• The name of the log destination.

  Automatically generated

property role

readonly role: iam.IRole;

• The role to assume that grants permissions to write to 'target'.

  The role must be assumable by 'logs.{REGION}.amazonaws.com'.

property targetArn

readonly targetArn: string;

• The log destination target's ARN

property logPatternString

readonly logPatternString: string;

property logGroupArn

readonly logGroupArn: string;

• The ARN of this log group, with ':*' appended

property logGroupName

readonly logGroupName: string;

• The name of this log group

method addMetricFilter

addMetricFilter: (id: string, props: MetricFilterOptions) => MetricFilter;

• Create a new Metric Filter on this Log Group

  Parameter id

  Unique identifier for the construct in its parent

  Parameter props

  Properties for creating the MetricFilter

method addStream

addStream: (id: string, props?: StreamOptions) => LogStream;

• Create a new Log Stream for this Log Group

  Parameter id

  Unique identifier for the construct in its parent

  Parameter props

  Properties for creating the LogStream

method addSubscriptionFilter

addSubscriptionFilter: (
    id: string,
    props: SubscriptionFilterOptions
) => SubscriptionFilter;

• Create a new Subscription Filter on this Log Group

  Parameter id

  Unique identifier for the construct in its parent

  Parameter props

  Properties for creating the SubscriptionFilter

method extractMetric

extractMetric: (
    jsonField: string,
    metricNamespace: string,
    metricName: string
) => cloudwatch.Metric;

• Extract a metric from structured log events in the LogGroup

  Creates a MetricFilter on this LogGroup that will extract the value of the indicated JSON field in all records where it occurs.

  The metric will be available in CloudWatch Metrics under the indicated namespace and name.

  Parameter jsonField

  JSON field to extract (example: '$.myfield')

  Parameter metricNamespace

  Namespace to emit the metric under

  Parameter metricName

  Name to emit the metric under

  Returns

  A Metric object representing the extracted metric

method grant

grant: (grantee: iam.IGrantable, ...actions: string[]) => iam.Grant;

• Give the indicated permissions on this log group and all streams

method grantWrite

grantWrite: (grantee: iam.IGrantable) => iam.Grant;

• Give permissions to write to create and write to streams in this log group

method logGroupPhysicalName

logGroupPhysicalName: () => string;

• Public method to get the physical name of this log group

property logStreamName

readonly logStreamName: string;

• The name of this log stream

method bind

bind: (
    scope: CoreConstruct,
    sourceLogGroup: ILogGroup
) => LogSubscriptionDestinationConfig;

• 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.

property encryptionKey

readonly encryptionKey?: kms.IKey;

• The KMS Key to encrypt the log group with.

  - log group is encrypted with the default master key

property logGroupName

readonly logGroupName?: string;

• Name of the log group.

  Automatically generated

property removalPolicy

readonly removalPolicy?: RemovalPolicy;

• Determine the removal policy of this log group.

  Normally you want to retain the log group so you can diagnose issues from logs even after a deployment that no longer includes the log group. In that case, use the normal date-based retention policy to age out your logs.

  RemovalPolicy.Retain

property retention

readonly retention?: RetentionDays;

• How long, in days, the log contents will be retained.

  To retain all logs, set this value to RetentionDays.INFINITE.

  RetentionDays.TWO_YEARS

property logGroupName

readonly logGroupName: string;

• The log group name.

property logGroupRegion

readonly logGroupRegion?: string;

• The region where the log group should be created - same region as the stack

property logRetentionRetryOptions

readonly logRetentionRetryOptions?: LogRetentionRetryOptions;

• Retry options for all AWS API calls.

  - AWS SDK default retry options

property retention

readonly retention: RetentionDays;

• The number of days log events are kept in CloudWatch Logs.

property role

readonly role?: iam.IRole;

• The IAM role for the Lambda function associated with the custom resource.

  - A new role is created

property base

readonly base?: cdk.Duration;

• The base duration to use in the exponential backoff for operation retries.

  Duration.millis(100) (AWS SDK default)

property maxRetries

readonly maxRetries?: number;

• The maximum amount of retries.

  3 (AWS SDK default)

property logGroup

readonly logGroup: ILogGroup;

• The log group to create a log stream for.

property logStreamName

readonly logStreamName?: string;

• The name of the log stream to create.

  The name must be unique within the log group.

  Automatically generated

property removalPolicy

readonly removalPolicy?: RemovalPolicy;

• Determine what happens when the log stream resource is removed from the app.

  Normally you want to retain the log stream so you can diagnose issues from logs even after a deployment that no longer includes the log stream.

  The date-based retention policy of your log group will age out the logs after a certain time.

  RemovalPolicy.Retain

property arn

readonly arn: string;

• The ARN of the subscription's destination

property role

readonly role?: iam.IRole;

• The role to assume to write log events to the destination

  No role assumed

property defaultValue

readonly defaultValue?: number;

• The value to emit if the pattern does not match a particular event.

  No metric emitted.

property filterPattern

readonly filterPattern: IFilterPattern;

• Pattern to search for log events.

property metricName

readonly metricName: string;

• The name of the metric to emit.

property metricNamespace

readonly metricNamespace: string;

• The namespace of the metric to emit.

property metricValue

readonly metricValue?: string;

• The value to emit for the metric.

  Can either be a literal number (typically "1"), or the name of a field in the structure to take the value from the matched event. If you are using a field value, the field value must have been matched using the pattern.

  If you want to specify a field from a matched JSON structure, use '$.fieldName', and make sure the field is in the pattern (if only as '$.fieldName = *').

  If you want to specify a field from a matched space-delimited structure, use '$fieldName'.

  "1"

property logGroup

readonly logGroup: ILogGroup;

• The log group to create the filter on.

property logGroups

readonly logGroups?: ILogGroup[];

• Specify certain log groups for the query definition.

  - no specified log groups

property queryDefinitionName

readonly queryDefinitionName: string;

• Name of the query definition.

property queryString

readonly queryString: QueryString;

• The query string to use for this query definition.

property display

readonly display?: string;

• Specifies which fields to display in the query results.

  - no display in QueryString

property fields

readonly fields?: string[];

• Retrieves the specified fields from log events for display.

  - no fields in QueryString

property filter

readonly filter?: string;

• Filters the results of a query that's based on one or more conditions.

  - no filter in QueryString

property limit

readonly limit?: Number;

• Specifies the number of log events returned by the query.

  - no limit in QueryString

property parse

readonly parse?: string;

• Extracts data from a log field and creates one or more ephemeral fields that you can process further in the query.

  - no parse in QueryString

property sort

readonly sort?: string;

• Sorts the retrieved log events.

  - no sort in QueryString

property stats

readonly stats?: string;

• Uses log field values to calculate aggregate statistics.

  - no stats in QueryString

property policyStatements

readonly policyStatements?: PolicyStatement[];

• Initial statements to add to the resource policy

  - No statements

property resourcePolicyName

readonly resourcePolicyName?: string;

• Name of the log group resource policy - Uses a unique id based on the construct path

property logStreamName

readonly logStreamName?: string;

• The name of the log stream to create.

  The name must be unique within the log group.

  Automatically generated

property destination

readonly destination: ILogSubscriptionDestination;

• The destination to send the filtered events to.

  For example, a Kinesis stream or a Lambda function.

property filterPattern

readonly filterPattern: IFilterPattern;

• Log events matching this pattern will be sent to the destination.

property logGroup

readonly logGroup: ILogGroup;

• The log group to create the subscription on.