Write-CORecommendationPreference Cmdlet

Amazon.PowerShell.Cmdlets.CO.AmazonComputeOptimizerClientCmdlet.ClientConfig

The status of the enhanced infrastructure metrics recommendation preference to create or update.Specify the Active status to activate the preference, or specify Inactive to deactivate the preference.For more information, see Enhanced infrastructure metrics in the Compute Optimizer User Guide.

Contains the source options for external metrics preferences.

This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.

The status of the inferred workload types recommendation preference to create or update.The inferred workload type feature is active by default. To deactivate it, create a recommendation preference.Specify the Inactive status to deactivate the feature, or specify Active to activate it.For more information, see Inferred workload types in the Compute Optimizer User Guide.

The preference to control the number of days the utilization metrics of the Amazon Web Services resource are analyzed. When this preference isn't specified, we use the default value DAYS_14. You can only set this preference for the Amazon EC2 instance and Auto Scaling group resource types.

• Amazon EC2 instance lookback preferences can be set at the organization, account, and resource levels.
• Auto Scaling group lookback preferences can only be set at the resource level.

Changes the cmdlet behavior to return the value passed to the ResourceType parameter. The -PassThru parameter is deprecated, use -Select '^ResourceType' instead. This parameter will be removed in a future version.

The preference to control which resource type values are considered when generating rightsizing recommendations. You can specify this preference as a combination of include and exclude lists. You must specify either an includeList or excludeList. If the preference is an empty set of resource type values, an error occurs. You can only set this preference for the Amazon EC2 instance and Auto Scaling group resource types.

The target resource type of the recommendation preference to create.The Ec2Instance option encompasses standalone instances and instances that are part of Auto Scaling groups. The AutoScalingGroup option encompasses only instances that are part of an Auto Scaling group.

The status of the savings estimation mode preference to create or update. Specify the AfterDiscounts status to activate the preference, or specify BeforeDiscounts to deactivate the preference.Only the account manager or delegated administrator of your organization can activate this preference.For more information, see Savings estimation mode in the Compute Optimizer User Guide.

The name of the scope.The following scopes are possible:

• Organization - Specifies that the recommendation preference applies at the organization level, for all member accounts of an organization.
• AccountId - Specifies that the recommendation preference applies at the account level, for all resources of a given resource type in an account.
• ResourceArn - Specifies that the recommendation preference applies at the individual resource level.

The value of the scope.If you specified the name of the scope as:

• Organization - The value must be ALL_ACCOUNTS.
• AccountId - The value must be a 12-digit Amazon Web Services account ID.
• ResourceArn - The value must be the Amazon Resource Name (ARN) of an EC2 instance or an Auto Scaling group.

Only EC2 instance and Auto Scaling group ARNs are currently supported.

Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ComputeOptimizer.Model.PutRecommendationPreferencesResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.

The preference to control the resource’s CPU utilization threshold, CPU utilization headroom, and memory utilization headroom. When this preference isn't specified, we use the following default values. CPU utilization:

• P99_5 for threshold
• PERCENT_20 for headroom

Memory utilization:

• PERCENT_20 for headroom

• You can only set CPU and memory utilization preferences for the Amazon EC2 instance resource type.
• The threshold setting isn’t available for memory utilization.

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.

An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.

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.

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.

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.

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.

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.

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.

The session token if the access and secret keys are temporary session-based credentials.