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 Compute Optimizer Automation Service CreateAutomationRule API operation.

Syntax

New-COAAutomationRule
-OrganizationConfiguration_AccountId <String[]>
-Description <String>
-Criteria_EbsVolumeSizeInGib <IntegerCriteriaCondition[]>
-Criteria_EbsVolumeType <StringCriteriaCondition[]>
-Criteria_EstimatedMonthlySaving <DoubleCriteriaCondition[]>
-Schedule_ExecutionWindowInMinute <Int32>
-Criteria_LookBackPeriodInDay <IntegerCriteriaCondition[]>
-Name <String>
-Priority <String>
-RecommendedActionType <String[]>
-Criteria_Region <StringCriteriaCondition[]>
-Criteria_ResourceArn <StringCriteriaCondition[]>
-Criteria_ResourceTag <ResourceTagsCriteriaCondition[]>
-Criteria_RestartNeeded <StringCriteriaCondition[]>
-OrganizationConfiguration_RuleApplyOrder <RuleApplyOrder>
-RuleType <RuleType>
-Schedule_ScheduleExpression <String>
-Schedule_ScheduleExpressionTimezone <String>
-Status <RuleStatus>
-Tag <Tag[]>
-ClientToken <String>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonComputeOptimizerAutomationConfig>

Description

Creates a new automation rule to apply recommended actions to resources based on specified criteria.

Parameters

-ClientConfig <AmazonComputeOptimizerAutomationConfig>
Amazon.PowerShell.Cmdlets.COA.AmazonComputeOptimizerAutomationClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientToken <String>
A unique identifier to ensure idempotency of the request.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Criteria_EbsVolumeSizeInGib <IntegerCriteriaCondition[]>
Filter criteria for EBS volume sizes in gibibytes (GiB). Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Criteria_EbsVolumeType <StringCriteriaCondition[]>
Filter criteria for EBS volume types, such as gp2, gp3, io1, io2, st1, or sc1. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Criteria_EstimatedMonthlySaving <DoubleCriteriaCondition[]>
Filter criteria for estimated monthly cost savings from the recommended action. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCriteria_EstimatedMonthlySavings
-Criteria_LookBackPeriodInDay <IntegerCriteriaCondition[]>
Filter criteria for the lookback period in days used to analyze resource utilization. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCriteria_LookBackPeriodInDays
-Criteria_Region <StringCriteriaCondition[]>
Filter criteria for Amazon Web Services regions where resources must be located. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Criteria_ResourceArn <StringCriteriaCondition[]>
Filter criteria for specific resource ARNs to include or exclude. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Criteria_ResourceTag <ResourceTagsCriteriaCondition[]>
Filter criteria for resource tags, allowing filtering by tag key and value combinations. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Criteria_RestartNeeded <StringCriteriaCondition[]>
Filter criteria indicating whether the recommended action requires a resource restart. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Description <String>
A description of the automation rule.
Required?False
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)
-Name <String>
The name of the automation rule.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-OrganizationConfiguration_AccountId <String[]>
List of specific Amazon Web Services account IDs where the organization rule should be applied. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOrganizationConfiguration_AccountIds
-OrganizationConfiguration_RuleApplyOrder <RuleApplyOrder>
Specifies when organization rules should be applied relative to account rules.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Priority <String>
A string representation of a decimal number between 0 and 1 (having up to 30 digits after the decimal point) that determines the priority of the rule. When multiple rules match the same recommended action, Compute Optimizer assigns the action to the rule with the lowest priority value (highest priority), even if that rule is scheduled to run later than other matching rules.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RecommendedActionType <String[]>
The types of recommended actions this rule will automate. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRecommendedActionTypes
-RuleType <RuleType>
The type of rule. Only the management account or a delegated administrator can set the ruleType to be OrganizationRule.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-Schedule_ExecutionWindowInMinute <Int32>
The time window in minutes during which the automation rule can start implementing recommended actions.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSchedule_ExecutionWindowInMinutes
-Schedule_ScheduleExpression <String>
The expression that defines when the schedule runs. cron expression is supported. A cron expression consists of six fields separated by white spaces: (minuteshoursday_of_monthmonthday_of_weekyear)You can schedule rules to run at most once per day. Your cron expression must use specific values (not wildcards) for the minutes and hours fields. For example: (30 12 * * *) runs daily at 12:30 PM UTC.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Schedule_ScheduleExpressionTimezone <String>
The timezone to use when interpreting the schedule expression.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ComputeOptimizerAutomation.Model.CreateAutomationRuleResponse). Specifying the name of a property of type Amazon.ComputeOptimizerAutomation.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)
-Status <RuleStatus>
The status of the rule
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-Tag <Tag[]>
The tags to associate with the rule. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
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

Amazon.ComputeOptimizerAutomation.Model.CreateAutomationRuleResponse
This cmdlet returns an Amazon.ComputeOptimizerAutomation.Model.CreateAutomationRuleResponse object containing multiple properties.
AWS Tools for PowerShell User Guide

Supported Version

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