Struct aws_sdk_backup::operation::create_report_plan::CreateReportPlanInput

#[non_exhaustive]
pub struct CreateReportPlanInput {
    pub report_plan_name: Option<String>,
    pub report_plan_description: Option<String>,
    pub report_delivery_channel: Option<ReportDeliveryChannel>,
    pub report_setting: Option<ReportSetting>,
    pub report_plan_tags: Option<HashMap<String, String>>,
    pub idempotency_token: Option<String>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

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

report_plan_description: Option<String>

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

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

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

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

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

Implementations

impl CreateReportPlanInput

pub fn report_plan_name(&self) -> Option<&str>

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) -> Option<&str>

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

pub fn 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) -> 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) -> 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) -> Option<&str>

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.

impl CreateReportPlanInput

pub fn builder() -> CreateReportPlanInputBuilder

Creates a new builder-style object to manufacture CreateReportPlanInput.

Trait Implementations

impl Clone for CreateReportPlanInput

fn clone(&self) -> CreateReportPlanInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateReportPlanInput

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

Formats the value using the given formatter.

impl PartialEq for CreateReportPlanInput

fn eq(&self, other: &CreateReportPlanInput) -> 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 CreateReportPlanInput