CfnTelemetryRuleProps

class aws_cdk.aws_observabilityadmin.CfnTelemetryRuleProps(*, rule, rule_name, tags=None)

Bases: object

Properties for defining a CfnTelemetryRule.

Parameters:

• rule (Union[IResolvable, TelemetryRuleProperty, Dict[str, Any]]) – Retrieves the details of a specific telemetry rule in your account.

• rule_name (str) – The name of the telemetry rule.

• tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – Lists all tags attached to the specified resource. Supports telemetry rule resources and telemetry pipeline resources.

See:

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

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 import aws_observabilityadmin as observabilityadmin

cfn_telemetry_rule_props = observabilityadmin.CfnTelemetryRuleProps(
    rule=observabilityadmin.CfnTelemetryRule.TelemetryRuleProperty(
        resource_type="resourceType",
        telemetry_type="telemetryType",

        # the properties below are optional
        destination_configuration=observabilityadmin.CfnTelemetryRule.TelemetryDestinationConfigurationProperty(
            cloudtrail_parameters=observabilityadmin.CfnTelemetryRule.CloudtrailParametersProperty(
                advanced_event_selectors=[observabilityadmin.CfnTelemetryRule.AdvancedEventSelectorProperty(
                    field_selectors=[observabilityadmin.CfnTelemetryRule.AdvancedFieldSelectorProperty(
                        ends_with=["endsWith"],
                        equal_to=["equalTo"],
                        field="field",
                        not_ends_with=["notEndsWith"],
                        not_equals=["notEquals"],
                        not_starts_with=["notStartsWith"],
                        starts_with=["startsWith"]
                    )],

                    # the properties below are optional
                    name="name"
                )]
            ),
            destination_pattern="destinationPattern",
            destination_type="destinationType",
            elb_load_balancer_logging_parameters=observabilityadmin.CfnTelemetryRule.ELBLoadBalancerLoggingParametersProperty(
                field_delimiter="fieldDelimiter",
                output_format="outputFormat"
            ),
            log_delivery_parameters=observabilityadmin.CfnTelemetryRule.LogDeliveryParametersProperty(
                log_types=["logTypes"]
            ),
            retention_in_days=123,
            vpc_flow_log_parameters=observabilityadmin.CfnTelemetryRule.VPCFlowLogParametersProperty(
                log_format="logFormat",
                max_aggregation_interval=123,
                traffic_type="trafficType"
            ),
            waf_logging_parameters=observabilityadmin.CfnTelemetryRule.WAFLoggingParametersProperty(
                logging_filter=observabilityadmin.CfnTelemetryRule.LoggingFilterProperty(
                    default_behavior="defaultBehavior",
                    filters=[observabilityadmin.CfnTelemetryRule.FilterProperty(
                        behavior="behavior",
                        conditions=[observabilityadmin.CfnTelemetryRule.ConditionProperty(
                            action_condition=observabilityadmin.CfnTelemetryRule.ActionConditionProperty(
                                action="action"
                            ),
                            label_name_condition=observabilityadmin.CfnTelemetryRule.LabelNameConditionProperty(
                                label_name="labelName"
                            )
                        )],
                        requirement="requirement"
                    )]
                ),
                log_type="logType",
                redacted_fields=[observabilityadmin.CfnTelemetryRule.FieldToMatchProperty(
                    method="method",
                    query_string="queryString",
                    single_header=observabilityadmin.CfnTelemetryRule.SingleHeaderProperty(
                        name="name"
                    ),
                    uri_path="uriPath"
                )]
            )
        ),
        selection_criteria="selectionCriteria",
        telemetry_source_types=["telemetrySourceTypes"]
    ),
    rule_name="ruleName",

    # the properties below are optional
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

rule

Retrieves the details of a specific telemetry rule in your account.

See:

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

rule_name

The name of the telemetry rule.

See:

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

tags

Lists all tags attached to the specified resource.

Supports telemetry rule resources and telemetry pipeline resources.

See:

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