You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::ComputeOptimizer::Types::ExportAutoScalingGroupRecommendationsRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing ExportAutoScalingGroupRecommendationsRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  account_ids: ["AccountId"],
  filters: [
    {
      name: "Finding", # accepts Finding, RecommendationSourceType
      values: ["FilterValue"],
    },
  ],
  fields_to_export: ["AccountId"], # accepts AccountId, AutoScalingGroupArn, AutoScalingGroupName, Finding, UtilizationMetricsCpuMaximum, UtilizationMetricsMemoryMaximum, UtilizationMetricsEbsReadOpsPerSecondMaximum, UtilizationMetricsEbsWriteOpsPerSecondMaximum, UtilizationMetricsEbsReadBytesPerSecondMaximum, UtilizationMetricsEbsWriteBytesPerSecondMaximum, LookbackPeriodInDays, CurrentConfigurationInstanceType, CurrentConfigurationDesiredCapacity, CurrentConfigurationMinSize, CurrentConfigurationMaxSize, CurrentOnDemandPrice, CurrentStandardOneYearNoUpfrontReservedPrice, CurrentStandardThreeYearNoUpfrontReservedPrice, CurrentVCpus, CurrentMemory, CurrentStorage, CurrentNetwork, RecommendationOptionsConfigurationInstanceType, RecommendationOptionsConfigurationDesiredCapacity, RecommendationOptionsConfigurationMinSize, RecommendationOptionsConfigurationMaxSize, RecommendationOptionsProjectedUtilizationMetricsCpuMaximum, RecommendationOptionsProjectedUtilizationMetricsMemoryMaximum, RecommendationOptionsPerformanceRisk, RecommendationOptionsOnDemandPrice, RecommendationOptionsStandardOneYearNoUpfrontReservedPrice, RecommendationOptionsStandardThreeYearNoUpfrontReservedPrice, RecommendationOptionsVcpus, RecommendationOptionsMemory, RecommendationOptionsStorage, RecommendationOptionsNetwork, LastRefreshTimestamp
  s3_destination_config: { # required
    bucket: "DestinationBucket",
    key_prefix: "DestinationKeyPrefix",
  },
  file_format: "Csv", # accepts Csv
  include_member_accounts: false,
}

Instance Attribute Summary collapse

Instance Attribute Details

#account_idsArray<String>

The IDs of the AWS accounts for which to export Auto Scaling group recommendations.

If your account is the master account of an organization, use this parameter to specify the member accounts for which you want to export recommendations.

This parameter cannot be specified together with the include member accounts parameter. The parameters are mutually exclusive.

Recommendations for member accounts are not included in the export if this parameter, or the include member accounts parameter, is omitted.

You can specify multiple account IDs per request.

Returns:

  • (Array<String>)

    The IDs of the AWS accounts for which to export Auto Scaling group recommendations.

#fields_to_exportArray<String>

The recommendations data to include in the export file. For more information about the fields that can be exported, see Exported files in the Compute Optimizer User Guide.

Returns:

  • (Array<String>)

    The recommendations data to include in the export file.

#file_formatString

The format of the export file.

The only export file format currently supported is Csv.

Possible values:

  • Csv

Returns:

  • (String)

    The format of the export file.

#filtersArray<Types::Filter>

An array of objects that describe a filter to export a more specific set of Auto Scaling group recommendations.

Returns:

  • (Array<Types::Filter>)

    An array of objects that describe a filter to export a more specific set of Auto Scaling group recommendations.

#include_member_accountsBoolean

Indicates whether to include recommendations for resources in all member accounts of the organization if your account is the master account of an organization.

The member accounts must also be opted in to Compute Optimizer.

Recommendations for member accounts of the organization are not included in the export file if this parameter is omitted.

This parameter cannot be specified together with the account IDs parameter. The parameters are mutually exclusive.

Recommendations for member accounts are not included in the export if this parameter, or the account IDs parameter, is omitted.

Returns:

  • (Boolean)

    Indicates whether to include recommendations for resources in all member accounts of the organization if your account is the master account of an organization.

#s3_destination_configTypes::S3DestinationConfig

An object to specify the destination Amazon Simple Storage Service (Amazon S3) bucket name and key prefix for the export job.

You must create the destination Amazon S3 bucket for your recommendations export before you create the export job. Compute Optimizer does not create the S3 bucket for you. After you create the S3 bucket, ensure that it has the required permission policy to allow Compute Optimizer to write the export file to it. If you plan to specify an object prefix when you create the export job, you must include the object prefix in the policy that you add to the S3 bucket. For more information, see Amazon S3 Bucket Policy for Compute Optimizer in the Compute Optimizer user guide.

Returns:

  • (Types::S3DestinationConfig)

    An object to specify the destination Amazon Simple Storage Service (Amazon S3) bucket name and key prefix for the export job.