aws_sdk_arcregionswitch/client/create_plan.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3 /// Constructs a fluent builder for the [`CreatePlan`](crate::operation::create_plan::builders::CreatePlanFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`description(impl Into<String>)`](crate::operation::create_plan::builders::CreatePlanFluentBuilder::description) / [`set_description(Option<String>)`](crate::operation::create_plan::builders::CreatePlanFluentBuilder::set_description):<br>required: **false**<br><p>The description of a Region switch plan.</p><br>
7 /// - [`workflows(Workflow)`](crate::operation::create_plan::builders::CreatePlanFluentBuilder::workflows) / [`set_workflows(Option<Vec::<Workflow>>)`](crate::operation::create_plan::builders::CreatePlanFluentBuilder::set_workflows):<br>required: **true**<br><p>An array of workflows included in a Region switch plan.</p><br>
8 /// - [`execution_role(impl Into<String>)`](crate::operation::create_plan::builders::CreatePlanFluentBuilder::execution_role) / [`set_execution_role(Option<String>)`](crate::operation::create_plan::builders::CreatePlanFluentBuilder::set_execution_role):<br>required: **true**<br><p>An execution role is a way to categorize a Region switch plan.</p><br>
9 /// - [`recovery_time_objective_minutes(i32)`](crate::operation::create_plan::builders::CreatePlanFluentBuilder::recovery_time_objective_minutes) / [`set_recovery_time_objective_minutes(Option<i32>)`](crate::operation::create_plan::builders::CreatePlanFluentBuilder::set_recovery_time_objective_minutes):<br>required: **false**<br><p>Optionally, you can specify an recovery time objective for a Region switch plan, in minutes.</p><br>
10 /// - [`associated_alarms(impl Into<String>, AssociatedAlarm)`](crate::operation::create_plan::builders::CreatePlanFluentBuilder::associated_alarms) / [`set_associated_alarms(Option<HashMap::<String, AssociatedAlarm>>)`](crate::operation::create_plan::builders::CreatePlanFluentBuilder::set_associated_alarms):<br>required: **false**<br><p>The alarms associated with a Region switch plan.</p><br>
11 /// - [`triggers(Trigger)`](crate::operation::create_plan::builders::CreatePlanFluentBuilder::triggers) / [`set_triggers(Option<Vec::<Trigger>>)`](crate::operation::create_plan::builders::CreatePlanFluentBuilder::set_triggers):<br>required: **false**<br><p>The triggers associated with a Region switch plan.</p><br>
12 /// - [`name(impl Into<String>)`](crate::operation::create_plan::builders::CreatePlanFluentBuilder::name) / [`set_name(Option<String>)`](crate::operation::create_plan::builders::CreatePlanFluentBuilder::set_name):<br>required: **true**<br><p>The name of a Region switch plan.</p><br>
13 /// - [`regions(impl Into<String>)`](crate::operation::create_plan::builders::CreatePlanFluentBuilder::regions) / [`set_regions(Option<Vec::<String>>)`](crate::operation::create_plan::builders::CreatePlanFluentBuilder::set_regions):<br>required: **true**<br><p>An array that specifies the Amazon Web Services Regions for a Region switch plan. Specify two Regions.</p><br>
14 /// - [`recovery_approach(RecoveryApproach)`](crate::operation::create_plan::builders::CreatePlanFluentBuilder::recovery_approach) / [`set_recovery_approach(Option<RecoveryApproach>)`](crate::operation::create_plan::builders::CreatePlanFluentBuilder::set_recovery_approach):<br>required: **true**<br><p>The recovery approach for a Region switch plan, which can be active/active (activeActive) or active/passive (activePassive).</p><br>
15 /// - [`primary_region(impl Into<String>)`](crate::operation::create_plan::builders::CreatePlanFluentBuilder::primary_region) / [`set_primary_region(Option<String>)`](crate::operation::create_plan::builders::CreatePlanFluentBuilder::set_primary_region):<br>required: **false**<br><p>The primary Amazon Web Services Region for the application. This is the Region where the application normally runs before any Region switch occurs.</p><br>
16 /// - [`tags(impl Into<String>, impl Into<String>)`](crate::operation::create_plan::builders::CreatePlanFluentBuilder::tags) / [`set_tags(Option<HashMap::<String, String>>)`](crate::operation::create_plan::builders::CreatePlanFluentBuilder::set_tags):<br>required: **false**<br><p>The tags to apply to the Region switch plan.</p><br>
17 /// - On success, responds with [`CreatePlanOutput`](crate::operation::create_plan::CreatePlanOutput) with field(s):
18 /// - [`plan(Option<Plan>)`](crate::operation::create_plan::CreatePlanOutput::plan): <p>The details of the created Region switch plan.</p>
19 /// - On failure, responds with [`SdkError<CreatePlanError>`](crate::operation::create_plan::CreatePlanError)
20 pub fn create_plan(&self) -> crate::operation::create_plan::builders::CreatePlanFluentBuilder {
21 crate::operation::create_plan::builders::CreatePlanFluentBuilder::new(self.handle.clone())
22 }
23}