AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the AWS Security Hub CreateAutomationRule API operation.

Syntax

New-SHUBAutomationRule
-Action <AutomationRulesAction[]>
-Criteria_AwsAccountId <StringFilter[]>
-Criteria_AwsAccountName <StringFilter[]>
-Criteria_CompanyName <StringFilter[]>
-Criteria_ComplianceAssociatedStandardsId <StringFilter[]>
-Criteria_ComplianceSecurityControlId <StringFilter[]>
-Criteria_ComplianceStatus <StringFilter[]>
-Criteria_Confidence <NumberFilter[]>
-Criteria_CreatedAt <DateFilter[]>
-Criteria_Criticality <NumberFilter[]>
-Criteria_Description <StringFilter[]>
-Description <String>
-Criteria_FirstObservedAt <DateFilter[]>
-Criteria_GeneratorId <StringFilter[]>
-Criteria_Id <StringFilter[]>
-IsTerminal <Boolean>
-Criteria_LastObservedAt <DateFilter[]>
-Criteria_NoteText <StringFilter[]>
-Criteria_NoteUpdatedAt <DateFilter[]>
-Criteria_NoteUpdatedBy <StringFilter[]>
-Criteria_ProductArn <StringFilter[]>
-Criteria_ProductName <StringFilter[]>
-Criteria_RecordState <StringFilter[]>
-Criteria_RelatedFindingsId <StringFilter[]>
-Criteria_RelatedFindingsProductArn <StringFilter[]>
-Criteria_ResourceApplicationArn <StringFilter[]>
-Criteria_ResourceApplicationName <StringFilter[]>
-Criteria_ResourceDetailsOther <MapFilter[]>
-Criteria_ResourceId <StringFilter[]>
-Criteria_ResourcePartition <StringFilter[]>
-Criteria_ResourceRegion <StringFilter[]>
-Criteria_ResourceTag <MapFilter[]>
-Criteria_ResourceType <StringFilter[]>
-RuleName <String>
-RuleOrder <Int32>
-RuleStatus <RuleStatus>
-Criteria_SeverityLabel <StringFilter[]>
-Criteria_SourceUrl <StringFilter[]>
-Tag <Hashtable>
-Criteria_Title <StringFilter[]>
-Criteria_Type <StringFilter[]>
-Criteria_UpdatedAt <DateFilter[]>
-Criteria_UserDefinedField <MapFilter[]>
-Criteria_VerificationState <StringFilter[]>
-Criteria_WorkflowStatus <StringFilter[]>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonSecurityHubConfig>

Description

Creates an automation rule based on input parameters.

Parameters

-Action <AutomationRulesAction[]>
One or more actions to update finding fields if a finding matches the conditions specified in Criteria.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesActions
-ClientConfig <AmazonSecurityHubConfig>
Amazon.PowerShell.Cmdlets.SHUB.AmazonSecurityHubClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Criteria_AwsAccountId <StringFilter[]>
The Amazon Web Services account ID in which a finding was generated. Array Members: Minimum number of 1 item. Maximum number of 100 items.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Criteria_AwsAccountName <StringFilter[]>
The name of the Amazon Web Services account in which a finding was generated. Array Members: Minimum number of 1 item. Maximum number of 20 items.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Criteria_CompanyName <StringFilter[]>
The name of the company for the product that generated the finding. For control-based findings, the company is Amazon Web Services. Array Members: Minimum number of 1 item. Maximum number of 20 items.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Criteria_ComplianceAssociatedStandardsId <StringFilter[]>
The unique identifier of a standard in which a control is enabled. This field consists of the resource portion of the Amazon Resource Name (ARN) returned for a standard in the DescribeStandards API response. Array Members: Minimum number of 1 item. Maximum number of 20 items.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Criteria_ComplianceSecurityControlId <StringFilter[]>
The security control ID for which a finding was generated. Security control IDs are the same across standards. Array Members: Minimum number of 1 item. Maximum number of 20 items.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Criteria_ComplianceStatus <StringFilter[]>
The result of a security check. This field is only used for findings generated from controls. Array Members: Minimum number of 1 item. Maximum number of 20 items.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Criteria_Confidence <NumberFilter[]>
The likelihood that a finding accurately identifies the behavior or issue that it was intended to identify. Confidence is scored on a 0–100 basis using a ratio scale. A value of 0 means 0 percent confidence, and a value of 100 means 100 percent confidence. For example, a data exfiltration detection based on a statistical deviation of network traffic has low confidence because an actual exfiltration hasn't been verified. For more information, see Confidence in the Security Hub CSPM User Guide. Array Members: Minimum number of 1 item. Maximum number of 20 items.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Criteria_CreatedAt <DateFilter[]>
A timestamp that indicates when this finding record was created. For more information about the validation and formatting of timestamp fields in Security Hub CSPM, see Timestamps. Array Members: Minimum number of 1 item. Maximum number of 20 items.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Criteria_Criticality <NumberFilter[]>
The level of importance that is assigned to the resources that are associated with a finding. Criticality is scored on a 0–100 basis, using a ratio scale that supports only full integers. A score of 0 means that the underlying resources have no criticality, and a score of 100 is reserved for the most critical resources. For more information, see Criticality in the Security Hub CSPM User Guide. Array Members: Minimum number of 1 item. Maximum number of 20 items.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Criteria_Description <StringFilter[]>
A finding's description. Array Members: Minimum number of 1 item. Maximum number of 20 items.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Criteria_FirstObservedAt <DateFilter[]>
A timestamp that indicates when the potential security issue captured by a finding was first observed by the security findings product. For more information about the validation and formatting of timestamp fields in Security Hub CSPM, see Timestamps. Array Members: Minimum number of 1 item. Maximum number of 20 items.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Criteria_GeneratorId <StringFilter[]>
The identifier for the solution-specific component that generated a finding. Array Members: Minimum number of 1 item. Maximum number of 100 items.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Criteria_Id <StringFilter[]>
The product-specific identifier for a finding. Array Members: Minimum number of 1 item. Maximum number of 20 items.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Criteria_LastObservedAt <DateFilter[]>
A timestamp that indicates when the security findings provider most recently observed a change in the resource that is involved in the finding. For more information about the validation and formatting of timestamp fields in Security Hub CSPM, see Timestamps. Array Members: Minimum number of 1 item. Maximum number of 20 items.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Criteria_NoteText <StringFilter[]>
The text of a user-defined note that's added to a finding. Array Members: Minimum number of 1 item. Maximum number of 20 items.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Criteria_NoteUpdatedAt <DateFilter[]>
The timestamp of when the note was updated.For more information about the validation and formatting of timestamp fields in Security Hub CSPM, see Timestamps. Array Members: Minimum number of 1 item. Maximum number of 20 items.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Criteria_NoteUpdatedBy <StringFilter[]>
The principal that created a note. Array Members: Minimum number of 1 item. Maximum number of 20 items.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Criteria_ProductArn <StringFilter[]>
The Amazon Resource Name (ARN) for a third-party product that generated a finding in Security Hub CSPM. Array Members: Minimum number of 1 item. Maximum number of 20 items.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Criteria_ProductName <StringFilter[]>
Provides the name of the product that generated the finding. For control-based findings, the product name is Security Hub CSPM. Array Members: Minimum number of 1 item. Maximum number of 20 items.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Criteria_RecordState <StringFilter[]>
Provides the current state of a finding. Array Members: Minimum number of 1 item. Maximum number of 20 items.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Criteria_RelatedFindingsId <StringFilter[]>
The product-generated identifier for a related finding. Array Members: Minimum number of 1 item. Maximum number of 20 items.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Criteria_RelatedFindingsProductArn <StringFilter[]>
The ARN for the product that generated a related finding. Array Members: Minimum number of 1 item. Maximum number of 20 items.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Criteria_ResourceApplicationArn <StringFilter[]>
The Amazon Resource Name (ARN) of the application that is related to a finding. Array Members: Minimum number of 1 item. Maximum number of 20 items.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Criteria_ResourceApplicationName <StringFilter[]>
The name of the application that is related to a finding. Array Members: Minimum number of 1 item. Maximum number of 20 items.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Criteria_ResourceDetailsOther <MapFilter[]>
Custom fields and values about the resource that a finding pertains to. Array Members: Minimum number of 1 item. Maximum number of 20 items.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Criteria_ResourceId <StringFilter[]>
The identifier for the given resource type. For Amazon Web Services resources that are identified by Amazon Resource Names (ARNs), this is the ARN. For Amazon Web Services resources that lack ARNs, this is the identifier as defined by the Amazon Web Services service that created the resource. For non-Amazon Web Services resources, this is a unique identifier that is associated with the resource. Array Members: Minimum number of 1 item. Maximum number of 100 items.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Criteria_ResourcePartition <StringFilter[]>
The partition in which the resource that the finding pertains to is located. A partition is a group of Amazon Web Services Regions. Each Amazon Web Services account is scoped to one partition. Array Members: Minimum number of 1 item. Maximum number of 20 items.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Criteria_ResourceRegion <StringFilter[]>
The Amazon Web Services Region where the resource that a finding pertains to is located. Array Members: Minimum number of 1 item. Maximum number of 20 items.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Criteria_ResourceTag <MapFilter[]>
A list of Amazon Web Services tags associated with a resource at the time the finding was processed. Array Members: Minimum number of 1 item. Maximum number of 20 items.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCriteria_ResourceTags
-Criteria_ResourceType <StringFilter[]>
The type of resource that the finding pertains to. Array Members: Minimum number of 1 item. Maximum number of 20 items.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Criteria_SeverityLabel <StringFilter[]>
The severity value of the finding. Array Members: Minimum number of 1 item. Maximum number of 20 items.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Criteria_SourceUrl <StringFilter[]>
Provides a URL that links to a page about the current finding in the finding product. Array Members: Minimum number of 1 item. Maximum number of 20 items.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Criteria_Title <StringFilter[]>
A finding's title. Array Members: Minimum number of 1 item. Maximum number of 100 items.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Criteria_Type <StringFilter[]>
One or more finding types in the format of namespace/category/classifier that classify a finding. For a list of namespaces, classifiers, and categories, see Types taxonomy for ASFF in the Security Hub CSPM User Guide. Array Members: Minimum number of 1 item. Maximum number of 20 items.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Criteria_UpdatedAt <DateFilter[]>
A timestamp that indicates when the finding record was most recently updated. For more information about the validation and formatting of timestamp fields in Security Hub CSPM, see Timestamps. Array Members: Minimum number of 1 item. Maximum number of 20 items.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Criteria_UserDefinedField <MapFilter[]>
A list of user-defined name and value string pairs added to a finding. Array Members: Minimum number of 1 item. Maximum number of 20 items.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCriteria_UserDefinedFields
-Criteria_VerificationState <StringFilter[]>
Provides the veracity of a finding. Array Members: Minimum number of 1 item. Maximum number of 20 items.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Criteria_WorkflowStatus <StringFilter[]>
Provides information about the status of the investigation into a finding. Array Members: Minimum number of 1 item. Maximum number of 20 items.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Description <String>
A description of the rule.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-IsTerminal <Boolean>
Specifies whether a rule is the last to be applied with respect to a finding that matches the rule criteria. This is useful when a finding matches the criteria for multiple rules, and each rule has different actions. If a rule is terminal, Security Hub CSPM applies the rule action to a finding that matches the rule criteria and doesn't evaluate other rules for the finding. By default, a rule isn't terminal.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RuleName <String>
The name of the rule.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-RuleOrder <Int32>
An integer ranging from 1 to 1000 that represents the order in which the rule action is applied to findings. Security Hub CSPM applies rules with lower values for this parameter first.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-RuleStatus <RuleStatus>
Whether the rule is active after it is created. If this parameter is equal to ENABLED, Security Hub CSPM starts applying the rule to findings and finding updates after the rule is created. To change the value of this parameter after creating a rule, use BatchUpdateAutomationRules.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'RuleArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SecurityHub.Model.CreateAutomationRuleResponse). Specifying the name of a property of type Amazon.SecurityHub.Model.CreateAutomationRuleResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Tag <Hashtable>
User-defined tags associated with an automation rule.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTags

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

System.String or Amazon.SecurityHub.Model.CreateAutomationRuleResponse
This cmdlet returns a System.String object. The service call response (type Amazon.SecurityHub.Model.CreateAutomationRuleResponse) can be returned by specifying '-Select *'.
Service API Reference
User Guide
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z