AWS.Tools.ARCRegionswitch.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.ARCRegionswitch</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.ARC.AddARCResourceTagCmdlet"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ARC.AddARCResourceTagCmdlet.Arn"> <summary> <para> <para>The Amazon Resource Name (ARN) for a tag that you add to a resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ARC.AddARCResourceTagCmdlet.Tag"> <summary> <para> <para>Tags that you add to a resource. You can add a maximum of 50 tags in Region switch.</para><para /> Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ARC.AddARCResourceTagCmdlet.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.ARCRegionswitch.Model.TagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ARC.AddARCResourceTagCmdlet.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.ARC.ApproveARCPlanExecutionStepCmdlet"> <summary> 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. <para> You must specify the plan ARN, execution ID, step name, and approval status. You can also provide an optional comment explaining the approval decision. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ARC.ApproveARCPlanExecutionStepCmdlet.Approval"> <summary> <para> <para>The status of approval for a plan execution step. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ARC.ApproveARCPlanExecutionStepCmdlet.Comment"> <summary> <para> <para>A comment that you can enter about a plan execution.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ARC.ApproveARCPlanExecutionStepCmdlet.ExecutionId"> <summary> <para> <para>The execution identifier of a plan execution.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ARC.ApproveARCPlanExecutionStepCmdlet.PlanArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the plan.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ARC.ApproveARCPlanExecutionStepCmdlet.StepName"> <summary> <para> <para>The name of a step in a plan execution.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ARC.ApproveARCPlanExecutionStepCmdlet.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.ARCRegionswitch.Model.ApprovePlanExecutionStepResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ARC.ApproveARCPlanExecutionStepCmdlet.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.ARC.GetARCPlanCmdlet"> <summary> Retrieves detailed information about a Region switch plan. You must specify the ARN of the plan. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ARC.GetARCPlanCmdlet.Arn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the plan.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ARC.GetARCPlanCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Plan'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ARCRegionswitch.Model.GetPlanResponse). Specifying the name of a property of type Amazon.ARCRegionswitch.Model.GetPlanResponse 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.ARC.GetARCPlanEvaluationStatusCmdlet"> <summary> 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.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ARC.GetARCPlanEvaluationStatusCmdlet.PlanArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the Region switch plan to retrieve evaluation status for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ARC.GetARCPlanEvaluationStatusCmdlet.MaxResult"> <summary> <para> <para>The number of objects that you want to return with this call.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ARC.GetARCPlanEvaluationStatusCmdlet.NextToken"> <summary> <para> <para>Specifies that you want to receive the next page of results. Valid only if you received a <c>nextToken</c> 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 <c>nextToken</c> response to request the next page of results.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ARC.GetARCPlanEvaluationStatusCmdlet.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.ARCRegionswitch.Model.GetPlanEvaluationStatusResponse). Specifying the name of a property of type Amazon.ARCRegionswitch.Model.GetPlanEvaluationStatusResponse 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.ARC.GetARCPlanEvaluationStatusCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ARC.GetARCPlanExecutionCmdlet"> <summary> Retrieves detailed information about a specific plan execution. You must specify the plan ARN and execution ID.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ARC.GetARCPlanExecutionCmdlet.ExecutionId"> <summary> <para> <para>The execution identifier of a plan execution.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ARC.GetARCPlanExecutionCmdlet.PlanArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the plan with the execution to retrieve.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ARC.GetARCPlanExecutionCmdlet.MaxResult"> <summary> <para> <para>The number of objects that you want to return with this call.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ARC.GetARCPlanExecutionCmdlet.NextToken"> <summary> <para> <para>Specifies that you want to receive the next page of results. Valid only if you received a <c>nextToken</c> 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 <c>nextToken</c> response to request the next page of results.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ARC.GetARCPlanExecutionCmdlet.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.ARCRegionswitch.Model.GetPlanExecutionResponse). Specifying the name of a property of type Amazon.ARCRegionswitch.Model.GetPlanExecutionResponse 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.ARC.GetARCPlanExecutionCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ARC.GetARCPlanExecutionEventListCmdlet"> <summary> Lists the events that occurred during a plan execution. These events provide a detailed timeline of the execution process.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ARC.GetARCPlanExecutionEventListCmdlet.ExecutionId"> <summary> <para> <para>The execution identifier of a plan execution.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ARC.GetARCPlanExecutionEventListCmdlet.Name"> <summary> <para> <para>The name of the plan execution event.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ARC.GetARCPlanExecutionEventListCmdlet.PlanArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the plan.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ARC.GetARCPlanExecutionEventListCmdlet.MaxResult"> <summary> <para> <para>The number of objects that you want to return with this call.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ARC.GetARCPlanExecutionEventListCmdlet.NextToken"> <summary> <para> <para>Specifies that you want to receive the next page of results. Valid only if you received a <c>nextToken</c> 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 <c>nextToken</c> response to request the next page of results.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ARC.GetARCPlanExecutionEventListCmdlet.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.ARCRegionswitch.Model.ListPlanExecutionEventsResponse). Specifying the name of a property of type Amazon.ARCRegionswitch.Model.ListPlanExecutionEventsResponse 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.ARC.GetARCPlanExecutionEventListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ARC.GetARCPlanExecutionListCmdlet"> <summary> Lists the executions of a Region switch plan. This operation returns information about both current and historical executions.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ARC.GetARCPlanExecutionListCmdlet.PlanArn"> <summary> <para> <para>The ARN for the plan.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ARC.GetARCPlanExecutionListCmdlet.State"> <summary> <para> <para>The state of the plan execution. For example, the plan execution might be In Progress.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ARC.GetARCPlanExecutionListCmdlet.MaxResult"> <summary> <para> <para>The number of objects that you want to return with this call.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ARC.GetARCPlanExecutionListCmdlet.NextToken"> <summary> <para> <para>Specifies that you want to receive the next page of results. Valid only if you received a <c>nextToken</c> 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 <c>nextToken</c> response to request the next page of results.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ARC.GetARCPlanExecutionListCmdlet.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.ARCRegionswitch.Model.ListPlanExecutionsResponse). Specifying the name of a property of type Amazon.ARCRegionswitch.Model.ListPlanExecutionsResponse 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.ARC.GetARCPlanExecutionListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ARC.GetARCPlanInRegionCmdlet"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ARC.GetARCPlanInRegionCmdlet.Arn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the plan in Region.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ARC.GetARCPlanInRegionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Plan'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ARCRegionswitch.Model.GetPlanInRegionResponse). Specifying the name of a property of type Amazon.ARCRegionswitch.Model.GetPlanInRegionResponse 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.ARC.GetARCPlanListCmdlet"> <summary> Lists all Region switch plans in your Amazon Web Services account.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ARC.GetARCPlanListCmdlet.MaxResult"> <summary> <para> <para>The number of objects that you want to return with this call.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ARC.GetARCPlanListCmdlet.NextToken"> <summary> <para> <para>Specifies that you want to receive the next page of results. Valid only if you received a <c>nextToken</c> 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 <c>nextToken</c> response to request the next page of results.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ARC.GetARCPlanListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Plans'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ARCRegionswitch.Model.ListPlansResponse). Specifying the name of a property of type Amazon.ARCRegionswitch.Model.ListPlansResponse 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.ARC.GetARCPlanListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ARC.GetARCPlansInRegionListCmdlet"> <summary> Lists all Region switch plans in your Amazon Web Services account that are available in the current Amazon Web Services Region.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ARC.GetARCPlansInRegionListCmdlet.MaxResult"> <summary> <para> <para>The number of objects that you want to return with this call.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ARC.GetARCPlansInRegionListCmdlet.NextToken"> <summary> <para> <para>Specifies that you want to receive the next page of results. Valid only if you received a <c>nextToken</c> 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 <c>nextToken</c> response to request the next page of results.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ARC.GetARCPlansInRegionListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Plans'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ARCRegionswitch.Model.ListPlansInRegionResponse). Specifying the name of a property of type Amazon.ARCRegionswitch.Model.ListPlansInRegionResponse 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.ARC.GetARCPlansInRegionListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ARC.GetARCResourceTagCmdlet"> <summary> Lists the tags attached to a Region switch resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ARC.GetARCResourceTagCmdlet.Arn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ARC.GetARCResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ResourceTags'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ARCRegionswitch.Model.ListTagsForResourceResponse). Specifying the name of a property of type Amazon.ARCRegionswitch.Model.ListTagsForResourceResponse 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.ARC.GetARCRoute53HealthCheckListCmdlet"> <summary> List the Amazon Route 53 health checks.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ARC.GetARCRoute53HealthCheckListCmdlet.Arn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the Amazon Route 53 health check request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ARC.GetARCRoute53HealthCheckListCmdlet.HostedZoneId"> <summary> <para> <para>The hosted zone ID for the health checks.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ARC.GetARCRoute53HealthCheckListCmdlet.RecordName"> <summary> <para> <para>The record name for the health checks.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ARC.GetARCRoute53HealthCheckListCmdlet.MaxResult"> <summary> <para> <para>The number of objects that you want to return with this call.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ARC.GetARCRoute53HealthCheckListCmdlet.NextToken"> <summary> <para> <para>Specifies that you want to receive the next page of results. Valid only if you received a <c>nextToken</c> 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 <c>nextToken</c> response to request the next page of results.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ARC.GetARCRoute53HealthCheckListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'HealthChecks'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ARCRegionswitch.Model.ListRoute53HealthChecksResponse). Specifying the name of a property of type Amazon.ARCRegionswitch.Model.ListRoute53HealthChecksResponse 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.ARC.GetARCRoute53HealthCheckListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ARC.NewARCPlanCmdlet"> <summary> Creates a new Region switch plan. A plan defines the steps required to shift traffic from one Amazon Web Services Region to another. <para> 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. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ARC.NewARCPlanCmdlet.AssociatedAlarm"> <summary> <para> <para>The alarms associated with a Region switch plan.</para><para /> Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ARC.NewARCPlanCmdlet.Description"> <summary> <para> <para>The description of a Region switch plan.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ARC.NewARCPlanCmdlet.ExecutionRole"> <summary> <para> <para>An execution role is a way to categorize a Region switch plan.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ARC.NewARCPlanCmdlet.Name"> <summary> <para> <para>The name of a Region switch plan.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ARC.NewARCPlanCmdlet.PrimaryRegion"> <summary> <para> <para>The primary Amazon Web Services Region for the application. This is the Region where the application normally runs before any Region switch occurs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ARC.NewARCPlanCmdlet.RecoveryApproach"> <summary> <para> <para>The recovery approach for a Region switch plan, which can be active/active (activeActive) or active/passive (activePassive).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ARC.NewARCPlanCmdlet.RecoveryTimeObjectiveMinute"> <summary> <para> <para>Optionally, you can specify an recovery time objective for a Region switch plan, in minutes.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ARC.NewARCPlanCmdlet.PlanRegions"> <summary> <para> <para>An array that specifies the Amazon Web Services Regions for a Region switch plan. Specify two Regions.</para><para /> Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ARC.NewARCPlanCmdlet.Tag"> <summary> <para> <para>The tags to apply to the Region switch plan.</para><para /> Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ARC.NewARCPlanCmdlet.Trigger"> <summary> <para> <para>The triggers associated with a Region switch plan.</para><para /> Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ARC.NewARCPlanCmdlet.Workflow"> <summary> <para> <para>An array of workflows included in a Region switch plan.</para><para /> Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ARC.NewARCPlanCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Plan'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ARCRegionswitch.Model.CreatePlanResponse). Specifying the name of a property of type Amazon.ARCRegionswitch.Model.CreatePlanResponse 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.ARC.NewARCPlanCmdlet.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.ARC.RemoveARCPlanCmdlet"> <summary> Deletes a Region switch plan. You must specify the ARN of the plan to delete. <para> You cannot delete a plan that has an active execution in progress. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ARC.RemoveARCPlanCmdlet.Arn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the plan.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ARC.RemoveARCPlanCmdlet.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.ARCRegionswitch.Model.DeletePlanResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ARC.RemoveARCPlanCmdlet.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.ARC.RemoveARCResourceTagCmdlet"> <summary> Removes tags from a Region switch resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ARC.RemoveARCResourceTagCmdlet.Arn"> <summary> <para> <para>The Amazon Resource Name (ARN) for a tag you remove a resource from.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ARC.RemoveARCResourceTagCmdlet.ResourceTagKey"> <summary> <para> <para>Tag keys that you remove from a resource.</para><para /> Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ARC.RemoveARCResourceTagCmdlet.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.ARCRegionswitch.Model.UntagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ARC.RemoveARCResourceTagCmdlet.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.ARC.StartARCPlanExecutionCmdlet"> <summary> Starts the execution of a Region switch plan. You can execute a plan in either PRACTICE or RECOVERY mode. <para> In PRACTICE mode, the execution simulates the steps without making actual changes to your application's traffic routing. In RECOVERY mode, the execution performs actual changes to shift traffic between Regions. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ARC.StartARCPlanExecutionCmdlet.Action"> <summary> <para> <para>The action to perform. Valid values are ACTIVATE (to shift traffic to the target Region) or DEACTIVATE (to shift traffic away from the target Region).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ARC.StartARCPlanExecutionCmdlet.Comment"> <summary> <para> <para>An optional comment explaining why the plan execution is being started.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ARC.StartARCPlanExecutionCmdlet.LatestVersion"> <summary> <para> <para>A boolean value indicating whether to use the latest version of the plan. If set to false, you must specify a specific version.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ARC.StartARCPlanExecutionCmdlet.Mode"> <summary> <para> <para>The plan execution mode. Valid values are <c>Practice</c>, for testing without making actual changes, or <c>Recovery</c>, for actual traffic shifting and application recovery.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ARC.StartARCPlanExecutionCmdlet.PlanArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the plan to execute.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ARC.StartARCPlanExecutionCmdlet.TargetRegion"> <summary> <para> <para>The Amazon Web Services Region to target with this execution. This is the Region that traffic will be shifted to or from, depending on the action.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ARC.StartARCPlanExecutionCmdlet.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.ARCRegionswitch.Model.StartPlanExecutionResponse). Specifying the name of a property of type Amazon.ARCRegionswitch.Model.StartPlanExecutionResponse 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.ARC.StartARCPlanExecutionCmdlet.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.ARC.StopARCPlanExecutionCmdlet"> <summary> Cancels an in-progress plan execution. This operation stops the execution of the plan and prevents any further steps from being processed. <para> You must specify the plan ARN and execution ID. You can also provide an optional comment explaining why the execution was canceled. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ARC.StopARCPlanExecutionCmdlet.Comment"> <summary> <para> <para>A comment that you can enter about canceling a plan execution step.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ARC.StopARCPlanExecutionCmdlet.ExecutionId"> <summary> <para> <para>The execution identifier of a plan execution.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ARC.StopARCPlanExecutionCmdlet.PlanArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the plan.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ARC.StopARCPlanExecutionCmdlet.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.ARCRegionswitch.Model.CancelPlanExecutionResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ARC.StopARCPlanExecutionCmdlet.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.ARC.UpdateARCPlanCmdlet"> <summary> Updates an existing Region switch plan. You can modify the plan's description, workflows, execution role, recovery time objective, associated alarms, and triggers. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ARC.UpdateARCPlanCmdlet.Arn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the plan.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ARC.UpdateARCPlanCmdlet.AssociatedAlarm"> <summary> <para> <para>The updated CloudWatch alarms associated with the plan.</para><para /> Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ARC.UpdateARCPlanCmdlet.Description"> <summary> <para> <para>The updated description for the Region switch plan.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ARC.UpdateARCPlanCmdlet.ExecutionRole"> <summary> <para> <para>The updated IAM role ARN that grants Region switch the permissions needed to execute the plan steps.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ARC.UpdateARCPlanCmdlet.RecoveryTimeObjectiveMinute"> <summary> <para> <para>The updated target recovery time objective (RTO) in minutes for the plan.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ARC.UpdateARCPlanCmdlet.Trigger"> <summary> <para> <para>The updated conditions that can automatically trigger the execution of the plan.</para><para /> Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ARC.UpdateARCPlanCmdlet.Workflow"> <summary> <para> <para>The updated workflows for the Region switch plan.</para><para /> Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ARC.UpdateARCPlanCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Plan'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ARCRegionswitch.Model.UpdatePlanResponse). Specifying the name of a property of type Amazon.ARCRegionswitch.Model.UpdatePlanResponse 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.ARC.UpdateARCPlanCmdlet.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.ARC.UpdateARCPlanExecutionCmdlet"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ARC.UpdateARCPlanExecutionCmdlet.Action"> <summary> <para> <para>The action specified for a plan execution, for example, Switch to Graceful or Pause.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ARC.UpdateARCPlanExecutionCmdlet.Comment"> <summary> <para> <para>An optional comment about the plan execution.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ARC.UpdateARCPlanExecutionCmdlet.ExecutionId"> <summary> <para> <para>The execution identifier of a plan execution.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ARC.UpdateARCPlanExecutionCmdlet.PlanArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the plan with the execution to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ARC.UpdateARCPlanExecutionCmdlet.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.ARCRegionswitch.Model.UpdatePlanExecutionResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ARC.UpdateARCPlanExecutionCmdlet.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.ARC.UpdateARCPlanExecutionStepCmdlet"> <summary> Updates a specific step in an in-progress plan execution. This operation allows you to modify the step's comment or action. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ARC.UpdateARCPlanExecutionStepCmdlet.ActionToTake"> <summary> <para> <para>The updated action to take for the step. This can be used to skip or retry a step.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ARC.UpdateARCPlanExecutionStepCmdlet.Comment"> <summary> <para> <para>An optional comment about the plan execution.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ARC.UpdateARCPlanExecutionStepCmdlet.ExecutionId"> <summary> <para> <para>The unique identifier of the plan execution containing the step to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ARC.UpdateARCPlanExecutionStepCmdlet.PlanArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the plan containing the execution step to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ARC.UpdateARCPlanExecutionStepCmdlet.StepName"> <summary> <para> <para>The name of the execution step to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ARC.UpdateARCPlanExecutionStepCmdlet.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.ARCRegionswitch.Model.UpdatePlanExecutionStepResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ARC.UpdateARCPlanExecutionStepCmdlet.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> |