RuntimePlugin

Trait RuntimePlugin 

Source
pub trait RuntimePlugin:
    Debug
    + Send
    + Sync {
    // Provided methods
    fn order(&self) -> Order { ... }
    fn config(&self) -> Option<FrozenLayer> { ... }
    fn runtime_components(
        &self,
        current_components: &RuntimeComponentsBuilder,
    ) -> Cow<'_, RuntimeComponentsBuilder> { ... }
}
Expand description

Runtime plugin trait

A RuntimePlugin is the unit of configuration for augmenting the client with new behavior.

Runtime plugins can register interceptors, set runtime components, and modify configuration.

Provided Methods§

Source

fn order(&self) -> Order

Runtime plugin ordering.

There are two runtime plugin “levels” that run in the following order:

  1. Service runtime plugins - runtime plugins that pertain to the entire service.
  2. Operation runtime plugins - runtime plugins relevant only to a single operation.

This function is used to determine runtime plugin order within those levels. So regardless of this Order value, service runtime plugins will still always execute before operation runtime plugins. However, Defaults service runtime plugins will run before Overrides service runtime plugins.

Source

fn config(&self) -> Option<FrozenLayer>

Optionally returns additional config that should be added to the ConfigBag.

As a best practice, a frozen layer should be stored on the runtime plugin instance as a member, and then cloned upon return since that clone is cheap. Constructing a new Layer and freezing it will require a lot of allocations.

Source

fn runtime_components( &self, current_components: &RuntimeComponentsBuilder, ) -> Cow<'_, RuntimeComponentsBuilder>

Returns a RuntimeComponentsBuilder to incorporate into the final runtime components.

The order of runtime plugins determines which runtime components “win”. Components set by later runtime plugins will override those set by earlier runtime plugins.

If no runtime component changes are desired, just return an empty builder.

This method returns a Cow for flexibility. Some implementers may want to store the components builder as a member and return a reference to it, while others may need to create the builder every call. If possible, returning a reference is preferred for performance.

Components configured by previous runtime plugins are in the current_components argument, and can be used to create nested/wrapped components, such as a connector calling into an inner (customer provided) connector.

Implementations on Foreign Types§

Source§

impl RuntimePlugin for PayloadSigningOverrideRuntimePlugin

Source§

impl RuntimePlugin for NoAuthRuntimePlugin

Source§

impl RuntimePlugin for EnforceContentLengthRuntimePlugin

Source§

impl RuntimePlugin for MetricsRuntimePlugin

Source§

impl RuntimePlugin for CannedResponseDeserializer

Source§

impl RuntimePlugin for CannedRequestSerializer

Implementors§

Source§

impl RuntimePlugin for AttachInstances

Source§

impl RuntimePlugin for AttachLoadBalancerTargetGroups

Source§

impl RuntimePlugin for AttachLoadBalancers

Source§

impl RuntimePlugin for AttachTrafficSources

Source§

impl RuntimePlugin for BatchDeleteScheduledAction

Source§

impl RuntimePlugin for BatchPutScheduledUpdateGroupAction

Source§

impl RuntimePlugin for CancelInstanceRefresh

Source§

impl RuntimePlugin for CompleteLifecycleAction

Source§

impl RuntimePlugin for CreateAutoScalingGroup

Source§

impl RuntimePlugin for CreateLaunchConfiguration

Source§

impl RuntimePlugin for CreateOrUpdateTags

Source§

impl RuntimePlugin for DeleteAutoScalingGroup

Source§

impl RuntimePlugin for DeleteLaunchConfiguration

Source§

impl RuntimePlugin for DeleteLifecycleHook

Source§

impl RuntimePlugin for DeleteNotificationConfiguration

Source§

impl RuntimePlugin for DeletePolicy

Source§

impl RuntimePlugin for DeleteScheduledAction

Source§

impl RuntimePlugin for DeleteTags

Source§

impl RuntimePlugin for DeleteWarmPool

Source§

impl RuntimePlugin for DescribeAccountLimits

Source§

impl RuntimePlugin for DescribeAdjustmentTypes

Source§

impl RuntimePlugin for DescribeAutoScalingGroups

Source§

impl RuntimePlugin for DescribeAutoScalingInstances

Source§

impl RuntimePlugin for DescribeAutoScalingNotificationTypes

Source§

impl RuntimePlugin for DescribeInstanceRefreshes

Source§

impl RuntimePlugin for DescribeLaunchConfigurations

Source§

impl RuntimePlugin for DescribeLifecycleHookTypes

Source§

impl RuntimePlugin for DescribeLifecycleHooks

Source§

impl RuntimePlugin for DescribeLoadBalancerTargetGroups

Source§

impl RuntimePlugin for DescribeLoadBalancers

Source§

impl RuntimePlugin for DescribeMetricCollectionTypes

Source§

impl RuntimePlugin for DescribeNotificationConfigurations

Source§

impl RuntimePlugin for DescribePolicies

Source§

impl RuntimePlugin for DescribeScalingActivities

Source§

impl RuntimePlugin for DescribeScalingProcessTypes

Source§

impl RuntimePlugin for DescribeScheduledActions

Source§

impl RuntimePlugin for DescribeTags

Source§

impl RuntimePlugin for DescribeTerminationPolicyTypes

Source§

impl RuntimePlugin for DescribeTrafficSources

Source§

impl RuntimePlugin for DescribeWarmPool

Source§

impl RuntimePlugin for DetachInstances

Source§

impl RuntimePlugin for DetachLoadBalancerTargetGroups

Source§

impl RuntimePlugin for DetachLoadBalancers

Source§

impl RuntimePlugin for DetachTrafficSources

Source§

impl RuntimePlugin for DisableMetricsCollection

Source§

impl RuntimePlugin for EnableMetricsCollection

Source§

impl RuntimePlugin for EnterStandby

Source§

impl RuntimePlugin for ExecutePolicy

Source§

impl RuntimePlugin for ExitStandby

Source§

impl RuntimePlugin for GetPredictiveScalingForecast

Source§

impl RuntimePlugin for PutLifecycleHook

Source§

impl RuntimePlugin for PutNotificationConfiguration

Source§

impl RuntimePlugin for PutScalingPolicy

Source§

impl RuntimePlugin for PutScheduledUpdateGroupAction

Source§

impl RuntimePlugin for PutWarmPool

Source§

impl RuntimePlugin for RecordLifecycleActionHeartbeat

Source§

impl RuntimePlugin for ResumeProcesses

Source§

impl RuntimePlugin for RollbackInstanceRefresh

Source§

impl RuntimePlugin for SetDesiredCapacity

Source§

impl RuntimePlugin for SetInstanceHealth

Source§

impl RuntimePlugin for SetInstanceProtection

Source§

impl RuntimePlugin for StartInstanceRefresh

Source§

impl RuntimePlugin for SuspendProcesses

Source§

impl RuntimePlugin for TerminateInstanceInAutoScalingGroup

Source§

impl RuntimePlugin for UpdateAutoScalingGroup

Source§

impl RuntimePlugin for StaticRuntimePlugin

Source§

impl RuntimePlugin for SharedRuntimePlugin