1. Packages
  2. AWS Native
  3. API Docs
  4. securityhub
  5. getAutomationRule

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.77.0 published on Wednesday, Sep 20, 2023 by Pulumi

aws-native.securityhub.getAutomationRule

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.77.0 published on Wednesday, Sep 20, 2023 by Pulumi

    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:

    RuleArn string

    An Automation Rule Arn is automatically created

    RuleArn string

    An Automation Rule Arn is automatically created

    ruleArn String

    An Automation Rule Arn is automatically created

    ruleArn string

    An Automation Rule Arn is automatically created

    rule_arn str

    An Automation Rule Arn is automatically created

    ruleArn String

    An Automation Rule Arn is automatically created

    getAutomationRule Result

    The following output properties are available:

    Actions List<Pulumi.AwsNative.SecurityHub.Outputs.AutomationRulesAction>
    CreatedAt string

    The date and time when Automation Rule was created

    CreatedBy string

    The identifier by which created the rule

    Criteria Pulumi.AwsNative.SecurityHub.Outputs.AutomationRulesFindingFilters

    The rule criteria for evaluating findings

    Description string

    Rule description

    IsTerminal bool

    If Rule is a terminal rule

    RuleArn string

    An Automation Rule Arn is automatically created

    RuleName string

    Rule name

    RuleOrder int

    Rule order value

    RuleStatus Pulumi.AwsNative.SecurityHub.AutomationRuleRuleStatus

    Status of the Rule upon creation

    Tags Pulumi.AwsNative.SecurityHub.Outputs.AutomationRuleTags
    UpdatedAt string

    The date and time when Automation Rule was last updated

    Actions []AutomationRulesAction
    CreatedAt string

    The date and time when Automation Rule was created

    CreatedBy string

    The identifier by which created the rule

    Criteria AutomationRulesFindingFilters

    The rule criteria for evaluating findings

    Description string

    Rule description

    IsTerminal bool

    If Rule is a terminal rule

    RuleArn string

    An Automation Rule Arn is automatically created

    RuleName string

    Rule name

    RuleOrder int

    Rule order value

    RuleStatus AutomationRuleRuleStatus

    Status of the Rule upon creation

    Tags AutomationRuleTags
    UpdatedAt string

    The date and time when Automation Rule was last updated

    actions List<AutomationRulesAction>
    createdAt String

    The date and time when Automation Rule was created

    createdBy String

    The identifier by which created the rule

    criteria AutomationRulesFindingFilters

    The rule criteria for evaluating findings

    description String

    Rule description

    isTerminal Boolean

    If Rule is a terminal rule

    ruleArn String

    An Automation Rule Arn is automatically created

    ruleName String

    Rule name

    ruleOrder Integer

    Rule order value

    ruleStatus AutomationRuleRuleStatus

    Status of the Rule upon creation

    tags AutomationRuleTags
    updatedAt String

    The date and time when Automation Rule was last updated

    actions AutomationRulesAction[]
    createdAt string

    The date and time when Automation Rule was created

    createdBy string

    The identifier by which created the rule

    criteria AutomationRulesFindingFilters

    The rule criteria for evaluating findings

    description string

    Rule description

    isTerminal boolean

    If Rule is a terminal rule

    ruleArn string

    An Automation Rule Arn is automatically created

    ruleName string

    Rule name

    ruleOrder number

    Rule order value

    ruleStatus AutomationRuleRuleStatus

    Status of the Rule upon creation

    tags AutomationRuleTags
    updatedAt string

    The date and time when Automation Rule was last updated

    actions Sequence[AutomationRulesAction]
    created_at str

    The date and time when Automation Rule was created

    created_by str

    The identifier by which created the rule

    criteria AutomationRulesFindingFilters

    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 AutomationRuleRuleStatus

    Status of the Rule upon creation

    tags AutomationRuleTags
    updated_at str

    The date and time when Automation Rule was last updated

    actions List<Property Map>
    createdAt String

    The date and time when Automation Rule was created

    createdBy String

    The identifier by which created the rule

    criteria Property Map

    The rule criteria for evaluating findings

    description String

    Rule description

    isTerminal Boolean

    If Rule is a terminal rule

    ruleArn String

    An Automation Rule Arn is automatically created

    ruleName String

    Rule name

    ruleOrder Number

    Rule order value

    ruleStatus "ENABLED" | "DISABLED"

    Status of the Rule upon creation

    tags Property Map
    updatedAt String

    The date and time when Automation Rule was last updated

    Supporting Types

    AutomationRuleDateFilter

    AutomationRuleDateRange

    AutomationRuleDateRangeUnit

    AutomationRuleMapFilter

    AutomationRuleMapFilterComparison

    AutomationRuleNoteUpdate

    Text string
    UpdatedBy string
    Text string
    UpdatedBy string
    text String
    updatedBy String
    text string
    updatedBy string
    text String
    updatedBy String

    AutomationRuleNumberFilter

    Eq double
    Gte double
    Lte double
    Eq float64
    Gte float64
    Lte float64
    eq Double
    gte Double
    lte Double
    eq number
    gte number
    lte number
    eq float
    gte float
    lte float
    eq Number
    gte Number
    lte Number

    AutomationRuleRelatedFinding

    Id string
    ProductArn string
    Id string
    ProductArn string
    id String
    productArn String
    id string
    productArn string
    id String
    productArn String

    AutomationRuleRuleStatus

    AutomationRuleSeverityUpdate

    AutomationRuleSeverityUpdateLabel

    AutomationRuleStringFilter

    AutomationRuleStringFilterComparison

    AutomationRuleWorkflowUpdate

    AutomationRuleWorkflowUpdateStatus

    AutomationRulesAction

    AutomationRulesActionType

    AutomationRulesFindingFieldsUpdate

    AutomationRulesFindingFieldsUpdateVerificationState

    AutomationRulesFindingFilters

    AwsAccountId List<Pulumi.AwsNative.SecurityHub.Inputs.AutomationRuleStringFilter>
    CompanyName List<Pulumi.AwsNative.SecurityHub.Inputs.AutomationRuleStringFilter>
    ComplianceAssociatedStandardsId List<Pulumi.AwsNative.SecurityHub.Inputs.AutomationRuleStringFilter>
    ComplianceSecurityControlId List<Pulumi.AwsNative.SecurityHub.Inputs.AutomationRuleStringFilter>
    ComplianceStatus List<Pulumi.AwsNative.SecurityHub.Inputs.AutomationRuleStringFilter>
    Confidence List<Pulumi.AwsNative.SecurityHub.Inputs.AutomationRuleNumberFilter>
    CreatedAt List<Pulumi.AwsNative.SecurityHub.Inputs.AutomationRuleDateFilter>
    Criticality List<Pulumi.AwsNative.SecurityHub.Inputs.AutomationRuleNumberFilter>
    Description List<Pulumi.AwsNative.SecurityHub.Inputs.AutomationRuleStringFilter>
    FirstObservedAt List<Pulumi.AwsNative.SecurityHub.Inputs.AutomationRuleDateFilter>
    GeneratorId List<Pulumi.AwsNative.SecurityHub.Inputs.AutomationRuleStringFilter>
    Id List<Pulumi.AwsNative.SecurityHub.Inputs.AutomationRuleStringFilter>
    LastObservedAt List<Pulumi.AwsNative.SecurityHub.Inputs.AutomationRuleDateFilter>
    NoteText List<Pulumi.AwsNative.SecurityHub.Inputs.AutomationRuleStringFilter>
    NoteUpdatedAt List<Pulumi.AwsNative.SecurityHub.Inputs.AutomationRuleDateFilter>
    NoteUpdatedBy List<Pulumi.AwsNative.SecurityHub.Inputs.AutomationRuleStringFilter>
    ProductArn List<Pulumi.AwsNative.SecurityHub.Inputs.AutomationRuleStringFilter>
    ProductName List<Pulumi.AwsNative.SecurityHub.Inputs.AutomationRuleStringFilter>
    RecordState List<Pulumi.AwsNative.SecurityHub.Inputs.AutomationRuleStringFilter>
    RelatedFindingsId List<Pulumi.AwsNative.SecurityHub.Inputs.AutomationRuleStringFilter>
    RelatedFindingsProductArn List<Pulumi.AwsNative.SecurityHub.Inputs.AutomationRuleStringFilter>
    ResourceDetailsOther List<Pulumi.AwsNative.SecurityHub.Inputs.AutomationRuleMapFilter>
    ResourceId List<Pulumi.AwsNative.SecurityHub.Inputs.AutomationRuleStringFilter>
    ResourcePartition List<Pulumi.AwsNative.SecurityHub.Inputs.AutomationRuleStringFilter>
    ResourceRegion List<Pulumi.AwsNative.SecurityHub.Inputs.AutomationRuleStringFilter>
    ResourceTags List<Pulumi.AwsNative.SecurityHub.Inputs.AutomationRuleMapFilter>
    ResourceType List<Pulumi.AwsNative.SecurityHub.Inputs.AutomationRuleStringFilter>
    SeverityLabel List<Pulumi.AwsNative.SecurityHub.Inputs.AutomationRuleStringFilter>
    SourceUrl List<Pulumi.AwsNative.SecurityHub.Inputs.AutomationRuleStringFilter>
    Title List<Pulumi.AwsNative.SecurityHub.Inputs.AutomationRuleStringFilter>
    Type List<Pulumi.AwsNative.SecurityHub.Inputs.AutomationRuleStringFilter>
    UpdatedAt List<Pulumi.AwsNative.SecurityHub.Inputs.AutomationRuleDateFilter>
    UserDefinedFields List<Pulumi.AwsNative.SecurityHub.Inputs.AutomationRuleMapFilter>
    VerificationState List<Pulumi.AwsNative.SecurityHub.Inputs.AutomationRuleStringFilter>
    WorkflowStatus List<Pulumi.AwsNative.SecurityHub.Inputs.AutomationRuleStringFilter>
    AwsAccountId []AutomationRuleStringFilter
    CompanyName []AutomationRuleStringFilter
    ComplianceAssociatedStandardsId []AutomationRuleStringFilter
    ComplianceSecurityControlId []AutomationRuleStringFilter
    ComplianceStatus []AutomationRuleStringFilter
    Confidence []AutomationRuleNumberFilter
    CreatedAt []AutomationRuleDateFilter
    Criticality []AutomationRuleNumberFilter
    Description []AutomationRuleStringFilter
    FirstObservedAt []AutomationRuleDateFilter
    GeneratorId []AutomationRuleStringFilter
    Id []AutomationRuleStringFilter
    LastObservedAt []AutomationRuleDateFilter
    NoteText []AutomationRuleStringFilter
    NoteUpdatedAt []AutomationRuleDateFilter
    NoteUpdatedBy []AutomationRuleStringFilter
    ProductArn []AutomationRuleStringFilter
    ProductName []AutomationRuleStringFilter
    RecordState []AutomationRuleStringFilter
    RelatedFindingsId []AutomationRuleStringFilter
    RelatedFindingsProductArn []AutomationRuleStringFilter
    ResourceDetailsOther []AutomationRuleMapFilter
    ResourceId []AutomationRuleStringFilter
    ResourcePartition []AutomationRuleStringFilter
    ResourceRegion []AutomationRuleStringFilter
    ResourceTags []AutomationRuleMapFilter
    ResourceType []AutomationRuleStringFilter
    SeverityLabel []AutomationRuleStringFilter
    SourceUrl []AutomationRuleStringFilter
    Title []AutomationRuleStringFilter
    Type []AutomationRuleStringFilter
    UpdatedAt []AutomationRuleDateFilter
    UserDefinedFields []AutomationRuleMapFilter
    VerificationState []AutomationRuleStringFilter
    WorkflowStatus []AutomationRuleStringFilter
    awsAccountId List<AutomationRuleStringFilter>
    companyName List<AutomationRuleStringFilter>
    complianceAssociatedStandardsId List<AutomationRuleStringFilter>
    complianceSecurityControlId List<AutomationRuleStringFilter>
    complianceStatus List<AutomationRuleStringFilter>
    confidence List<AutomationRuleNumberFilter>
    createdAt List<AutomationRuleDateFilter>
    criticality List<AutomationRuleNumberFilter>
    description List<AutomationRuleStringFilter>
    firstObservedAt List<AutomationRuleDateFilter>
    generatorId List<AutomationRuleStringFilter>
    id List<AutomationRuleStringFilter>
    lastObservedAt List<AutomationRuleDateFilter>
    noteText List<AutomationRuleStringFilter>
    noteUpdatedAt List<AutomationRuleDateFilter>
    noteUpdatedBy List<AutomationRuleStringFilter>
    productArn List<AutomationRuleStringFilter>
    productName List<AutomationRuleStringFilter>
    recordState List<AutomationRuleStringFilter>
    relatedFindingsId List<AutomationRuleStringFilter>
    relatedFindingsProductArn List<AutomationRuleStringFilter>
    resourceDetailsOther List<AutomationRuleMapFilter>
    resourceId List<AutomationRuleStringFilter>
    resourcePartition List<AutomationRuleStringFilter>
    resourceRegion List<AutomationRuleStringFilter>
    resourceTags List<AutomationRuleMapFilter>
    resourceType List<AutomationRuleStringFilter>
    severityLabel List<AutomationRuleStringFilter>
    sourceUrl List<AutomationRuleStringFilter>
    title List<AutomationRuleStringFilter>
    type List<AutomationRuleStringFilter>
    updatedAt List<AutomationRuleDateFilter>
    userDefinedFields List<AutomationRuleMapFilter>
    verificationState List<AutomationRuleStringFilter>
    workflowStatus List<AutomationRuleStringFilter>
    awsAccountId AutomationRuleStringFilter[]
    companyName AutomationRuleStringFilter[]
    complianceAssociatedStandardsId AutomationRuleStringFilter[]
    complianceSecurityControlId AutomationRuleStringFilter[]
    complianceStatus AutomationRuleStringFilter[]
    confidence AutomationRuleNumberFilter[]
    createdAt AutomationRuleDateFilter[]
    criticality AutomationRuleNumberFilter[]
    description AutomationRuleStringFilter[]
    firstObservedAt AutomationRuleDateFilter[]
    generatorId AutomationRuleStringFilter[]
    id AutomationRuleStringFilter[]
    lastObservedAt AutomationRuleDateFilter[]
    noteText AutomationRuleStringFilter[]
    noteUpdatedAt AutomationRuleDateFilter[]
    noteUpdatedBy AutomationRuleStringFilter[]
    productArn AutomationRuleStringFilter[]
    productName AutomationRuleStringFilter[]
    recordState AutomationRuleStringFilter[]
    relatedFindingsId AutomationRuleStringFilter[]
    relatedFindingsProductArn AutomationRuleStringFilter[]
    resourceDetailsOther AutomationRuleMapFilter[]
    resourceId AutomationRuleStringFilter[]
    resourcePartition AutomationRuleStringFilter[]
    resourceRegion AutomationRuleStringFilter[]
    resourceTags AutomationRuleMapFilter[]
    resourceType AutomationRuleStringFilter[]
    severityLabel AutomationRuleStringFilter[]
    sourceUrl AutomationRuleStringFilter[]
    title AutomationRuleStringFilter[]
    type AutomationRuleStringFilter[]
    updatedAt AutomationRuleDateFilter[]
    userDefinedFields AutomationRuleMapFilter[]
    verificationState AutomationRuleStringFilter[]
    workflowStatus AutomationRuleStringFilter[]
    aws_account_id Sequence[AutomationRuleStringFilter]
    company_name Sequence[AutomationRuleStringFilter]
    compliance_associated_standards_id Sequence[AutomationRuleStringFilter]
    compliance_security_control_id Sequence[AutomationRuleStringFilter]
    compliance_status Sequence[AutomationRuleStringFilter]
    confidence Sequence[AutomationRuleNumberFilter]
    created_at Sequence[AutomationRuleDateFilter]
    criticality Sequence[AutomationRuleNumberFilter]
    description Sequence[AutomationRuleStringFilter]
    first_observed_at Sequence[AutomationRuleDateFilter]
    generator_id Sequence[AutomationRuleStringFilter]
    id Sequence[AutomationRuleStringFilter]
    last_observed_at Sequence[AutomationRuleDateFilter]
    note_text Sequence[AutomationRuleStringFilter]
    note_updated_at Sequence[AutomationRuleDateFilter]
    note_updated_by Sequence[AutomationRuleStringFilter]
    product_arn Sequence[AutomationRuleStringFilter]
    product_name Sequence[AutomationRuleStringFilter]
    record_state Sequence[AutomationRuleStringFilter]
    related_findings_id Sequence[AutomationRuleStringFilter]
    related_findings_product_arn Sequence[AutomationRuleStringFilter]
    resource_details_other Sequence[AutomationRuleMapFilter]
    resource_id Sequence[AutomationRuleStringFilter]
    resource_partition Sequence[AutomationRuleStringFilter]
    resource_region Sequence[AutomationRuleStringFilter]
    resource_tags Sequence[AutomationRuleMapFilter]
    resource_type Sequence[AutomationRuleStringFilter]
    severity_label Sequence[AutomationRuleStringFilter]
    source_url Sequence[AutomationRuleStringFilter]
    title Sequence[AutomationRuleStringFilter]
    type Sequence[AutomationRuleStringFilter]
    updated_at Sequence[AutomationRuleDateFilter]
    user_defined_fields Sequence[AutomationRuleMapFilter]
    verification_state Sequence[AutomationRuleStringFilter]
    workflow_status Sequence[AutomationRuleStringFilter]
    awsAccountId List<Property Map>
    companyName List<Property Map>
    complianceAssociatedStandardsId List<Property Map>
    complianceSecurityControlId List<Property Map>
    complianceStatus List<Property Map>
    confidence List<Property Map>
    createdAt List<Property Map>
    criticality List<Property Map>
    description List<Property Map>
    firstObservedAt List<Property Map>
    generatorId List<Property Map>
    id List<Property Map>
    lastObservedAt List<Property Map>
    noteText List<Property Map>
    noteUpdatedAt List<Property Map>
    noteUpdatedBy List<Property Map>
    productArn List<Property Map>
    productName List<Property Map>
    recordState List<Property Map>
    relatedFindingsId List<Property Map>
    relatedFindingsProductArn List<Property Map>
    resourceDetailsOther List<Property Map>
    resourceId List<Property Map>
    resourcePartition List<Property Map>
    resourceRegion List<Property Map>
    resourceTags List<Property Map>
    resourceType List<Property Map>
    severityLabel List<Property Map>
    sourceUrl List<Property Map>
    title List<Property Map>
    type List<Property Map>
    updatedAt List<Property Map>
    userDefinedFields List<Property Map>
    verificationState List<Property Map>
    workflowStatus List<Property Map>

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.77.0 published on Wednesday, Sep 20, 2023 by Pulumi