CfnScheduledQueryPropsMixin

class aws_cdk.mixins_preview.aws_logs.mixins.CfnScheduledQueryPropsMixin(props, *, strategy=None)

Bases: Mixin

Creates a new Scheduled Query that allows you to define a Logs Insights query that will run on a schedule and configure actions to take with the query results.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-scheduledquery.html
CloudformationResource:: AWS::Logs::ScheduledQuery
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_logs import mixins as logs_mixins

cfn_scheduled_query_props_mixin = logs_mixins.CfnScheduledQueryPropsMixin(logs_mixins.CfnScheduledQueryMixinProps(
    description="description",
    destination_configuration=logs_mixins.CfnScheduledQueryPropsMixin.DestinationConfigurationProperty(
        s3_configuration=logs_mixins.CfnScheduledQueryPropsMixin.S3ConfigurationProperty(
            destination_identifier="destinationIdentifier",
            role_arn="roleArn"
        )
    ),
    execution_role_arn="executionRoleArn",
    log_group_identifiers=["logGroupIdentifiers"],
    name="name",
    query_language="queryLanguage",
    query_string="queryString",
    schedule_end_time=123,
    schedule_expression="scheduleExpression",
    schedule_start_time=123,
    start_time_offset=123,
    state="state",
    tags=[logs_mixins.CfnScheduledQueryPropsMixin.TagsItemsProperty(
        key="key",
        value="value"
    )],
    timezone="timezone"
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::Logs::ScheduledQuery.

Parameters:

props (Union[CfnScheduledQueryMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: None

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['description', 'destinationConfiguration', 'executionRoleArn', 'logGroupIdentifiers', 'name', 'queryLanguage', 'queryString', 'scheduleEndTime', 'scheduleExpression', 'scheduleStartTime', 'startTimeOffset', 'state', 'tags', 'timezone']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

DestinationConfigurationProperty

class CfnScheduledQueryPropsMixin.DestinationConfigurationProperty(*, s3_configuration=None)

Bases: object

Parameters:: s3_configuration (Union[IResolvable, S3ConfigurationProperty, Dict[str, Any], None])
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-logs-scheduledquery-destinationconfiguration.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_logs import mixins as logs_mixins

destination_configuration_property = logs_mixins.CfnScheduledQueryPropsMixin.DestinationConfigurationProperty(
    s3_configuration=logs_mixins.CfnScheduledQueryPropsMixin.S3ConfigurationProperty(
        destination_identifier="destinationIdentifier",
        role_arn="roleArn"
    )
)

Attributes

s3_configuration

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

Type:: see

S3ConfigurationProperty

class CfnScheduledQueryPropsMixin.S3ConfigurationProperty(*, destination_identifier=None, role_arn=None)

Bases: object

Parameters:

destination_identifier (Optional[str])
role_arn (Optional[str])

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-logs-scheduledquery-s3configuration.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_logs import mixins as logs_mixins

s3_configuration_property = logs_mixins.CfnScheduledQueryPropsMixin.S3ConfigurationProperty(
    destination_identifier="destinationIdentifier",
    role_arn="roleArn"
)

Attributes

destination_identifier

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-logs-scheduledquery-s3configuration.html#cfn-logs-scheduledquery-s3configuration-destinationidentifier

Type:: see

role_arn

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-logs-scheduledquery-s3configuration.html#cfn-logs-scheduledquery-s3configuration-rolearn

Type:: see

TagsItemsProperty

class CfnScheduledQueryPropsMixin.TagsItemsProperty(*, key=None, value=None)

Bases: object

Parameters:

key (Optional[str])
value (Optional[str])

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-logs-scheduledquery-tagsitems.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_logs import mixins as logs_mixins

tags_items_property = logs_mixins.CfnScheduledQueryPropsMixin.TagsItemsProperty(
    key="key",
    value="value"
)

Attributes

key

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-logs-scheduledquery-tagsitems.html#cfn-logs-scheduledquery-tagsitems-key

Type:: see

value

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-logs-scheduledquery-tagsitems.html#cfn-logs-scheduledquery-tagsitems-value

Type:: see