AWS.Tools.ARCZonalShift

4.1.332

AWS.Tools.ARCZonalShift.XML

<?xml version="1.0"?>
<doc>
    <assembly>
        <name>AWS.Tools.ARCZonalShift</name>
    </assembly>
    <members>
        <member name="T:Amazon.PowerShell.Cmdlets.AZS.GetAZSManagedResourceCmdlet">
            <summary>
            Get information about a resource that's been registered for zonal shifts with Amazon
            Route 53 Application Recovery Controller in this AWS Region. Resources that are registered
            for zonal shifts are managed resources in Route 53 ARC.
             
              
            <para>
            At this time, you can only start a zonal shift for Network Load Balancers and Application
            Load Balancers with cross-zone load balancing turned off.
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.AZS.GetAZSManagedResourceCmdlet.ResourceIdentifier">
            <summary>
            <para>
            <para>The identifier for the resource to include in a zonal shift. The identifier is the
            Amazon Resource Name (ARN) for the resource.</para><para>At this time, you can only start a zonal shift for Network Load Balancers and Application
            Load Balancers with cross-zone load balancing turned off.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.AZS.GetAZSManagedResourceCmdlet.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.ARCZonalShift.Model.GetManagedResourceResponse).
            Specifying the name of a property of type Amazon.ARCZonalShift.Model.GetManagedResourceResponse 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.AZS.GetAZSManagedResourceCmdlet.PassThru">
            <summary>
            Changes the cmdlet behavior to return the value passed to the ResourceIdentifier parameter.
            The -PassThru parameter is deprecated, use -Select '^ResourceIdentifier' instead. This parameter will be removed in a future version.
            </summary>
        </member>
        <member name="T:Amazon.PowerShell.Cmdlets.AZS.GetAZSManagedResourceListCmdlet">
            <summary>
            Lists all the resources in your AWS account in this AWS Region that are managed for
            zonal shifts in Amazon Route 53 Application Recovery Controller, and information about
            them. The information includes their Amazon Resource Names (ARNs), the Availability
            Zones the resources are deployed in, and the resource name.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.AZS.GetAZSManagedResourceListCmdlet.MaxResult">
            <summary>
            <para>
            <para>The number of objects that you want to return with this call.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.AZS.GetAZSManagedResourceListCmdlet.NextToken">
            <summary>
            <para>
            <para>Specifies that you want to receive the next page of results. Valid only if you received
            a <code>NextToken</code> response in the previous request. If you did, it indicates
            that more output is available. Set this parameter to the value provided by the previous
            call's <code>NextToken</code> response to request the next page of results.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.AZS.GetAZSManagedResourceListCmdlet.Select">
            <summary>
            Use the -Select parameter to control the cmdlet output. The default value is 'Items'.
            Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ARCZonalShift.Model.ListManagedResourcesResponse).
            Specifying the name of a property of type Amazon.ARCZonalShift.Model.ListManagedResourcesResponse 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="T:Amazon.PowerShell.Cmdlets.AZS.GetAZSZonalShiftListCmdlet">
            <summary>
            Lists all the active zonal shifts in Amazon Route 53 Application Recovery Controller
            in your AWS account in this AWS Region.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.AZS.GetAZSZonalShiftListCmdlet.Status">
            <summary>
            <para>
            <para>A status for a zonal shift.</para><para>The <code>Status</code> for a zonal shift can have one of the following values:</para><ul><li><para><b>ACTIVE</b>: The zonal shift is started and active.</para></li><li><para><b>EXPIRED</b>: The zonal shift has expired (the expiry time was exceeded).</para></li><li><para><b>CANCELED</b>: The zonal shift was canceled.</para></li></ul>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.AZS.GetAZSZonalShiftListCmdlet.MaxResult">
            <summary>
            <para>
            <para>The number of objects that you want to return with this call.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.AZS.GetAZSZonalShiftListCmdlet.NextToken">
            <summary>
            <para>
            <para>Specifies that you want to receive the next page of results. Valid only if you received
            a <code>NextToken</code> response in the previous request. If you did, it indicates
            that more output is available. Set this parameter to the value provided by the previous
            call's <code>NextToken</code> response to request the next page of results.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.AZS.GetAZSZonalShiftListCmdlet.Select">
            <summary>
            Use the -Select parameter to control the cmdlet output. The default value is 'Items'.
            Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ARCZonalShift.Model.ListZonalShiftsResponse).
            Specifying the name of a property of type Amazon.ARCZonalShift.Model.ListZonalShiftsResponse 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.AZS.GetAZSZonalShiftListCmdlet.PassThru">
            <summary>
            Changes the cmdlet behavior to return the value passed to the Status parameter.
            The -PassThru parameter is deprecated, use -Select '^Status' instead. This parameter will be removed in a future version.
            </summary>
        </member>
        <member name="T:Amazon.PowerShell.Cmdlets.AZS.StartAZSZonalShiftCmdlet">
            <summary>
            You start a zonal shift to temporarily move load balancer traffic away from an Availability
            Zone in a AWS Region, to help your application recover immediately, for example, from
            a developer's bad code deployment or from an AWS infrastructure failure in a single
            Availability Zone. You can start a zonal shift in Route 53 ARC only for managed resources
            in your account in an AWS Region. Resources are automatically registered with Route
            53 ARC by AWS services.
             
              
            <para>
            At this time, you can only start a zonal shift for Network Load Balancers and Application
            Load Balancers with cross-zone load balancing turned off.
            </para><para>
            When you start a zonal shift, traffic for the resource is no longer routed to the
            Availability Zone. The zonal shift is created immediately in Route 53 ARC. However,
            it can take a short time, typically up to a few minutes, for existing, in-progress
            connections in the Availability Zone to complete.
            </para><para>
            For more information, see <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-shift.html">Zonal
            shift</a> in the Amazon Route 53 Application Recovery Controller Developer Guide.
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.AZS.StartAZSZonalShiftCmdlet.AwayFrom">
            <summary>
            <para>
            <para>The Availability Zone that traffic is moved away from for a resource when you start
            a zonal shift. Until the zonal shift expires or you cancel it, traffic for the resource
            is instead moved to other Availability Zones in the AWS Region.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.AZS.StartAZSZonalShiftCmdlet.Comment">
            <summary>
            <para>
            <para>A comment that you enter about the zonal shift. Only the latest comment is retained;
            no comment history is maintained. A new comment overwrites any existing comment string.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.AZS.StartAZSZonalShiftCmdlet.ExpiresIn">
            <summary>
            <para>
            <para>The length of time that you want a zonal shift to be active, which Route 53 ARC converts
            to an expiry time (expiration time). Zonal shifts are temporary. You can set a zonal
            shift to be active initially for up to three days (72 hours).</para><para>If you want to still keep traffic away from an Availability Zone, you can update the
            zonal shift and set a new expiration. You can also cancel a zonal shift, before it
            expires, for example, if you're ready to restore traffic to the Availability Zone.</para><para>To set a length of time for a zonal shift to be active, specify a whole number, and
            then one of the following, with no space:</para><pre><code> &lt;ul&gt; &lt;li&gt; &lt;p&gt; &lt;b&gt;A lowercase letter m:&lt;/b&gt;
            To specify that the value is in minutes.&lt;/p&gt; &lt;/li&gt; &lt;li&gt; &lt;p&gt;
            &lt;b&gt;A lowercase letter h:&lt;/b&gt; To specify that the value is in hours.&lt;/p&gt;
            &lt;/li&gt; &lt;/ul&gt; &lt;p&gt;For example: &lt;code&gt;20h&lt;/code&gt; means the
            zonal shift expires in 20 hours. &lt;code&gt;120m&lt;/code&gt; means the zonal shift
            expires in 120 minutes (2 hours).&lt;/p&gt; </code></pre>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.AZS.StartAZSZonalShiftCmdlet.ResourceIdentifier">
            <summary>
            <para>
            <para>The identifier for the resource to include in a zonal shift. The identifier is the
            Amazon Resource Name (ARN) for the resource.</para><para>At this time, you can only start a zonal shift for Network Load Balancers and Application
            Load Balancers with cross-zone load balancing turned off.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.AZS.StartAZSZonalShiftCmdlet.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.ARCZonalShift.Model.StartZonalShiftResponse).
            Specifying the name of a property of type Amazon.ARCZonalShift.Model.StartZonalShiftResponse 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.AZS.StartAZSZonalShiftCmdlet.PassThru">
            <summary>
            Changes the cmdlet behavior to return the value passed to the ResourceIdentifier parameter.
            The -PassThru parameter is deprecated, use -Select '^ResourceIdentifier' instead. This parameter will be removed in a future version.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.AZS.StartAZSZonalShiftCmdlet.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.AZS.StopAZSZonalShiftCmdlet">
            <summary>
            Cancel a zonal shift in Amazon Route 53 Application Recovery Controller that you've
            started for a resource in your AWS account in an AWS Region.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.AZS.StopAZSZonalShiftCmdlet.ZonalShiftId">
            <summary>
            <para>
            <para>The internally-generated identifier of a zonal shift.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.AZS.StopAZSZonalShiftCmdlet.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.ARCZonalShift.Model.CancelZonalShiftResponse).
            Specifying the name of a property of type Amazon.ARCZonalShift.Model.CancelZonalShiftResponse 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.AZS.StopAZSZonalShiftCmdlet.PassThru">
            <summary>
            Changes the cmdlet behavior to return the value passed to the ZonalShiftId parameter.
            The -PassThru parameter is deprecated, use -Select '^ZonalShiftId' instead. This parameter will be removed in a future version.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.AZS.StopAZSZonalShiftCmdlet.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.AZS.UpdateAZSZonalShiftCmdlet">
            <summary>
            Update an active zonal shift in Amazon Route 53 Application Recovery Controller in
            your AWS account. You can update a zonal shift to set a new expiration, or edit or
            replace the comment for the zonal shift.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.AZS.UpdateAZSZonalShiftCmdlet.Comment">
            <summary>
            <para>
            <para>A comment that you enter about the zonal shift. Only the latest comment is retained;
            no comment history is maintained. A new comment overwrites any existing comment string.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.AZS.UpdateAZSZonalShiftCmdlet.ExpiresIn">
            <summary>
            <para>
            <para>The length of time that you want a zonal shift to be active, which Route 53 ARC converts
            to an expiry time (expiration time). Zonal shifts are temporary. You can set a zonal
            shift to be active initially for up to three days (72 hours).</para><para>If you want to still keep traffic away from an Availability Zone, you can update the
            zonal shift and set a new expiration. You can also cancel a zonal shift, before it
            expires, for example, if you're ready to restore traffic to the Availability Zone.</para><para>To set a length of time for a zonal shift to be active, specify a whole number, and
            then one of the following, with no space:</para><ul><li><para><b>A lowercase letter m:</b> To specify that the value is in minutes.</para></li><li><para><b>A lowercase letter h:</b> To specify that the value is in hours.</para></li></ul><para>For example: <code>20h</code> means the zonal shift expires in 20 hours. <code>120m</code>
            means the zonal shift expires in 120 minutes (2 hours).</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.AZS.UpdateAZSZonalShiftCmdlet.ZonalShiftId">
            <summary>
            <para>
            <para>The identifier of a zonal shift.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.AZS.UpdateAZSZonalShiftCmdlet.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.ARCZonalShift.Model.UpdateZonalShiftResponse).
            Specifying the name of a property of type Amazon.ARCZonalShift.Model.UpdateZonalShiftResponse 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.AZS.UpdateAZSZonalShiftCmdlet.PassThru">
            <summary>
            Changes the cmdlet behavior to return the value passed to the ZonalShiftId parameter.
            The -PassThru parameter is deprecated, use -Select '^ZonalShiftId' instead. This parameter will be removed in a future version.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.AZS.UpdateAZSZonalShiftCmdlet.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>