CfnTelemetryRulePropsMixin

class aws_cdk.mixins_preview.aws_observabilityadmin.mixins.CfnTelemetryRulePropsMixin(props, *, strategy=None)

Bases: Mixin

Creates a telemetry rule that defines how telemetry should be configured for AWS resources in your account.

The rule specifies which resources should have telemetry enabled and how that telemetry data should be collected based on resource type, telemetry type, and selection criteria.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-observabilityadmin-telemetryrule.html

CloudformationResource:

AWS::ObservabilityAdmin::TelemetryRule

Mixin:

true

ExampleMetadata:

fixture=_generated

Example:

from aws_cdk import CfnTag
# 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_observabilityadmin import mixins as observabilityadmin_mixins

cfn_telemetry_rule_props_mixin = observabilityadmin_mixins.CfnTelemetryRulePropsMixin(observabilityadmin_mixins.CfnTelemetryRuleMixinProps(
    rule=observabilityadmin_mixins.CfnTelemetryRulePropsMixin.TelemetryRuleProperty(
        destination_configuration=observabilityadmin_mixins.CfnTelemetryRulePropsMixin.TelemetryDestinationConfigurationProperty(
            cloudtrail_parameters=observabilityadmin_mixins.CfnTelemetryRulePropsMixin.CloudtrailParametersProperty(
                advanced_event_selectors=[observabilityadmin_mixins.CfnTelemetryRulePropsMixin.AdvancedEventSelectorProperty(
                    field_selectors=[observabilityadmin_mixins.CfnTelemetryRulePropsMixin.AdvancedFieldSelectorProperty(
                        ends_with=["endsWith"],
                        equal_to=["equalTo"],
                        field="field",
                        not_ends_with=["notEndsWith"],
                        not_equals=["notEquals"],
                        not_starts_with=["notStartsWith"],
                        starts_with=["startsWith"]
                    )],
                    name="name"
                )]
            ),
            destination_pattern="destinationPattern",
            destination_type="destinationType",
            elb_load_balancer_logging_parameters=observabilityadmin_mixins.CfnTelemetryRulePropsMixin.ELBLoadBalancerLoggingParametersProperty(
                field_delimiter="fieldDelimiter",
                output_format="outputFormat"
            ),
            log_delivery_parameters=observabilityadmin_mixins.CfnTelemetryRulePropsMixin.LogDeliveryParametersProperty(
                log_types=["logTypes"]
            ),
            retention_in_days=123,
            vpc_flow_log_parameters=observabilityadmin_mixins.CfnTelemetryRulePropsMixin.VPCFlowLogParametersProperty(
                log_format="logFormat",
                max_aggregation_interval=123,
                traffic_type="trafficType"
            ),
            waf_logging_parameters=observabilityadmin_mixins.CfnTelemetryRulePropsMixin.WAFLoggingParametersProperty(
                logging_filter=observabilityadmin_mixins.CfnTelemetryRulePropsMixin.LoggingFilterProperty(
                    default_behavior="defaultBehavior",
                    filters=[observabilityadmin_mixins.CfnTelemetryRulePropsMixin.FilterProperty(
                        behavior="behavior",
                        conditions=[observabilityadmin_mixins.CfnTelemetryRulePropsMixin.ConditionProperty(
                            action_condition=observabilityadmin_mixins.CfnTelemetryRulePropsMixin.ActionConditionProperty(
                                action="action"
                            ),
                            label_name_condition=observabilityadmin_mixins.CfnTelemetryRulePropsMixin.LabelNameConditionProperty(
                                label_name="labelName"
                            )
                        )],
                        requirement="requirement"
                    )]
                ),
                log_type="logType",
                redacted_fields=[observabilityadmin_mixins.CfnTelemetryRulePropsMixin.FieldToMatchProperty(
                    method="method",
                    query_string="queryString",
                    single_header=observabilityadmin_mixins.CfnTelemetryRulePropsMixin.SingleHeaderProperty(
                        name="name"
                    ),
                    uri_path="uriPath"
                )]
            )
        ),
        resource_type="resourceType",
        selection_criteria="selectionCriteria",
        telemetry_source_types=["telemetrySourceTypes"],
        telemetry_type="telemetryType"
    ),
    rule_name="ruleName",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::ObservabilityAdmin::TelemetryRule.

Parameters:

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:

construct (IConstruct)

Return type:

IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:

construct (IConstruct)

Return type:

bool

Attributes

CFN_PROPERTY_KEYS = ['rule', 'ruleName', 'tags']

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

ActionConditionProperty

class CfnTelemetryRulePropsMixin.ActionConditionProperty(*, action=None)

Bases: object

Condition that matches based on the specific WAF action taken on the request.

Parameters:

action (Optional[str]) – The WAF action to match against (ALLOW, BLOCK, COUNT, CAPTCHA, CHALLENGE, EXCLUDED_AS_COUNT).

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-actioncondition.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_observabilityadmin import mixins as observabilityadmin_mixins

action_condition_property = observabilityadmin_mixins.CfnTelemetryRulePropsMixin.ActionConditionProperty(
    action="action"
)

Attributes

action

The WAF action to match against (ALLOW, BLOCK, COUNT, CAPTCHA, CHALLENGE, EXCLUDED_AS_COUNT).

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-actioncondition.html#cfn-observabilityadmin-telemetryrule-actioncondition-action

AdvancedEventSelectorProperty

class CfnTelemetryRulePropsMixin.AdvancedEventSelectorProperty(*, field_selectors=None, name=None)

Bases: object

Advanced event selectors let you create fine-grained selectors for management, data, and network activity events.

Parameters:

  • field_selectors (Union[IResolvable, Sequence[Union[IResolvable, AdvancedFieldSelectorProperty, Dict[str, Any]]], None]) – Contains all selector statements in an advanced event selector.

  • name (Optional[str]) – An optional, descriptive name for an advanced event selector, such as “Log data events for only two S3 buckets”.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-advancedeventselector.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_observabilityadmin import mixins as observabilityadmin_mixins

advanced_event_selector_property = observabilityadmin_mixins.CfnTelemetryRulePropsMixin.AdvancedEventSelectorProperty(
    field_selectors=[observabilityadmin_mixins.CfnTelemetryRulePropsMixin.AdvancedFieldSelectorProperty(
        ends_with=["endsWith"],
        equal_to=["equalTo"],
        field="field",
        not_ends_with=["notEndsWith"],
        not_equals=["notEquals"],
        not_starts_with=["notStartsWith"],
        starts_with=["startsWith"]
    )],
    name="name"
)

Attributes

field_selectors

Contains all selector statements in an advanced event selector.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-advancedeventselector.html#cfn-observabilityadmin-telemetryrule-advancedeventselector-fieldselectors

name

An optional, descriptive name for an advanced event selector, such as “Log data events for only two S3 buckets”.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-advancedeventselector.html#cfn-observabilityadmin-telemetryrule-advancedeventselector-name

AdvancedFieldSelectorProperty

class CfnTelemetryRulePropsMixin.AdvancedFieldSelectorProperty(*, ends_with=None, equal_to=None, field=None, not_ends_with=None, not_equals=None, not_starts_with=None, starts_with=None)

Bases: object

Defines criteria for selecting resources based on field values.

Parameters:

  • ends_with (Optional[Sequence[str]]) – Matches if the field value ends with the specified value.

  • equal_to (Optional[Sequence[str]]) – Matches if the field value equals the specified value.

  • field (Optional[str]) – The name of the field to use for selection.

  • not_ends_with (Optional[Sequence[str]]) – Matches if the field value does not end with the specified value.

  • not_equals (Optional[Sequence[str]]) – Matches if the field value does not equal the specified value.

  • not_starts_with (Optional[Sequence[str]]) – Matches if the field value does not start with the specified value.

  • starts_with (Optional[Sequence[str]]) – Matches if the field value starts with the specified value.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-advancedfieldselector.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_observabilityadmin import mixins as observabilityadmin_mixins

advanced_field_selector_property = observabilityadmin_mixins.CfnTelemetryRulePropsMixin.AdvancedFieldSelectorProperty(
    ends_with=["endsWith"],
    equal_to=["equalTo"],
    field="field",
    not_ends_with=["notEndsWith"],
    not_equals=["notEquals"],
    not_starts_with=["notStartsWith"],
    starts_with=["startsWith"]
)

Attributes

ends_with

Matches if the field value ends with the specified value.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-advancedfieldselector.html#cfn-observabilityadmin-telemetryrule-advancedfieldselector-endswith

equal_to

Matches if the field value equals the specified value.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-advancedfieldselector.html#cfn-observabilityadmin-telemetryrule-advancedfieldselector-equals

field

The name of the field to use for selection.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-advancedfieldselector.html#cfn-observabilityadmin-telemetryrule-advancedfieldselector-field

not_ends_with

Matches if the field value does not end with the specified value.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-advancedfieldselector.html#cfn-observabilityadmin-telemetryrule-advancedfieldselector-notendswith

not_equals

Matches if the field value does not equal the specified value.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-advancedfieldselector.html#cfn-observabilityadmin-telemetryrule-advancedfieldselector-notequals

not_starts_with

Matches if the field value does not start with the specified value.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-advancedfieldselector.html#cfn-observabilityadmin-telemetryrule-advancedfieldselector-notstartswith

starts_with

Matches if the field value starts with the specified value.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-advancedfieldselector.html#cfn-observabilityadmin-telemetryrule-advancedfieldselector-startswith

CloudtrailParametersProperty

class CfnTelemetryRulePropsMixin.CloudtrailParametersProperty(*, advanced_event_selectors=None)

Bases: object

Parameters specific to AWS CloudTrail telemetry configuration.

Parameters:

advanced_event_selectors (Union[IResolvable, Sequence[Union[IResolvable, AdvancedEventSelectorProperty, Dict[str, Any]]], None]) – The advanced event selectors to use for filtering AWS CloudTrail events.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-cloudtrailparameters.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_observabilityadmin import mixins as observabilityadmin_mixins

cloudtrail_parameters_property = observabilityadmin_mixins.CfnTelemetryRulePropsMixin.CloudtrailParametersProperty(
    advanced_event_selectors=[observabilityadmin_mixins.CfnTelemetryRulePropsMixin.AdvancedEventSelectorProperty(
        field_selectors=[observabilityadmin_mixins.CfnTelemetryRulePropsMixin.AdvancedFieldSelectorProperty(
            ends_with=["endsWith"],
            equal_to=["equalTo"],
            field="field",
            not_ends_with=["notEndsWith"],
            not_equals=["notEquals"],
            not_starts_with=["notStartsWith"],
            starts_with=["startsWith"]
        )],
        name="name"
    )]
)

Attributes

advanced_event_selectors

The advanced event selectors to use for filtering AWS CloudTrail events.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-cloudtrailparameters.html#cfn-observabilityadmin-telemetryrule-cloudtrailparameters-advancedeventselectors

ConditionProperty

class CfnTelemetryRulePropsMixin.ConditionProperty(*, action_condition=None, label_name_condition=None)

Bases: object

A single condition that can match based on WAF rule action or label name.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-condition.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_observabilityadmin import mixins as observabilityadmin_mixins

condition_property = observabilityadmin_mixins.CfnTelemetryRulePropsMixin.ConditionProperty(
    action_condition=observabilityadmin_mixins.CfnTelemetryRulePropsMixin.ActionConditionProperty(
        action="action"
    ),
    label_name_condition=observabilityadmin_mixins.CfnTelemetryRulePropsMixin.LabelNameConditionProperty(
        label_name="labelName"
    )
)

Attributes

action_condition

Matches log records based on the WAF rule action taken (ALLOW, BLOCK, COUNT, etc.).

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-condition.html#cfn-observabilityadmin-telemetryrule-condition-actioncondition

label_name_condition

Matches log records based on WAF rule labels applied to the request.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-condition.html#cfn-observabilityadmin-telemetryrule-condition-labelnamecondition

ELBLoadBalancerLoggingParametersProperty

class CfnTelemetryRulePropsMixin.ELBLoadBalancerLoggingParametersProperty(*, field_delimiter=None, output_format=None)

Bases: object

Configuration parameters for ELB load balancer logging, including output format and field delimiter settings.

Parameters:

  • field_delimiter (Optional[str]) – The delimiter character used to separate fields in ELB access log entries when using plain text format.

  • output_format (Optional[str]) – The format for ELB access log entries (plain text or JSON format).

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-elbloadbalancerloggingparameters.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_observabilityadmin import mixins as observabilityadmin_mixins

e_lBLoad_balancer_logging_parameters_property = observabilityadmin_mixins.CfnTelemetryRulePropsMixin.ELBLoadBalancerLoggingParametersProperty(
    field_delimiter="fieldDelimiter",
    output_format="outputFormat"
)

Attributes

field_delimiter

The delimiter character used to separate fields in ELB access log entries when using plain text format.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-elbloadbalancerloggingparameters.html#cfn-observabilityadmin-telemetryrule-elbloadbalancerloggingparameters-fielddelimiter

output_format

The format for ELB access log entries (plain text or JSON format).

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-elbloadbalancerloggingparameters.html#cfn-observabilityadmin-telemetryrule-elbloadbalancerloggingparameters-outputformat

FieldToMatchProperty

class CfnTelemetryRulePropsMixin.FieldToMatchProperty(*, method=None, query_string=None, single_header=None, uri_path=None)

Bases: object

Specifies a field in the request to redact from WAF logs, such as headers, query parameters, or body content.

Parameters:

  • method (Optional[str]) – Redacts the HTTP method from WAF logs.

  • query_string (Optional[str]) – Redacts the entire query string from WAF logs.

  • single_header (Union[IResolvable, SingleHeaderProperty, Dict[str, Any], None]) – Redacts a specific header field by name from WAF logs.

  • uri_path (Optional[str]) – Redacts the URI path from WAF logs.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-fieldtomatch.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_observabilityadmin import mixins as observabilityadmin_mixins

field_to_match_property = observabilityadmin_mixins.CfnTelemetryRulePropsMixin.FieldToMatchProperty(
    method="method",
    query_string="queryString",
    single_header=observabilityadmin_mixins.CfnTelemetryRulePropsMixin.SingleHeaderProperty(
        name="name"
    ),
    uri_path="uriPath"
)

Attributes

method

Redacts the HTTP method from WAF logs.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-fieldtomatch.html#cfn-observabilityadmin-telemetryrule-fieldtomatch-method

query_string

Redacts the entire query string from WAF logs.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-fieldtomatch.html#cfn-observabilityadmin-telemetryrule-fieldtomatch-querystring

single_header

Redacts a specific header field by name from WAF logs.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-fieldtomatch.html#cfn-observabilityadmin-telemetryrule-fieldtomatch-singleheader

uri_path

Redacts the URI path from WAF logs.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-fieldtomatch.html#cfn-observabilityadmin-telemetryrule-fieldtomatch-uripath

FilterProperty

class CfnTelemetryRulePropsMixin.FilterProperty(*, behavior=None, conditions=None, requirement=None)

Bases: object

A single filter condition that specifies behavior, requirement, and matching conditions for WAF log records.

Parameters:

  • behavior (Optional[str]) – The action to take for log records matching this filter (KEEP or DROP).

  • conditions (Union[IResolvable, Sequence[Union[IResolvable, ConditionProperty, Dict[str, Any]]], None]) – The list of conditions that determine if a log record matches this filter.

  • requirement (Optional[str]) – Whether the log record must meet all conditions (MEETS_ALL) or any condition (MEETS_ANY) to match this filter.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-filter.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_observabilityadmin import mixins as observabilityadmin_mixins

filter_property = observabilityadmin_mixins.CfnTelemetryRulePropsMixin.FilterProperty(
    behavior="behavior",
    conditions=[observabilityadmin_mixins.CfnTelemetryRulePropsMixin.ConditionProperty(
        action_condition=observabilityadmin_mixins.CfnTelemetryRulePropsMixin.ActionConditionProperty(
            action="action"
        ),
        label_name_condition=observabilityadmin_mixins.CfnTelemetryRulePropsMixin.LabelNameConditionProperty(
            label_name="labelName"
        )
    )],
    requirement="requirement"
)

Attributes

behavior

The action to take for log records matching this filter (KEEP or DROP).

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-filter.html#cfn-observabilityadmin-telemetryrule-filter-behavior

conditions

The list of conditions that determine if a log record matches this filter.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-filter.html#cfn-observabilityadmin-telemetryrule-filter-conditions

requirement

Whether the log record must meet all conditions (MEETS_ALL) or any condition (MEETS_ANY) to match this filter.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-filter.html#cfn-observabilityadmin-telemetryrule-filter-requirement

LabelNameConditionProperty

class CfnTelemetryRulePropsMixin.LabelNameConditionProperty(*, label_name=None)

Bases: object

Condition that matches based on WAF rule labels, with label names limited to 1024 characters.

Parameters:

label_name (Optional[str]) – The label name to match, supporting alphanumeric characters, underscores, hyphens, and colons.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-labelnamecondition.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_observabilityadmin import mixins as observabilityadmin_mixins

label_name_condition_property = observabilityadmin_mixins.CfnTelemetryRulePropsMixin.LabelNameConditionProperty(
    label_name="labelName"
)

Attributes

label_name

The label name to match, supporting alphanumeric characters, underscores, hyphens, and colons.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-labelnamecondition.html#cfn-observabilityadmin-telemetryrule-labelnamecondition-labelname

LogDeliveryParametersProperty

class CfnTelemetryRulePropsMixin.LogDeliveryParametersProperty(*, log_types=None)

Bases: object

Configuration parameters for Amazon Bedrock AgentCore logging, including logType settings.

Parameters:

log_types (Optional[Sequence[str]]) – The type of log that the source is sending.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-logdeliveryparameters.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_observabilityadmin import mixins as observabilityadmin_mixins

log_delivery_parameters_property = observabilityadmin_mixins.CfnTelemetryRulePropsMixin.LogDeliveryParametersProperty(
    log_types=["logTypes"]
)

Attributes

log_types

The type of log that the source is sending.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-logdeliveryparameters.html#cfn-observabilityadmin-telemetryrule-logdeliveryparameters-logtypes

LoggingFilterProperty

class CfnTelemetryRulePropsMixin.LoggingFilterProperty(*, default_behavior=None, filters=None)

Bases: object

Configuration that determines which WAF log records to keep or drop based on specified conditions.

Parameters:

  • default_behavior (Optional[str]) – The default action (KEEP or DROP) for log records that don’t match any filter conditions.

  • filters (Union[IResolvable, Sequence[Union[IResolvable, FilterProperty, Dict[str, Any]]], None]) – A list of filter conditions that determine log record handling behavior.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-loggingfilter.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_observabilityadmin import mixins as observabilityadmin_mixins

logging_filter_property = observabilityadmin_mixins.CfnTelemetryRulePropsMixin.LoggingFilterProperty(
    default_behavior="defaultBehavior",
    filters=[observabilityadmin_mixins.CfnTelemetryRulePropsMixin.FilterProperty(
        behavior="behavior",
        conditions=[observabilityadmin_mixins.CfnTelemetryRulePropsMixin.ConditionProperty(
            action_condition=observabilityadmin_mixins.CfnTelemetryRulePropsMixin.ActionConditionProperty(
                action="action"
            ),
            label_name_condition=observabilityadmin_mixins.CfnTelemetryRulePropsMixin.LabelNameConditionProperty(
                label_name="labelName"
            )
        )],
        requirement="requirement"
    )]
)

Attributes

default_behavior

The default action (KEEP or DROP) for log records that don’t match any filter conditions.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-loggingfilter.html#cfn-observabilityadmin-telemetryrule-loggingfilter-defaultbehavior

filters

A list of filter conditions that determine log record handling behavior.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-loggingfilter.html#cfn-observabilityadmin-telemetryrule-loggingfilter-filters

SingleHeaderProperty

class CfnTelemetryRulePropsMixin.SingleHeaderProperty(*, name=None)

Bases: object

Structure containing a name field limited to 64 characters for header or query parameter identification.

Parameters:

name (Optional[str]) – The name value, limited to 64 characters.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-singleheader.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_observabilityadmin import mixins as observabilityadmin_mixins

single_header_property = observabilityadmin_mixins.CfnTelemetryRulePropsMixin.SingleHeaderProperty(
    name="name"
)

Attributes

name

The name value, limited to 64 characters.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-singleheader.html#cfn-observabilityadmin-telemetryrule-singleheader-name

TelemetryDestinationConfigurationProperty

class CfnTelemetryRulePropsMixin.TelemetryDestinationConfigurationProperty(*, cloudtrail_parameters=None, destination_pattern=None, destination_type=None, elb_load_balancer_logging_parameters=None, log_delivery_parameters=None, retention_in_days=None, vpc_flow_log_parameters=None, waf_logging_parameters=None)

Bases: object

Configuration specifying where and how telemetry data should be delivered for AWS resources.

Parameters:

  • cloudtrail_parameters (Union[IResolvable, CloudtrailParametersProperty, Dict[str, Any], None]) – Configuration parameters specific to AWS CloudTrail when CloudTrail is the source type.

  • destination_pattern (Optional[str]) – The pattern used to generate the destination path or name, supporting macros like and .

  • destination_type (Optional[str]) – The type of destination for the telemetry data (e.g., “Amazon CloudWatch Logs”, “S3”).

  • elb_load_balancer_logging_parameters (Union[IResolvable, ELBLoadBalancerLoggingParametersProperty, Dict[str, Any], None]) – Configuration parameters specific to ELB load balancer logging when ELB is the resource type.

  • log_delivery_parameters (Union[IResolvable, LogDeliveryParametersProperty, Dict[str, Any], None]) – Configuration parameters specific to Amazon Bedrock AgentCore logging when Amazon Bedrock AgentCore is the resource type.

  • retention_in_days (Union[int, float, None]) – The number of days to retain the telemetry data in the destination.

  • vpc_flow_log_parameters (Union[IResolvable, VPCFlowLogParametersProperty, Dict[str, Any], None]) – Configuration parameters specific to VPC Flow Logs when VPC is the resource type.

  • waf_logging_parameters (Union[IResolvable, WAFLoggingParametersProperty, Dict[str, Any], None]) – Configuration parameters specific to WAF logging when WAF is the resource type.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-telemetrydestinationconfiguration.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_observabilityadmin import mixins as observabilityadmin_mixins

telemetry_destination_configuration_property = observabilityadmin_mixins.CfnTelemetryRulePropsMixin.TelemetryDestinationConfigurationProperty(
    cloudtrail_parameters=observabilityadmin_mixins.CfnTelemetryRulePropsMixin.CloudtrailParametersProperty(
        advanced_event_selectors=[observabilityadmin_mixins.CfnTelemetryRulePropsMixin.AdvancedEventSelectorProperty(
            field_selectors=[observabilityadmin_mixins.CfnTelemetryRulePropsMixin.AdvancedFieldSelectorProperty(
                ends_with=["endsWith"],
                equal_to=["equalTo"],
                field="field",
                not_ends_with=["notEndsWith"],
                not_equals=["notEquals"],
                not_starts_with=["notStartsWith"],
                starts_with=["startsWith"]
            )],
            name="name"
        )]
    ),
    destination_pattern="destinationPattern",
    destination_type="destinationType",
    elb_load_balancer_logging_parameters=observabilityadmin_mixins.CfnTelemetryRulePropsMixin.ELBLoadBalancerLoggingParametersProperty(
        field_delimiter="fieldDelimiter",
        output_format="outputFormat"
    ),
    log_delivery_parameters=observabilityadmin_mixins.CfnTelemetryRulePropsMixin.LogDeliveryParametersProperty(
        log_types=["logTypes"]
    ),
    retention_in_days=123,
    vpc_flow_log_parameters=observabilityadmin_mixins.CfnTelemetryRulePropsMixin.VPCFlowLogParametersProperty(
        log_format="logFormat",
        max_aggregation_interval=123,
        traffic_type="trafficType"
    ),
    waf_logging_parameters=observabilityadmin_mixins.CfnTelemetryRulePropsMixin.WAFLoggingParametersProperty(
        logging_filter=observabilityadmin_mixins.CfnTelemetryRulePropsMixin.LoggingFilterProperty(
            default_behavior="defaultBehavior",
            filters=[observabilityadmin_mixins.CfnTelemetryRulePropsMixin.FilterProperty(
                behavior="behavior",
                conditions=[observabilityadmin_mixins.CfnTelemetryRulePropsMixin.ConditionProperty(
                    action_condition=observabilityadmin_mixins.CfnTelemetryRulePropsMixin.ActionConditionProperty(
                        action="action"
                    ),
                    label_name_condition=observabilityadmin_mixins.CfnTelemetryRulePropsMixin.LabelNameConditionProperty(
                        label_name="labelName"
                    )
                )],
                requirement="requirement"
            )]
        ),
        log_type="logType",
        redacted_fields=[observabilityadmin_mixins.CfnTelemetryRulePropsMixin.FieldToMatchProperty(
            method="method",
            query_string="queryString",
            single_header=observabilityadmin_mixins.CfnTelemetryRulePropsMixin.SingleHeaderProperty(
                name="name"
            ),
            uri_path="uriPath"
        )]
    )
)

Attributes

cloudtrail_parameters

Configuration parameters specific to AWS CloudTrail when CloudTrail is the source type.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-telemetrydestinationconfiguration.html#cfn-observabilityadmin-telemetryrule-telemetrydestinationconfiguration-cloudtrailparameters

destination_pattern

The pattern used to generate the destination path or name, supporting macros like and .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-telemetrydestinationconfiguration.html#cfn-observabilityadmin-telemetryrule-telemetrydestinationconfiguration-destinationpattern

destination_type

The type of destination for the telemetry data (e.g., “Amazon CloudWatch Logs”, “S3”).

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-telemetrydestinationconfiguration.html#cfn-observabilityadmin-telemetryrule-telemetrydestinationconfiguration-destinationtype

elb_load_balancer_logging_parameters

Configuration parameters specific to ELB load balancer logging when ELB is the resource type.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-telemetrydestinationconfiguration.html#cfn-observabilityadmin-telemetryrule-telemetrydestinationconfiguration-elbloadbalancerloggingparameters

log_delivery_parameters

Configuration parameters specific to Amazon Bedrock AgentCore logging when Amazon Bedrock AgentCore is the resource type.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-telemetrydestinationconfiguration.html#cfn-observabilityadmin-telemetryrule-telemetrydestinationconfiguration-logdeliveryparameters

retention_in_days

The number of days to retain the telemetry data in the destination.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-telemetrydestinationconfiguration.html#cfn-observabilityadmin-telemetryrule-telemetrydestinationconfiguration-retentionindays

vpc_flow_log_parameters

Configuration parameters specific to VPC Flow Logs when VPC is the resource type.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-telemetrydestinationconfiguration.html#cfn-observabilityadmin-telemetryrule-telemetrydestinationconfiguration-vpcflowlogparameters

waf_logging_parameters

Configuration parameters specific to WAF logging when WAF is the resource type.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-telemetrydestinationconfiguration.html#cfn-observabilityadmin-telemetryrule-telemetrydestinationconfiguration-wafloggingparameters

TelemetryRuleProperty

class CfnTelemetryRulePropsMixin.TelemetryRuleProperty(*, destination_configuration=None, resource_type=None, selection_criteria=None, telemetry_source_types=None, telemetry_type=None)

Bases: object

Defines how telemetry should be configured for specific AWS resources.

Parameters:

  • destination_configuration (Union[IResolvable, TelemetryDestinationConfigurationProperty, Dict[str, Any], None]) – Configuration specifying where and how the telemetry data should be delivered.

  • resource_type (Optional[str]) – The type of AWS resource to configure telemetry for (e.g., “AWS::EC2::VPC”, “AWS::EKS::Cluster”, “AWS::WAFv2::WebACL”).

  • selection_criteria (Optional[str]) – Criteria for selecting which resources the rule applies to, such as resource tags.

  • telemetry_source_types (Optional[Sequence[str]]) – The specific telemetry source types to configure for the resource, such as VPC_FLOW_LOGS or EKS_AUDIT_LOGS. TelemetrySourceTypes must be correlated with the specific resource type.

  • telemetry_type (Optional[str]) – The type of telemetry to collect (Logs, Metrics, or Traces).

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-telemetryrule.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_observabilityadmin import mixins as observabilityadmin_mixins

telemetry_rule_property = observabilityadmin_mixins.CfnTelemetryRulePropsMixin.TelemetryRuleProperty(
    destination_configuration=observabilityadmin_mixins.CfnTelemetryRulePropsMixin.TelemetryDestinationConfigurationProperty(
        cloudtrail_parameters=observabilityadmin_mixins.CfnTelemetryRulePropsMixin.CloudtrailParametersProperty(
            advanced_event_selectors=[observabilityadmin_mixins.CfnTelemetryRulePropsMixin.AdvancedEventSelectorProperty(
                field_selectors=[observabilityadmin_mixins.CfnTelemetryRulePropsMixin.AdvancedFieldSelectorProperty(
                    ends_with=["endsWith"],
                    equal_to=["equalTo"],
                    field="field",
                    not_ends_with=["notEndsWith"],
                    not_equals=["notEquals"],
                    not_starts_with=["notStartsWith"],
                    starts_with=["startsWith"]
                )],
                name="name"
            )]
        ),
        destination_pattern="destinationPattern",
        destination_type="destinationType",
        elb_load_balancer_logging_parameters=observabilityadmin_mixins.CfnTelemetryRulePropsMixin.ELBLoadBalancerLoggingParametersProperty(
            field_delimiter="fieldDelimiter",
            output_format="outputFormat"
        ),
        log_delivery_parameters=observabilityadmin_mixins.CfnTelemetryRulePropsMixin.LogDeliveryParametersProperty(
            log_types=["logTypes"]
        ),
        retention_in_days=123,
        vpc_flow_log_parameters=observabilityadmin_mixins.CfnTelemetryRulePropsMixin.VPCFlowLogParametersProperty(
            log_format="logFormat",
            max_aggregation_interval=123,
            traffic_type="trafficType"
        ),
        waf_logging_parameters=observabilityadmin_mixins.CfnTelemetryRulePropsMixin.WAFLoggingParametersProperty(
            logging_filter=observabilityadmin_mixins.CfnTelemetryRulePropsMixin.LoggingFilterProperty(
                default_behavior="defaultBehavior",
                filters=[observabilityadmin_mixins.CfnTelemetryRulePropsMixin.FilterProperty(
                    behavior="behavior",
                    conditions=[observabilityadmin_mixins.CfnTelemetryRulePropsMixin.ConditionProperty(
                        action_condition=observabilityadmin_mixins.CfnTelemetryRulePropsMixin.ActionConditionProperty(
                            action="action"
                        ),
                        label_name_condition=observabilityadmin_mixins.CfnTelemetryRulePropsMixin.LabelNameConditionProperty(
                            label_name="labelName"
                        )
                    )],
                    requirement="requirement"
                )]
            ),
            log_type="logType",
            redacted_fields=[observabilityadmin_mixins.CfnTelemetryRulePropsMixin.FieldToMatchProperty(
                method="method",
                query_string="queryString",
                single_header=observabilityadmin_mixins.CfnTelemetryRulePropsMixin.SingleHeaderProperty(
                    name="name"
                ),
                uri_path="uriPath"
            )]
        )
    ),
    resource_type="resourceType",
    selection_criteria="selectionCriteria",
    telemetry_source_types=["telemetrySourceTypes"],
    telemetry_type="telemetryType"
)

Attributes

destination_configuration

Configuration specifying where and how the telemetry data should be delivered.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-telemetryrule.html#cfn-observabilityadmin-telemetryrule-telemetryrule-destinationconfiguration

resource_type

The type of AWS resource to configure telemetry for (e.g., “AWS::EC2::VPC”, “AWS::EKS::Cluster”, “AWS::WAFv2::WebACL”).

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-telemetryrule.html#cfn-observabilityadmin-telemetryrule-telemetryrule-resourcetype

selection_criteria

Criteria for selecting which resources the rule applies to, such as resource tags.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-telemetryrule.html#cfn-observabilityadmin-telemetryrule-telemetryrule-selectioncriteria

telemetry_source_types

The specific telemetry source types to configure for the resource, such as VPC_FLOW_LOGS or EKS_AUDIT_LOGS.

TelemetrySourceTypes must be correlated with the specific resource type.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-telemetryrule.html#cfn-observabilityadmin-telemetryrule-telemetryrule-telemetrysourcetypes

telemetry_type

The type of telemetry to collect (Logs, Metrics, or Traces).

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-telemetryrule.html#cfn-observabilityadmin-telemetryrule-telemetryrule-telemetrytype

VPCFlowLogParametersProperty

class CfnTelemetryRulePropsMixin.VPCFlowLogParametersProperty(*, log_format=None, max_aggregation_interval=None, traffic_type=None)

Bases: object

Configuration parameters specific to VPC Flow Logs.

Parameters:

  • log_format (Optional[str]) – The format in which VPC Flow Log entries should be logged.

  • max_aggregation_interval (Union[int, float, None]) – The maximum interval in seconds between the capture of flow log records.

  • traffic_type (Optional[str]) – The type of traffic to log (ACCEPT, REJECT, or ALL).

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-vpcflowlogparameters.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_observabilityadmin import mixins as observabilityadmin_mixins

v_pCFlow_log_parameters_property = observabilityadmin_mixins.CfnTelemetryRulePropsMixin.VPCFlowLogParametersProperty(
    log_format="logFormat",
    max_aggregation_interval=123,
    traffic_type="trafficType"
)

Attributes

log_format

The format in which VPC Flow Log entries should be logged.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-vpcflowlogparameters.html#cfn-observabilityadmin-telemetryrule-vpcflowlogparameters-logformat

max_aggregation_interval

The maximum interval in seconds between the capture of flow log records.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-vpcflowlogparameters.html#cfn-observabilityadmin-telemetryrule-vpcflowlogparameters-maxaggregationinterval

traffic_type

The type of traffic to log (ACCEPT, REJECT, or ALL).

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-vpcflowlogparameters.html#cfn-observabilityadmin-telemetryrule-vpcflowlogparameters-traffictype

WAFLoggingParametersProperty

class CfnTelemetryRulePropsMixin.WAFLoggingParametersProperty(*, logging_filter=None, log_type=None, redacted_fields=None)

Bases: object

Configuration parameters for WAF logging, including redacted fields and logging filters.

Parameters:

  • logging_filter (Union[IResolvable, LoggingFilterProperty, Dict[str, Any], None]) – A filter configuration that determines which WAF log records to include or exclude.

  • log_type (Optional[str]) – The type of WAF logs to collect (currently supports WAF_LOGS).

  • redacted_fields (Union[IResolvable, Sequence[Union[IResolvable, FieldToMatchProperty, Dict[str, Any]]], None]) – The fields to redact from WAF logs to protect sensitive information.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-wafloggingparameters.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_observabilityadmin import mixins as observabilityadmin_mixins

w_aFLogging_parameters_property = observabilityadmin_mixins.CfnTelemetryRulePropsMixin.WAFLoggingParametersProperty(
    logging_filter=observabilityadmin_mixins.CfnTelemetryRulePropsMixin.LoggingFilterProperty(
        default_behavior="defaultBehavior",
        filters=[observabilityadmin_mixins.CfnTelemetryRulePropsMixin.FilterProperty(
            behavior="behavior",
            conditions=[observabilityadmin_mixins.CfnTelemetryRulePropsMixin.ConditionProperty(
                action_condition=observabilityadmin_mixins.CfnTelemetryRulePropsMixin.ActionConditionProperty(
                    action="action"
                ),
                label_name_condition=observabilityadmin_mixins.CfnTelemetryRulePropsMixin.LabelNameConditionProperty(
                    label_name="labelName"
                )
            )],
            requirement="requirement"
        )]
    ),
    log_type="logType",
    redacted_fields=[observabilityadmin_mixins.CfnTelemetryRulePropsMixin.FieldToMatchProperty(
        method="method",
        query_string="queryString",
        single_header=observabilityadmin_mixins.CfnTelemetryRulePropsMixin.SingleHeaderProperty(
            name="name"
        ),
        uri_path="uriPath"
    )]
)

Attributes

log_type

The type of WAF logs to collect (currently supports WAF_LOGS).

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-wafloggingparameters.html#cfn-observabilityadmin-telemetryrule-wafloggingparameters-logtype

logging_filter

A filter configuration that determines which WAF log records to include or exclude.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-wafloggingparameters.html#cfn-observabilityadmin-telemetryrule-wafloggingparameters-loggingfilter

redacted_fields

The fields to redact from WAF logs to protect sensitive information.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetryrule-wafloggingparameters.html#cfn-observabilityadmin-telemetryrule-wafloggingparameters-redactedfields