AWS.Tools.GlobalAccelerator.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.GlobalAccelerator</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.GACL.GetGACLAcceleratorCmdlet"> <summary> Describe an accelerator. To see an AWS CLI example of describing an accelerator, scroll down to <b>Example</b>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GACL.GetGACLAcceleratorCmdlet.AcceleratorArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the accelerator to describe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GACL.GetGACLAcceleratorCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Accelerator'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.GlobalAccelerator.Model.DescribeAcceleratorResponse). Specifying the name of a property of type Amazon.GlobalAccelerator.Model.DescribeAcceleratorResponse 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.GACL.GetGACLAcceleratorCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AcceleratorArn parameter. The -PassThru parameter is deprecated, use -Select '^AcceleratorArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.GACL.GetGACLAcceleratorAttributeCmdlet"> <summary> Describe the attributes of an accelerator. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GACL.GetGACLAcceleratorAttributeCmdlet.AcceleratorArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the accelerator with the attributes that you want to describe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GACL.GetGACLAcceleratorAttributeCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AcceleratorAttributes'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.GlobalAccelerator.Model.DescribeAcceleratorAttributesResponse). Specifying the name of a property of type Amazon.GlobalAccelerator.Model.DescribeAcceleratorAttributesResponse 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.GACL.GetGACLAcceleratorAttributeCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AcceleratorArn parameter. The -PassThru parameter is deprecated, use -Select '^AcceleratorArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.GACL.GetGACLAcceleratorListCmdlet"> <summary> List the accelerators for an AWS 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.GACL.GetGACLAcceleratorListCmdlet.MaxResult"> <summary> <para> <para>The number of Global Accelerator objects that you want to return with this call. The default value is 10.</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> <para>If a value for this parameter is not specified the cmdlet will use a default value of '<b>100</b>'.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GACL.GetGACLAcceleratorListCmdlet.NextToken"> <summary> <para> <para>The token for the next set of results. You receive this token from a previous call.</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.GACL.GetGACLAcceleratorListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Accelerators'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.GlobalAccelerator.Model.ListAcceleratorsResponse). Specifying the name of a property of type Amazon.GlobalAccelerator.Model.ListAcceleratorsResponse 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.GACL.GetGACLAcceleratorListCmdlet.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.GACL.GetGACLEndpointGroupCmdlet"> <summary> Describe an endpoint group. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GACL.GetGACLEndpointGroupCmdlet.EndpointGroupArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the endpoint group to describe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GACL.GetGACLEndpointGroupCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'EndpointGroup'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.GlobalAccelerator.Model.DescribeEndpointGroupResponse). Specifying the name of a property of type Amazon.GlobalAccelerator.Model.DescribeEndpointGroupResponse 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.GACL.GetGACLEndpointGroupCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the EndpointGroupArn parameter. The -PassThru parameter is deprecated, use -Select '^EndpointGroupArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.GACL.GetGACLEndpointGroupListCmdlet"> <summary> List the endpoint groups that are associated with a listener.<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.GACL.GetGACLEndpointGroupListCmdlet.ListenerArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the listener.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GACL.GetGACLEndpointGroupListCmdlet.MaxResult"> <summary> <para> <para>The number of endpoint group objects that you want to return with this call. The default value is 10.</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> <para>If a value for this parameter is not specified the cmdlet will use a default value of '<b>100</b>'.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GACL.GetGACLEndpointGroupListCmdlet.NextToken"> <summary> <para> <para>The token for the next set of results. You receive this token from a previous call.</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.GACL.GetGACLEndpointGroupListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'EndpointGroups'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.GlobalAccelerator.Model.ListEndpointGroupsResponse). Specifying the name of a property of type Amazon.GlobalAccelerator.Model.ListEndpointGroupsResponse 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.GACL.GetGACLEndpointGroupListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ListenerArn parameter. The -PassThru parameter is deprecated, use -Select '^ListenerArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GACL.GetGACLEndpointGroupListCmdlet.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.GACL.GetGACLListenerCmdlet"> <summary> Describe a listener. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GACL.GetGACLListenerCmdlet.ListenerArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the listener to describe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GACL.GetGACLListenerCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Listener'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.GlobalAccelerator.Model.DescribeListenerResponse). Specifying the name of a property of type Amazon.GlobalAccelerator.Model.DescribeListenerResponse 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.GACL.GetGACLListenerCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ListenerArn parameter. The -PassThru parameter is deprecated, use -Select '^ListenerArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.GACL.GetGACLListenerListCmdlet"> <summary> List the listeners for an accelerator.<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.GACL.GetGACLListenerListCmdlet.AcceleratorArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the accelerator for which you want to list listener objects.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GACL.GetGACLListenerListCmdlet.MaxResult"> <summary> <para> <para>The number of listener objects that you want to return with this call. The default value is 10.</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> <para>If a value for this parameter is not specified the cmdlet will use a default value of '<b>100</b>'.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GACL.GetGACLListenerListCmdlet.NextToken"> <summary> <para> <para>The token for the next set of results. You receive this token from a previous call.</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.GACL.GetGACLListenerListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Listeners'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.GlobalAccelerator.Model.ListListenersResponse). Specifying the name of a property of type Amazon.GlobalAccelerator.Model.ListListenersResponse 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.GACL.GetGACLListenerListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AcceleratorArn parameter. The -PassThru parameter is deprecated, use -Select '^AcceleratorArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GACL.GetGACLListenerListCmdlet.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.GACL.NewGACLAcceleratorCmdlet"> <summary> Create an accelerator. An accelerator includes one or more listeners that process inbound connections and direct traffic to one or more endpoint groups, each of which includes endpoints, such as Network Load Balancers. To see an AWS CLI example of creating an accelerator, scroll down to <b>Example</b>. <important><para> You must specify the US-West-2 (Oregon) Region to create or update accelerators. </para></important> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GACL.NewGACLAcceleratorCmdlet.Enabled"> <summary> <para> <para>Indicates whether an accelerator is enabled. The value is true or false. The default value is true. </para><para>If the value is set to true, an accelerator cannot be deleted. If set to false, the accelerator can be deleted.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GACL.NewGACLAcceleratorCmdlet.IdempotencyToken"> <summary> <para> <para>A unique, case-sensitive identifier that you provide to ensure the idempotency—that is, the uniqueness—of an accelerator.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GACL.NewGACLAcceleratorCmdlet.IpAddressType"> <summary> <para> <para>The value for the address type must be IPv4. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GACL.NewGACLAcceleratorCmdlet.Name"> <summary> <para> <para>The name of an accelerator. The name can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens (-), and must not begin or end with a hyphen.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GACL.NewGACLAcceleratorCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Accelerator'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.GlobalAccelerator.Model.CreateAcceleratorResponse). Specifying the name of a property of type Amazon.GlobalAccelerator.Model.CreateAcceleratorResponse 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.GACL.NewGACLAcceleratorCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GACL.NewGACLAcceleratorCmdlet.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.GACL.NewGACLEndpointGroupCmdlet"> <summary> Create an endpoint group for the specified listener. An endpoint group is a collection of endpoints in one AWS Region. To see an AWS CLI example of creating an endpoint group, scroll down to <b>Example</b>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GACL.NewGACLEndpointGroupCmdlet.EndpointConfiguration"> <summary> <para> <para>The list of endpoint objects.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GACL.NewGACLEndpointGroupCmdlet.EndpointGroupRegion"> <summary> <para> <para>The name of the AWS Region where the endpoint group is located. A listener can have only one endpoint group in a specific Region.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GACL.NewGACLEndpointGroupCmdlet.HealthCheckIntervalSecond"> <summary> <para> <para>The time—10 seconds or 30 seconds—between each health check for an endpoint. The default value is 30.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GACL.NewGACLEndpointGroupCmdlet.HealthCheckPath"> <summary> <para> <para>If the protocol is HTTP/S, then this specifies the path that is the destination for health check targets. The default value is slash (/).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GACL.NewGACLEndpointGroupCmdlet.HealthCheckPort"> <summary> <para> <para>The port that AWS Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default port is the listener port that this endpoint group is associated with. If listener port is a list of ports, Global Accelerator uses the first port in the list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GACL.NewGACLEndpointGroupCmdlet.HealthCheckProtocol"> <summary> <para> <para>The protocol that AWS Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default value is TCP.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GACL.NewGACLEndpointGroupCmdlet.IdempotencyToken"> <summary> <para> <para>A unique, case-sensitive identifier that you provide to ensure the idempotency—that is, the uniqueness—of the request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GACL.NewGACLEndpointGroupCmdlet.ListenerArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the listener.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GACL.NewGACLEndpointGroupCmdlet.ThresholdCount"> <summary> <para> <para>The number of consecutive health checks required to set the state of a healthy endpoint to unhealthy, or to set an unhealthy endpoint to healthy. The default value is 3.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GACL.NewGACLEndpointGroupCmdlet.TrafficDialPercentage"> <summary> <para> <para>The percentage of traffic to send to an AWS Region. Additional traffic is distributed to other endpoint groups for this listener. </para><para>Use this action to increase (dial up) or decrease (dial down) traffic to a specific Region. The percentage is applied to the traffic that would otherwise have been routed to the Region based on optimal routing.</para><para>The default value is 100.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GACL.NewGACLEndpointGroupCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'EndpointGroup'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.GlobalAccelerator.Model.CreateEndpointGroupResponse). Specifying the name of a property of type Amazon.GlobalAccelerator.Model.CreateEndpointGroupResponse 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.GACL.NewGACLEndpointGroupCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ListenerArn parameter. The -PassThru parameter is deprecated, use -Select '^ListenerArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GACL.NewGACLEndpointGroupCmdlet.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.GACL.NewGACLListenerCmdlet"> <summary> Create a listener to process inbound connections from clients to an accelerator. Connections arrive to assigned static IP addresses on a port, port range, or list of port ranges that you specify. To see an AWS CLI example of creating a listener, scroll down to <b>Example</b>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GACL.NewGACLListenerCmdlet.AcceleratorArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of your accelerator.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GACL.NewGACLListenerCmdlet.ClientAffinity"> <summary> <para> <para>Client affinity lets you direct all requests from a user to the same endpoint, if you have stateful applications, regardless of the port and protocol of the client request. Clienty affinity gives you control over whether to always route each client to the same specific endpoint.</para><para>AWS Global Accelerator uses a consistent-flow hashing algorithm to choose the optimal endpoint for a connection. If client affinity is <code>NONE</code>, Global Accelerator uses the "five-tuple" (5-tuple) properties—source IP address, source port, destination IP address, destination port, and protocol—to select the hash value, and then chooses the best endpoint. However, with this setting, if someone uses different ports to connect to Global Accelerator, their connections might not be always routed to the same endpoint because the hash value changes. </para><para>If you want a given client to always be routed to the same endpoint, set client affinity to <code>SOURCE_IP</code> instead. When you use the <code>SOURCE_IP</code> setting, Global Accelerator uses the "two-tuple" (2-tuple) properties— source (client) IP address and destination IP address—to select the hash value.</para><para>The default value is <code>NONE</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GACL.NewGACLListenerCmdlet.IdempotencyToken"> <summary> <para> <para>A unique, case-sensitive identifier that you provide to ensure the idempotency—that is, the uniqueness—of the request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GACL.NewGACLListenerCmdlet.PortRange"> <summary> <para> <para>The list of port ranges to support for connections from clients to your accelerator.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GACL.NewGACLListenerCmdlet.Protocol"> <summary> <para> <para>The protocol for connections from clients to your accelerator.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GACL.NewGACLListenerCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Listener'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.GlobalAccelerator.Model.CreateListenerResponse). Specifying the name of a property of type Amazon.GlobalAccelerator.Model.CreateListenerResponse 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.GACL.NewGACLListenerCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AcceleratorArn parameter. The -PassThru parameter is deprecated, use -Select '^AcceleratorArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GACL.NewGACLListenerCmdlet.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.GACL.RemoveGACLAcceleratorCmdlet"> <summary> Delete an accelerator. Note: before you can delete an accelerator, you must disable it and remove all dependent resources (listeners and endpoint groups). </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GACL.RemoveGACLAcceleratorCmdlet.AcceleratorArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of an accelerator.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GACL.RemoveGACLAcceleratorCmdlet.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.GlobalAccelerator.Model.DeleteAcceleratorResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GACL.RemoveGACLAcceleratorCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AcceleratorArn parameter. The -PassThru parameter is deprecated, use -Select '^AcceleratorArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GACL.RemoveGACLAcceleratorCmdlet.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.GACL.RemoveGACLEndpointGroupCmdlet"> <summary> Delete an endpoint group from a listener. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GACL.RemoveGACLEndpointGroupCmdlet.EndpointGroupArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the endpoint group to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GACL.RemoveGACLEndpointGroupCmdlet.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.GlobalAccelerator.Model.DeleteEndpointGroupResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GACL.RemoveGACLEndpointGroupCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the EndpointGroupArn parameter. The -PassThru parameter is deprecated, use -Select '^EndpointGroupArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GACL.RemoveGACLEndpointGroupCmdlet.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.GACL.RemoveGACLListenerCmdlet"> <summary> Delete a listener from an accelerator. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GACL.RemoveGACLListenerCmdlet.ListenerArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the listener.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GACL.RemoveGACLListenerCmdlet.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.GlobalAccelerator.Model.DeleteListenerResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GACL.RemoveGACLListenerCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ListenerArn parameter. The -PassThru parameter is deprecated, use -Select '^ListenerArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GACL.RemoveGACLListenerCmdlet.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.GACL.UpdateGACLAcceleratorCmdlet"> <summary> Update an accelerator. To see an AWS CLI example of updating an accelerator, scroll down to <b>Example</b>. <important><para> You must specify the US-West-2 (Oregon) Region to create or update accelerators. </para></important> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GACL.UpdateGACLAcceleratorCmdlet.AcceleratorArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the accelerator to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GACL.UpdateGACLAcceleratorCmdlet.Enabled"> <summary> <para> <para>Indicates whether an accelerator is enabled. The value is true or false. The default value is true. </para><para>If the value is set to true, the accelerator cannot be deleted. If set to false, the accelerator can be deleted.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GACL.UpdateGACLAcceleratorCmdlet.IpAddressType"> <summary> <para> <para>The value for the address type must be IPv4. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GACL.UpdateGACLAcceleratorCmdlet.Name"> <summary> <para> <para>The name of the accelerator. The name can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens (-), and must not begin or end with a hyphen.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GACL.UpdateGACLAcceleratorCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Accelerator'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.GlobalAccelerator.Model.UpdateAcceleratorResponse). Specifying the name of a property of type Amazon.GlobalAccelerator.Model.UpdateAcceleratorResponse 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.GACL.UpdateGACLAcceleratorCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AcceleratorArn parameter. The -PassThru parameter is deprecated, use -Select '^AcceleratorArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GACL.UpdateGACLAcceleratorCmdlet.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.GACL.UpdateGACLAcceleratorAttributeCmdlet"> <summary> Update the attributes for an accelerator. To see an AWS CLI example of updating an accelerator to enable flow logs, scroll down to <b>Example</b>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GACL.UpdateGACLAcceleratorAttributeCmdlet.AcceleratorArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the accelerator that you want to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GACL.UpdateGACLAcceleratorAttributeCmdlet.FlowLogsEnabled"> <summary> <para> <para>Update whether flow logs are enabled. The default value is false. If the value is true, <code>FlowLogsS3Bucket</code> and <code>FlowLogsS3Prefix</code> must be specified.</para><para>For more information, see <a href="https://docs.aws.amazon.com/global-accelerator/latest/dg/monitoring-global-accelerator.flow-logs.html">Flow Logs</a> in the <i>AWS Global Accelerator Developer Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GACL.UpdateGACLAcceleratorAttributeCmdlet.FlowLogsS3Bucket"> <summary> <para> <para>The name of the Amazon S3 bucket for the flow logs. Attribute is required if <code>FlowLogsEnabled</code> is <code>true</code>. The bucket must exist and have a bucket policy that grants AWS Global Accelerator permission to write to the bucket.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GACL.UpdateGACLAcceleratorAttributeCmdlet.FlowLogsS3Prefix"> <summary> <para> <para>Update the prefix for the location in the Amazon S3 bucket for the flow logs. Attribute is required if <code>FlowLogsEnabled</code> is <code>true</code>. If you don’t specify a prefix, the flow logs are stored in the root of the bucket.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GACL.UpdateGACLAcceleratorAttributeCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AcceleratorAttributes'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.GlobalAccelerator.Model.UpdateAcceleratorAttributesResponse). Specifying the name of a property of type Amazon.GlobalAccelerator.Model.UpdateAcceleratorAttributesResponse 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.GACL.UpdateGACLAcceleratorAttributeCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AcceleratorArn parameter. The -PassThru parameter is deprecated, use -Select '^AcceleratorArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GACL.UpdateGACLAcceleratorAttributeCmdlet.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.GACL.UpdateGACLEndpointGroupCmdlet"> <summary> Update an endpoint group. To see an AWS CLI example of updating an endpoint group, scroll down to <b>Example</b>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GACL.UpdateGACLEndpointGroupCmdlet.EndpointConfiguration"> <summary> <para> <para>The list of endpoint objects.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GACL.UpdateGACLEndpointGroupCmdlet.EndpointGroupArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the endpoint group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GACL.UpdateGACLEndpointGroupCmdlet.HealthCheckIntervalSecond"> <summary> <para> <para>The time—10 seconds or 30 seconds—between each health check for an endpoint. The default value is 30.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GACL.UpdateGACLEndpointGroupCmdlet.HealthCheckPath"> <summary> <para> <para>If the protocol is HTTP/S, then this specifies the path that is the destination for health check targets. The default value is slash (/).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GACL.UpdateGACLEndpointGroupCmdlet.HealthCheckPort"> <summary> <para> <para>The port that AWS Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default port is the listener port that this endpoint group is associated with. If the listener port is a list of ports, Global Accelerator uses the first port in the list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GACL.UpdateGACLEndpointGroupCmdlet.HealthCheckProtocol"> <summary> <para> <para>The protocol that AWS Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default value is TCP.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GACL.UpdateGACLEndpointGroupCmdlet.ThresholdCount"> <summary> <para> <para>The number of consecutive health checks required to set the state of a healthy endpoint to unhealthy, or to set an unhealthy endpoint to healthy. The default value is 3.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GACL.UpdateGACLEndpointGroupCmdlet.TrafficDialPercentage"> <summary> <para> <para>The percentage of traffic to send to an AWS Region. Additional traffic is distributed to other endpoint groups for this listener. </para><para>Use this action to increase (dial up) or decrease (dial down) traffic to a specific Region. The percentage is applied to the traffic that would otherwise have been routed to the Region based on optimal routing.</para><para>The default value is 100.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GACL.UpdateGACLEndpointGroupCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'EndpointGroup'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.GlobalAccelerator.Model.UpdateEndpointGroupResponse). Specifying the name of a property of type Amazon.GlobalAccelerator.Model.UpdateEndpointGroupResponse 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.GACL.UpdateGACLEndpointGroupCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the EndpointGroupArn parameter. The -PassThru parameter is deprecated, use -Select '^EndpointGroupArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GACL.UpdateGACLEndpointGroupCmdlet.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.GACL.UpdateGACLListenerCmdlet"> <summary> Update a listener. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GACL.UpdateGACLListenerCmdlet.ClientAffinity"> <summary> <para> <para>Client affinity lets you direct all requests from a user to the same endpoint, if you have stateful applications, regardless of the port and protocol of the client request. Clienty affinity gives you control over whether to always route each client to the same specific endpoint.</para><para>AWS Global Accelerator uses a consistent-flow hashing algorithm to choose the optimal endpoint for a connection. If client affinity is <code>NONE</code>, Global Accelerator uses the "five-tuple" (5-tuple) properties—source IP address, source port, destination IP address, destination port, and protocol—to select the hash value, and then chooses the best endpoint. However, with this setting, if someone uses different ports to connect to Global Accelerator, their connections might not be always routed to the same endpoint because the hash value changes. </para><para>If you want a given client to always be routed to the same endpoint, set client affinity to <code>SOURCE_IP</code> instead. When you use the <code>SOURCE_IP</code> setting, Global Accelerator uses the "two-tuple" (2-tuple) properties— source (client) IP address and destination IP address—to select the hash value.</para><para>The default value is <code>NONE</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GACL.UpdateGACLListenerCmdlet.ListenerArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the listener to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GACL.UpdateGACLListenerCmdlet.PortRange"> <summary> <para> <para>The updated list of port ranges for the connections from clients to the accelerator.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GACL.UpdateGACLListenerCmdlet.Protocol"> <summary> <para> <para>The updated protocol for the connections from clients to the accelerator.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GACL.UpdateGACLListenerCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Listener'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.GlobalAccelerator.Model.UpdateListenerResponse). Specifying the name of a property of type Amazon.GlobalAccelerator.Model.UpdateListenerResponse 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.GACL.UpdateGACLListenerCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ListenerArn parameter. The -PassThru parameter is deprecated, use -Select '^ListenerArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.GACL.UpdateGACLListenerCmdlet.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> |