1. Packages
  2. Dynatrace
  3. API Docs
  4. K8sMonitoring
Dynatrace v0.21.0 published on Sunday, Nov 17, 2024 by Pulumiverse

dynatrace.K8sMonitoring

Explore with Pulumi AI

dynatrace logo
Dynatrace v0.21.0 published on Sunday, Nov 17, 2024 by Pulumiverse

    Create K8sMonitoring Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new K8sMonitoring(name: string, args: K8sMonitoringArgs, opts?: CustomResourceOptions);
    @overload
    def K8sMonitoring(resource_name: str,
                      args: K8sMonitoringArgs,
                      opts: Optional[ResourceOptions] = None)
    
    @overload
    def K8sMonitoring(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      cloud_application_pipeline_enabled: Optional[bool] = None,
                      event_processing_active: Optional[bool] = None,
                      open_metrics_builtin_enabled: Optional[bool] = None,
                      open_metrics_pipeline_enabled: Optional[bool] = None,
                      event_patterns: Optional[K8sMonitoringEventPatternsArgs] = None,
                      filter_events: Optional[bool] = None,
                      include_all_fdi_events: Optional[bool] = None,
                      pvc_monitoring_enabled: Optional[bool] = None,
                      scope: Optional[str] = None)
    func NewK8sMonitoring(ctx *Context, name string, args K8sMonitoringArgs, opts ...ResourceOption) (*K8sMonitoring, error)
    public K8sMonitoring(string name, K8sMonitoringArgs args, CustomResourceOptions? opts = null)
    public K8sMonitoring(String name, K8sMonitoringArgs args)
    public K8sMonitoring(String name, K8sMonitoringArgs args, CustomResourceOptions options)
    
    type: dynatrace:K8sMonitoring
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args K8sMonitoringArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args K8sMonitoringArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args K8sMonitoringArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args K8sMonitoringArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args K8sMonitoringArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var k8sMonitoringResource = new Dynatrace.K8sMonitoring("k8sMonitoringResource", new()
    {
        CloudApplicationPipelineEnabled = false,
        EventProcessingActive = false,
        OpenMetricsBuiltinEnabled = false,
        OpenMetricsPipelineEnabled = false,
        EventPatterns = new Dynatrace.Inputs.K8sMonitoringEventPatternsArgs
        {
            EventPatterns = new[]
            {
                new Dynatrace.Inputs.K8sMonitoringEventPatternsEventPatternArgs
                {
                    Active = false,
                    Label = "string",
                    Pattern = "string",
                },
            },
        },
        FilterEvents = false,
        IncludeAllFdiEvents = false,
        Scope = "string",
    });
    
    example, err := dynatrace.NewK8sMonitoring(ctx, "k8sMonitoringResource", &dynatrace.K8sMonitoringArgs{
    	CloudApplicationPipelineEnabled: pulumi.Bool(false),
    	EventProcessingActive:           pulumi.Bool(false),
    	OpenMetricsBuiltinEnabled:       pulumi.Bool(false),
    	OpenMetricsPipelineEnabled:      pulumi.Bool(false),
    	EventPatterns: &dynatrace.K8sMonitoringEventPatternsArgs{
    		EventPatterns: dynatrace.K8sMonitoringEventPatternsEventPatternArray{
    			&dynatrace.K8sMonitoringEventPatternsEventPatternArgs{
    				Active:  pulumi.Bool(false),
    				Label:   pulumi.String("string"),
    				Pattern: pulumi.String("string"),
    			},
    		},
    	},
    	FilterEvents:        pulumi.Bool(false),
    	IncludeAllFdiEvents: pulumi.Bool(false),
    	Scope:               pulumi.String("string"),
    })
    
    var k8sMonitoringResource = new K8sMonitoring("k8sMonitoringResource", K8sMonitoringArgs.builder()
        .cloudApplicationPipelineEnabled(false)
        .eventProcessingActive(false)
        .openMetricsBuiltinEnabled(false)
        .openMetricsPipelineEnabled(false)
        .eventPatterns(K8sMonitoringEventPatternsArgs.builder()
            .eventPatterns(K8sMonitoringEventPatternsEventPatternArgs.builder()
                .active(false)
                .label("string")
                .pattern("string")
                .build())
            .build())
        .filterEvents(false)
        .includeAllFdiEvents(false)
        .scope("string")
        .build());
    
    k8s_monitoring_resource = dynatrace.K8sMonitoring("k8sMonitoringResource",
        cloud_application_pipeline_enabled=False,
        event_processing_active=False,
        open_metrics_builtin_enabled=False,
        open_metrics_pipeline_enabled=False,
        event_patterns={
            "event_patterns": [{
                "active": False,
                "label": "string",
                "pattern": "string",
            }],
        },
        filter_events=False,
        include_all_fdi_events=False,
        scope="string")
    
    const k8sMonitoringResource = new dynatrace.K8sMonitoring("k8sMonitoringResource", {
        cloudApplicationPipelineEnabled: false,
        eventProcessingActive: false,
        openMetricsBuiltinEnabled: false,
        openMetricsPipelineEnabled: false,
        eventPatterns: {
            eventPatterns: [{
                active: false,
                label: "string",
                pattern: "string",
            }],
        },
        filterEvents: false,
        includeAllFdiEvents: false,
        scope: "string",
    });
    
    type: dynatrace:K8sMonitoring
    properties:
        cloudApplicationPipelineEnabled: false
        eventPatterns:
            eventPatterns:
                - active: false
                  label: string
                  pattern: string
        eventProcessingActive: false
        filterEvents: false
        includeAllFdiEvents: false
        openMetricsBuiltinEnabled: false
        openMetricsPipelineEnabled: false
        scope: string
    

    K8sMonitoring Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The K8sMonitoring resource accepts the following input properties:

    CloudApplicationPipelineEnabled bool
    Monitor Kubernetes namespaces, services, workloads, and pods
    EventProcessingActive bool
    All events are monitored unless event filters are specified. All ingested events are subject to licensing by default.
    OpenMetricsBuiltinEnabled bool
    Workload and node resource metrics are based on a subset of cAdvisor metrics. Depending on your Kubernetes cluster size, this may increase the CPU/memory resource consumption of your ActiveGate.
    OpenMetricsPipelineEnabled bool
    For annotation guidance, see the documentation.
    EventPatterns Pulumiverse.Dynatrace.Inputs.K8sMonitoringEventPatterns
    Define Kubernetes event filters to ingest events into your environment. For more details, see the documentation.
    FilterEvents bool
    Include only events specified by Events Field Selectors
    IncludeAllFdiEvents bool
    For a list of included events, see the documentation.
    PvcMonitoringEnabled bool
    To enable dashboards and alerts, add the Kubernetes persistent volume claims extension to your environment.

    Deprecated: This attribute is deprecated, see this community guide for details.

    Scope string
    The scope of this setting (KUBERNETES_CLUSTER). Omit this property if you want to cover the whole environment.
    CloudApplicationPipelineEnabled bool
    Monitor Kubernetes namespaces, services, workloads, and pods
    EventProcessingActive bool
    All events are monitored unless event filters are specified. All ingested events are subject to licensing by default.
    OpenMetricsBuiltinEnabled bool
    Workload and node resource metrics are based on a subset of cAdvisor metrics. Depending on your Kubernetes cluster size, this may increase the CPU/memory resource consumption of your ActiveGate.
    OpenMetricsPipelineEnabled bool
    For annotation guidance, see the documentation.
    EventPatterns K8sMonitoringEventPatternsArgs
    Define Kubernetes event filters to ingest events into your environment. For more details, see the documentation.
    FilterEvents bool
    Include only events specified by Events Field Selectors
    IncludeAllFdiEvents bool
    For a list of included events, see the documentation.
    PvcMonitoringEnabled bool
    To enable dashboards and alerts, add the Kubernetes persistent volume claims extension to your environment.

    Deprecated: This attribute is deprecated, see this community guide for details.

    Scope string
    The scope of this setting (KUBERNETES_CLUSTER). Omit this property if you want to cover the whole environment.
    cloudApplicationPipelineEnabled Boolean
    Monitor Kubernetes namespaces, services, workloads, and pods
    eventProcessingActive Boolean
    All events are monitored unless event filters are specified. All ingested events are subject to licensing by default.
    openMetricsBuiltinEnabled Boolean
    Workload and node resource metrics are based on a subset of cAdvisor metrics. Depending on your Kubernetes cluster size, this may increase the CPU/memory resource consumption of your ActiveGate.
    openMetricsPipelineEnabled Boolean
    For annotation guidance, see the documentation.
    eventPatterns K8sMonitoringEventPatterns
    Define Kubernetes event filters to ingest events into your environment. For more details, see the documentation.
    filterEvents Boolean
    Include only events specified by Events Field Selectors
    includeAllFdiEvents Boolean
    For a list of included events, see the documentation.
    pvcMonitoringEnabled Boolean
    To enable dashboards and alerts, add the Kubernetes persistent volume claims extension to your environment.

    Deprecated: This attribute is deprecated, see this community guide for details.

    scope String
    The scope of this setting (KUBERNETES_CLUSTER). Omit this property if you want to cover the whole environment.
    cloudApplicationPipelineEnabled boolean
    Monitor Kubernetes namespaces, services, workloads, and pods
    eventProcessingActive boolean
    All events are monitored unless event filters are specified. All ingested events are subject to licensing by default.
    openMetricsBuiltinEnabled boolean
    Workload and node resource metrics are based on a subset of cAdvisor metrics. Depending on your Kubernetes cluster size, this may increase the CPU/memory resource consumption of your ActiveGate.
    openMetricsPipelineEnabled boolean
    For annotation guidance, see the documentation.
    eventPatterns K8sMonitoringEventPatterns
    Define Kubernetes event filters to ingest events into your environment. For more details, see the documentation.
    filterEvents boolean
    Include only events specified by Events Field Selectors
    includeAllFdiEvents boolean
    For a list of included events, see the documentation.
    pvcMonitoringEnabled boolean
    To enable dashboards and alerts, add the Kubernetes persistent volume claims extension to your environment.

    Deprecated: This attribute is deprecated, see this community guide for details.

    scope string
    The scope of this setting (KUBERNETES_CLUSTER). Omit this property if you want to cover the whole environment.
    cloud_application_pipeline_enabled bool
    Monitor Kubernetes namespaces, services, workloads, and pods
    event_processing_active bool
    All events are monitored unless event filters are specified. All ingested events are subject to licensing by default.
    open_metrics_builtin_enabled bool
    Workload and node resource metrics are based on a subset of cAdvisor metrics. Depending on your Kubernetes cluster size, this may increase the CPU/memory resource consumption of your ActiveGate.
    open_metrics_pipeline_enabled bool
    For annotation guidance, see the documentation.
    event_patterns K8sMonitoringEventPatternsArgs
    Define Kubernetes event filters to ingest events into your environment. For more details, see the documentation.
    filter_events bool
    Include only events specified by Events Field Selectors
    include_all_fdi_events bool
    For a list of included events, see the documentation.
    pvc_monitoring_enabled bool
    To enable dashboards and alerts, add the Kubernetes persistent volume claims extension to your environment.

    Deprecated: This attribute is deprecated, see this community guide for details.

    scope str
    The scope of this setting (KUBERNETES_CLUSTER). Omit this property if you want to cover the whole environment.
    cloudApplicationPipelineEnabled Boolean
    Monitor Kubernetes namespaces, services, workloads, and pods
    eventProcessingActive Boolean
    All events are monitored unless event filters are specified. All ingested events are subject to licensing by default.
    openMetricsBuiltinEnabled Boolean
    Workload and node resource metrics are based on a subset of cAdvisor metrics. Depending on your Kubernetes cluster size, this may increase the CPU/memory resource consumption of your ActiveGate.
    openMetricsPipelineEnabled Boolean
    For annotation guidance, see the documentation.
    eventPatterns Property Map
    Define Kubernetes event filters to ingest events into your environment. For more details, see the documentation.
    filterEvents Boolean
    Include only events specified by Events Field Selectors
    includeAllFdiEvents Boolean
    For a list of included events, see the documentation.
    pvcMonitoringEnabled Boolean
    To enable dashboards and alerts, add the Kubernetes persistent volume claims extension to your environment.

    Deprecated: This attribute is deprecated, see this community guide for details.

    scope String
    The scope of this setting (KUBERNETES_CLUSTER). Omit this property if you want to cover the whole environment.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the K8sMonitoring resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing K8sMonitoring Resource

    Get an existing K8sMonitoring resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: K8sMonitoringState, opts?: CustomResourceOptions): K8sMonitoring
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            cloud_application_pipeline_enabled: Optional[bool] = None,
            event_patterns: Optional[K8sMonitoringEventPatternsArgs] = None,
            event_processing_active: Optional[bool] = None,
            filter_events: Optional[bool] = None,
            include_all_fdi_events: Optional[bool] = None,
            open_metrics_builtin_enabled: Optional[bool] = None,
            open_metrics_pipeline_enabled: Optional[bool] = None,
            pvc_monitoring_enabled: Optional[bool] = None,
            scope: Optional[str] = None) -> K8sMonitoring
    func GetK8sMonitoring(ctx *Context, name string, id IDInput, state *K8sMonitoringState, opts ...ResourceOption) (*K8sMonitoring, error)
    public static K8sMonitoring Get(string name, Input<string> id, K8sMonitoringState? state, CustomResourceOptions? opts = null)
    public static K8sMonitoring get(String name, Output<String> id, K8sMonitoringState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    CloudApplicationPipelineEnabled bool
    Monitor Kubernetes namespaces, services, workloads, and pods
    EventPatterns Pulumiverse.Dynatrace.Inputs.K8sMonitoringEventPatterns
    Define Kubernetes event filters to ingest events into your environment. For more details, see the documentation.
    EventProcessingActive bool
    All events are monitored unless event filters are specified. All ingested events are subject to licensing by default.
    FilterEvents bool
    Include only events specified by Events Field Selectors
    IncludeAllFdiEvents bool
    For a list of included events, see the documentation.
    OpenMetricsBuiltinEnabled bool
    Workload and node resource metrics are based on a subset of cAdvisor metrics. Depending on your Kubernetes cluster size, this may increase the CPU/memory resource consumption of your ActiveGate.
    OpenMetricsPipelineEnabled bool
    For annotation guidance, see the documentation.
    PvcMonitoringEnabled bool
    To enable dashboards and alerts, add the Kubernetes persistent volume claims extension to your environment.

    Deprecated: This attribute is deprecated, see this community guide for details.

    Scope string
    The scope of this setting (KUBERNETES_CLUSTER). Omit this property if you want to cover the whole environment.
    CloudApplicationPipelineEnabled bool
    Monitor Kubernetes namespaces, services, workloads, and pods
    EventPatterns K8sMonitoringEventPatternsArgs
    Define Kubernetes event filters to ingest events into your environment. For more details, see the documentation.
    EventProcessingActive bool
    All events are monitored unless event filters are specified. All ingested events are subject to licensing by default.
    FilterEvents bool
    Include only events specified by Events Field Selectors
    IncludeAllFdiEvents bool
    For a list of included events, see the documentation.
    OpenMetricsBuiltinEnabled bool
    Workload and node resource metrics are based on a subset of cAdvisor metrics. Depending on your Kubernetes cluster size, this may increase the CPU/memory resource consumption of your ActiveGate.
    OpenMetricsPipelineEnabled bool
    For annotation guidance, see the documentation.
    PvcMonitoringEnabled bool
    To enable dashboards and alerts, add the Kubernetes persistent volume claims extension to your environment.

    Deprecated: This attribute is deprecated, see this community guide for details.

    Scope string
    The scope of this setting (KUBERNETES_CLUSTER). Omit this property if you want to cover the whole environment.
    cloudApplicationPipelineEnabled Boolean
    Monitor Kubernetes namespaces, services, workloads, and pods
    eventPatterns K8sMonitoringEventPatterns
    Define Kubernetes event filters to ingest events into your environment. For more details, see the documentation.
    eventProcessingActive Boolean
    All events are monitored unless event filters are specified. All ingested events are subject to licensing by default.
    filterEvents Boolean
    Include only events specified by Events Field Selectors
    includeAllFdiEvents Boolean
    For a list of included events, see the documentation.
    openMetricsBuiltinEnabled Boolean
    Workload and node resource metrics are based on a subset of cAdvisor metrics. Depending on your Kubernetes cluster size, this may increase the CPU/memory resource consumption of your ActiveGate.
    openMetricsPipelineEnabled Boolean
    For annotation guidance, see the documentation.
    pvcMonitoringEnabled Boolean
    To enable dashboards and alerts, add the Kubernetes persistent volume claims extension to your environment.

    Deprecated: This attribute is deprecated, see this community guide for details.

    scope String
    The scope of this setting (KUBERNETES_CLUSTER). Omit this property if you want to cover the whole environment.
    cloudApplicationPipelineEnabled boolean
    Monitor Kubernetes namespaces, services, workloads, and pods
    eventPatterns K8sMonitoringEventPatterns
    Define Kubernetes event filters to ingest events into your environment. For more details, see the documentation.
    eventProcessingActive boolean
    All events are monitored unless event filters are specified. All ingested events are subject to licensing by default.
    filterEvents boolean
    Include only events specified by Events Field Selectors
    includeAllFdiEvents boolean
    For a list of included events, see the documentation.
    openMetricsBuiltinEnabled boolean
    Workload and node resource metrics are based on a subset of cAdvisor metrics. Depending on your Kubernetes cluster size, this may increase the CPU/memory resource consumption of your ActiveGate.
    openMetricsPipelineEnabled boolean
    For annotation guidance, see the documentation.
    pvcMonitoringEnabled boolean
    To enable dashboards and alerts, add the Kubernetes persistent volume claims extension to your environment.

    Deprecated: This attribute is deprecated, see this community guide for details.

    scope string
    The scope of this setting (KUBERNETES_CLUSTER). Omit this property if you want to cover the whole environment.
    cloud_application_pipeline_enabled bool
    Monitor Kubernetes namespaces, services, workloads, and pods
    event_patterns K8sMonitoringEventPatternsArgs
    Define Kubernetes event filters to ingest events into your environment. For more details, see the documentation.
    event_processing_active bool
    All events are monitored unless event filters are specified. All ingested events are subject to licensing by default.
    filter_events bool
    Include only events specified by Events Field Selectors
    include_all_fdi_events bool
    For a list of included events, see the documentation.
    open_metrics_builtin_enabled bool
    Workload and node resource metrics are based on a subset of cAdvisor metrics. Depending on your Kubernetes cluster size, this may increase the CPU/memory resource consumption of your ActiveGate.
    open_metrics_pipeline_enabled bool
    For annotation guidance, see the documentation.
    pvc_monitoring_enabled bool
    To enable dashboards and alerts, add the Kubernetes persistent volume claims extension to your environment.

    Deprecated: This attribute is deprecated, see this community guide for details.

    scope str
    The scope of this setting (KUBERNETES_CLUSTER). Omit this property if you want to cover the whole environment.
    cloudApplicationPipelineEnabled Boolean
    Monitor Kubernetes namespaces, services, workloads, and pods
    eventPatterns Property Map
    Define Kubernetes event filters to ingest events into your environment. For more details, see the documentation.
    eventProcessingActive Boolean
    All events are monitored unless event filters are specified. All ingested events are subject to licensing by default.
    filterEvents Boolean
    Include only events specified by Events Field Selectors
    includeAllFdiEvents Boolean
    For a list of included events, see the documentation.
    openMetricsBuiltinEnabled Boolean
    Workload and node resource metrics are based on a subset of cAdvisor metrics. Depending on your Kubernetes cluster size, this may increase the CPU/memory resource consumption of your ActiveGate.
    openMetricsPipelineEnabled Boolean
    For annotation guidance, see the documentation.
    pvcMonitoringEnabled Boolean
    To enable dashboards and alerts, add the Kubernetes persistent volume claims extension to your environment.

    Deprecated: This attribute is deprecated, see this community guide for details.

    scope String
    The scope of this setting (KUBERNETES_CLUSTER). Omit this property if you want to cover the whole environment.

    Supporting Types

    K8sMonitoringEventPatterns, K8sMonitoringEventPatternsArgs

    K8sMonitoringEventPatternsEventPattern, K8sMonitoringEventPatternsEventPatternArgs

    Active bool
    Activate
    Label string
    Field selector name
    Pattern string
    The set of allowed characters for this field has been extended with ActiveGate version 1.259. For more details, see the documentation.
    Active bool
    Activate
    Label string
    Field selector name
    Pattern string
    The set of allowed characters for this field has been extended with ActiveGate version 1.259. For more details, see the documentation.
    active Boolean
    Activate
    label String
    Field selector name
    pattern String
    The set of allowed characters for this field has been extended with ActiveGate version 1.259. For more details, see the documentation.
    active boolean
    Activate
    label string
    Field selector name
    pattern string
    The set of allowed characters for this field has been extended with ActiveGate version 1.259. For more details, see the documentation.
    active bool
    Activate
    label str
    Field selector name
    pattern str
    The set of allowed characters for this field has been extended with ActiveGate version 1.259. For more details, see the documentation.
    active Boolean
    Activate
    label String
    Field selector name
    pattern String
    The set of allowed characters for this field has been extended with ActiveGate version 1.259. For more details, see the documentation.

    Package Details

    Repository
    dynatrace pulumiverse/pulumi-dynatrace
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the dynatrace Terraform Provider.
    dynatrace logo
    Dynatrace v0.21.0 published on Sunday, Nov 17, 2024 by Pulumiverse