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:

# 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(
            destination_pattern="destinationPattern",
            destination_type="destinationType",
            retention_in_days=123,
            vpc_flow_log_parameters=observabilityadmin_mixins.CfnTelemetryRulePropsMixin.VPCFlowLogParametersProperty(
                log_format="logFormat",
                max_aggregation_interval=123,
                traffic_type="trafficType"
            )
        ),
        resource_type="resourceType",
        selection_criteria="selectionCriteria",
        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

TelemetryDestinationConfigurationProperty

class CfnTelemetryRulePropsMixin.TelemetryDestinationConfigurationProperty(*, destination_pattern=None, destination_type=None, retention_in_days=None, vpc_flow_log_parameters=None)

Bases: object

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

Parameters:

  • 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”).

  • 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.

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(
    destination_pattern="destinationPattern",
    destination_type="destinationType",
    retention_in_days=123,
    vpc_flow_log_parameters=observabilityadmin_mixins.CfnTelemetryRulePropsMixin.VPCFlowLogParametersProperty(
        log_format="logFormat",
        max_aggregation_interval=123,
        traffic_type="trafficType"
    )
)

Attributes

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

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

TelemetryRuleProperty

class CfnTelemetryRulePropsMixin.TelemetryRuleProperty(*, destination_configuration=None, resource_type=None, selection_criteria=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”).

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

  • 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(
        destination_pattern="destinationPattern",
        destination_type="destinationType",
        retention_in_days=123,
        vpc_flow_log_parameters=observabilityadmin_mixins.CfnTelemetryRulePropsMixin.VPCFlowLogParametersProperty(
            log_format="logFormat",
            max_aggregation_interval=123,
            traffic_type="trafficType"
        )
    ),
    resource_type="resourceType",
    selection_criteria="selectionCriteria",
    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”).

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_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