azurerm_sentinel_alert_rule_scheduled

package
v0.0.0-...-4deecce Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 16, 2024 License: Apache-2.0 Imports: 5 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AlertDetailsOverride 

type AlertDetailsOverride struct {
	// DescriptionFormat: string, optional
	DescriptionFormat terra.StringValue `hcl:"description_format,attr"`
	// DisplayNameFormat: string, optional
	DisplayNameFormat terra.StringValue `hcl:"display_name_format,attr"`
	// SeverityColumnName: string, optional
	SeverityColumnName terra.StringValue `hcl:"severity_column_name,attr"`
	// TacticsColumnName: string, optional
	TacticsColumnName terra.StringValue `hcl:"tactics_column_name,attr"`
	// AlertDetailsOverrideDynamicProperty: min=0
	DynamicProperty []AlertDetailsOverrideDynamicProperty `hcl:"dynamic_property,block" validate:"min=0"`
}

type AlertDetailsOverrideAttributes 

type AlertDetailsOverrideAttributes struct {
	// contains filtered or unexported fields
}

func (AlertDetailsOverrideAttributes) DescriptionFormat 

func (ado AlertDetailsOverrideAttributes) DescriptionFormat() terra.StringValue

func (AlertDetailsOverrideAttributes) DisplayNameFormat 

func (ado AlertDetailsOverrideAttributes) DisplayNameFormat() terra.StringValue

func (AlertDetailsOverrideAttributes) DynamicProperty 

func (ado AlertDetailsOverrideAttributes) DynamicProperty() terra.ListValue[AlertDetailsOverrideDynamicPropertyAttributes]

func (AlertDetailsOverrideAttributes) InternalRef 

func (ado AlertDetailsOverrideAttributes) InternalRef() (terra.Reference, error)

func (AlertDetailsOverrideAttributes) InternalTokens 

func (ado AlertDetailsOverrideAttributes) InternalTokens() (hclwrite.Tokens, error)

func (AlertDetailsOverrideAttributes) InternalWithRef 

func (ado AlertDetailsOverrideAttributes) InternalWithRef(ref terra.Reference) AlertDetailsOverrideAttributes

func (AlertDetailsOverrideAttributes) SeverityColumnName 

func (ado AlertDetailsOverrideAttributes) SeverityColumnName() terra.StringValue

func (AlertDetailsOverrideAttributes) TacticsColumnName 

func (ado AlertDetailsOverrideAttributes) TacticsColumnName() terra.StringValue

type AlertDetailsOverrideDynamicProperty 

type AlertDetailsOverrideDynamicProperty struct {
	// Name: string, required
	Name terra.StringValue `hcl:"name,attr" validate:"required"`
	// Value: string, required
	Value terra.StringValue `hcl:"value,attr" validate:"required"`
}

type AlertDetailsOverrideDynamicPropertyAttributes 

type AlertDetailsOverrideDynamicPropertyAttributes struct {
	// contains filtered or unexported fields
}

func (AlertDetailsOverrideDynamicPropertyAttributes) InternalRef 

func (dp AlertDetailsOverrideDynamicPropertyAttributes) InternalRef() (terra.Reference, error)

func (AlertDetailsOverrideDynamicPropertyAttributes) InternalTokens 

func (dp AlertDetailsOverrideDynamicPropertyAttributes) InternalTokens() (hclwrite.Tokens, error)

func (AlertDetailsOverrideDynamicPropertyAttributes) InternalWithRef 

func (dp AlertDetailsOverrideDynamicPropertyAttributes) InternalWithRef(ref terra.Reference) AlertDetailsOverrideDynamicPropertyAttributes

func (AlertDetailsOverrideDynamicPropertyAttributes) Name 

func (dp AlertDetailsOverrideDynamicPropertyAttributes) Name() terra.StringValue

func (AlertDetailsOverrideDynamicPropertyAttributes) Value 

func (dp AlertDetailsOverrideDynamicPropertyAttributes) Value() terra.StringValue

type AlertDetailsOverrideDynamicPropertyState 

type AlertDetailsOverrideDynamicPropertyState struct {
	Name  string `json:"name"`
	Value string `json:"value"`
}

type AlertDetailsOverrideState 

type AlertDetailsOverrideState struct {
	DescriptionFormat  string                                     `json:"description_format"`
	DisplayNameFormat  string                                     `json:"display_name_format"`
	SeverityColumnName string                                     `json:"severity_column_name"`
	TacticsColumnName  string                                     `json:"tactics_column_name"`
	DynamicProperty    []AlertDetailsOverrideDynamicPropertyState `json:"dynamic_property"`
}

type Args 

type Args struct {
	// AlertRuleTemplateGuid: string, optional
	AlertRuleTemplateGuid terra.StringValue `hcl:"alert_rule_template_guid,attr"`
	// AlertRuleTemplateVersion: string, optional
	AlertRuleTemplateVersion terra.StringValue `hcl:"alert_rule_template_version,attr"`
	// CustomDetails: map of string, optional
	CustomDetails terra.MapValue[terra.StringValue] `hcl:"custom_details,attr"`
	// Description: string, optional
	Description terra.StringValue `hcl:"description,attr"`
	// DisplayName: string, required
	DisplayName terra.StringValue `hcl:"display_name,attr" validate:"required"`
	// Enabled: bool, optional
	Enabled terra.BoolValue `hcl:"enabled,attr"`
	// Id: string, optional
	Id terra.StringValue `hcl:"id,attr"`
	// LogAnalyticsWorkspaceId: string, required
	LogAnalyticsWorkspaceId terra.StringValue `hcl:"log_analytics_workspace_id,attr" validate:"required"`
	// Name: string, required
	Name terra.StringValue `hcl:"name,attr" validate:"required"`
	// Query: string, required
	Query terra.StringValue `hcl:"query,attr" validate:"required"`
	// QueryFrequency: string, optional
	QueryFrequency terra.StringValue `hcl:"query_frequency,attr"`
	// QueryPeriod: string, optional
	QueryPeriod terra.StringValue `hcl:"query_period,attr"`
	// Severity: string, required
	Severity terra.StringValue `hcl:"severity,attr" validate:"required"`
	// SuppressionDuration: string, optional
	SuppressionDuration terra.StringValue `hcl:"suppression_duration,attr"`
	// SuppressionEnabled: bool, optional
	SuppressionEnabled terra.BoolValue `hcl:"suppression_enabled,attr"`
	// Tactics: set of string, optional
	Tactics terra.SetValue[terra.StringValue] `hcl:"tactics,attr"`
	// Techniques: set of string, optional
	Techniques terra.SetValue[terra.StringValue] `hcl:"techniques,attr"`
	// TriggerOperator: string, optional
	TriggerOperator terra.StringValue `hcl:"trigger_operator,attr"`
	// TriggerThreshold: number, optional
	TriggerThreshold terra.NumberValue `hcl:"trigger_threshold,attr"`
	// AlertDetailsOverride: min=0
	AlertDetailsOverride []AlertDetailsOverride `hcl:"alert_details_override,block" validate:"min=0"`
	// EntityMapping: min=0,max=5
	EntityMapping []EntityMapping `hcl:"entity_mapping,block" validate:"min=0,max=5"`
	// EventGrouping: optional
	EventGrouping *EventGrouping `hcl:"event_grouping,block"`
	// IncidentConfiguration: optional
	IncidentConfiguration *IncidentConfiguration `hcl:"incident_configuration,block"`
	// SentinelEntityMapping: min=0,max=5
	SentinelEntityMapping []SentinelEntityMapping `hcl:"sentinel_entity_mapping,block" validate:"min=0,max=5"`
	// Timeouts: optional
	Timeouts *Timeouts `hcl:"timeouts,block"`
}

Args contains the configurations for azurerm_sentinel_alert_rule_scheduled.

type EntityMapping 

type EntityMapping struct {
	// EntityType: string, required
	EntityType terra.StringValue `hcl:"entity_type,attr" validate:"required"`
	// EntityMappingFieldMapping: min=1,max=3
	FieldMapping []EntityMappingFieldMapping `hcl:"field_mapping,block" validate:"min=1,max=3"`
}

type EntityMappingAttributes 

type EntityMappingAttributes struct {
	// contains filtered or unexported fields
}

func (EntityMappingAttributes) EntityType 

func (em EntityMappingAttributes) EntityType() terra.StringValue

func (EntityMappingAttributes) FieldMapping 

func (em EntityMappingAttributes) FieldMapping() terra.ListValue[EntityMappingFieldMappingAttributes]

func (EntityMappingAttributes) InternalRef 

func (em EntityMappingAttributes) InternalRef() (terra.Reference, error)

func (EntityMappingAttributes) InternalTokens 

func (em EntityMappingAttributes) InternalTokens() (hclwrite.Tokens, error)

func (EntityMappingAttributes) InternalWithRef 

func (em EntityMappingAttributes) InternalWithRef(ref terra.Reference) EntityMappingAttributes

type EntityMappingFieldMapping 

type EntityMappingFieldMapping struct {
	// ColumnName: string, required
	ColumnName terra.StringValue `hcl:"column_name,attr" validate:"required"`
	// Identifier: string, required
	Identifier terra.StringValue `hcl:"identifier,attr" validate:"required"`
}

type EntityMappingFieldMappingAttributes 

type EntityMappingFieldMappingAttributes struct {
	// contains filtered or unexported fields
}

func (EntityMappingFieldMappingAttributes) ColumnName 

func (fm EntityMappingFieldMappingAttributes) ColumnName() terra.StringValue

func (EntityMappingFieldMappingAttributes) Identifier 

func (fm EntityMappingFieldMappingAttributes) Identifier() terra.StringValue

func (EntityMappingFieldMappingAttributes) InternalRef 

func (fm EntityMappingFieldMappingAttributes) InternalRef() (terra.Reference, error)

func (EntityMappingFieldMappingAttributes) InternalTokens 

func (fm EntityMappingFieldMappingAttributes) InternalTokens() (hclwrite.Tokens, error)

func (EntityMappingFieldMappingAttributes) InternalWithRef 

func (fm EntityMappingFieldMappingAttributes) InternalWithRef(ref terra.Reference) EntityMappingFieldMappingAttributes

type EntityMappingFieldMappingState 

type EntityMappingFieldMappingState struct {
	ColumnName string `json:"column_name"`
	Identifier string `json:"identifier"`
}

type EntityMappingState 

type EntityMappingState struct {
	EntityType   string                           `json:"entity_type"`
	FieldMapping []EntityMappingFieldMappingState `json:"field_mapping"`
}

type EventGrouping 

type EventGrouping struct {
	// AggregationMethod: string, required
	AggregationMethod terra.StringValue `hcl:"aggregation_method,attr" validate:"required"`
}

type EventGroupingAttributes 

type EventGroupingAttributes struct {
	// contains filtered or unexported fields
}

func (EventGroupingAttributes) AggregationMethod 

func (eg EventGroupingAttributes) AggregationMethod() terra.StringValue

func (EventGroupingAttributes) InternalRef 

func (eg EventGroupingAttributes) InternalRef() (terra.Reference, error)

func (EventGroupingAttributes) InternalTokens 

func (eg EventGroupingAttributes) InternalTokens() (hclwrite.Tokens, error)

func (EventGroupingAttributes) InternalWithRef 

func (eg EventGroupingAttributes) InternalWithRef(ref terra.Reference) EventGroupingAttributes

type EventGroupingState 

type EventGroupingState struct {
	AggregationMethod string `json:"aggregation_method"`
}

type IncidentConfiguration 

type IncidentConfiguration struct {
	// CreateIncident: bool, required
	CreateIncident terra.BoolValue `hcl:"create_incident,attr" validate:"required"`
	// IncidentConfigurationGrouping: required
	Grouping *IncidentConfigurationGrouping `hcl:"grouping,block" validate:"required"`
}

type IncidentConfigurationAttributes 

type IncidentConfigurationAttributes struct {
	// contains filtered or unexported fields
}

func (IncidentConfigurationAttributes) CreateIncident 

func (ic IncidentConfigurationAttributes) CreateIncident() terra.BoolValue

func (IncidentConfigurationAttributes) Grouping 

func (ic IncidentConfigurationAttributes) Grouping() terra.ListValue[IncidentConfigurationGroupingAttributes]

func (IncidentConfigurationAttributes) InternalRef 

func (ic IncidentConfigurationAttributes) InternalRef() (terra.Reference, error)

func (IncidentConfigurationAttributes) InternalTokens 

func (ic IncidentConfigurationAttributes) InternalTokens() (hclwrite.Tokens, error)

func (IncidentConfigurationAttributes) InternalWithRef 

func (ic IncidentConfigurationAttributes) InternalWithRef(ref terra.Reference) IncidentConfigurationAttributes

type IncidentConfigurationGrouping 

type IncidentConfigurationGrouping struct {
	// Enabled: bool, optional
	Enabled terra.BoolValue `hcl:"enabled,attr"`
	// EntityMatchingMethod: string, optional
	EntityMatchingMethod terra.StringValue `hcl:"entity_matching_method,attr"`
	// GroupByAlertDetails: list of string, optional
	GroupByAlertDetails terra.ListValue[terra.StringValue] `hcl:"group_by_alert_details,attr"`
	// GroupByCustomDetails: list of string, optional
	GroupByCustomDetails terra.ListValue[terra.StringValue] `hcl:"group_by_custom_details,attr"`
	// GroupByEntities: list of string, optional
	GroupByEntities terra.ListValue[terra.StringValue] `hcl:"group_by_entities,attr"`
	// LookbackDuration: string, optional
	LookbackDuration terra.StringValue `hcl:"lookback_duration,attr"`
	// ReopenClosedIncidents: bool, optional
	ReopenClosedIncidents terra.BoolValue `hcl:"reopen_closed_incidents,attr"`
}

type IncidentConfigurationGroupingAttributes 

type IncidentConfigurationGroupingAttributes struct {
	// contains filtered or unexported fields
}

func (IncidentConfigurationGroupingAttributes) Enabled 

func (g IncidentConfigurationGroupingAttributes) Enabled() terra.BoolValue

func (IncidentConfigurationGroupingAttributes) EntityMatchingMethod 

func (g IncidentConfigurationGroupingAttributes) EntityMatchingMethod() terra.StringValue

func (IncidentConfigurationGroupingAttributes) GroupByAlertDetails 

func (g IncidentConfigurationGroupingAttributes) GroupByAlertDetails() terra.ListValue[terra.StringValue]

func (IncidentConfigurationGroupingAttributes) GroupByCustomDetails 

func (g IncidentConfigurationGroupingAttributes) GroupByCustomDetails() terra.ListValue[terra.StringValue]

func (IncidentConfigurationGroupingAttributes) GroupByEntities 

func (g IncidentConfigurationGroupingAttributes) GroupByEntities() terra.ListValue[terra.StringValue]

func (IncidentConfigurationGroupingAttributes) InternalRef 

func (g IncidentConfigurationGroupingAttributes) InternalRef() (terra.Reference, error)

func (IncidentConfigurationGroupingAttributes) InternalTokens 

func (g IncidentConfigurationGroupingAttributes) InternalTokens() (hclwrite.Tokens, error)

func (IncidentConfigurationGroupingAttributes) InternalWithRef 

func (g IncidentConfigurationGroupingAttributes) InternalWithRef(ref terra.Reference) IncidentConfigurationGroupingAttributes

func (IncidentConfigurationGroupingAttributes) LookbackDuration 

func (g IncidentConfigurationGroupingAttributes) LookbackDuration() terra.StringValue

func (IncidentConfigurationGroupingAttributes) ReopenClosedIncidents 

func (g IncidentConfigurationGroupingAttributes) ReopenClosedIncidents() terra.BoolValue

type IncidentConfigurationGroupingState 

type IncidentConfigurationGroupingState struct {
	Enabled               bool     `json:"enabled"`
	EntityMatchingMethod  string   `json:"entity_matching_method"`
	GroupByAlertDetails   []string `json:"group_by_alert_details"`
	GroupByCustomDetails  []string `json:"group_by_custom_details"`
	GroupByEntities       []string `json:"group_by_entities"`
	LookbackDuration      string   `json:"lookback_duration"`
	ReopenClosedIncidents bool     `json:"reopen_closed_incidents"`
}

type IncidentConfigurationState 

type IncidentConfigurationState struct {
	CreateIncident bool                                 `json:"create_incident"`
	Grouping       []IncidentConfigurationGroupingState `json:"grouping"`
}

type Resource 

type Resource struct {
	Name string
	Args Args

	DependsOn terra.Dependencies
	Lifecycle *terra.Lifecycle
	// contains filtered or unexported fields
}

Resource represents the Terraform resource azurerm_sentinel_alert_rule_scheduled.

func New 

func New(name string, args Args) *Resource

New creates a new instance of Resource.

func (*Resource) Attributes 

func (asars *Resource) Attributes() azurermSentinelAlertRuleScheduledAttributes

Attributes returns the attributes for Resource.

func (*Resource) Configuration 

func (asars *Resource) Configuration() interface{}

Configuration returns the configuration (args) for Resource.

func (*Resource) DependOn 

func (asars *Resource) DependOn() terra.Reference

DependOn is used for other resources to depend on Resource.

func (*Resource) Dependencies 

func (asars *Resource) Dependencies() terra.Dependencies

Dependencies returns the list of resources Resource depends_on.

func (*Resource) ImportState 

func (asars *Resource) ImportState(state io.Reader) error

ImportState imports the given attribute values into Resource's state.

func (*Resource) LifecycleManagement 

func (asars *Resource) LifecycleManagement() *terra.Lifecycle

LifecycleManagement returns the lifecycle block for Resource.

func (*Resource) LocalName 

func (asars *Resource) LocalName() string

LocalName returns the local name for Resource.

func (*Resource) State 

func (asars *Resource) State() (*azurermSentinelAlertRuleScheduledState, bool)

State returns the state and a bool indicating if Resource has state.

func (*Resource) StateMust 

func (asars *Resource) StateMust() *azurermSentinelAlertRuleScheduledState

StateMust returns the state for Resource. Panics if the state is nil.

func (*Resource) Type 

func (asars *Resource) Type() string

Type returns the Terraform object type for Resource.

type SentinelEntityMapping 

type SentinelEntityMapping struct {
	// ColumnName: string, required
	ColumnName terra.StringValue `hcl:"column_name,attr" validate:"required"`
}

type SentinelEntityMappingAttributes 

type SentinelEntityMappingAttributes struct {
	// contains filtered or unexported fields
}

func (SentinelEntityMappingAttributes) ColumnName 

func (sem SentinelEntityMappingAttributes) ColumnName() terra.StringValue

func (SentinelEntityMappingAttributes) InternalRef 

func (sem SentinelEntityMappingAttributes) InternalRef() (terra.Reference, error)

func (SentinelEntityMappingAttributes) InternalTokens 

func (sem SentinelEntityMappingAttributes) InternalTokens() (hclwrite.Tokens, error)

func (SentinelEntityMappingAttributes) InternalWithRef 

func (sem SentinelEntityMappingAttributes) InternalWithRef(ref terra.Reference) SentinelEntityMappingAttributes

type SentinelEntityMappingState 

type SentinelEntityMappingState struct {
	ColumnName string `json:"column_name"`
}

type Timeouts 

type Timeouts struct {
	// Create: string, optional
	Create terra.StringValue `hcl:"create,attr"`
	// Delete: string, optional
	Delete terra.StringValue `hcl:"delete,attr"`
	// Read: string, optional
	Read terra.StringValue `hcl:"read,attr"`
	// Update: string, optional
	Update terra.StringValue `hcl:"update,attr"`
}

type TimeoutsAttributes 

type TimeoutsAttributes struct {
	// contains filtered or unexported fields
}

func (TimeoutsAttributes) Create 

func (t TimeoutsAttributes) Create() terra.StringValue

func (TimeoutsAttributes) Delete 

func (t TimeoutsAttributes) Delete() terra.StringValue

func (TimeoutsAttributes) InternalRef 

func (t TimeoutsAttributes) InternalRef() (terra.Reference, error)

func (TimeoutsAttributes) InternalTokens 

func (t TimeoutsAttributes) InternalTokens() (hclwrite.Tokens, error)

func (TimeoutsAttributes) InternalWithRef 

func (t TimeoutsAttributes) InternalWithRef(ref terra.Reference) TimeoutsAttributes

func (TimeoutsAttributes) Read 

func (t TimeoutsAttributes) Read() terra.StringValue

func (TimeoutsAttributes) Update 

func (t TimeoutsAttributes) Update() terra.StringValue

type TimeoutsState 

type TimeoutsState struct {
	Create string `json:"create"`
	Delete string `json:"delete"`
	Read   string `json:"read"`
	Update string `json:"update"`
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.