AWS Native is in preview. AWS Classic is fully supported.
aws-native.securityhub.getAutomationRule
Explore with Pulumi AI
AWS Native is in preview. AWS Classic is fully supported.
The AWS::SecurityHub::AutomationRule resource represents the Automation Rule in your account. One rule resource is created for each Automation Rule in which you configure rule criteria and actions.
Using getAutomationRule
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getAutomationRule(args: GetAutomationRuleArgs, opts?: InvokeOptions): Promise<GetAutomationRuleResult>
function getAutomationRuleOutput(args: GetAutomationRuleOutputArgs, opts?: InvokeOptions): Output<GetAutomationRuleResult>
def get_automation_rule(rule_arn: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetAutomationRuleResult
def get_automation_rule_output(rule_arn: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetAutomationRuleResult]
func LookupAutomationRule(ctx *Context, args *LookupAutomationRuleArgs, opts ...InvokeOption) (*LookupAutomationRuleResult, error)
func LookupAutomationRuleOutput(ctx *Context, args *LookupAutomationRuleOutputArgs, opts ...InvokeOption) LookupAutomationRuleResultOutput
> Note: This function is named LookupAutomationRule
in the Go SDK.
public static class GetAutomationRule
{
public static Task<GetAutomationRuleResult> InvokeAsync(GetAutomationRuleArgs args, InvokeOptions? opts = null)
public static Output<GetAutomationRuleResult> Invoke(GetAutomationRuleInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetAutomationRuleResult> getAutomationRule(GetAutomationRuleArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: aws-native:securityhub:getAutomationRule
arguments:
# arguments dictionary
The following arguments are supported:
- Rule
Arn string An Automation Rule Arn is automatically created
- Rule
Arn string An Automation Rule Arn is automatically created
- rule
Arn String An Automation Rule Arn is automatically created
- rule
Arn string An Automation Rule Arn is automatically created
- rule_
arn str An Automation Rule Arn is automatically created
- rule
Arn String An Automation Rule Arn is automatically created
getAutomationRule Result
The following output properties are available:
- Actions
List<Pulumi.
Aws Native. Security Hub. Outputs. Automation Rules Action> - Created
At string The date and time when Automation Rule was created
- Created
By string The identifier by which created the rule
- Criteria
Pulumi.
Aws Native. Security Hub. Outputs. Automation Rules Finding Filters The rule criteria for evaluating findings
- Description string
Rule description
- Is
Terminal bool If Rule is a terminal rule
- Rule
Arn string An Automation Rule Arn is automatically created
- Rule
Name string Rule name
- Rule
Order int Rule order value
- Rule
Status Pulumi.Aws Native. Security Hub. Automation Rule Rule Status Status of the Rule upon creation
- Pulumi.
Aws Native. Security Hub. Outputs. Automation Rule Tags - Updated
At string The date and time when Automation Rule was last updated
- Actions
[]Automation
Rules Action - Created
At string The date and time when Automation Rule was created
- Created
By string The identifier by which created the rule
- Criteria
Automation
Rules Finding Filters The rule criteria for evaluating findings
- Description string
Rule description
- Is
Terminal bool If Rule is a terminal rule
- Rule
Arn string An Automation Rule Arn is automatically created
- Rule
Name string Rule name
- Rule
Order int Rule order value
- Rule
Status AutomationRule Rule Status Status of the Rule upon creation
- Automation
Rule Tags - Updated
At string The date and time when Automation Rule was last updated
- actions
List<Automation
Rules Action> - created
At String The date and time when Automation Rule was created
- created
By String The identifier by which created the rule
- criteria
Automation
Rules Finding Filters The rule criteria for evaluating findings
- description String
Rule description
- is
Terminal Boolean If Rule is a terminal rule
- rule
Arn String An Automation Rule Arn is automatically created
- rule
Name String Rule name
- rule
Order Integer Rule order value
- rule
Status AutomationRule Rule Status Status of the Rule upon creation
- Automation
Rule Tags - updated
At String The date and time when Automation Rule was last updated
- actions
Automation
Rules Action[] - created
At string The date and time when Automation Rule was created
- created
By string The identifier by which created the rule
- criteria
Automation
Rules Finding Filters The rule criteria for evaluating findings
- description string
Rule description
- is
Terminal boolean If Rule is a terminal rule
- rule
Arn string An Automation Rule Arn is automatically created
- rule
Name string Rule name
- rule
Order number Rule order value
- rule
Status AutomationRule Rule Status Status of the Rule upon creation
- Automation
Rule Tags - updated
At string The date and time when Automation Rule was last updated
- actions
Sequence[Automation
Rules Action] - created_
at str The date and time when Automation Rule was created
- created_
by str The identifier by which created the rule
- criteria
Automation
Rules Finding Filters The rule criteria for evaluating findings
- description str
Rule description
- is_
terminal bool If Rule is a terminal rule
- rule_
arn str An Automation Rule Arn is automatically created
- rule_
name str Rule name
- rule_
order int Rule order value
- rule_
status AutomationRule Rule Status Status of the Rule upon creation
- Automation
Rule Tags - updated_
at str The date and time when Automation Rule was last updated
- actions List<Property Map>
- created
At String The date and time when Automation Rule was created
- created
By String The identifier by which created the rule
- criteria Property Map
The rule criteria for evaluating findings
- description String
Rule description
- is
Terminal Boolean If Rule is a terminal rule
- rule
Arn String An Automation Rule Arn is automatically created
- rule
Name String Rule name
- rule
Order Number Rule order value
- rule
Status "ENABLED" | "DISABLED" Status of the Rule upon creation
- Property Map
- updated
At String The date and time when Automation Rule was last updated
Supporting Types
AutomationRuleDateFilter
- Date
Range AutomationRule Date Range - End string
- Start string
- date
Range AutomationRule Date Range - end String
- start String
- date
Range AutomationRule Date Range - end string
- start string
- date
Range Property Map - end String
- start String
AutomationRuleDateRange
- Unit
Automation
Rule Date Range Unit - Value float64
AutomationRuleDateRangeUnit
AutomationRuleMapFilter
- Comparison
Automation
Rule Map Filter Comparison - Key string
- Value string
- comparison
Automation
Rule Map Filter Comparison - key String
- value String
- comparison
Automation
Rule Map Filter Comparison - key string
- value string
AutomationRuleMapFilterComparison
AutomationRuleNoteUpdate
- text str
- updated_
by str
AutomationRuleNumberFilter
AutomationRuleRelatedFinding
- Id string
- Product
Arn string
- Id string
- Product
Arn string
- id String
- product
Arn String
- id string
- product
Arn string
- id str
- product_
arn str
- id String
- product
Arn String
AutomationRuleRuleStatus
AutomationRuleSeverityUpdate
- label
Automation
Rule Severity Update Label - normalized Integer
- product Double
- label
Automation
Rule Severity Update Label - normalized number
- product number
AutomationRuleSeverityUpdateLabel
AutomationRuleStringFilter
AutomationRuleStringFilterComparison
AutomationRuleWorkflowUpdate
AutomationRuleWorkflowUpdateStatus
AutomationRulesAction
AutomationRulesActionType
AutomationRulesFindingFieldsUpdate
- Confidence int
- Criticality int
- Note
Pulumi.
Aws Native. Security Hub. Inputs. Automation Rule Note Update Note added to the finding
- List<Pulumi.
Aws Native. Security Hub. Inputs. Automation Rule Related Finding> - Severity
Pulumi.
Aws Native. Security Hub. Inputs. Automation Rule Severity Update Severity of the finding
- Types List<string>
- User
Defined Pulumi.Fields Aws Native. Security Hub. Inputs. Automation Rulemap - Verification
State Pulumi.Aws Native. Security Hub. Automation Rules Finding Fields Update Verification State - Workflow
Pulumi.
Aws Native. Security Hub. Inputs. Automation Rule Workflow Update Workflow status set for the finding
- Confidence int
- Criticality int
- Note
Automation
Rule Note Update Note added to the finding
- []Automation
Rule Related Finding - Severity
Automation
Rule Severity Update Severity of the finding
- Types []string
- User
Defined AutomationFields Rulemap - Verification
State AutomationRules Finding Fields Update Verification State - Workflow
Automation
Rule Workflow Update Workflow status set for the finding
- confidence Integer
- criticality Integer
- note
Automation
Rule Note Update Note added to the finding
- List<Automation
Rule Related Finding> - severity
Automation
Rule Severity Update Severity of the finding
- types List<String>
- user
Defined AutomationFields Rulemap - verification
State AutomationRules Finding Fields Update Verification State - workflow
Automation
Rule Workflow Update Workflow status set for the finding
- confidence number
- criticality number
- note
Automation
Rule Note Update Note added to the finding
- Automation
Rule Related Finding[] - severity
Automation
Rule Severity Update Severity of the finding
- types string[]
- user
Defined AutomationFields Rulemap - verification
State AutomationRules Finding Fields Update Verification State - workflow
Automation
Rule Workflow Update Workflow status set for the finding
- confidence int
- criticality int
- note
Automation
Rule Note Update Note added to the finding
- Sequence[Automation
Rule Related Finding] - severity
Automation
Rule Severity Update Severity of the finding
- types Sequence[str]
- user_
defined_ Automationfields Rulemap - verification_
state AutomationRules Finding Fields Update Verification State - workflow
Automation
Rule Workflow Update Workflow status set for the finding
- confidence Number
- criticality Number
- note Property Map
Note added to the finding
- List<Property Map>
- severity Property Map
Severity of the finding
- types List<String>
- user
Defined Property MapFields - verification
State "UNKNOWN" | "TRUE_POSITIVE" | "FALSE_POSITIVE" | "BENIGN_POSITIVE" - workflow Property Map
Workflow status set for the finding
AutomationRulesFindingFieldsUpdateVerificationState
AutomationRulesFindingFilters
- Aws
Account List<Pulumi.Id Aws Native. Security Hub. Inputs. Automation Rule String Filter> - Company
Name List<Pulumi.Aws Native. Security Hub. Inputs. Automation Rule String Filter> - Compliance
Associated List<Pulumi.Standards Id Aws Native. Security Hub. Inputs. Automation Rule String Filter> - Compliance
Security List<Pulumi.Control Id Aws Native. Security Hub. Inputs. Automation Rule String Filter> - Compliance
Status List<Pulumi.Aws Native. Security Hub. Inputs. Automation Rule String Filter> - Confidence
List<Pulumi.
Aws Native. Security Hub. Inputs. Automation Rule Number Filter> - Created
At List<Pulumi.Aws Native. Security Hub. Inputs. Automation Rule Date Filter> - Criticality
List<Pulumi.
Aws Native. Security Hub. Inputs. Automation Rule Number Filter> - Description
List<Pulumi.
Aws Native. Security Hub. Inputs. Automation Rule String Filter> - First
Observed List<Pulumi.At Aws Native. Security Hub. Inputs. Automation Rule Date Filter> - Generator
Id List<Pulumi.Aws Native. Security Hub. Inputs. Automation Rule String Filter> - Id
List<Pulumi.
Aws Native. Security Hub. Inputs. Automation Rule String Filter> - Last
Observed List<Pulumi.At Aws Native. Security Hub. Inputs. Automation Rule Date Filter> - Note
Text List<Pulumi.Aws Native. Security Hub. Inputs. Automation Rule String Filter> - Note
Updated List<Pulumi.At Aws Native. Security Hub. Inputs. Automation Rule Date Filter> - Note
Updated List<Pulumi.By Aws Native. Security Hub. Inputs. Automation Rule String Filter> - Product
Arn List<Pulumi.Aws Native. Security Hub. Inputs. Automation Rule String Filter> - Product
Name List<Pulumi.Aws Native. Security Hub. Inputs. Automation Rule String Filter> - Record
State List<Pulumi.Aws Native. Security Hub. Inputs. Automation Rule String Filter> - List<Pulumi.
Aws Native. Security Hub. Inputs. Automation Rule String Filter> - List<Pulumi.
Aws Native. Security Hub. Inputs. Automation Rule String Filter> - Resource
Details List<Pulumi.Other Aws Native. Security Hub. Inputs. Automation Rule Map Filter> - Resource
Id List<Pulumi.Aws Native. Security Hub. Inputs. Automation Rule String Filter> - Resource
Partition List<Pulumi.Aws Native. Security Hub. Inputs. Automation Rule String Filter> - Resource
Region List<Pulumi.Aws Native. Security Hub. Inputs. Automation Rule String Filter> - List<Pulumi.
Aws Native. Security Hub. Inputs. Automation Rule Map Filter> - Resource
Type List<Pulumi.Aws Native. Security Hub. Inputs. Automation Rule String Filter> - Severity
Label List<Pulumi.Aws Native. Security Hub. Inputs. Automation Rule String Filter> - Source
Url List<Pulumi.Aws Native. Security Hub. Inputs. Automation Rule String Filter> - Title
List<Pulumi.
Aws Native. Security Hub. Inputs. Automation Rule String Filter> - Type
List<Pulumi.
Aws Native. Security Hub. Inputs. Automation Rule String Filter> - Updated
At List<Pulumi.Aws Native. Security Hub. Inputs. Automation Rule Date Filter> - User
Defined List<Pulumi.Fields Aws Native. Security Hub. Inputs. Automation Rule Map Filter> - Verification
State List<Pulumi.Aws Native. Security Hub. Inputs. Automation Rule String Filter> - Workflow
Status List<Pulumi.Aws Native. Security Hub. Inputs. Automation Rule String Filter>
- Aws
Account []AutomationId Rule String Filter - Company
Name []AutomationRule String Filter - Compliance
Associated []AutomationStandards Id Rule String Filter - Compliance
Security []AutomationControl Id Rule String Filter - Compliance
Status []AutomationRule String Filter - Confidence
[]Automation
Rule Number Filter - Created
At []AutomationRule Date Filter - Criticality
[]Automation
Rule Number Filter - Description
[]Automation
Rule String Filter - First
Observed []AutomationAt Rule Date Filter - Generator
Id []AutomationRule String Filter - Id
[]Automation
Rule String Filter - Last
Observed []AutomationAt Rule Date Filter - Note
Text []AutomationRule String Filter - Note
Updated []AutomationAt Rule Date Filter - Note
Updated []AutomationBy Rule String Filter - Product
Arn []AutomationRule String Filter - Product
Name []AutomationRule String Filter - Record
State []AutomationRule String Filter - []Automation
Rule String Filter - []Automation
Rule String Filter - Resource
Details []AutomationOther Rule Map Filter - Resource
Id []AutomationRule String Filter - Resource
Partition []AutomationRule String Filter - Resource
Region []AutomationRule String Filter - []Automation
Rule Map Filter - Resource
Type []AutomationRule String Filter - Severity
Label []AutomationRule String Filter - Source
Url []AutomationRule String Filter - Title
[]Automation
Rule String Filter - Type
[]Automation
Rule String Filter - Updated
At []AutomationRule Date Filter - User
Defined []AutomationFields Rule Map Filter - Verification
State []AutomationRule String Filter - Workflow
Status []AutomationRule String Filter
- aws
Account List<AutomationId Rule String Filter> - company
Name List<AutomationRule String Filter> - compliance
Associated List<AutomationStandards Id Rule String Filter> - compliance
Security List<AutomationControl Id Rule String Filter> - compliance
Status List<AutomationRule String Filter> - confidence
List<Automation
Rule Number Filter> - created
At List<AutomationRule Date Filter> - criticality
List<Automation
Rule Number Filter> - description
List<Automation
Rule String Filter> - first
Observed List<AutomationAt Rule Date Filter> - generator
Id List<AutomationRule String Filter> - id
List<Automation
Rule String Filter> - last
Observed List<AutomationAt Rule Date Filter> - note
Text List<AutomationRule String Filter> - note
Updated List<AutomationAt Rule Date Filter> - note
Updated List<AutomationBy Rule String Filter> - product
Arn List<AutomationRule String Filter> - product
Name List<AutomationRule String Filter> - record
State List<AutomationRule String Filter> - List<Automation
Rule String Filter> - List<Automation
Rule String Filter> - resource
Details List<AutomationOther Rule Map Filter> - resource
Id List<AutomationRule String Filter> - resource
Partition List<AutomationRule String Filter> - resource
Region List<AutomationRule String Filter> - List<Automation
Rule Map Filter> - resource
Type List<AutomationRule String Filter> - severity
Label List<AutomationRule String Filter> - source
Url List<AutomationRule String Filter> - title
List<Automation
Rule String Filter> - type
List<Automation
Rule String Filter> - updated
At List<AutomationRule Date Filter> - user
Defined List<AutomationFields Rule Map Filter> - verification
State List<AutomationRule String Filter> - workflow
Status List<AutomationRule String Filter>
- aws
Account AutomationId Rule String Filter[] - company
Name AutomationRule String Filter[] - compliance
Associated AutomationStandards Id Rule String Filter[] - compliance
Security AutomationControl Id Rule String Filter[] - compliance
Status AutomationRule String Filter[] - confidence
Automation
Rule Number Filter[] - created
At AutomationRule Date Filter[] - criticality
Automation
Rule Number Filter[] - description
Automation
Rule String Filter[] - first
Observed AutomationAt Rule Date Filter[] - generator
Id AutomationRule String Filter[] - id
Automation
Rule String Filter[] - last
Observed AutomationAt Rule Date Filter[] - note
Text AutomationRule String Filter[] - note
Updated AutomationAt Rule Date Filter[] - note
Updated AutomationBy Rule String Filter[] - product
Arn AutomationRule String Filter[] - product
Name AutomationRule String Filter[] - record
State AutomationRule String Filter[] - Automation
Rule String Filter[] - Automation
Rule String Filter[] - resource
Details AutomationOther Rule Map Filter[] - resource
Id AutomationRule String Filter[] - resource
Partition AutomationRule String Filter[] - resource
Region AutomationRule String Filter[] - Automation
Rule Map Filter[] - resource
Type AutomationRule String Filter[] - severity
Label AutomationRule String Filter[] - source
Url AutomationRule String Filter[] - title
Automation
Rule String Filter[] - type
Automation
Rule String Filter[] - updated
At AutomationRule Date Filter[] - user
Defined AutomationFields Rule Map Filter[] - verification
State AutomationRule String Filter[] - workflow
Status AutomationRule String Filter[]
- aws_
account_ Sequence[Automationid Rule String Filter] - company_
name Sequence[AutomationRule String Filter] - compliance_
associated_ Sequence[Automationstandards_ id Rule String Filter] - compliance_
security_ Sequence[Automationcontrol_ id Rule String Filter] - compliance_
status Sequence[AutomationRule String Filter] - confidence
Sequence[Automation
Rule Number Filter] - created_
at Sequence[AutomationRule Date Filter] - criticality
Sequence[Automation
Rule Number Filter] - description
Sequence[Automation
Rule String Filter] - first_
observed_ Sequence[Automationat Rule Date Filter] - generator_
id Sequence[AutomationRule String Filter] - id
Sequence[Automation
Rule String Filter] - last_
observed_ Sequence[Automationat Rule Date Filter] - note_
text Sequence[AutomationRule String Filter] - note_
updated_ Sequence[Automationat Rule Date Filter] - note_
updated_ Sequence[Automationby Rule String Filter] - product_
arn Sequence[AutomationRule String Filter] - product_
name Sequence[AutomationRule String Filter] - record_
state Sequence[AutomationRule String Filter] - Sequence[Automation
Rule String Filter] - Sequence[Automation
Rule String Filter] - resource_
details_ Sequence[Automationother Rule Map Filter] - resource_
id Sequence[AutomationRule String Filter] - resource_
partition Sequence[AutomationRule String Filter] - resource_
region Sequence[AutomationRule String Filter] - Sequence[Automation
Rule Map Filter] - resource_
type Sequence[AutomationRule String Filter] - severity_
label Sequence[AutomationRule String Filter] - source_
url Sequence[AutomationRule String Filter] - title
Sequence[Automation
Rule String Filter] - type
Sequence[Automation
Rule String Filter] - updated_
at Sequence[AutomationRule Date Filter] - user_
defined_ Sequence[Automationfields Rule Map Filter] - verification_
state Sequence[AutomationRule String Filter] - workflow_
status Sequence[AutomationRule String Filter]
- aws
Account List<Property Map>Id - company
Name List<Property Map> - compliance
Associated List<Property Map>Standards Id - compliance
Security List<Property Map>Control Id - compliance
Status List<Property Map> - confidence List<Property Map>
- created
At List<Property Map> - criticality List<Property Map>
- description List<Property Map>
- first
Observed List<Property Map>At - generator
Id List<Property Map> - id List<Property Map>
- last
Observed List<Property Map>At - note
Text List<Property Map> - note
Updated List<Property Map>At - note
Updated List<Property Map>By - product
Arn List<Property Map> - product
Name List<Property Map> - record
State List<Property Map> - List<Property Map>
- List<Property Map>
- resource
Details List<Property Map>Other - resource
Id List<Property Map> - resource
Partition List<Property Map> - resource
Region List<Property Map> - List<Property Map>
- resource
Type List<Property Map> - severity
Label List<Property Map> - source
Url List<Property Map> - title List<Property Map>
- type List<Property Map>
- updated
At List<Property Map> - user
Defined List<Property Map>Fields - verification
State List<Property Map> - workflow
Status List<Property Map>
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
AWS Native is in preview. AWS Classic is fully supported.