software.amazon.awssdk.services.computeoptimizer.model

Interface ExportEbsVolumeRecommendationsRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, ComputeOptimizerRequest.Builder, CopyableBuilder<ExportEbsVolumeRecommendationsRequest.Builder,ExportEbsVolumeRecommendationsRequest>, SdkBuilder<ExportEbsVolumeRecommendationsRequest.Builder,ExportEbsVolumeRecommendationsRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

ExportEbsVolumeRecommendationsRequest

public static interface ExportEbsVolumeRecommendationsRequest.Builder
extends ComputeOptimizerRequest.Builder, SdkPojo, CopyableBuilder<ExportEbsVolumeRecommendationsRequest.Builder,ExportEbsVolumeRecommendationsRequest>

Method Summary

Modifier and Type	Method and Description
ExportEbsVolumeRecommendationsRequest.Builder	accountIds(Collection<String> accountIds) The IDs of the Amazon Web Services accounts for which to export Amazon EBS volume recommendations.
ExportEbsVolumeRecommendationsRequest.Builder	accountIds(String... accountIds) The IDs of the Amazon Web Services accounts for which to export Amazon EBS volume recommendations.
ExportEbsVolumeRecommendationsRequest.Builder	fieldsToExport(Collection<ExportableVolumeField> fieldsToExport) The recommendations data to include in the export file.
ExportEbsVolumeRecommendationsRequest.Builder	fieldsToExport(ExportableVolumeField... fieldsToExport) The recommendations data to include in the export file.
ExportEbsVolumeRecommendationsRequest.Builder	fieldsToExportWithStrings(Collection<String> fieldsToExport) The recommendations data to include in the export file.
ExportEbsVolumeRecommendationsRequest.Builder	fieldsToExportWithStrings(String... fieldsToExport) The recommendations data to include in the export file.
ExportEbsVolumeRecommendationsRequest.Builder	fileFormat(FileFormat fileFormat) The format of the export file.
ExportEbsVolumeRecommendationsRequest.Builder	fileFormat(String fileFormat) The format of the export file.
ExportEbsVolumeRecommendationsRequest.Builder	filters(Collection<EBSFilter> filters) An array of objects to specify a filter that exports a more specific set of Amazon EBS volume recommendations.
ExportEbsVolumeRecommendationsRequest.Builder	filters(Consumer<EBSFilter.Builder>... filters) An array of objects to specify a filter that exports a more specific set of Amazon EBS volume recommendations.
ExportEbsVolumeRecommendationsRequest.Builder	filters(EBSFilter... filters) An array of objects to specify a filter that exports a more specific set of Amazon EBS volume recommendations.
ExportEbsVolumeRecommendationsRequest.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.
ExportEbsVolumeRecommendationsRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
ExportEbsVolumeRecommendationsRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
default ExportEbsVolumeRecommendationsRequest.Builder	s3DestinationConfig(Consumer<S3DestinationConfig.Builder> s3DestinationConfig) Sets the value of the S3DestinationConfig property for this object.
ExportEbsVolumeRecommendationsRequest.Builder	s3DestinationConfig(S3DestinationConfig s3DestinationConfig) Sets the value of the S3DestinationConfig property for this object.

Methods inherited from interface software.amazon.awssdk.services.computeoptimizer.model.ComputeOptimizerRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

accountIds

ExportEbsVolumeRecommendationsRequest.Builder accountIds(Collection<String> accountIds)

The IDs of the Amazon Web Services accounts for which to export Amazon EBS volume 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 Amazon EBS volume 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

ExportEbsVolumeRecommendationsRequest.Builder accountIds(String... accountIds)

The IDs of the Amazon Web Services accounts for which to export Amazon EBS volume 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 Amazon EBS volume 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

ExportEbsVolumeRecommendationsRequest.Builder filters(Collection<EBSFilter> filters)

An array of objects to specify a filter that exports a more specific set of Amazon EBS volume recommendations.

Parameters:

filters - An array of objects to specify a filter that exports a more specific set of Amazon EBS volume recommendations.

Returns:

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

filters

ExportEbsVolumeRecommendationsRequest.Builder filters(EBSFilter... filters)

An array of objects to specify a filter that exports a more specific set of Amazon EBS volume recommendations.

Parameters:

filters - An array of objects to specify a filter that exports a more specific set of Amazon EBS volume recommendations.

Returns:

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

filters

ExportEbsVolumeRecommendationsRequest.Builder filters(Consumer<EBSFilter.Builder>... filters)

An array of objects to specify a filter that exports a more specific set of Amazon EBS volume recommendations.

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

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

Parameters:

filters - a consumer that will call methods on EBSFilter.Builder

Returns:

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

See Also:

#filters(java.util.Collection)

fieldsToExportWithStrings

ExportEbsVolumeRecommendationsRequest.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

ExportEbsVolumeRecommendationsRequest.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

ExportEbsVolumeRecommendationsRequest.Builder fieldsToExport(Collection<ExportableVolumeField> 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

ExportEbsVolumeRecommendationsRequest.Builder fieldsToExport(ExportableVolumeField... 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

ExportEbsVolumeRecommendationsRequest.Builder s3DestinationConfig(S3DestinationConfig s3DestinationConfig)

Sets the value of the S3DestinationConfig property for this object.

Parameters:

s3DestinationConfig - The new value for the S3DestinationConfig property for this object.

Returns:

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

s3DestinationConfig

default ExportEbsVolumeRecommendationsRequest.Builder s3DestinationConfig(Consumer<S3DestinationConfig.Builder> s3DestinationConfig)

Sets the value of the S3DestinationConfig property for this object. 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:

s3DestinationConfig(S3DestinationConfig)

fileFormat

ExportEbsVolumeRecommendationsRequest.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, FileFormat

fileFormat

ExportEbsVolumeRecommendationsRequest.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:

FileFormat, FileFormat

includeMemberAccounts

ExportEbsVolumeRecommendationsRequest.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.

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.

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.

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:

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

overrideConfiguration

ExportEbsVolumeRecommendationsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

ExportEbsVolumeRecommendationsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder