Struct aws_sdk_backup::operation::create_report_plan::builders::CreateReportPlanFluentBuilder

pub struct CreateReportPlanFluentBuilder { /* private fields */ }

Fluent builder constructing a request to CreateReportPlan.

Creates a report plan. A report plan is a document that contains information about the contents of the report and where Backup will deliver it.

If you call CreateReportPlan with a plan that already exists, you receive an AlreadyExistsException exception.

Implementations

impl CreateReportPlanFluentBuilder

pub fn as_input(&self) -> &CreateReportPlanInputBuilder

Access the CreateReportPlan as a reference.

pub async fn send( self, ) -> Result<CreateReportPlanOutput, SdkError<CreateReportPlanError, HttpResponse>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn customize( self, ) -> CustomizableOperation<CreateReportPlanOutput, CreateReportPlanError, Self>

Consumes this builder, creating a customizable operation that can be modified before being sent.

pub fn report_plan_name(self, input: impl Into<String>) -> Self

The unique name of the report plan. The name must be between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).

pub fn set_report_plan_name(self, input: Option<String>) -> Self

The unique name of the report plan. The name must be between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).

pub fn get_report_plan_name(&self) -> &Option<String>

The unique name of the report plan. The name must be between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).

pub fn report_plan_description(self, input: impl Into<String>) -> Self

An optional description of the report plan with a maximum of 1,024 characters.

pub fn set_report_plan_description(self, input: Option<String>) -> Self

An optional description of the report plan with a maximum of 1,024 characters.

pub fn get_report_plan_description(&self) -> &Option<String>

An optional description of the report plan with a maximum of 1,024 characters.

pub fn report_delivery_channel(self, input: ReportDeliveryChannel) -> Self

A structure that contains information about where and how to deliver your reports, specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your reports.

pub fn set_report_delivery_channel( self, input: Option<ReportDeliveryChannel>, ) -> Self

A structure that contains information about where and how to deliver your reports, specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your reports.

pub fn get_report_delivery_channel(&self) -> &Option<ReportDeliveryChannel>

A structure that contains information about where and how to deliver your reports, specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your reports.

pub fn report_setting(self, input: ReportSetting) -> Self

Identifies 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_REPORT

If the report template is RESOURCE_COMPLIANCE_REPORT or CONTROL_COMPLIANCE_REPORT, this API resource also describes the report coverage by Amazon Web Services Regions and frameworks.

pub fn set_report_setting(self, input: Option<ReportSetting>) -> Self

Identifies 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_REPORT

If the report template is RESOURCE_COMPLIANCE_REPORT or CONTROL_COMPLIANCE_REPORT, this API resource also describes the report coverage by Amazon Web Services Regions and frameworks.

pub fn get_report_setting(&self) -> &Option<ReportSetting>

Identifies 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_REPORT

If the report template is RESOURCE_COMPLIANCE_REPORT or CONTROL_COMPLIANCE_REPORT, this API resource also describes the report coverage by Amazon Web Services Regions and frameworks.

pub fn report_plan_tags( self, k: impl Into<String>, v: impl Into<String>, ) -> Self

Adds a key-value pair to ReportPlanTags.

To override the contents of this collection use set_report_plan_tags.

Metadata that you can assign to help organize the report plans that you create. Each tag is a key-value pair.

pub fn set_report_plan_tags( self, input: Option<HashMap<String, String>>, ) -> Self

Metadata that you can assign to help organize the report plans that you create. Each tag is a key-value pair.

pub fn get_report_plan_tags(&self) -> &Option<HashMap<String, String>>

Metadata that you can assign to help organize the report plans that you create. Each tag is a key-value pair.

pub fn idempotency_token(self, input: impl Into<String>) -> Self

A customer-chosen string that you can use to distinguish between otherwise identical calls to CreateReportPlanInput. Retrying a successful request with the same idempotency token results in a success message with no action taken.

pub fn set_idempotency_token(self, input: Option<String>) -> Self

A customer-chosen string that you can use to distinguish between otherwise identical calls to CreateReportPlanInput. Retrying a successful request with the same idempotency token results in a success message with no action taken.

pub fn get_idempotency_token(&self) -> &Option<String>

A customer-chosen string that you can use to distinguish between otherwise identical calls to CreateReportPlanInput. Retrying a successful request with the same idempotency token results in a success message with no action taken.

Trait Implementations

impl Clone for CreateReportPlanFluentBuilder

fn clone(&self) -> CreateReportPlanFluentBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CreateReportPlanFluentBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.