AWS.Tools.Route53RecoveryControlConfig.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.Route53RecoveryControlConfig</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.R53RC.AddR53RCResourceTagCmdlet"> <summary> Adds a tag to a resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53RC.AddR53RCResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) for the resource that's tagged.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53RC.AddR53RCResourceTagCmdlet.Tag"> <summary> <para> <para>The tags associated with the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53RC.AddR53RCResourceTagCmdlet.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.Route53RecoveryControlConfig.Model.TagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53RC.AddR53RCResourceTagCmdlet.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.R53RC.GetR53RCAssociatedRoute53HealthCheckListCmdlet"> <summary> Returns an array of all Amazon Route 53 health checks associated with a specific routing control.<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.R53RC.GetR53RCAssociatedRoute53HealthCheckListCmdlet.RoutingControlArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the routing control.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53RC.GetR53RCAssociatedRoute53HealthCheckListCmdlet.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.R53RC.GetR53RCAssociatedRoute53HealthCheckListCmdlet.NextToken"> <summary> <para> <para>The token that identifies which batch of results you want to see.</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/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53RC.GetR53RCAssociatedRoute53HealthCheckListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'HealthCheckIds'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Route53RecoveryControlConfig.Model.ListAssociatedRoute53HealthChecksResponse). Specifying the name of a property of type Amazon.Route53RecoveryControlConfig.Model.ListAssociatedRoute53HealthChecksResponse 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.R53RC.GetR53RCAssociatedRoute53HealthCheckListCmdlet.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.R53RC.GetR53RCClusterCmdlet"> <summary> Display the details about a cluster. The response includes the cluster name, endpoints, status, and Amazon Resource Name (ARN). </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53RC.GetR53RCClusterCmdlet.ClusterArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53RC.GetR53RCClusterCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Cluster'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Route53RecoveryControlConfig.Model.DescribeClusterResponse). Specifying the name of a property of type Amazon.Route53RecoveryControlConfig.Model.DescribeClusterResponse 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.R53RC.GetR53RCClusterListCmdlet"> <summary> Returns an array of all the clusters in an 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.R53RC.GetR53RCClusterListCmdlet.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.R53RC.GetR53RCClusterListCmdlet.NextToken"> <summary> <para> <para>The token that identifies which batch of results you want to see.</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/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53RC.GetR53RCClusterListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Clusters'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Route53RecoveryControlConfig.Model.ListClustersResponse). Specifying the name of a property of type Amazon.Route53RecoveryControlConfig.Model.ListClustersResponse 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.R53RC.GetR53RCClusterListCmdlet.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.R53RC.GetR53RCControlPanelCmdlet"> <summary> Displays details about a control panel. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53RC.GetR53RCControlPanelCmdlet.ControlPanelArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the control panel.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53RC.GetR53RCControlPanelCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ControlPanel'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Route53RecoveryControlConfig.Model.DescribeControlPanelResponse). Specifying the name of a property of type Amazon.Route53RecoveryControlConfig.Model.DescribeControlPanelResponse 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.R53RC.GetR53RCControlPanelListCmdlet"> <summary> Returns an array of control panels in an account or in a cluster.<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.R53RC.GetR53RCControlPanelListCmdlet.ClusterArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of a cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53RC.GetR53RCControlPanelListCmdlet.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.R53RC.GetR53RCControlPanelListCmdlet.NextToken"> <summary> <para> <para>The token that identifies which batch of results you want to see.</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/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53RC.GetR53RCControlPanelListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ControlPanels'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Route53RecoveryControlConfig.Model.ListControlPanelsResponse). Specifying the name of a property of type Amazon.Route53RecoveryControlConfig.Model.ListControlPanelsResponse 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.R53RC.GetR53RCControlPanelListCmdlet.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.R53RC.GetR53RCResourcePolicyCmdlet"> <summary> Get information about the resource policy for a cluster. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53RC.GetR53RCResourcePolicyCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53RC.GetR53RCResourcePolicyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Policy'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Route53RecoveryControlConfig.Model.GetResourcePolicyResponse). Specifying the name of a property of type Amazon.Route53RecoveryControlConfig.Model.GetResourcePolicyResponse 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.R53RC.GetR53RCResourceTagCmdlet"> <summary> Lists the tags for a resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53RC.GetR53RCResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) for the resource that's tagged.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53RC.GetR53RCResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Tags'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Route53RecoveryControlConfig.Model.ListTagsForResourceResponse). Specifying the name of a property of type Amazon.Route53RecoveryControlConfig.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.R53RC.GetR53RCRoutingControlCmdlet"> <summary> Displays details about a routing control. A routing control has one of two states: ON and OFF. You can map the routing control state to the state of an Amazon Route 53 health check, which can be used to control routing. <para> To get or update the routing control state, see the Recovery Cluster (data plane) API actions for Amazon Route 53 Application Recovery Controller. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53RC.GetR53RCRoutingControlCmdlet.RoutingControlArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the routing control.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53RC.GetR53RCRoutingControlCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'RoutingControl'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Route53RecoveryControlConfig.Model.DescribeRoutingControlResponse). Specifying the name of a property of type Amazon.Route53RecoveryControlConfig.Model.DescribeRoutingControlResponse 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.R53RC.GetR53RCRoutingControlListCmdlet"> <summary> Returns an array of routing controls for a control panel. A routing control is an Amazon Route 53 Application Recovery Controller construct that has one of two states: ON and OFF. You can map the routing control state to the state of an Amazon Route 53 health check, which can be used to control routing.<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.R53RC.GetR53RCRoutingControlListCmdlet.ControlPanelArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the control panel.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53RC.GetR53RCRoutingControlListCmdlet.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.R53RC.GetR53RCRoutingControlListCmdlet.NextToken"> <summary> <para> <para>The token that identifies which batch of results you want to see.</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/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53RC.GetR53RCRoutingControlListCmdlet.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.Route53RecoveryControlConfig.Model.ListRoutingControlsResponse). Specifying the name of a property of type Amazon.Route53RecoveryControlConfig.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.R53RC.GetR53RCRoutingControlListCmdlet.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.R53RC.GetR53RCSafetyRuleCmdlet"> <summary> Returns information about a safety rule. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53RC.GetR53RCSafetyRuleCmdlet.SafetyRuleArn"> <summary> <para> <para>The ARN of the safety rule.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53RC.GetR53RCSafetyRuleCmdlet.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.Route53RecoveryControlConfig.Model.DescribeSafetyRuleResponse). Specifying the name of a property of type Amazon.Route53RecoveryControlConfig.Model.DescribeSafetyRuleResponse 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.R53RC.GetR53RCSafetyRuleListCmdlet"> <summary> List the safety rules (the assertion rules and gating rules) that you've defined for the routing controls in a control panel.<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.R53RC.GetR53RCSafetyRuleListCmdlet.ControlPanelArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the control panel.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53RC.GetR53RCSafetyRuleListCmdlet.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.R53RC.GetR53RCSafetyRuleListCmdlet.NextToken"> <summary> <para> <para>The token that identifies which batch of results you want to see.</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/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53RC.GetR53RCSafetyRuleListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'SafetyRules'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Route53RecoveryControlConfig.Model.ListSafetyRulesResponse). Specifying the name of a property of type Amazon.Route53RecoveryControlConfig.Model.ListSafetyRulesResponse 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.R53RC.GetR53RCSafetyRuleListCmdlet.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.R53RC.NewR53RCClusterCmdlet"> <summary> Create a new cluster. A cluster is a set of redundant Regional endpoints against which you can run API calls to update or get the state of one or more routing controls. Each cluster has a name, status, Amazon Resource Name (ARN), and an array of the five cluster endpoints (one for each supported Amazon Web Services Region) that you can use with API calls to the cluster data plane. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53RC.NewR53RCClusterCmdlet.ClusterName"> <summary> <para> <para>The name of the cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53RC.NewR53RCClusterCmdlet.Tag"> <summary> <para> <para>The tags associated with the cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53RC.NewR53RCClusterCmdlet.ClientToken"> <summary> <para> <para>A unique, case-sensitive string of up to 64 ASCII characters. To make an idempotent API request with an action, specify a client token in the request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53RC.NewR53RCClusterCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Cluster'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Route53RecoveryControlConfig.Model.CreateClusterResponse). Specifying the name of a property of type Amazon.Route53RecoveryControlConfig.Model.CreateClusterResponse 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.R53RC.NewR53RCClusterCmdlet.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.R53RC.NewR53RCControlPanelCmdlet"> <summary> Creates a new control panel. A control panel represents a group of routing controls that can be changed together in a single transaction. You can use a control panel to centrally view the operational status of applications across your organization, and trigger multi-app failovers in a single transaction, for example, to fail over an Availability Zone or Amazon Web Services Region. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53RC.NewR53RCControlPanelCmdlet.ClusterArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the cluster for the control panel.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53RC.NewR53RCControlPanelCmdlet.ControlPanelName"> <summary> <para> <para>The name of the control panel.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53RC.NewR53RCControlPanelCmdlet.Tag"> <summary> <para> <para>The tags associated with the control panel.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53RC.NewR53RCControlPanelCmdlet.ClientToken"> <summary> <para> <para>A unique, case-sensitive string of up to 64 ASCII characters. To make an idempotent API request with an action, specify a client token in the request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53RC.NewR53RCControlPanelCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ControlPanel'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Route53RecoveryControlConfig.Model.CreateControlPanelResponse). Specifying the name of a property of type Amazon.Route53RecoveryControlConfig.Model.CreateControlPanelResponse 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.R53RC.NewR53RCControlPanelCmdlet.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.R53RC.NewR53RCRoutingControlCmdlet"> <summary> Creates a new routing control. <para> A routing control has one of two states: ON and OFF. You can map the routing control state to the state of an Amazon Route 53 health check, which can be used to control traffic routing. </para><para> To get or update the routing control state, see the Recovery Cluster (data plane) API actions for Amazon Route 53 Application Recovery Controller. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53RC.NewR53RCRoutingControlCmdlet.ClusterArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the cluster that includes the routing control.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53RC.NewR53RCRoutingControlCmdlet.ControlPanelArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the control panel that includes the routing control.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53RC.NewR53RCRoutingControlCmdlet.RoutingControlName"> <summary> <para> <para>The name of the routing control.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53RC.NewR53RCRoutingControlCmdlet.ClientToken"> <summary> <para> <para>A unique, case-sensitive string of up to 64 ASCII characters. To make an idempotent API request with an action, specify a client token in the request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53RC.NewR53RCRoutingControlCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'RoutingControl'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Route53RecoveryControlConfig.Model.CreateRoutingControlResponse). Specifying the name of a property of type Amazon.Route53RecoveryControlConfig.Model.CreateRoutingControlResponse 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.R53RC.NewR53RCRoutingControlCmdlet.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.R53RC.NewR53RCSafetyRuleCmdlet"> <summary> Creates a safety rule in a control panel. Safety rules let you add safeguards around changing routing control states, and for enabling and disabling routing controls, to help prevent unexpected outcomes. <para> There are two types of safety rules: assertion rules and gating rules. </para><para> Assertion rule: An assertion rule enforces that, when you change a routing control state, that a certain criteria is met. For example, the criteria might be that at least one routing control state is On after the transaction so that traffic continues to flow to at least one cell for the application. This ensures that you avoid a fail-open scenario. </para><para> Gating rule: A gating rule lets you configure a gating routing control as an overall "on/off" switch for a group of routing controls. Or, you can configure more complex gating scenarios, for example by configuring multiple gating routing controls. </para><para> For more information, see <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.safety-rules.html">Safety rules</a> in the Amazon Route 53 Application Recovery Controller Developer Guide. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53RC.NewR53RCSafetyRuleCmdlet.AssertionRule_AssertedControl"> <summary> <para> <para>The routing controls that are part of transactions that are evaluated to determine if a request to change a routing control state is allowed. For example, you might include three routing controls, one for each of three Amazon Web Services Regions.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53RC.NewR53RCSafetyRuleCmdlet.AssertionRule_ControlPanelArn"> <summary> <para> <para>The Amazon Resource Name (ARN) for the control panel.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53RC.NewR53RCSafetyRuleCmdlet.GatingRule_ControlPanelArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the control panel.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53RC.NewR53RCSafetyRuleCmdlet.GatingRule_GatingControl"> <summary> <para> <para>The gating controls for the new gating rule. That is, routing controls that are evaluated by the rule configuration that you specify.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53RC.NewR53RCSafetyRuleCmdlet.AssertionRule_RuleConfig_Inverted"> <summary> <para> <para>Logical negation of the rule. If the rule would usually evaluate true, it's evaluated as false, and vice versa.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53RC.NewR53RCSafetyRuleCmdlet.GatingRule_RuleConfig_Inverted"> <summary> <para> <para>Logical negation of the rule. If the rule would usually evaluate true, it's evaluated as false, and vice versa.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53RC.NewR53RCSafetyRuleCmdlet.AssertionRule_Name"> <summary> <para> <para>The name of the assertion rule. You can use any non-white space character in the name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53RC.NewR53RCSafetyRuleCmdlet.GatingRule_Name"> <summary> <para> <para>The name for the new gating rule.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53RC.NewR53RCSafetyRuleCmdlet.Tag"> <summary> <para> <para>The tags associated with the safety rule.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53RC.NewR53RCSafetyRuleCmdlet.GatingRule_TargetControl"> <summary> <para> <para>Routing controls that can only be set or unset if the specified RuleConfig evaluates to true for the specified GatingControls. For example, say you have three gating controls, one for each of three Amazon Web Services Regions. Now you specify ATLEAST 2 as your RuleConfig. With these settings, you can only change (set or unset) the routing controls that you have specified as TargetControls if that rule evaluates to true.</para><para>In other words, your ability to change the routing controls that you have specified as TargetControls is gated by the rule that you set for the routing controls in GatingControls.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53RC.NewR53RCSafetyRuleCmdlet.AssertionRule_RuleConfig_Threshold"> <summary> <para> <para>The value of N, when you specify an ATLEAST rule type. That is, Threshold is the number of controls that must be set when you specify an ATLEAST type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53RC.NewR53RCSafetyRuleCmdlet.GatingRule_RuleConfig_Threshold"> <summary> <para> <para>The value of N, when you specify an ATLEAST rule type. That is, Threshold is the number of controls that must be set when you specify an ATLEAST type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53RC.NewR53RCSafetyRuleCmdlet.AssertionRule_RuleConfig_Type"> <summary> <para> <para>A rule can be one of the following: ATLEAST, AND, or OR.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53RC.NewR53RCSafetyRuleCmdlet.GatingRule_RuleConfig_Type"> <summary> <para> <para>A rule can be one of the following: ATLEAST, AND, or OR.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53RC.NewR53RCSafetyRuleCmdlet.AssertionRule_WaitPeriodMs"> <summary> <para> <para>An evaluation period, in milliseconds (ms), during which any request against the target routing controls will fail. This helps prevent "flapping" of state. The wait period is 5000 ms by default, but you can choose a custom value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53RC.NewR53RCSafetyRuleCmdlet.GatingRule_WaitPeriodMs"> <summary> <para> <para>An evaluation period, in milliseconds (ms), during which any request against the target routing controls will fail. This helps prevent "flapping" of state. The wait period is 5000 ms by default, but you can choose a custom value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53RC.NewR53RCSafetyRuleCmdlet.ClientToken"> <summary> <para> <para>A unique, case-sensitive string of up to 64 ASCII characters. To make an idempotent API request with an action, specify a client token in the request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53RC.NewR53RCSafetyRuleCmdlet.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.Route53RecoveryControlConfig.Model.CreateSafetyRuleResponse). Specifying the name of a property of type Amazon.Route53RecoveryControlConfig.Model.CreateSafetyRuleResponse 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.R53RC.NewR53RCSafetyRuleCmdlet.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.R53RC.RemoveR53RCClusterCmdlet"> <summary> Delete a cluster. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53RC.RemoveR53RCClusterCmdlet.ClusterArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the cluster that you're deleting.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53RC.RemoveR53RCClusterCmdlet.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.Route53RecoveryControlConfig.Model.DeleteClusterResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53RC.RemoveR53RCClusterCmdlet.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.R53RC.RemoveR53RCControlPanelCmdlet"> <summary> Deletes a control panel. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53RC.RemoveR53RCControlPanelCmdlet.ControlPanelArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the control panel.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53RC.RemoveR53RCControlPanelCmdlet.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.Route53RecoveryControlConfig.Model.DeleteControlPanelResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53RC.RemoveR53RCControlPanelCmdlet.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.R53RC.RemoveR53RCResourceTagCmdlet"> <summary> Removes a tag from a resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53RC.RemoveR53RCResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) for the resource that's tagged.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53RC.RemoveR53RCResourceTagCmdlet.TagKey"> <summary> <para> <para>Keys for the tags to be removed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53RC.RemoveR53RCResourceTagCmdlet.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.Route53RecoveryControlConfig.Model.UntagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53RC.RemoveR53RCResourceTagCmdlet.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.R53RC.RemoveR53RCRoutingControlCmdlet"> <summary> Deletes a routing control. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53RC.RemoveR53RCRoutingControlCmdlet.RoutingControlArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the routing control that you're deleting.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53RC.RemoveR53RCRoutingControlCmdlet.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.Route53RecoveryControlConfig.Model.DeleteRoutingControlResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53RC.RemoveR53RCRoutingControlCmdlet.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.R53RC.RemoveR53RCSafetyRuleCmdlet"> <summary> Deletes a safety rule. /> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53RC.RemoveR53RCSafetyRuleCmdlet.SafetyRuleArn"> <summary> <para> <para>The ARN of the safety rule.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53RC.RemoveR53RCSafetyRuleCmdlet.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.Route53RecoveryControlConfig.Model.DeleteSafetyRuleResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53RC.RemoveR53RCSafetyRuleCmdlet.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.R53RC.UpdateR53RCControlPanelCmdlet"> <summary> Updates a control panel. The only update you can make to a control panel is to change the name of the control panel. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53RC.UpdateR53RCControlPanelCmdlet.ControlPanelArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the control panel.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53RC.UpdateR53RCControlPanelCmdlet.ControlPanelName"> <summary> <para> <para>The name of the control panel.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53RC.UpdateR53RCControlPanelCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ControlPanel'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Route53RecoveryControlConfig.Model.UpdateControlPanelResponse). Specifying the name of a property of type Amazon.Route53RecoveryControlConfig.Model.UpdateControlPanelResponse 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.R53RC.UpdateR53RCControlPanelCmdlet.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.R53RC.UpdateR53RCRoutingControlCmdlet"> <summary> Updates a routing control. You can only update the name of the routing control. To get or update the routing control state, see the Recovery Cluster (data plane) API actions for Amazon Route 53 Application Recovery Controller. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53RC.UpdateR53RCRoutingControlCmdlet.RoutingControlArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the routing control.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53RC.UpdateR53RCRoutingControlCmdlet.RoutingControlName"> <summary> <para> <para>The name of the routing control.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53RC.UpdateR53RCRoutingControlCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'RoutingControl'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Route53RecoveryControlConfig.Model.UpdateRoutingControlResponse). Specifying the name of a property of type Amazon.Route53RecoveryControlConfig.Model.UpdateRoutingControlResponse 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.R53RC.UpdateR53RCRoutingControlCmdlet.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.R53RC.UpdateR53RCSafetyRuleCmdlet"> <summary> Update a safety rule (an assertion rule or gating rule). You can only update the name and the waiting period for a safety rule. To make other updates, delete the safety rule and create a new one. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53RC.UpdateR53RCSafetyRuleCmdlet.AssertionRuleUpdate_Name"> <summary> <para> <para>The name of the assertion rule. You can use any non-white space character in the name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53RC.UpdateR53RCSafetyRuleCmdlet.GatingRuleUpdate_Name"> <summary> <para> <para>The name for the gating rule. You can use any non-white space character in the name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53RC.UpdateR53RCSafetyRuleCmdlet.AssertionRuleUpdate_SafetyRuleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the assertion rule.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53RC.UpdateR53RCSafetyRuleCmdlet.GatingRuleUpdate_SafetyRuleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the gating rule.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53RC.UpdateR53RCSafetyRuleCmdlet.AssertionRuleUpdate_WaitPeriodMs"> <summary> <para> <para>An evaluation period, in milliseconds (ms), during which any request against the target routing controls will fail. This helps prevent "flapping" of state. The wait period is 5000 ms by default, but you can choose a custom value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53RC.UpdateR53RCSafetyRuleCmdlet.GatingRuleUpdate_WaitPeriodMs"> <summary> <para> <para>An evaluation period, in milliseconds (ms), during which any request against the target routing controls will fail. This helps prevent "flapping" of state. The wait period is 5000 ms by default, but you can choose a custom value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.R53RC.UpdateR53RCSafetyRuleCmdlet.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.Route53RecoveryControlConfig.Model.UpdateSafetyRuleResponse). Specifying the name of a property of type Amazon.Route53RecoveryControlConfig.Model.UpdateSafetyRuleResponse 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.R53RC.UpdateR53RCSafetyRuleCmdlet.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> |