Struct aws_sdk_backup::input::create_report_plan_input::Builder

pub struct Builder { /* private fields */ }

A builder for CreateReportPlanInput.

Implementations

impl Builder

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 (_).

Examples found in repository

src/client.rs (line 1591)

        pub fn report_plan_name(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.report_plan_name(input.into());
            self
        }

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 (_).

Examples found in repository

src/client.rs (line 1599)

        pub fn set_report_plan_name(
            mut self,
            input: std::option::Option<std::string::String>,
        ) -> Self {
            self.inner = self.inner.set_report_plan_name(input);
            self
        }

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.

Examples found in repository

src/client.rs (line 1604)

        pub fn report_plan_description(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.report_plan_description(input.into());
            self
        }

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.

Examples found in repository

src/client.rs (line 1612)

        pub fn set_report_plan_description(
            mut self,
            input: std::option::Option<std::string::String>,
        ) -> Self {
            self.inner = self.inner.set_report_plan_description(input);
            self
        }

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.

Examples found in repository

src/client.rs (line 1620)

        pub fn report_delivery_channel(
            mut self,
            input: crate::model::ReportDeliveryChannel,
        ) -> Self {
            self.inner = self.inner.report_delivery_channel(input);
            self
        }

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.

Examples found in repository

src/client.rs (line 1628)

        pub fn set_report_delivery_channel(
            mut self,
            input: std::option::Option<crate::model::ReportDeliveryChannel>,
        ) -> Self {
            self.inner = self.inner.set_report_delivery_channel(input);
            self
        }

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.

Examples found in repository

src/client.rs (line 1635)

        pub fn report_setting(mut self, input: crate::model::ReportSetting) -> Self {
            self.inner = self.inner.report_setting(input);
            self
        }

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.

Examples found in repository

src/client.rs (line 1645)

        pub fn set_report_setting(
            mut self,
            input: std::option::Option<crate::model::ReportSetting>,
        ) -> Self {
            self.inner = self.inner.set_report_setting(input);
            self
        }

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

Adds a key-value pair to report_plan_tags.

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.

Examples found in repository

src/client.rs (line 1658)

        pub fn report_plan_tags(
            mut self,
            k: impl Into<std::string::String>,
            v: impl Into<std::string::String>,
        ) -> Self {
            self.inner = self.inner.report_plan_tags(k.into(), v.into());
            self
        }

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.

Examples found in repository

src/client.rs (line 1668)

        pub fn set_report_plan_tags(
            mut self,
            input: std::option::Option<
                std::collections::HashMap<std::string::String, std::string::String>,
            >,
        ) -> Self {
            self.inner = self.inner.set_report_plan_tags(input);
            self
        }

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.

Examples found in repository

src/client.rs (line 1673)

        pub fn idempotency_token(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.idempotency_token(input.into());
            self
        }

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.

Examples found in repository

src/client.rs (line 1681)

        pub fn set_idempotency_token(
            mut self,
            input: std::option::Option<std::string::String>,
        ) -> Self {
            self.inner = self.inner.set_idempotency_token(input);
            self
        }

pub fn build(self) -> Result<CreateReportPlanInput, BuildError>

Consumes the builder and constructs a CreateReportPlanInput.

Examples found in repository

src/client.rs (line 1558)

        pub async fn customize(
            self,
        ) -> std::result::Result<
            crate::operation::customize::CustomizableOperation<
                crate::operation::CreateReportPlan,
                aws_http::retry::AwsResponseRetryClassifier,
            >,
            aws_smithy_http::result::SdkError<crate::error::CreateReportPlanError>,
        > {
            let handle = self.handle.clone();
            let operation = self
                .inner
                .build()
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?
                .make_operation(&handle.conf)
                .await
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?;
            Ok(crate::operation::customize::CustomizableOperation { handle, operation })
        }

        /// 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](aws_smithy_types::retry::RetryConfig), which can be
        /// set when configuring the client.
        pub async fn send(
            self,
        ) -> std::result::Result<
            crate::output::CreateReportPlanOutput,
            aws_smithy_http::result::SdkError<crate::error::CreateReportPlanError>,
        > {
            let op = self
                .inner
                .build()
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?
                .make_operation(&self.handle.conf)
                .await
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?;
            self.handle.client.call(op).await
        }

Trait Implementations

impl Clone for Builder

fn clone(&self) -> Builder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Builder

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

Formats the value using the given formatter.

impl Default for Builder

fn default() -> Builder

Returns the “default value” for a type.

impl PartialEq<Builder> for Builder

fn eq(&self, other: &Builder) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Builder