AWS.Tools.Route53RecoveryCluster.XML

<?xml version="1.0"?>
<doc>
    <assembly>
        <name>AWS.Tools.Route53RecoveryCluster</name>
    </assembly>
    <members>
        <member name="T:Amazon.PowerShell.Cmdlets.RRC.GetRRCRoutingControlListCmdlet">
            <summary>
            List routing control names and Amazon Resource Names (ARNs), as well as the routing
            control state for each routing control, along with the control panel name and control
            panel ARN for the routing controls. If you specify a control panel ARN, this call
            lists the routing controls in the control panel. Otherwise, it lists all the routing
            controls in the cluster.
             
              
            <para>
            A routing control is a simple on/off switch in Route 53 ARC that you can use to route
            traffic to cells. When a routing control state is set to ON, traffic flows to a cell.
            When the state is set to OFF, traffic does not flow.
            </para><para>
            Before you can create a routing control, you must first create a cluster, and then
            host the control in a control panel on the cluster. For more information, see <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.create.html">
            Create routing control structures</a> in the Amazon Route 53 Application Recovery
            Controller Developer Guide. You access one of the endpoints for the cluster to get
            or update the routing control state to redirect traffic for your application.
            </para><para><i>You must specify Regional endpoints when you work with API cluster operations
            to use this API operation to list routing controls in Route 53 ARC.</i></para><para>
            Learn more about working with routing controls in the following topics in the Amazon
            Route 53 Application Recovery Controller Developer Guide:
            </para><ul><li><para><a href="https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.update.html">
            Viewing and updating routing control states</a></para></li><li><para><a href="https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.html">Working
            with routing controls in Route 53 ARC</a></para></li></ul>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.RRC.GetRRCRoutingControlListCmdlet.ControlPanelArn">
            <summary>
            <para>
            <para>The Amazon Resource Name (ARN) of the control panel of the routing controls to list.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.RRC.GetRRCRoutingControlListCmdlet.MaxResult">
            <summary>
            <para>
            <para>The number of routing controls objects that you want to return with this call. The
            default value is 500.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.RRC.GetRRCRoutingControlListCmdlet.NextToken">
            <summary>
            <para>
            <para>The token for the next set of results. You receive this token from a previous call.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.RRC.GetRRCRoutingControlListCmdlet.Select">
            <summary>
            Use the -Select parameter to control the cmdlet output. The default value is 'RoutingControls'.
            Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Route53RecoveryCluster.Model.ListRoutingControlsResponse).
            Specifying the name of a property of type Amazon.Route53RecoveryCluster.Model.ListRoutingControlsResponse will result in that property being returned.
            Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.RRC.GetRRCRoutingControlListCmdlet.PassThru">
            <summary>
            Changes the cmdlet behavior to return the value passed to the ControlPanelArn parameter.
            The -PassThru parameter is deprecated, use -Select '^ControlPanelArn' instead. This parameter will be removed in a future version.
            </summary>
        </member>
        <member name="T:Amazon.PowerShell.Cmdlets.RRC.GetRRCRoutingControlStateCmdlet">
            <summary>
            Get the state for a routing control. A routing control is a simple on/off switch that
            you can use to route traffic to cells. When a routing control state is set to ON,
            traffic flows to a cell. When the state is set to OFF, traffic does not flow.
             
              
            <para>
            Before you can create a routing control, you must first create a cluster, and then
            host the control in a control panel on the cluster. For more information, see <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.create.html">
            Create routing control structures</a> in the Amazon Route 53 Application Recovery
            Controller Developer Guide. You access one of the endpoints for the cluster to get
            or update the routing control state to redirect traffic for your application.
            </para><para><i>You must specify Regional endpoints when you work with API cluster operations
            to get or update routing control states in Route 53 ARC.</i></para><para>
            To see a code example for getting a routing control state, including accessing Regional
            cluster endpoints in sequence, see <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/service_code_examples_actions.html">API
            examples</a> in the Amazon Route 53 Application Recovery Controller Developer Guide.
            </para><para>
            Learn more about working with routing controls in the following topics in the Amazon
            Route 53 Application Recovery Controller Developer Guide:
            </para><ul><li><para><a href="https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.update.html">
            Viewing and updating routing control states</a></para></li><li><para><a href="https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.html">Working
            with routing controls in Route 53 ARC</a></para></li></ul>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.RRC.GetRRCRoutingControlStateCmdlet.RoutingControlArn">
            <summary>
            <para>
            <para>The Amazon Resource Name (ARN) for the routing control that you want to get the state
            for.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.RRC.GetRRCRoutingControlStateCmdlet.Select">
            <summary>
            Use the -Select parameter to control the cmdlet output. The default value is '*'.
            Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Route53RecoveryCluster.Model.GetRoutingControlStateResponse).
            Specifying the name of a property of type Amazon.Route53RecoveryCluster.Model.GetRoutingControlStateResponse will result in that property being returned.
            Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.RRC.GetRRCRoutingControlStateCmdlet.PassThru">
            <summary>
            Changes the cmdlet behavior to return the value passed to the RoutingControlArn parameter.
            The -PassThru parameter is deprecated, use -Select '^RoutingControlArn' instead. This parameter will be removed in a future version.
            </summary>
        </member>
        <member name="T:Amazon.PowerShell.Cmdlets.RRC.UpdateRRCRoutingControlStateCmdlet">
            <summary>
            Set the state of the routing control to reroute traffic. You can set the value to
            ON or OFF. When the state is ON, traffic flows to a cell. When the state is OFF, traffic
            does not flow.
             
              
            <para>
            With Route 53 ARC, you can add safety rules for routing controls, which are safeguards
            for routing control state updates that help prevent unexpected outcomes, like fail
            open traffic routing. However, there are scenarios when you might want to bypass the
            routing control safeguards that are enforced with safety rules that you've configured.
            For example, you might want to fail over quickly for disaster recovery, and one or
            more safety rules might be unexpectedly preventing you from updating a routing control
            state to reroute traffic. In a "break glass" scenario like this, you can override
            one or more safety rules to change a routing control state and fail over your application.
            </para><para>
            The <c>SafetyRulesToOverride</c> property enables you override one or more safety
            rules and update routing control states. For more information, see <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.override-safety-rule.html">
            Override safety rules to reroute traffic</a> in the Amazon Route 53 Application Recovery
            Controller Developer Guide.
            </para><para><i>You must specify Regional endpoints when you work with API cluster operations
            to get or update routing control states in Route 53 ARC.</i></para><para>
            To see a code example for getting a routing control state, including accessing Regional
            cluster endpoints in sequence, see <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/service_code_examples_actions.html">API
            examples</a> in the Amazon Route 53 Application Recovery Controller Developer Guide.
            </para><ul><li><para><a href="https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.update.html">
            Viewing and updating routing control states</a></para></li><li><para><a href="https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.html">Working
            with routing controls overall</a></para></li></ul>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.RRC.UpdateRRCRoutingControlStateCmdlet.RoutingControlArn">
            <summary>
            <para>
            <para>The Amazon Resource Name (ARN) for the routing control that you want to update the
            state for.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.RRC.UpdateRRCRoutingControlStateCmdlet.RoutingControlState">
            <summary>
            <para>
            <para>The state of the routing control. You can set the value to ON or OFF.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.RRC.UpdateRRCRoutingControlStateCmdlet.SafetyRulesToOverride">
            <summary>
            <para>
            <para>The Amazon Resource Names (ARNs) for the safety rules that you want to override when
            you're updating the state of a routing control. You can override one safety rule or
            multiple safety rules by including one or more ARNs, separated by commas.</para><para>For more information, see <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.override-safety-rule.html">
            Override safety rules to reroute traffic</a> in the Amazon Route 53 Application Recovery
            Controller Developer Guide.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.RRC.UpdateRRCRoutingControlStateCmdlet.Select">
            <summary>
            Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default.
            Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Route53RecoveryCluster.Model.UpdateRoutingControlStateResponse).
            Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.RRC.UpdateRRCRoutingControlStateCmdlet.PassThru">
            <summary>
            Changes the cmdlet behavior to return the value passed to the RoutingControlArn parameter.
            The -PassThru parameter is deprecated, use -Select '^RoutingControlArn' instead. This parameter will be removed in a future version.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.RRC.UpdateRRCRoutingControlStateCmdlet.Force">
            <summary>
            This parameter overrides confirmation prompts to force
            the cmdlet to continue its operation. This parameter should always
            be used with caution.
            </summary>
        </member>
        <member name="T:Amazon.PowerShell.Cmdlets.RRC.UpdateRRCRoutingControlStateBatchCmdlet">
            <summary>
            Set multiple routing control states. You can set the value for each state to be ON
            or OFF. When the state is ON, traffic flows to a cell. When it's OFF, traffic does
            not flow.
             
              
            <para>
            With Route 53 ARC, you can add safety rules for routing controls, which are safeguards
            for routing control state updates that help prevent unexpected outcomes, like fail
            open traffic routing. However, there are scenarios when you might want to bypass the
            routing control safeguards that are enforced with safety rules that you've configured.
            For example, you might want to fail over quickly for disaster recovery, and one or
            more safety rules might be unexpectedly preventing you from updating a routing control
            state to reroute traffic. In a "break glass" scenario like this, you can override
            one or more safety rules to change a routing control state and fail over your application.
            </para><para>
            The <c>SafetyRulesToOverride</c> property enables you override one or more safety
            rules and update routing control states. For more information, see <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.override-safety-rule.html">
            Override safety rules to reroute traffic</a> in the Amazon Route 53 Application Recovery
            Controller Developer Guide.
            </para><para><i>You must specify Regional endpoints when you work with API cluster operations
            to get or update routing control states in Route 53 ARC.</i></para><para>
            To see a code example for getting a routing control state, including accessing Regional
            cluster endpoints in sequence, see <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/service_code_examples_actions.html">API
            examples</a> in the Amazon Route 53 Application Recovery Controller Developer Guide.
            </para><ul><li><para><a href="https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.update.html">
            Viewing and updating routing control states</a></para></li><li><para><a href="https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.html">Working
            with routing controls overall</a></para></li></ul>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.RRC.UpdateRRCRoutingControlStateBatchCmdlet.SafetyRulesToOverride">
            <summary>
            <para>
            <para>The Amazon Resource Names (ARNs) for the safety rules that you want to override when
            you're updating routing control states. You can override one safety rule or multiple
            safety rules by including one or more ARNs, separated by commas.</para><para>For more information, see <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.override-safety-rule.html">
            Override safety rules to reroute traffic</a> in the Amazon Route 53 Application Recovery
            Controller Developer Guide.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.RRC.UpdateRRCRoutingControlStateBatchCmdlet.UpdateRoutingControlStateEntry">
            <summary>
            <para>
            <para>A set of routing control entries that you want to update.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.RRC.UpdateRRCRoutingControlStateBatchCmdlet.Select">
            <summary>
            Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default.
            Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Route53RecoveryCluster.Model.UpdateRoutingControlStatesResponse).
            Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.RRC.UpdateRRCRoutingControlStateBatchCmdlet.Force">
            <summary>
            This parameter overrides confirmation prompts to force
            the cmdlet to continue its operation. This parameter should always
            be used with caution.
            </summary>
        </member>
    </members>
</doc>