Package software.amazon.awscdk.services.logs

Interface CfnScheduledQueryProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnScheduledQueryProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-02T12:05:12.010Z")
@Stability(Stable)
public interface CfnScheduledQueryProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnScheduledQuery.

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.*;
 CfnScheduledQueryProps cfnScheduledQueryProps = CfnScheduledQueryProps.builder()
         .executionRoleArn("executionRoleArn")
         .name("name")
         .queryLanguage("queryLanguage")
         .queryString("queryString")
         .scheduleExpression("scheduleExpression")
         // the properties below are optional
         .description("description")
         .destinationConfiguration(DestinationConfigurationProperty.builder()
                 .s3Configuration(S3ConfigurationProperty.builder()
                         .destinationIdentifier("destinationIdentifier")
                         .roleArn("roleArn")
                         .build())
                 .build())
         .logGroupIdentifiers(List.of("logGroupIdentifiers"))
         .scheduleEndTime(123)
         .scheduleStartTime(123)
         .startTimeOffset(123)
         .state("state")
         .tags(List.of(TagsItemsProperty.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .timezone("timezone")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-scheduledquery.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnScheduledQueryProps.Builder	builder()
default String	getDescription()
default Object	getDestinationConfiguration()	Returns union: either IResolvable or CfnScheduledQuery.DestinationConfigurationProperty
String	getExecutionRoleArn()
default List<String>	getLogGroupIdentifiers()
String	getName()
String	getQueryLanguage()
String	getQueryString()
default Number	getScheduleEndTime()
String	getScheduleExpression()
default Number	getScheduleStartTime()
default Number	getStartTimeOffset()
default String	getState()
default List<CfnScheduledQuery.TagsItemsProperty>	getTags()
default String	getTimezone()

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getExecutionRoleArn

@Stability(Stable)
@NotNull
String getExecutionRoleArn()

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-scheduledquery.html#cfn-logs-scheduledquery-executionrolearn

getName

@Stability(Stable)
@NotNull
String getName()

See Also:

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

getQueryLanguage

@Stability(Stable)
@NotNull
String getQueryLanguage()

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-scheduledquery.html#cfn-logs-scheduledquery-querylanguage

getQueryString

@Stability(Stable)
@NotNull
String getQueryString()

See Also:

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

getScheduleExpression

@Stability(Stable)
@NotNull
String getScheduleExpression()

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-scheduledquery.html#cfn-logs-scheduledquery-scheduleexpression

getDescription

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-scheduledquery.html#cfn-logs-scheduledquery-description

getDestinationConfiguration

@Stability(Stable)
@Nullable
default Object getDestinationConfiguration()

Returns union: either IResolvable or CfnScheduledQuery.DestinationConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-scheduledquery.html#cfn-logs-scheduledquery-destinationconfiguration

getLogGroupIdentifiers

@Stability(Stable)
@Nullable
default List<String> getLogGroupIdentifiers()

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-scheduledquery.html#cfn-logs-scheduledquery-loggroupidentifiers

getScheduleEndTime

@Stability(Stable)
@Nullable
default Number getScheduleEndTime()

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-scheduledquery.html#cfn-logs-scheduledquery-scheduleendtime

getScheduleStartTime

@Stability(Stable)
@Nullable
default Number getScheduleStartTime()

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-scheduledquery.html#cfn-logs-scheduledquery-schedulestarttime

getStartTimeOffset

@Stability(Stable)
@Nullable
default Number getStartTimeOffset()

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-scheduledquery.html#cfn-logs-scheduledquery-starttimeoffset

getState

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-scheduledquery.html#cfn-logs-scheduledquery-state

getTags

@Stability(Stable)
@Nullable
default List<CfnScheduledQuery.TagsItemsProperty> getTags()

See Also:

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

getTimezone

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-scheduledquery.html#cfn-logs-scheduledquery-timezone

builder

@Stability(Stable)
static CfnScheduledQueryProps.Builder builder()

Returns:

a CfnScheduledQueryProps.Builder of CfnScheduledQueryProps