Interface UpdateReportPlanRequest.Builder
- All Superinterfaces:
AwsRequest.Builder,BackupRequest.Builder,Buildable,CopyableBuilder<UpdateReportPlanRequest.Builder,,UpdateReportPlanRequest> SdkBuilder<UpdateReportPlanRequest.Builder,,UpdateReportPlanRequest> SdkPojo,SdkRequest.Builder
- Enclosing class:
UpdateReportPlanRequest
-
Method Summary
Modifier and TypeMethodDescriptionidempotencyToken(String idempotencyToken) A customer-chosen string that you can use to distinguish between otherwise identical calls toUpdateReportPlanInput.overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.default UpdateReportPlanRequest.BuilderreportDeliveryChannel(Consumer<ReportDeliveryChannel.Builder> reportDeliveryChannel) The information about where to deliver your reports, specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your reports.reportDeliveryChannel(ReportDeliveryChannel reportDeliveryChannel) The information about where to deliver your reports, specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your reports.reportPlanDescription(String reportPlanDescription) An optional description of the report plan with a maximum 1,024 characters.reportPlanName(String reportPlanName) The unique name of the report plan.default UpdateReportPlanRequest.BuilderreportSetting(Consumer<ReportSetting.Builder> reportSetting) The report template for the report.reportSetting(ReportSetting reportSetting) The report template for the report.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfigurationMethods inherited from interface software.amazon.awssdk.services.backup.model.BackupRequest.Builder
buildMethods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copyMethods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, buildMethods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
Method Details
-
reportPlanName
The unique name of the report plan. This name is between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).
- Parameters:
reportPlanName- The unique name of the report plan. This name is between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
reportPlanDescription
An optional description of the report plan with a maximum 1,024 characters.
- Parameters:
reportPlanDescription- An optional description of the report plan with a maximum 1,024 characters.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
reportDeliveryChannel
The information about where to deliver your reports, specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your reports.
- Parameters:
reportDeliveryChannel- The information about where to deliver your reports, specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your reports.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
reportDeliveryChannel
default UpdateReportPlanRequest.Builder reportDeliveryChannel(Consumer<ReportDeliveryChannel.Builder> reportDeliveryChannel) The information about where to deliver your reports, specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your reports.
This is a convenience method that creates an instance of theReportDeliveryChannel.Builderavoiding the need to create one manually viaReportDeliveryChannel.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed toreportDeliveryChannel(ReportDeliveryChannel).- Parameters:
reportDeliveryChannel- a consumer that will call methods onReportDeliveryChannel.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
reportSetting
The report template for the report. Reports are built using a report template. The report templates are:
RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORTIf the report template is
RESOURCE_COMPLIANCE_REPORTorCONTROL_COMPLIANCE_REPORT, this API resource also describes the report coverage by Amazon Web Services Regions and frameworks.- Parameters:
reportSetting- The report template for the report. Reports are built using a report template. The report templates are:RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORTIf the report template is
RESOURCE_COMPLIANCE_REPORTorCONTROL_COMPLIANCE_REPORT, this API resource also describes the report coverage by Amazon Web Services Regions and frameworks.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
reportSetting
default UpdateReportPlanRequest.Builder reportSetting(Consumer<ReportSetting.Builder> reportSetting) The report template for the report. Reports are built using a report template. The report templates are:
RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORTIf the report template is
This is a convenience method that creates an instance of theRESOURCE_COMPLIANCE_REPORTorCONTROL_COMPLIANCE_REPORT, this API resource also describes the report coverage by Amazon Web Services Regions and frameworks.ReportSetting.Builderavoiding the need to create one manually viaReportSetting.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed toreportSetting(ReportSetting).- Parameters:
reportSetting- a consumer that will call methods onReportSetting.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
idempotencyToken
A customer-chosen string that you can use to distinguish between otherwise identical calls to
UpdateReportPlanInput. Retrying a successful request with the same idempotency token results in a success message with no action taken.- Parameters:
idempotencyToken- A customer-chosen string that you can use to distinguish between otherwise identical calls toUpdateReportPlanInput. Retrying a successful request with the same idempotency token results in a success message with no action taken.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
UpdateReportPlanRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.BuilderAdd an optional request override configuration.- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder- Parameters:
overrideConfiguration- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
UpdateReportPlanRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.BuilderAdd an optional request override configuration.- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder- Parameters:
builderConsumer- AConsumerto which an emptyAwsRequestOverrideConfiguration.Builderwill be given.- Returns:
- This object for method chaining.
-