AWS.Tools.CloudFrontKeyValueStore.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.CloudFrontKeyValueStore</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.CFKV.GetCFKVKeyCmdlet"> <summary> Returns a key value pair. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFKV.GetCFKVKeyCmdlet.Key"> <summary> <para> <para>The key to get.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFKV.GetCFKVKeyCmdlet.KvsARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the Key Value Store.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFKV.GetCFKVKeyCmdlet.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.CloudFrontKeyValueStore.Model.GetKeyResponse). Specifying the name of a property of type Amazon.CloudFrontKeyValueStore.Model.GetKeyResponse 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.CFKV.GetCFKVKeyCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the KvsARN parameter. The -PassThru parameter is deprecated, use -Select '^KvsARN' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CFKV.GetCFKVKeyListCmdlet"> <summary> Returns a list of key value pairs.<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.CFKV.GetCFKVKeyListCmdlet.KvsARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the Key Value Store.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFKV.GetCFKVKeyListCmdlet.MaxResult"> <summary> <para> <para>Maximum number of results that are returned per call. The default is 10 and maximum allowed page is 50.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFKV.GetCFKVKeyListCmdlet.NextToken"> <summary> <para> <para>If nextToken is returned in the response, there are more results available. Make the next call using the returned token to retrieve the next page.</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.CFKV.GetCFKVKeyListCmdlet.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.CloudFrontKeyValueStore.Model.ListKeysResponse). Specifying the name of a property of type Amazon.CloudFrontKeyValueStore.Model.ListKeysResponse 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.CFKV.GetCFKVKeyListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the KvsARN parameter. The -PassThru parameter is deprecated, use -Select '^KvsARN' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFKV.GetCFKVKeyListCmdlet.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.CFKV.GetCFKVKeyValueStoreCmdlet"> <summary> Returns metadata information about Key Value Store. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFKV.GetCFKVKeyValueStoreCmdlet.KvsARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the Key Value Store.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFKV.GetCFKVKeyValueStoreCmdlet.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.CloudFrontKeyValueStore.Model.DescribeKeyValueStoreResponse). Specifying the name of a property of type Amazon.CloudFrontKeyValueStore.Model.DescribeKeyValueStoreResponse 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.CFKV.GetCFKVKeyValueStoreCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the KvsARN parameter. The -PassThru parameter is deprecated, use -Select '^KvsARN' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CFKV.RemoveCFKVKeyCmdlet"> <summary> Deletes the key value pair specified by the key. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFKV.RemoveCFKVKeyCmdlet.IfMatch"> <summary> <para> <para>The current version (ETag) of the Key Value Store that you are deleting keys from, which you can get using DescribeKeyValueStore.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFKV.RemoveCFKVKeyCmdlet.Key"> <summary> <para> <para>The key to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFKV.RemoveCFKVKeyCmdlet.KvsARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the Key Value Store.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFKV.RemoveCFKVKeyCmdlet.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.CloudFrontKeyValueStore.Model.DeleteKeyResponse). Specifying the name of a property of type Amazon.CloudFrontKeyValueStore.Model.DeleteKeyResponse 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.CFKV.RemoveCFKVKeyCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the KvsARN parameter. The -PassThru parameter is deprecated, use -Select '^KvsARN' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CFKV.UpdateCFKVKeyCmdlet"> <summary> Puts or Deletes multiple key value pairs in a single, all-or-nothing operation. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFKV.UpdateCFKVKeyCmdlet.Delete"> <summary> <para> <para>List of keys to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFKV.UpdateCFKVKeyCmdlet.IfMatch"> <summary> <para> <para>The current version (ETag) of the Key Value Store that you are updating keys of, which you can get using DescribeKeyValueStore.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFKV.UpdateCFKVKeyCmdlet.KvsARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the Key Value Store.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFKV.UpdateCFKVKeyCmdlet.Put"> <summary> <para> <para>List of key value pairs to put.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFKV.UpdateCFKVKeyCmdlet.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.CloudFrontKeyValueStore.Model.UpdateKeysResponse). Specifying the name of a property of type Amazon.CloudFrontKeyValueStore.Model.UpdateKeysResponse 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.CFKV.UpdateCFKVKeyCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the KvsARN parameter. The -PassThru parameter is deprecated, use -Select '^KvsARN' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CFKV.WriteCFKVKeyCmdlet"> <summary> Creates a new key value pair or replaces the value of an existing key. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFKV.WriteCFKVKeyCmdlet.IfMatch"> <summary> <para> <para>The current version (ETag) of the Key Value Store that you are putting keys into, which you can get using DescribeKeyValueStore.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFKV.WriteCFKVKeyCmdlet.Key"> <summary> <para> <para>The key to put.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFKV.WriteCFKVKeyCmdlet.KvsARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the Key Value Store.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFKV.WriteCFKVKeyCmdlet.Value"> <summary> <para> <para>The value to put.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CFKV.WriteCFKVKeyCmdlet.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.CloudFrontKeyValueStore.Model.PutKeyResponse). Specifying the name of a property of type Amazon.CloudFrontKeyValueStore.Model.PutKeyResponse 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.CFKV.WriteCFKVKeyCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the KvsARN parameter. The -PassThru parameter is deprecated, use -Select '^KvsARN' instead. This parameter will be removed in a future version. </summary> </member> </members> </doc> |