Package software.amazon.awscdk.services.kinesis

Interface CfnChannel.CloudWatchLogsConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnChannel.CloudWatchLogsConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnChannel

@Stability(Stable)
public static interface CfnChannel.CloudWatchLogsConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

CloudWatch Logs configuration for the channel.

When Enabled is true and LogGroupName is omitted, the service uses a default group derived from the channel name and id; LogStreamName defaults to the literal string 'DestinationDelivery'.

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.kinesis.*;
 CloudWatchLogsConfigurationProperty cloudWatchLogsConfigurationProperty = CloudWatchLogsConfigurationProperty.builder()
         .enabled(false)
         // the properties below are optional
         .logGroupName("logGroupName")
         .logStreamName("logStreamName")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesis-channel-cloudwatchlogsconfiguration.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnChannel.CloudWatchLogsConfigurationProperty.Builder	A builder for CfnChannel.CloudWatchLogsConfigurationProperty
static final class	CfnChannel.CloudWatchLogsConfigurationProperty.Jsii$Proxy	An implementation for CfnChannel.CloudWatchLogsConfigurationProperty

Method Summary

Modifier and Type	Method	Description
static CfnChannel.CloudWatchLogsConfigurationProperty.Builder	builder()
Object	getEnabled()	Whether CloudWatch Logs delivery is enabled.
default String	getLogGroupName()	The CloudWatch log group name.
default String	getLogStreamName()	The CloudWatch log stream name.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getEnabled

@Stability(Stable)
@NotNull
Object getEnabled()

Whether CloudWatch Logs delivery is enabled.

Returns union: either Boolean or IResolvable

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesis-channel-cloudwatchlogsconfiguration.html#cfn-kinesis-channel-cloudwatchlogsconfiguration-enabled

getLogGroupName

@Stability(Stable)
@Nullable
default String getLogGroupName()

The CloudWatch log group name.

When Enabled is true and LogGroupName is omitted, the service uses the default '/aws/kinesis//'.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesis-channel-cloudwatchlogsconfiguration.html#cfn-kinesis-channel-cloudwatchlogsconfiguration-loggroupname

getLogStreamName

@Stability(Stable)
@Nullable
default String getLogStreamName()

The CloudWatch log stream name.

Defaults to the literal string 'DestinationDelivery' when omitted.

Default: - "DestinationDelivery"

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesis-channel-cloudwatchlogsconfiguration.html#cfn-kinesis-channel-cloudwatchlogsconfiguration-logstreamname

builder

@Stability(Stable)
static CfnChannel.CloudWatchLogsConfigurationProperty.Builder builder()

Returns:

a CfnChannel.CloudWatchLogsConfigurationProperty.Builder of CfnChannel.CloudWatchLogsConfigurationProperty