AWS.Tools.DSQL.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.DSQL</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.DSQL.AddDSQLResourceTagCmdlet"> <summary> Tags a resource with a map of key and value pairs. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSQL.AddDSQLResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The ARN of the resource that you want to tag.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSQL.AddDSQLResourceTagCmdlet.Tag"> <summary> <para> <para>A map of key and value pairs to use to tag your resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSQL.AddDSQLResourceTagCmdlet.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.DSQL.Model.TagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSQL.AddDSQLResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSQL.AddDSQLResourceTagCmdlet.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.DSQL.GetDSQLClusterCmdlet"> <summary> Retrieves information about a cluster. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSQL.GetDSQLClusterCmdlet.Identifier"> <summary> <para> <para>The ID of the cluster to retrieve.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSQL.GetDSQLClusterCmdlet.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.DSQL.Model.GetClusterResponse). Specifying the name of a property of type Amazon.DSQL.Model.GetClusterResponse 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.DSQL.GetDSQLClusterCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Identifier parameter. The -PassThru parameter is deprecated, use -Select '^Identifier' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DSQL.GetDSQLClusterListCmdlet"> <summary> Retrieves information about a list of clusters. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSQL.GetDSQLClusterListCmdlet.MaxResult"> <summary> <para> <para>An optional parameter that specifies the maximum number of results to return. You can use nextToken to display the next page of results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSQL.GetDSQLClusterListCmdlet.NextToken"> <summary> <para> <para>If your initial ListClusters operation returns a nextToken, you can include the returned nextToken in following ListClusters operations, which returns results in the next page.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSQL.GetDSQLClusterListCmdlet.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.DSQL.Model.ListClustersResponse). Specifying the name of a property of type Amazon.DSQL.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="T:Amazon.PowerShell.Cmdlets.DSQL.GetDSQLResourceTagCmdlet"> <summary> Lists all of the tags for a resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSQL.GetDSQLResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The ARN of the resource for which you want to list the tags.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSQL.GetDSQLResourceTagCmdlet.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.DSQL.Model.ListTagsForResourceResponse). Specifying the name of a property of type Amazon.DSQL.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="P:Amazon.PowerShell.Cmdlets.DSQL.GetDSQLResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DSQL.GetDSQLVpcEndpointServiceNameCmdlet"> <summary> Retrieves the VPC endpoint service name. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSQL.GetDSQLVpcEndpointServiceNameCmdlet.Identifier"> <summary> <para> <para>The ID of the cluster to retrieve.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSQL.GetDSQLVpcEndpointServiceNameCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ServiceName'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DSQL.Model.GetVpcEndpointServiceNameResponse). Specifying the name of a property of type Amazon.DSQL.Model.GetVpcEndpointServiceNameResponse 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.DSQL.GetDSQLVpcEndpointServiceNameCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Identifier parameter. The -PassThru parameter is deprecated, use -Select '^Identifier' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DSQL.NewDSQLClusterCmdlet"> <summary> This operation creates a cluster in Amazon Aurora DSQL. You need the following permissions to use this operation. <para> Permission to create a cluster. </para><dl><dt>dsql:CreateCluster</dt><dd><para> Resources: arn:aws:dsql:<i>region</i>:<i>account-id</i>:cluster/* </para></dd></dl><para> Permission to add tags to a resource. </para><dl><dt>dsql:TagResource</dt><dd><para> Resources: arn:aws:dsql:<i>region</i>:<i>account-id</i>:cluster/* </para></dd></dl><para> Permission to configure multi-region properties for a cluster. </para><dl><dt>dsql:PutMultiRegionProperties</dt><dd><para> Resources: arn:aws:dsql:<i>region</i>:<i>account-id</i>:cluster/* </para></dd></dl><para> When specifying multiRegionProperties.clusters. </para><dl><dt>dsql:AddPeerCluster</dt><dd><para> Permission to add peer clusters. </para><para> Resources: </para><ul><li><para> Local cluster: arn:aws:dsql:<i>region</i>:<i>account-id</i>:cluster/* </para></li><li><para> Each peer cluster: exact ARN of each specified peer cluster </para></li></ul></dd></dl><para> When specifying multiRegionProperties.witnessRegion. </para><dl><dt>dsql:PutWitnessRegion</dt><dd><para> Permission to set a witness region. </para><para> Resources: arn:aws:dsql:<i>region</i>:<i>account-id</i>:cluster/* </para><para> Condition Keys: <c>dsql:WitnessRegion</c> (matching the specified witness region) </para><note><para> This permission is checked both in the cluster Region and in the witness Region. </para></note></dd></dl><important><para><b>Important Notes for Multi-Region Operations</b></para><ul><li><para> The witness region specified in <c>multiRegionProperties.witnessRegion</c> cannot be the same as the cluster's Region. </para></li><li><para> When updating clusters with peer relationships, permissions are checked for both adding and removing peers. </para></li></ul></important> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSQL.NewDSQLClusterCmdlet.MultiRegionProperties_Cluster"> <summary> <para> <para>The set of linked clusters that form the multi-Region cluster configuration. Each linked cluster represents a database instance in a different Region.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSQL.NewDSQLClusterCmdlet.DeletionProtectionEnabled"> <summary> <para> <para>If enabled, you can't delete your cluster. You must first disable this property before you can delete your cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSQL.NewDSQLClusterCmdlet.Tag"> <summary> <para> <para>A map of key and value pairs to use to tag your cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSQL.NewDSQLClusterCmdlet.MultiRegionProperties_WitnessRegion"> <summary> <para> <para>The that serves as the witness region for a multi-Region cluster. The witness region helps maintain cluster consistency and quorum.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSQL.NewDSQLClusterCmdlet.ClientToken"> <summary> <para> <para>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, the subsequent retries with the same client token return the result from the original successful request and they have no additional effect.</para><para>If you don't specify a client token, the Amazon Web Services SDK automatically generates one.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSQL.NewDSQLClusterCmdlet.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.DSQL.Model.CreateClusterResponse). Specifying the name of a property of type Amazon.DSQL.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.DSQL.NewDSQLClusterCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DeletionProtectionEnabled parameter. The -PassThru parameter is deprecated, use -Select '^DeletionProtectionEnabled' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSQL.NewDSQLClusterCmdlet.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.DSQL.NewDSQLMultiRegionClusterCmdlet"> <summary> Creates multi-Region clusters in Amazon Aurora DSQL. Multi-Region clusters require a linked Region list, which is an array of the Regions in which you want to create linked clusters. Multi-Region clusters require a witness Region, which participates in quorum in failure scenarios.<br/><br/>This operation is deprecated. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSQL.NewDSQLMultiRegionClusterCmdlet.ClusterProperty"> <summary> <para> <para>A mapping of properties to use when creating linked clusters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSQL.NewDSQLMultiRegionClusterCmdlet.LinkedRegionList"> <summary> <para> <para>An array of the Regions in which you want to create additional clusters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSQL.NewDSQLMultiRegionClusterCmdlet.WitnessRegion"> <summary> <para> <para>The witness Region of multi-Region clusters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSQL.NewDSQLMultiRegionClusterCmdlet.ClientToken"> <summary> <para> <para>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully. The subsequent retries with the same client token return the result from the original successful request and they have no additional effect.</para><para>If you don't specify a client token, the Amazon Web Services SDK automatically generates one.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSQL.NewDSQLMultiRegionClusterCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'LinkedClusterArns'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DSQL.Model.CreateMultiRegionClustersResponse). Specifying the name of a property of type Amazon.DSQL.Model.CreateMultiRegionClustersResponse 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.DSQL.NewDSQLMultiRegionClusterCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the WitnessRegion parameter. The -PassThru parameter is deprecated, use -Select '^WitnessRegion' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSQL.NewDSQLMultiRegionClusterCmdlet.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.DSQL.RemoveDSQLClusterCmdlet"> <summary> Deletes a cluster in Amazon Aurora DSQL. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSQL.RemoveDSQLClusterCmdlet.Identifier"> <summary> <para> <para>The ID of the cluster to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSQL.RemoveDSQLClusterCmdlet.ClientToken"> <summary> <para> <para>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully. The subsequent retries with the same client token return the result from the original successful request and they have no additional effect.</para><para>If you don't specify a client token, the Amazon Web Services SDK automatically generates one.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSQL.RemoveDSQLClusterCmdlet.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.DSQL.Model.DeleteClusterResponse). Specifying the name of a property of type Amazon.DSQL.Model.DeleteClusterResponse 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.DSQL.RemoveDSQLClusterCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Identifier parameter. The -PassThru parameter is deprecated, use -Select '^Identifier' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSQL.RemoveDSQLClusterCmdlet.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.DSQL.RemoveDSQLMultiRegionClusterCmdlet"> <summary> Deletes a multi-Region cluster in Amazon Aurora DSQL.<br/><br/>This operation is deprecated. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSQL.RemoveDSQLMultiRegionClusterCmdlet.LinkedClusterArn"> <summary> <para> <para>The ARNs of the clusters linked to the cluster you want to delete. also deletes these clusters as part of the operation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSQL.RemoveDSQLMultiRegionClusterCmdlet.ClientToken"> <summary> <para> <para>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully. The subsequent retries with the same client token return the result from the original successful request and they have no additional effect.</para><para>If you don't specify a client token, the Amazon Web Services SDK automatically generates one.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSQL.RemoveDSQLMultiRegionClusterCmdlet.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.DSQL.Model.DeleteMultiRegionClustersResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSQL.RemoveDSQLMultiRegionClusterCmdlet.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.DSQL.RemoveDSQLResourceTagCmdlet"> <summary> Removes a tag from a resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSQL.RemoveDSQLResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The ARN of the resource from which to remove tags.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSQL.RemoveDSQLResourceTagCmdlet.TagKey"> <summary> <para> <para>The array of keys of the tags that you want to remove.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSQL.RemoveDSQLResourceTagCmdlet.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.DSQL.Model.UntagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSQL.RemoveDSQLResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSQL.RemoveDSQLResourceTagCmdlet.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.DSQL.UpdateDSQLClusterCmdlet"> <summary> Updates a cluster. <para><b>Example IAM Policy for Multi-Region Operations</b></para><para> The following IAM policy grants permissions for multi-Region operations. </para><para> The <c>dsql:RemovePeerCluster</c> permission uses a wildcard ARN pattern to simplify permission management during updates. </para><important><para><b>Important Notes for Multi-Region Operations</b></para><ul><li><para> The witness region specified in <c>multiRegionProperties.witnessRegion</c> cannot be the same as the cluster's Region. </para></li><li><para> When updating clusters with peer relationships, permissions are checked for both adding and removing peers. </para></li><li><para> The <c>dsql:RemovePeerCluster</c> permission uses a wildcard ARN pattern to simplify permission management during updates. </para></li></ul></important> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSQL.UpdateDSQLClusterCmdlet.MultiRegionProperties_Cluster"> <summary> <para> <para>The set of linked clusters that form the multi-Region cluster configuration. Each linked cluster represents a database instance in a different Region.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSQL.UpdateDSQLClusterCmdlet.DeletionProtectionEnabled"> <summary> <para> <para>Specifies whether to enable deletion protection in your cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSQL.UpdateDSQLClusterCmdlet.Identifier"> <summary> <para> <para>The ID of the cluster you want to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSQL.UpdateDSQLClusterCmdlet.MultiRegionProperties_WitnessRegion"> <summary> <para> <para>The that serves as the witness region for a multi-Region cluster. The witness region helps maintain cluster consistency and quorum.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSQL.UpdateDSQLClusterCmdlet.ClientToken"> <summary> <para> <para>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully. The subsequent retries with the same client token return the result from the original successful request and they have no additional effect.</para><para>If you don't specify a client token, the Amazon Web Services SDK automatically generates one.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSQL.UpdateDSQLClusterCmdlet.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.DSQL.Model.UpdateClusterResponse). Specifying the name of a property of type Amazon.DSQL.Model.UpdateClusterResponse 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.DSQL.UpdateDSQLClusterCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Identifier parameter. The -PassThru parameter is deprecated, use -Select '^Identifier' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DSQL.UpdateDSQLClusterCmdlet.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> |