Module Awso_arc_region_switch.ValuesSource

Sourceval service : Awso.Service.t
Sourceval apiVersion : string
Sourceval endpointPrefix : string
Sourceval serviceFullName : string
Sourceval signatureVersion : string
Sourceval protocol : string
Sourceval globalEndpoint : string
Sourceval targetPrefix : string
Sourceval simple_to_json : ('a -> Awso__Botodata.value) -> 'a -> Yojson.Safe.t
Sourceval composed_to_json : ('a -> Awso__Botodata.value) -> 'a -> Yojson.Safe.t
Sourceval to_query : ('a -> Awso.Client.Query.value) -> 'a -> Awso.Client.Query.t
Sourceval structure_to_value_aux : ('a * 'b option) list -> f:(('a * 'b) list -> 'c) -> [> `Structure of 'c ]
Sourceval structure_to_value : ('a * 'b option) list -> [> `Structure of ('a * 'b) list ]
Sourceval structure_to_wrapped_value : wrapper:'a -> response:'a -> ('b * 'c option) list -> [> `Structure of ('a * [> `Structure of ('b * 'c) list ]) list ]
Sourcemodule Timestamp : sig ... end
Sourcemodule String_ : sig ... end
Sourcemodule PlanArn : sig ... end
Sourcemodule ExecutionState : sig ... end
Sourcemodule ExecutionMode : sig ... end
Sourcemodule ExecutionId : sig ... end
Sourcemodule ExecutionAction : sig ... end
Sourcemodule Duration : sig ... end
Sourcemodule AbbreviatedExecution : sig ... end

A summarized representation of a plan execution. This structure contains key information about an execution without all the detailed step data.

Sourcemodule AbbreviatedExecutionsList : sig ... end
Sourcemodule Region : sig ... end
Sourcemodule RegionList : sig ... end
Sourcemodule RecoveryApproach : sig ... end
Sourcemodule PlanName : sig ... end
Sourcemodule AccountId : sig ... end
Sourcemodule AbbreviatedPlan : sig ... end

A summarized representation of a Region switch plan. This structure contains key information about a plan without all the detailed workflow and step data.

Sourcemodule AccessDeniedException : sig ... end

You do not have sufficient access to perform this action. HTTP Status Code: 403

Sourcemodule AlarmCondition : sig ... end
Sourcemodule AlarmType : sig ... end
Sourcemodule Approval : sig ... end
Sourcemodule StepName : sig ... end
Sourcemodule ExecutionComment : sig ... end

Approves a step in a plan execution that requires manual approval. When you create a plan, you can include approval steps that require manual intervention before the execution can proceed. This operation allows you to provide that approval. You must specify the plan ARN, execution ID, step name, and approval status. You can also provide an optional comment explaining the approval decision.

Sourcemodule ResourceNotFoundException : sig ... end

The specified resource was not found. HTTP Status Code: 404

Approves a step in a plan execution that requires manual approval. When you create a plan, you can include approval steps that require manual intervention before the execution can proceed. This operation allows you to provide that approval. You must specify the plan ARN, execution ID, step name, and approval status. You can also provide an optional comment explaining the approval decision.

Sourcemodule RoutingControlStateChange : sig ... end
Sourcemodule RoutingControlArn : sig ... end
Sourcemodule ArcRoutingControlState : sig ... end

Represents the state of an ARC routing control.

Sourcemodule ArcRoutingControlStates : sig ... end
Sourcemodule RegionAndRoutingControls : sig ... end
Sourcemodule IamRoleArn : sig ... end

Configuration for ARC routing controls used in a Region switch plan. Routing controls are simple on/off switches that you can use to shift traffic away from an impaired Region.

Sourcemodule AsgArn : sig ... end
Sourcemodule Asg : sig ... end

Configuration for an Amazon EC2 Auto Scaling group used in a Region switch plan.

Sourcemodule AsgList : sig ... end
Sourcemodule AssociatedAlarm : sig ... end

An Amazon CloudWatch alarm associated with a Region switch plan. These alarms can be used to trigger automatic execution of the plan.

Sourcemodule AssociatedAlarmMap : sig ... end
Sourcemodule AuroraClusterArn : sig ... end
Sourcemodule AuroraClusterArns : sig ... end

Cancels an in-progress plan execution. This operation stops the execution of the plan and prevents any further steps from being processed. You must specify the plan ARN and execution ID. You can also provide an optional comment explaining why the execution was canceled.

Cancels an in-progress plan execution. This operation stops the execution of the plan and prevents any further steps from being processed. You must specify the plan ARN and execution ID. You can also provide an optional comment explaining why the execution was canceled.

Sourcemodule WorkflowTargetAction : sig ... end
Sourcemodule ExecutionBlockType : sig ... end
Sourcemodule Route53ResourceRecordSet : sig ... end

The Amazon Route 53 record set.

Sourcemodule Route53RecordName : sig ... end
Sourcemodule Route53HostedZoneId : sig ... end

The Amazon Route 53 health check configuration.

Configuration for nested Region switch plans. This allows one Region switch plan to trigger another plan as part of its execution.

Sourcemodule RdsDbInstanceArn : sig ... end
Sourcemodule RdsDbInstanceArnMap : sig ... end

Configuration for promoting an Amazon RDS read replica to a standalone database instance during a Region switch.

Configuration for creating an Amazon RDS cross-Region read replica during post-recovery in a Region switch.

Sourcemodule EventSourceMappingArn : sig ... end
Sourcemodule EventSourceMapping : sig ... end

The Amazon Web Services Lambda event source mapping configuration, containing the resource ARN and optional cross-account configuration.

Specifies whether to skip enabling or disabling an event source mapping during an ungraceful execution.

Sourcemodule EventSourceMappingAction : sig ... end

Configuration for Amazon Web Services Lambda event source mappings used in a Region switch plan.

Sourcemodule GlobalClusterIdentifier : sig ... end
Sourcemodule GlobalAuroraUngraceful : sig ... end

Configuration for handling failures when performing operations on Aurora global databases.

Sourcemodule GlobalAuroraConfiguration : sig ... end

Configuration for Amazon Aurora global databases used in a Region switch plan.

Sourcemodule RoleArn : sig ... end

Configuration for approval steps in a Region switch plan execution. Approval steps require manual intervention before the execution can proceed.

Sourcemodule KubernetesNamespace : sig ... end
Sourcemodule KubernetesScalingResource : sig ... end

Defines a Kubernetes resource to scale in an Amazon EKS cluster.

Sourcemodule RegionalScalingResource : sig ... end
Sourcemodule KubernetesScalingApps : sig ... end
Sourcemodule KubernetesResourceType : sig ... end

Defines the type of Kubernetes resource to scale in an Amazon EKS cluster.

The ungraceful settings for Amazon Web Services EKS resource scaling.

Sourcemodule EksClusterArn : sig ... end
Sourcemodule EksCluster : sig ... end

The Amazon Web Services EKS cluster execution block configuration.

Sourcemodule EksClusters : sig ... end

The Amazon Web Services EKS resource scaling configuration.

Sourcemodule EcsServiceArn : sig ... end
Sourcemodule EcsClusterArn : sig ... end
Sourcemodule Service : sig ... end

The service for a cross account role.

Sourcemodule ServiceList : sig ... end
Sourcemodule Integer : sig ... end
Sourcemodule EcsUngraceful : sig ... end

The settings for ungraceful execution.

The configuration for an Amazon Web Services ECS capacity increase.

Sourcemodule Ec2Ungraceful : sig ... end

Configuration for handling failures when performing operations on EC2 resources.

Configuration for increasing the capacity of Amazon EC2 Auto Scaling groups during a Region switch.

Sourcemodule DocumentDbUngraceful : sig ... end

Configuration for handling failures when performing operations on DocumentDB global clusters.

Sourcemodule DocumentDbDefaultBehavior : sig ... end
Sourcemodule DocumentDbClusterArn : sig ... end
Sourcemodule DocumentDbClusterArns : sig ... end
Sourcemodule DocumentDbConfiguration : sig ... end

Configuration for Amazon DocumentDB global clusters used in a Region switch plan.

Sourcemodule RegionToRunIn : sig ... end
Sourcemodule LambdaUngracefulBehavior : sig ... end
Sourcemodule LambdaUngraceful : sig ... end

Configuration for handling failures when invoking Lambda functions.

Sourcemodule LambdaArn : sig ... end
Sourcemodule Lambdas : sig ... end

Configuration for Amazon Web Services Lambda functions used in a Region switch plan.

Sourcemodule LambdaList : sig ... end
Sourcemodule Float_ : sig ... end

Configuration for Amazon Web Services Lambda functions that perform custom actions during a Region switch.

module ExecutionBlockConfiguration : sig ... end

Execution block configurations for a workflow in a Region switch plan. An execution block represents a specific type of action to perform during a Region switch.

Configuration for steps that should be executed in parallel during a Region switch.

module Step : sig ... end

Represents a step in a Region switch plan workflow. Each step performs a specific action during the Region switch process.

module Steps : sig ... end
Sourcemodule Workflow : sig ... end

Represents a workflow in a Region switch plan. A workflow defines a sequence of steps to execute during a Region switch.

Sourcemodule WorkflowList : sig ... end
Sourcemodule TriggerCondition : sig ... end

Defines a condition that must be met for a trigger to fire.

Sourcemodule TriggerConditionList : sig ... end
Sourcemodule Trigger : sig ... end

Defines a condition that can automatically trigger the execution of a Region switch plan.

Sourcemodule TriggerList : sig ... end
Sourcemodule TagValue : sig ... end
Sourcemodule TagKey : sig ... end
Sourcemodule Tags : sig ... end

Configuration for delivering generated reports to an Amazon S3 bucket.

Sourcemodule ReportOutputConfiguration : sig ... end

Configuration for report output destinations used in a Region switch plan.

Sourcemodule ReportOutputList : sig ... end
Sourcemodule ReportConfiguration : sig ... end

Configuration for automatic report generation for plan executions. When configured, Region switch automatically generates a report after each plan execution that includes execution events, plan configuration, and CloudWatch alarm states.

Sourcemodule CreatePlanRequest : sig ... end

Creates a new Region switch plan. A plan defines the steps required to shift traffic from one Amazon Web Services Region to another. You must specify a name for the plan, the primary Region, and at least one additional Region. You can also provide a description, execution role, recovery time objective, associated alarms, triggers, and workflows that define the steps to execute during a Region switch.

Sourcemodule Plan : sig ... end

Represents a Region switch plan. A plan defines the steps required to shift traffic from one Amazon Web Services Region to another.

Sourcemodule CreatePlanResponse : sig ... end

Creates a new Region switch plan. A plan defines the steps required to shift traffic from one Amazon Web Services Region to another. You must specify a name for the plan, the primary Region, and at least one additional Region. You can also provide a description, execution role, recovery time objective, associated alarms, triggers, and workflows that define the steps to execute during a Region switch.

Sourcemodule DeletePlanRequest : sig ... end

Deletes a Region switch plan. You must specify the ARN of the plan to delete. You cannot delete a plan that has an active execution in progress.

Sourcemodule IllegalStateException : sig ... end

The operation failed because the current state of the resource doesn't allow the operation to proceed. HTTP Status Code: 400

Sourcemodule DeletePlanResponse : sig ... end

Deletes a Region switch plan. You must specify the ARN of the plan to delete. You cannot delete a plan that has an active execution in progress.

Sourcemodule EvaluationStatus : sig ... end
Sourcemodule Resources : sig ... end
Sourcemodule ExecutionEventType : sig ... end
Sourcemodule ExecutionEvent : sig ... end

Represents an event that occurred during a plan execution. These events provide a detailed timeline of the execution process.

Sourcemodule ExecutionEventList : sig ... end
Sourcemodule FailedReportErrorCode : sig ... end
Sourcemodule FailedReportOutput : sig ... end

Information about a report generation that failed.

Sourcemodule S3ReportOutput : sig ... end

Information about a report delivered to Amazon S3.

Sourcemodule ReportOutput : sig ... end

The output location or cause of a failure in report generation.

Sourcemodule GeneratedReport : sig ... end

Information about a generated execution report.

Sourcemodule GeneratedReportDetails : sig ... end
Sourcemodule NextToken : sig ... end
Sourcemodule MaxResults : sig ... end

Retrieves the evaluation status of a Region switch plan. The evaluation status provides information about the last time the plan was evaluated and any warnings or issues detected.

Sourcemodule ResourceWarningStatus : sig ... end
Sourcemodule ResourceArn : sig ... end
Sourcemodule MinimalWorkflow : sig ... end

A simplified representation of a workflow in a Region switch plan.

Sourcemodule ResourceWarning : sig ... end

Represents a warning about a resource in a Region switch plan.

Sourcemodule PlanWarnings : sig ... end

Retrieves the evaluation status of a Region switch plan. The evaluation status provides information about the last time the plan was evaluated and any warnings or issues detected.

Sourcemodule GetPlanExecutionRequest : sig ... end

Retrieves detailed information about a specific plan execution. You must specify the plan ARN and execution ID.

Sourcemodule StepStatus : sig ... end
Sourcemodule StepState : sig ... end

Represents the state of a step in a plan execution.

Sourcemodule StepStates : sig ... end
Sourcemodule GetPlanExecutionResponse : sig ... end

Retrieves detailed information about a specific plan execution. You must specify the plan ARN and execution ID.

Sourcemodule GetPlanInRegionRequest : sig ... end

Retrieves information about a Region switch plan in a specific Amazon Web Services Region. This operation is useful for getting Region-specific information about a plan.

Sourcemodule GetPlanInRegionResponse : sig ... end

Retrieves information about a Region switch plan in a specific Amazon Web Services Region. This operation is useful for getting Region-specific information about a plan.

Sourcemodule GetPlanRequest : sig ... end

Retrieves detailed information about a Region switch plan. You must specify the ARN of the plan.

Sourcemodule GetPlanResponse : sig ... end

Retrieves detailed information about a Region switch plan. You must specify the ARN of the plan.

Sourcemodule IllegalArgumentException : sig ... end

The request processing has an invalid argument.

Sourcemodule InternalServerException : sig ... end

The request processing has failed because of an unknown error, exception, or failure. HTTP Status Code: 500

Sourcemodule ListExecutionsMaxResults : sig ... end

Lists the events that occurred during a plan execution. These events provide a detailed timeline of the execution process.

Lists the events that occurred during a plan execution. These events provide a detailed timeline of the execution process.

Sourcemodule ListPlanExecutionsRequest : sig ... end

Lists the executions of a Region switch plan. This operation returns information about both current and historical executions.

Lists the executions of a Region switch plan. This operation returns information about both current and historical executions.

Sourcemodule ListPlansInRegionRequest : sig ... end

Lists all Region switch plans in your Amazon Web Services account that are available in the current Amazon Web Services Region.

Sourcemodule PlanList : sig ... end
Sourcemodule ListPlansInRegionResponse : sig ... end

Lists all Region switch plans in your Amazon Web Services account that are available in the current Amazon Web Services Region.

Sourcemodule ListPlansRequest : sig ... end

Lists all Region switch plans in your Amazon Web Services account.

Sourcemodule ListPlansResponse : sig ... end

Lists all Region switch plans in your Amazon Web Services account.

List the Amazon Route 53 health checks in a specific Amazon Web Services Region.

Sourcemodule Route53HealthCheckStatus : sig ... end
Sourcemodule Route53HealthCheckId : sig ... end
Sourcemodule Route53HealthCheck : sig ... end

The Amazon Route 53 health check.

Sourcemodule Route53HealthCheckList : sig ... end

List the Amazon Route 53 health checks in a specific Amazon Web Services Region.

List the Amazon Route 53 health checks.

List the Amazon Route 53 health checks.

Lists the tags attached to a Region switch resource.

Lists the tags attached to a Region switch resource.

Sourcemodule RecoveryExecutionId : sig ... end
Sourcemodule StartPlanExecutionRequest : sig ... end

Starts the execution of a Region switch plan. You can execute a plan in either graceful or ungraceful mode. Specifing ungraceful mode either changes the behavior of the execution blocks in a workflow or skips specific execution blocks.

Starts the execution of a Region switch plan. You can execute a plan in either graceful or ungraceful mode. Specifing ungraceful mode either changes the behavior of the execution blocks in a workflow or skips specific execution blocks.

Sourcemodule TagKeys : sig ... end
Sourcemodule TagResourceRequest : sig ... end

Adds or updates tags for a Region switch resource. You can assign metadata to your resources in the form of tags, which are key-value pairs.

Sourcemodule TagResourceResponse : sig ... end

Adds or updates tags for a Region switch resource. You can assign metadata to your resources in the form of tags, which are key-value pairs.

Sourcemodule UntagResourceRequest : sig ... end

Removes tags from a Region switch resource.

Sourcemodule UntagResourceResponse : sig ... end

Removes tags from a Region switch resource.

Sourcemodule UpdatePlanExecutionAction : sig ... end

Updates an in-progress plan execution. This operation allows you to modify certain aspects of the execution, such as adding a comment or changing the action.

Updates an in-progress plan execution. This operation allows you to modify certain aspects of the execution, such as adding a comment or changing the action.

Updates a specific step in an in-progress plan execution. This operation allows you to modify the step's comment or action.

Updates a specific step in an in-progress plan execution. This operation allows you to modify the step's comment or action.

Sourcemodule UpdatePlanRequest : sig ... end

Updates an existing Region switch plan. You can modify the plan's description, workflows, execution role, recovery time objective, associated alarms, and triggers.

Sourcemodule UpdatePlanResponse : sig ... end

Updates an existing Region switch plan. You can modify the plan's description, workflows, execution role, recovery time objective, associated alarms, and triggers.