Class CfnTelemetryRule.TelemetryRuleProperty

Defines how telemetry should be configured for specific AWS resources.

Inheritance

object

CfnTelemetryRule.TelemetryRuleProperty

Implements

CfnTelemetryRule.ITelemetryRuleProperty

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.ObservabilityAdmin

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnTelemetryRule.TelemetryRuleProperty : CfnTelemetryRule.ITelemetryRuleProperty

Syntax (vb)

Public Class CfnTelemetryRule.TelemetryRuleProperty Implements CfnTelemetryRule.ITelemetryRuleProperty

Remarks

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.ObservabilityAdmin;

             var telemetryRuleProperty = new TelemetryRuleProperty {
                 ResourceType = "resourceType",
                 TelemetryType = "telemetryType",

                 // the properties below are optional
                 DestinationConfiguration = new TelemetryDestinationConfigurationProperty {
                     CloudtrailParameters = new CloudtrailParametersProperty {
                         AdvancedEventSelectors = new [] { new AdvancedEventSelectorProperty {
                             FieldSelectors = new [] { new AdvancedFieldSelectorProperty {
                                 EndsWith = new [] { "endsWith" },
                                 EqualTo = new [] { "equalTo" },
                                 Field = "field",
                                 NotEndsWith = new [] { "notEndsWith" },
                                 NotEquals = new [] { "notEquals" },
                                 NotStartsWith = new [] { "notStartsWith" },
                                 StartsWith = new [] { "startsWith" }
                             } },

                             // the properties below are optional
                             Name = "name"
                         } }
                     },
                     DestinationPattern = "destinationPattern",
                     DestinationType = "destinationType",
                     ElbLoadBalancerLoggingParameters = new ELBLoadBalancerLoggingParametersProperty {
                         FieldDelimiter = "fieldDelimiter",
                         OutputFormat = "outputFormat"
                     },
                     LogDeliveryParameters = new LogDeliveryParametersProperty {
                         LogTypes = new [] { "logTypes" }
                     },
                     RetentionInDays = 123,
                     VpcFlowLogParameters = new VPCFlowLogParametersProperty {
                         LogFormat = "logFormat",
                         MaxAggregationInterval = 123,
                         TrafficType = "trafficType"
                     },
                     WafLoggingParameters = new WAFLoggingParametersProperty {
                         LoggingFilter = new LoggingFilterProperty {
                             DefaultBehavior = "defaultBehavior",
                             Filters = new [] { new FilterProperty {
                                 Behavior = "behavior",
                                 Conditions = new [] { new ConditionProperty {
                                     ActionCondition = new ActionConditionProperty {
                                         Action = "action"
                                     },
                                     LabelNameCondition = new LabelNameConditionProperty {
                                         LabelName = "labelName"
                                     }
                                 } },
                                 Requirement = "requirement"
                             } }
                         },
                         LogType = "logType",
                         RedactedFields = new [] { new FieldToMatchProperty {
                             Method = "method",
                             QueryString = "queryString",
                             SingleHeader = new SingleHeaderProperty {
                                 Name = "name"
                             },
                             UriPath = "uriPath"
                         } }
                     }
                 },
                 SelectionCriteria = "selectionCriteria",
                 TelemetrySourceTypes = new [] { "telemetrySourceTypes" }
             };

Synopsis

Constructors

TelemetryRuleProperty()

Defines how telemetry should be configured for specific AWS resources.

Properties

DestinationConfiguration	Configuration specifying where and how the telemetry data should be delivered.
ResourceType	The type of AWS resource to configure telemetry for (e.g., "AWS::EC2::VPC", "AWS::EKS::Cluster", "AWS::WAFv2::WebACL").
SelectionCriteria	Criteria for selecting which resources the rule applies to, such as resource tags.
TelemetrySourceTypes	The specific telemetry source types to configure for the resource, such as VPC_FLOW_LOGS or EKS_AUDIT_LOGS.
TelemetryType	The type of telemetry to collect (Logs, Metrics, or Traces).

Constructors

TelemetryRuleProperty()

Defines how telemetry should be configured for specific AWS resources.

public TelemetryRuleProperty()

Remarks

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.ObservabilityAdmin;

             var telemetryRuleProperty = new TelemetryRuleProperty {
                 ResourceType = "resourceType",
                 TelemetryType = "telemetryType",

                 // the properties below are optional
                 DestinationConfiguration = new TelemetryDestinationConfigurationProperty {
                     CloudtrailParameters = new CloudtrailParametersProperty {
                         AdvancedEventSelectors = new [] { new AdvancedEventSelectorProperty {
                             FieldSelectors = new [] { new AdvancedFieldSelectorProperty {
                                 EndsWith = new [] { "endsWith" },
                                 EqualTo = new [] { "equalTo" },
                                 Field = "field",
                                 NotEndsWith = new [] { "notEndsWith" },
                                 NotEquals = new [] { "notEquals" },
                                 NotStartsWith = new [] { "notStartsWith" },
                                 StartsWith = new [] { "startsWith" }
                             } },

                             // the properties below are optional
                             Name = "name"
                         } }
                     },
                     DestinationPattern = "destinationPattern",
                     DestinationType = "destinationType",
                     ElbLoadBalancerLoggingParameters = new ELBLoadBalancerLoggingParametersProperty {
                         FieldDelimiter = "fieldDelimiter",
                         OutputFormat = "outputFormat"
                     },
                     LogDeliveryParameters = new LogDeliveryParametersProperty {
                         LogTypes = new [] { "logTypes" }
                     },
                     RetentionInDays = 123,
                     VpcFlowLogParameters = new VPCFlowLogParametersProperty {
                         LogFormat = "logFormat",
                         MaxAggregationInterval = 123,
                         TrafficType = "trafficType"
                     },
                     WafLoggingParameters = new WAFLoggingParametersProperty {
                         LoggingFilter = new LoggingFilterProperty {
                             DefaultBehavior = "defaultBehavior",
                             Filters = new [] { new FilterProperty {
                                 Behavior = "behavior",
                                 Conditions = new [] { new ConditionProperty {
                                     ActionCondition = new ActionConditionProperty {
                                         Action = "action"
                                     },
                                     LabelNameCondition = new LabelNameConditionProperty {
                                         LabelName = "labelName"
                                     }
                                 } },
                                 Requirement = "requirement"
                             } }
                         },
                         LogType = "logType",
                         RedactedFields = new [] { new FieldToMatchProperty {
                             Method = "method",
                             QueryString = "queryString",
                             SingleHeader = new SingleHeaderProperty {
                                 Name = "name"
                             },
                             UriPath = "uriPath"
                         } }
                     }
                 },
                 SelectionCriteria = "selectionCriteria",
                 TelemetrySourceTypes = new [] { "telemetrySourceTypes" }
             };

Properties

DestinationConfiguration

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

public object? DestinationConfiguration { get; set; }

Property Value

object

Remarks

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

Type union: either IResolvable or CfnTelemetryRule.ITelemetryDestinationConfigurationProperty

ResourceType

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

public string ResourceType { get; set; }

Property Value

string

Remarks

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

SelectionCriteria

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

public string? SelectionCriteria { get; set; }

Property Value

string

Remarks

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

TelemetrySourceTypes

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

public string[]? TelemetrySourceTypes { get; set; }

Property Value

string[]

Remarks

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

TelemetryType

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

public string TelemetryType { get; set; }

Property Value

string

Remarks

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

Implements

CfnTelemetryRule.ITelemetryRuleProperty