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.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="T:Amazon.PowerShell.Cmdlets.DSQL.GetDSQLClusterListCmdlet"> <summary> Retrieves information about a list of clusters.<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. This cmdlet didn't autopaginate in V4, auto-pagination support was added in V5. </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> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.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> <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.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="P:Amazon.PowerShell.Cmdlets.DSQL.GetDSQLClusterListCmdlet.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. This cmdlet didn't autopaginate in V4. To preserve the V4 autopagination behavior for all cmdlets, run Set-AWSAutoIterationMode -IterationMode v4. </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="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="T:Amazon.PowerShell.Cmdlets.DSQL.NewDSQLClusterCmdlet"> <summary> The CreateCluster API allows you to create both single-region clusters and multi-Region clusters. With the addition of the <i>multiRegionProperties</i> parameter, you can create a cluster with witness Region support and establish peer relationships with clusters in other Regions during creation. <note><para> Creating multi-Region clusters requires additional IAM permissions beyond those needed for single-Region clusters, as detailed in the <b>Required permissions</b> section below. </para></note><para><b>Required permissions</b></para><dl><dt>dsql:CreateCluster</dt><dd><para> Required to create a cluster. </para><para> Resources: <c>arn:aws:dsql:region:account-id:cluster/*</c></para></dd><dt>dsql:TagResource</dt><dd><para> Permission to add tags to a resource. </para><para> Resources: <c>arn:aws:dsql:region:account-id:cluster/*</c></para></dd><dt>dsql:PutMultiRegionProperties</dt><dd><para> Permission to configure multi-region properties for a cluster. </para><para> Resources: <c>arn:aws:dsql:region:account-id:cluster/*</c></para></dd><dt>dsql:AddPeerCluster</dt><dd><para> When specifying <c>multiRegionProperties.clusters</c>, permission to add peer clusters. </para><para> Resources: </para><ul><li><para> Local cluster: <c>arn:aws:dsql:region:account-id:cluster/*</c></para></li><li><para> Each peer cluster: exact ARN of each specified peer cluster </para></li></ul></dd><dt>dsql:PutWitnessRegion</dt><dd><para> When specifying <c>multiRegionProperties.witnessRegion</c>, permission to set a witness Region. This permission is checked both in the cluster Region and in the witness Region. </para><para> Resources: <c>arn:aws:dsql:region:account-id:cluster/*</c></para><para> Condition Keys: <c>dsql:WitnessRegion</c> (matching the specified witness region) </para></dd></dl><important><ul><li><para> The witness Region specified in <c>multiRegionProperties.witnessRegion</c> cannot be the same as the cluster's Region. </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.KmsEncryptionKey"> <summary> <para> <para>The KMS key that encrypts and protects the data on your cluster. You can specify the ARN, ID, or alias of an existing key or have Amazon Web Services create a default key for you.</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.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.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.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> The <i>UpdateCluster</i> API allows you to modify both single-Region and multi-Region cluster configurations. With the <i>multiRegionProperties</i> parameter, you can add or modify witness Region support and manage peer relationships with clusters in other Regions. <note><para> Note that updating multi-region clusters requires additional IAM permissions beyond those needed for standard cluster updates, as detailed in the Permissions section. </para></note><para><b>Required permissions</b></para><dl><dt>dsql:UpdateCluster</dt><dd><para> Permission to update a DSQL cluster. </para><para> Resources: <c>arn:aws:dsql:<i>region</i>:<i>account-id</i>:cluster/<i>cluster-id</i></c></para></dd></dl><dl><dt>dsql:PutMultiRegionProperties</dt><dd><para> Permission to configure multi-Region properties for a cluster. </para><para> Resources: <c>arn:aws:dsql:<i>region</i>:<i>account-id</i>:cluster/<i>cluster-id</i></c></para></dd></dl><dl><dt>dsql:GetCluster</dt><dd><para> Permission to retrieve cluster information. </para><para> Resources: <c>arn:aws:dsql:<i>region</i>:<i>account-id</i>:cluster/<i>cluster-id</i></c></para></dd><dt>dsql:AddPeerCluster</dt><dd><para> Permission to add peer clusters. </para><para> Resources: </para><ul><li><para> Local cluster: <c>arn:aws:dsql:<i>region</i>:<i>account-id</i>:cluster/<i>cluster-id</i></c></para></li><li><para> Each peer cluster: exact ARN of each specified peer cluster </para></li></ul></dd><dt>dsql:RemovePeerCluster</dt><dd><para> Permission to remove peer clusters. The <i>dsql:RemovePeerCluster</i> permission uses a wildcard ARN pattern to simplify permission management during updates. </para><para> Resources: <c>arn:aws:dsql:*:<i>account-id</i>:cluster/*</c></para></dd></dl><dl><dt>dsql:PutWitnessRegion</dt><dd><para> Permission to set a witness Region. </para><para> Resources: <c>arn:aws:dsql:<i>region</i>:<i>account-id</i>:cluster/<i>cluster-id</i></c></para><para> Condition Keys: dsql:WitnessRegion (matching the specified witness Region) </para><para><b>This permission is checked both in the cluster Region and in the witness Region.</b></para></dd></dl><important><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.KmsEncryptionKey"> <summary> <para> <para>The KMS key that encrypts and protects the data on your cluster. You can specify the ARN, ID, or alias of an existing key or have Amazon Web Services create a default key for you.</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.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> |