Documentation
¶
Index ¶
- type AnalysisType
- type AutoRemediationID
- type AutoRemediationParameters
- type Base64zipfile
- type Body
- type BulkUpload
- type BulkUploadResult
- type ComplianceStatus
- type DedupPeriodMinutes
- type DeleteEntry
- type DeletePolicies
- type Description
- type DisplayName
- type Enabled
- type EnabledPolicies
- type EnabledPolicy
- type Error
- type ID
- type ModifyTime
- type Paging
- type Policy
- type PolicyList
- type PolicySummary
- type Reference
- type Rule
- type RuleList
- type RuleSummary
- type Runbook
- type Severity
- type Suppress
- type Suppressions
- type Tags
- type TestErrorResult
- type TestExpectedResult
- type TestName
- type TestPolicy
- type TestPolicyResult
- type TestResource
- type TestResourceType
- type TestSuite
- type TestSummary
- type TestsErrored
- type TestsFailed
- type TestsPassed
- type TypeSet
- type UnitTest
- type UpdatePolicy
- type UpdateRule
- type UserID
- type VersionID
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AnalysisType ¶
type AnalysisType string
AnalysisType analysis type
swagger:model AnalysisType
const ( // AnalysisTypePOLICY captures enum value "POLICY" AnalysisTypePOLICY AnalysisType = "POLICY" // AnalysisTypeRULE captures enum value "RULE" AnalysisTypeRULE AnalysisType = "RULE" )
type AutoRemediationID ¶
type AutoRemediationID string
AutoRemediationID When a resource fails the policy, trigger the remediation with this ID
swagger:model autoRemediationId
type AutoRemediationParameters ¶
AutoRemediationParameters Configuration parameters passed to the remediation handler
swagger:model autoRemediationParameters
type Base64zipfile ¶
type Base64zipfile string
Base64zipfile Base64-encoded zipfile with a policy bundle
swagger:model base64zipfile
type BulkUpload ¶
type BulkUpload struct { // data // Required: true Data Base64zipfile `json:"data"` // user Id // Required: true UserID UserID `json:"userId"` }
BulkUpload bulk upload
swagger:model BulkUpload
func (*BulkUpload) MarshalBinary ¶
func (m *BulkUpload) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*BulkUpload) UnmarshalBinary ¶
func (m *BulkUpload) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type BulkUploadResult ¶
type BulkUploadResult struct { // modified policies // Required: true // Minimum: 0 ModifiedPolicies *int64 `json:"modifiedPolicies"` // modified rules // Required: true // Minimum: 0 ModifiedRules *int64 `json:"modifiedRules"` // new policies // Required: true // Minimum: 0 NewPolicies *int64 `json:"newPolicies"` // new rules // Required: true // Minimum: 0 NewRules *int64 `json:"newRules"` // total policies // Required: true // Minimum: 0 TotalPolicies *int64 `json:"totalPolicies"` // total rules // Required: true // Minimum: 0 TotalRules *int64 `json:"totalRules"` }
BulkUploadResult bulk upload result
swagger:model BulkUploadResult
func (*BulkUploadResult) MarshalBinary ¶
func (m *BulkUploadResult) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*BulkUploadResult) UnmarshalBinary ¶
func (m *BulkUploadResult) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ComplianceStatus ¶
type ComplianceStatus string
ComplianceStatus Pass/fail compliance status
swagger:model complianceStatus
const ( // ComplianceStatusERROR captures enum value "ERROR" ComplianceStatusERROR ComplianceStatus = "ERROR" // ComplianceStatusFAIL captures enum value "FAIL" ComplianceStatusFAIL ComplianceStatus = "FAIL" // ComplianceStatusPASS captures enum value "PASS" ComplianceStatusPASS ComplianceStatus = "PASS" )
type DedupPeriodMinutes ¶ added in v1.0.0
type DedupPeriodMinutes int64
DedupPeriodMinutes The time in minutes for which we deduplicate events when generating alerts for log analysis
swagger:model dedupPeriodMinutes
type DeleteEntry ¶
type DeleteEntry struct { // id // Required: true ID ID `json:"id"` }
DeleteEntry delete entry
swagger:model DeleteEntry
func (*DeleteEntry) MarshalBinary ¶
func (m *DeleteEntry) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*DeleteEntry) UnmarshalBinary ¶
func (m *DeleteEntry) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type DeletePolicies ¶
type DeletePolicies struct { // policies // Required: true // Max Items: 1000 // Min Items: 1 // Unique: true Policies []*DeleteEntry `json:"policies"` }
DeletePolicies delete policies
swagger:model DeletePolicies
func (*DeletePolicies) MarshalBinary ¶
func (m *DeletePolicies) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*DeletePolicies) UnmarshalBinary ¶
func (m *DeletePolicies) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Description ¶
type Description string
Description Summary of the policy and its purpose
swagger:model description
type DisplayName ¶
type DisplayName string
DisplayName Optional user-friendly policy name
swagger:model displayName
type Enabled ¶
type Enabled bool
Enabled True if the policy is currently being evaluated
swagger:model enabled
type EnabledPolicies ¶
type EnabledPolicies struct { // policies // Required: true Policies []*EnabledPolicy `json:"policies"` }
EnabledPolicies enabled policies
swagger:model EnabledPolicies
func (*EnabledPolicies) MarshalBinary ¶
func (m *EnabledPolicies) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*EnabledPolicies) UnmarshalBinary ¶
func (m *EnabledPolicies) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type EnabledPolicy ¶
type EnabledPolicy struct { // body Body Body `json:"body,omitempty"` // dedup period minutes DedupPeriodMinutes DedupPeriodMinutes `json:"dedupPeriodMinutes,omitempty"` // id ID ID `json:"id,omitempty"` // resource types ResourceTypes TypeSet `json:"resourceTypes,omitempty"` // severity Severity Severity `json:"severity,omitempty"` // suppressions Suppressions Suppressions `json:"suppressions,omitempty"` // version Id VersionID VersionID `json:"versionId,omitempty"` }
EnabledPolicy enabled policy
swagger:model EnabledPolicy
func (*EnabledPolicy) MarshalBinary ¶
func (m *EnabledPolicy) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*EnabledPolicy) UnmarshalBinary ¶
func (m *EnabledPolicy) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Error ¶
type Error struct { // Error message // Required: true Message *string `json:"message"` }
Error error
swagger:model Error
func (*Error) MarshalBinary ¶
MarshalBinary interface implementation
func (*Error) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type ModifyTime ¶
ModifyTime Policy modification timestamp
swagger:model modifyTime
func (*ModifyTime) MarshalBinary ¶
func (m *ModifyTime) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (ModifyTime) MarshalJSON ¶
func (m ModifyTime) MarshalJSON() ([]byte, error)
MarshalJSON retrieves a ModifyTime value as JSON output
func (*ModifyTime) UnmarshalBinary ¶
func (m *ModifyTime) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
func (*ModifyTime) UnmarshalJSON ¶
func (m *ModifyTime) UnmarshalJSON(b []byte) error
UnmarshalJSON sets a ModifyTime value from JSON input
type Paging ¶
type Paging struct { // this page // Required: true // Minimum: 1 ThisPage *int64 `json:"thisPage"` // total items // Required: true // Minimum: 1 TotalItems *int64 `json:"totalItems"` // total pages // Required: true // Minimum: 1 TotalPages *int64 `json:"totalPages"` }
Paging paging
swagger:model Paging
func (*Paging) MarshalBinary ¶
MarshalBinary interface implementation
func (*Paging) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type Policy ¶
type Policy struct { // auto remediation Id // Required: true AutoRemediationID AutoRemediationID `json:"autoRemediationId"` // auto remediation parameters // Required: true AutoRemediationParameters AutoRemediationParameters `json:"autoRemediationParameters"` // body // Required: true Body Body `json:"body"` // compliance status // Required: true ComplianceStatus ComplianceStatus `json:"complianceStatus"` // created at // Required: true // Format: date-time CreatedAt ModifyTime `json:"createdAt"` // created by // Required: true CreatedBy UserID `json:"createdBy"` // description // Required: true Description Description `json:"description"` // display name // Required: true DisplayName DisplayName `json:"displayName"` // enabled // Required: true Enabled Enabled `json:"enabled"` // id // Required: true ID ID `json:"id"` // last modified // Required: true // Format: date-time LastModified ModifyTime `json:"lastModified"` // last modified by // Required: true LastModifiedBy UserID `json:"lastModifiedBy"` // reference // Required: true Reference Reference `json:"reference"` // resource types // Required: true ResourceTypes TypeSet `json:"resourceTypes"` // runbook // Required: true Runbook Runbook `json:"runbook"` // severity // Required: true Severity Severity `json:"severity"` // suppressions // Required: true Suppressions Suppressions `json:"suppressions"` // tags // Required: true Tags Tags `json:"tags"` // tests // Required: true Tests TestSuite `json:"tests"` // version Id // Required: true VersionID VersionID `json:"versionId"` }
Policy policy
swagger:model Policy
func (*Policy) MarshalBinary ¶
MarshalBinary interface implementation
func (*Policy) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type PolicyList ¶
type PolicyList struct { // paging // Required: true Paging *Paging `json:"paging"` // policies // Required: true Policies []*PolicySummary `json:"policies"` }
PolicyList policy list
swagger:model PolicyList
func (*PolicyList) MarshalBinary ¶
func (m *PolicyList) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PolicyList) UnmarshalBinary ¶
func (m *PolicyList) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type PolicySummary ¶
type PolicySummary struct { // auto remediation Id // Required: true AutoRemediationID AutoRemediationID `json:"autoRemediationId"` // auto remediation parameters // Required: true AutoRemediationParameters AutoRemediationParameters `json:"autoRemediationParameters"` // compliance status // Required: true ComplianceStatus ComplianceStatus `json:"complianceStatus"` // display name // Required: true DisplayName DisplayName `json:"displayName"` // enabled // Required: true Enabled Enabled `json:"enabled"` // id // Required: true ID ID `json:"id"` // last modified // Required: true // Format: date-time LastModified ModifyTime `json:"lastModified"` // resource types // Required: true ResourceTypes TypeSet `json:"resourceTypes"` // severity // Required: true Severity Severity `json:"severity"` // suppressions // Required: true Suppressions Suppressions `json:"suppressions"` // tags // Required: true Tags Tags `json:"tags"` }
PolicySummary policy summary
swagger:model PolicySummary
func (*PolicySummary) MarshalBinary ¶
func (m *PolicySummary) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PolicySummary) UnmarshalBinary ¶
func (m *PolicySummary) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Reference ¶
type Reference string
Reference External documentation motivating the need for this policy
swagger:model reference
type Rule ¶
type Rule struct { // body // Required: true Body Body `json:"body"` // created at // Required: true // Format: date-time CreatedAt ModifyTime `json:"createdAt"` // created by // Required: true CreatedBy UserID `json:"createdBy"` // dedup period minutes // Required: true DedupPeriodMinutes DedupPeriodMinutes `json:"dedupPeriodMinutes"` // description // Required: true Description Description `json:"description"` // display name // Required: true DisplayName DisplayName `json:"displayName"` // enabled // Required: true Enabled Enabled `json:"enabled"` // id // Required: true ID ID `json:"id"` // last modified // Required: true // Format: date-time LastModified ModifyTime `json:"lastModified"` // last modified by // Required: true LastModifiedBy UserID `json:"lastModifiedBy"` // log types // Required: true LogTypes TypeSet `json:"logTypes"` // reference // Required: true Reference Reference `json:"reference"` // runbook // Required: true Runbook Runbook `json:"runbook"` // severity // Required: true Severity Severity `json:"severity"` // tags // Required: true Tags Tags `json:"tags"` // tests // Required: true Tests TestSuite `json:"tests"` // version Id // Required: true VersionID VersionID `json:"versionId"` }
Rule rule
swagger:model Rule
func (*Rule) MarshalBinary ¶
MarshalBinary interface implementation
func (*Rule) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type RuleList ¶
type RuleList struct { // paging // Required: true Paging *Paging `json:"paging"` // rules // Required: true Rules []*RuleSummary `json:"rules"` }
RuleList rule list
swagger:model RuleList
func (*RuleList) MarshalBinary ¶
MarshalBinary interface implementation
func (*RuleList) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type RuleSummary ¶
type RuleSummary struct { // display name // Required: true DisplayName DisplayName `json:"displayName"` // enabled // Required: true Enabled Enabled `json:"enabled"` // id // Required: true ID ID `json:"id"` // last modified // Required: true // Format: date-time LastModified ModifyTime `json:"lastModified"` // log types // Required: true LogTypes TypeSet `json:"logTypes"` // severity // Required: true Severity Severity `json:"severity"` // tags // Required: true Tags Tags `json:"tags"` }
RuleSummary rule summary
swagger:model RuleSummary
func (*RuleSummary) MarshalBinary ¶
func (m *RuleSummary) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*RuleSummary) UnmarshalBinary ¶
func (m *RuleSummary) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Runbook ¶
type Runbook string
Runbook Internal documenation about what to do when a policy fails
swagger:model runbook
type Severity ¶
type Severity string
Severity Policy severity
swagger:model severity
const ( // SeverityINFO captures enum value "INFO" SeverityINFO Severity = "INFO" // SeverityLOW captures enum value "LOW" SeverityLOW Severity = "LOW" // SeverityMEDIUM captures enum value "MEDIUM" SeverityMEDIUM Severity = "MEDIUM" // SeverityHIGH captures enum value "HIGH" SeverityHIGH Severity = "HIGH" // SeverityCRITICAL captures enum value "CRITICAL" SeverityCRITICAL Severity = "CRITICAL" )
type Suppress ¶
type Suppress struct { // policy ids // Required: true // Min Items: 1 PolicyIds []ID `json:"policyIds"` // resource patterns // Required: true ResourcePatterns Suppressions `json:"resourcePatterns"` }
Suppress suppress
swagger:model Suppress
func (*Suppress) MarshalBinary ¶
MarshalBinary interface implementation
func (*Suppress) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type Suppressions ¶
type Suppressions []string
Suppressions List of resource ID regexes that are excepted from this policy. The policy will still be evaluated, but failures will not trigger alerts nor remediations.
swagger:model suppressions
type TestErrorResult ¶
type TestErrorResult struct { // error message ErrorMessage string `json:"errorMessage,omitempty"` // name Name string `json:"name,omitempty"` }
TestErrorResult A combination of a test name and the error the test raised
swagger:model testErrorResult
func (*TestErrorResult) MarshalBinary ¶
func (m *TestErrorResult) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*TestErrorResult) UnmarshalBinary ¶
func (m *TestErrorResult) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type TestExpectedResult ¶
type TestExpectedResult bool
TestExpectedResult The expected outcome when running a unit test
swagger:model testExpectedResult
type TestPolicy ¶
type TestPolicy struct { // analysis type // Required: true AnalysisType AnalysisType `json:"analysisType"` // body // Required: true Body Body `json:"body"` // resource types // Required: true ResourceTypes TypeSet `json:"resourceTypes"` // tests // Required: true Tests TestSuite `json:"tests"` }
TestPolicy test policy
swagger:model TestPolicy
func (*TestPolicy) MarshalBinary ¶
func (m *TestPolicy) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*TestPolicy) UnmarshalBinary ¶
func (m *TestPolicy) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type TestPolicyResult ¶
type TestPolicyResult struct { // test summary // Required: true TestSummary TestSummary `json:"testSummary"` // tests errored // Required: true TestsErrored TestsErrored `json:"testsErrored"` // tests failed // Required: true TestsFailed TestsFailed `json:"testsFailed"` // tests passed // Required: true TestsPassed TestsPassed `json:"testsPassed"` }
TestPolicyResult test policy result
swagger:model TestPolicyResult
func (*TestPolicyResult) MarshalBinary ¶
func (m *TestPolicyResult) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*TestPolicyResult) UnmarshalBinary ¶
func (m *TestPolicyResult) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type TestResource ¶
type TestResource string
TestResource The resource (or log event) the unit test is running against
swagger:model testResource
type TestResourceType ¶
type TestResourceType string
TestResourceType The resource or log type of an individual unit test
swagger:model testResourceType
type TestSummary ¶
type TestSummary bool
TestSummary True if all tests passed
swagger:model testSummary
type TestsErrored ¶
type TestsErrored []*TestErrorResult
TestsErrored List of names of tests that raised an error, along with their error message
swagger:model testsErrored
type TestsFailed ¶
type TestsFailed []string
TestsFailed List of names of tests that failed
swagger:model testsFailed
type TestsPassed ¶
type TestsPassed []string
TestsPassed List of names of tests that passed
swagger:model testsPassed
type TypeSet ¶
type TypeSet []string
TypeSet List of resource/log types to which this policy applies
swagger:model TypeSet
type UnitTest ¶
type UnitTest struct { // expected result // Required: true ExpectedResult TestExpectedResult `json:"expectedResult"` // name // Required: true Name TestName `json:"name"` // resource // Required: true Resource TestResource `json:"resource"` // resource type // Required: true ResourceType TestResourceType `json:"resourceType"` }
UnitTest unit test
swagger:model UnitTest
func (*UnitTest) MarshalBinary ¶
MarshalBinary interface implementation
func (*UnitTest) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type UpdatePolicy ¶
type UpdatePolicy struct { // auto remediation Id AutoRemediationID AutoRemediationID `json:"autoRemediationId,omitempty"` // auto remediation parameters AutoRemediationParameters AutoRemediationParameters `json:"autoRemediationParameters,omitempty"` // body // Required: true Body Body `json:"body"` // description Description Description `json:"description,omitempty"` // display name DisplayName DisplayName `json:"displayName,omitempty"` // enabled // Required: true Enabled Enabled `json:"enabled"` // id // Required: true ID ID `json:"id"` // reference Reference Reference `json:"reference,omitempty"` // resource types ResourceTypes TypeSet `json:"resourceTypes,omitempty"` // runbook Runbook Runbook `json:"runbook,omitempty"` // severity // Required: true Severity Severity `json:"severity"` // suppressions Suppressions Suppressions `json:"suppressions,omitempty"` // tags Tags Tags `json:"tags,omitempty"` // tests Tests TestSuite `json:"tests,omitempty"` // user Id // Required: true UserID UserID `json:"userId"` }
UpdatePolicy update policy
swagger:model UpdatePolicy
func (*UpdatePolicy) MarshalBinary ¶
func (m *UpdatePolicy) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*UpdatePolicy) UnmarshalBinary ¶
func (m *UpdatePolicy) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type UpdateRule ¶
type UpdateRule struct { // body // Required: true Body Body `json:"body"` // dedup period minutes DedupPeriodMinutes DedupPeriodMinutes `json:"dedupPeriodMinutes,omitempty"` // description Description Description `json:"description,omitempty"` // display name DisplayName DisplayName `json:"displayName,omitempty"` // enabled // Required: true Enabled Enabled `json:"enabled"` // id // Required: true ID ID `json:"id"` // log types LogTypes TypeSet `json:"logTypes,omitempty"` // reference Reference Reference `json:"reference,omitempty"` // runbook Runbook Runbook `json:"runbook,omitempty"` // severity // Required: true Severity Severity `json:"severity"` // tags Tags Tags `json:"tags,omitempty"` // tests Tests TestSuite `json:"tests,omitempty"` // user Id // Required: true UserID UserID `json:"userId"` }
UpdateRule update rule
swagger:model UpdateRule
func (*UpdateRule) MarshalBinary ¶
func (m *UpdateRule) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*UpdateRule) UnmarshalBinary ¶
func (m *UpdateRule) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
Source Files
¶
- analysis_type.go
- auto_remediation_id.go
- auto_remediation_parameters.go
- base64zipfile.go
- body.go
- bulk_upload.go
- bulk_upload_result.go
- compliance_status.go
- dedup_period_minutes.go
- delete_entry.go
- delete_policies.go
- description.go
- display_name.go
- enabled.go
- enabled_policies.go
- enabled_policy.go
- error.go
- id.go
- modify_time.go
- paging.go
- policy.go
- policy_list.go
- policy_summary.go
- reference.go
- rule.go
- rule_list.go
- rule_summary.go
- runbook.go
- severity.go
- suppress.go
- suppressions.go
- tags.go
- test_error_result.go
- test_expected_result.go
- test_name.go
- test_policy.go
- test_policy_result.go
- test_resource.go
- test_resource_type.go
- test_suite.go
- test_summary.go
- tests_errored.go
- tests_failed.go
- tests_passed.go
- type_set.go
- unit_test_swagger.go
- update_policy.go
- update_rule.go
- user_id.go
- version_id.go