AWS.Tools.Route53RecoveryCluster.XML

<?xml version="1.0"?>
<doc>
    <assembly>
        <name>AWS.Tools.Route53RecoveryCluster</name>
    </assembly>
    <members>
        <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 the state is On, traffic flows to a cell.
            When it's off, traffic does not flow.
             
              
            <para>
            Before you can create a routing control, you first must create a cluster to host the
            control. For more information, see <a href="https://docs.aws.amazon.com/recovery-cluster/latest/api/cluster.html">CreateCluster</a>.
            Access one of the endpoints for the cluster to get or update the routing control state
            to redirect traffic.
            </para><para>
            For more information about working with routing controls, see <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.html">Routing
            control</a> in the Route 53 Application Recovery Controller Developer Guide.
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.RRC.GetRRCRoutingControlStateCmdlet.RoutingControlArn">
            <summary>
            <para>
            <para>The Amazon Resource Number (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
            be On or Off. When the state is On, traffic flows to a cell. When it's off, traffic
            does not flow.
             
              
            <para>
            For more information about working with routing controls, see <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.html">Routing
            control</a> in the Route 53 Application Recovery Controller Developer Guide.
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.RRC.UpdateRRCRoutingControlStateCmdlet.RoutingControlArn">
            <summary>
            <para>
            <para>The Amazon Resource Number (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 be On or Off.</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>
            For more information about working with routing controls, see <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.html">Routing
            control</a> in the Route 53 Application Recovery Controller Developer Guide.
            </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>