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 telemetry rule resource.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-observabilityadmin-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 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(
            destination_pattern="destinationPattern",
            destination_type="destinationType",
            retention_in_days=123,
            vpc_flow_log_parameters=observabilityadmin.CfnTelemetryRule.VPCFlowLogParametersProperty(
                log_format="logFormat",
                max_aggregation_interval=123,
                traffic_type="trafficType"
            )
        ),
        selection_criteria="selectionCriteria"
    ),
    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 telemetry rule resource.

See:

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