Package software.amazon.awssdk.services.computeoptimizer.model

Interface ExportEc2InstanceRecommendationsRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, ComputeOptimizerRequest.Builder, CopyableBuilder<ExportEc2InstanceRecommendationsRequest.Builder,ExportEc2InstanceRecommendationsRequest>, SdkBuilder<ExportEc2InstanceRecommendationsRequest.Builder,ExportEc2InstanceRecommendationsRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
ExportEc2InstanceRecommendationsRequest
public static interface ExportEc2InstanceRecommendationsRequest.Builder extends ComputeOptimizerRequest.Builder, SdkPojo, CopyableBuilder<ExportEc2InstanceRecommendationsRequest.Builder,ExportEc2InstanceRecommendationsRequest>

  • Method Details

    • accountIds

      ExportEc2InstanceRecommendationsRequest.Builder accountIds(Collection<String> accountIds)

      The IDs of the Amazon Web Services accounts for which to export instance recommendations.

      If your account is the management account of an organization, use this parameter to specify the member account 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.

      Parameters:
      accountIds - The IDs of the Amazon Web Services accounts for which to export instance recommendations.

      If your account is the management account of an organization, use this parameter to specify the member account 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:
      Returns a reference to this object so that method calls can be chained together.

    • accountIds

      ExportEc2InstanceRecommendationsRequest.Builder accountIds(String... accountIds)

      The IDs of the Amazon Web Services accounts for which to export instance recommendations.

      If your account is the management account of an organization, use this parameter to specify the member account 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.

      Parameters:
      accountIds - The IDs of the Amazon Web Services accounts for which to export instance recommendations.

      If your account is the management account of an organization, use this parameter to specify the member account 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:
      Returns a reference to this object so that method calls can be chained together.

    • filters

      ExportEc2InstanceRecommendationsRequest.Builder filters(Collection<Filter> filters)

      An array of objects to specify a filter that exports a more specific set of instance recommendations.

      Parameters:
      filters - An array of objects to specify a filter that exports a more specific set of instance recommendations.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • filters

      ExportEc2InstanceRecommendationsRequest.Builder filters(Filter... filters)

      An array of objects to specify a filter that exports a more specific set of instance recommendations.

      Parameters:
      filters - An array of objects to specify a filter that exports a more specific set of instance recommendations.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • filters

      ExportEc2InstanceRecommendationsRequest.Builder filters(Consumer<Filter.Builder>... filters)

      An array of objects to specify a filter that exports a more specific set of instance recommendations.

      This is a convenience method that creates an instance of the Filter.Builder avoiding the need to create one manually via Filter.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to filters(List<Filter>).

      Parameters:
      filters - a consumer that will call methods on Filter.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • fieldsToExportWithStrings

      ExportEc2InstanceRecommendationsRequest.Builder fieldsToExportWithStrings(Collection<String> fieldsToExport)

      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.

      Parameters:
      fieldsToExport - 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:
      Returns a reference to this object so that method calls can be chained together.

    • fieldsToExportWithStrings

      ExportEc2InstanceRecommendationsRequest.Builder fieldsToExportWithStrings(String... fieldsToExport)

      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.

      Parameters:
      fieldsToExport - 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:
      Returns a reference to this object so that method calls can be chained together.

    • fieldsToExport

      ExportEc2InstanceRecommendationsRequest.Builder fieldsToExport(Collection<ExportableInstanceField> fieldsToExport)

      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.

      Parameters:
      fieldsToExport - 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:
      Returns a reference to this object so that method calls can be chained together.

    • fieldsToExport

      ExportEc2InstanceRecommendationsRequest.Builder fieldsToExport(ExportableInstanceField... fieldsToExport)

      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.

      Parameters:
      fieldsToExport - 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:
      Returns a reference to this object so that method calls can be chained together.

    • s3DestinationConfig

      ExportEc2InstanceRecommendationsRequest.Builder s3DestinationConfig(S3DestinationConfig 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 permissions 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.

      Parameters:
      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 permissions 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:
      Returns a reference to this object so that method calls can be chained together.

    • s3DestinationConfig

      default ExportEc2InstanceRecommendationsRequest.Builder s3DestinationConfig(Consumer<S3DestinationConfig.Builder> 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 permissions 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.

      This is a convenience method that creates an instance of the S3DestinationConfig.Builder avoiding the need to create one manually via S3DestinationConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to s3DestinationConfig(S3DestinationConfig).

      Parameters:
      s3DestinationConfig - a consumer that will call methods on S3DestinationConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • fileFormat

      ExportEc2InstanceRecommendationsRequest.Builder fileFormat(String fileFormat)

      The format of the export file.

      The only export file format currently supported is Csv.

      Parameters:
      fileFormat - The format of the export file.

      The only export file format currently supported is Csv.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • fileFormat

      ExportEc2InstanceRecommendationsRequest.Builder fileFormat(FileFormat fileFormat)

      The format of the export file.

      The only export file format currently supported is Csv.

      Parameters:
      fileFormat - The format of the export file.

      The only export file format currently supported is Csv.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • includeMemberAccounts

      ExportEc2InstanceRecommendationsRequest.Builder includeMemberAccounts(Boolean includeMemberAccounts)

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

      The member accounts must also be opted in to Compute Optimizer, and trusted access for Compute Optimizer must be enabled in the organization account. For more information, see Compute Optimizer and Amazon Web Services Organizations trusted access in the Compute Optimizer User Guide.

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

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

      Parameters:
      includeMemberAccounts - Indicates whether to include recommendations for resources in all member accounts of the organization if your account is the management account of an organization.

      The member accounts must also be opted in to Compute Optimizer, and trusted access for Compute Optimizer must be enabled in the organization account. For more information, see Compute Optimizer and Amazon Web Services Organizations trusted access in the Compute Optimizer User Guide.

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

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

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • recommendationPreferences

      ExportEc2InstanceRecommendationsRequest.Builder recommendationPreferences(RecommendationPreferences recommendationPreferences)

      An object to specify the preferences for the Amazon EC2 instance recommendations to export.

      Parameters:
      recommendationPreferences - An object to specify the preferences for the Amazon EC2 instance recommendations to export.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • recommendationPreferences

      default ExportEc2InstanceRecommendationsRequest.Builder recommendationPreferences(Consumer<RecommendationPreferences.Builder> recommendationPreferences)

      An object to specify the preferences for the Amazon EC2 instance recommendations to export.

      This is a convenience method that creates an instance of the RecommendationPreferences.Builder avoiding the need to create one manually via RecommendationPreferences.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to recommendationPreferences(RecommendationPreferences).

      Parameters:
      recommendationPreferences - a consumer that will call methods on RecommendationPreferences.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

      ExportEc2InstanceRecommendationsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      ExportEc2InstanceRecommendationsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.