AWS.Tools.DocDBElastic.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.DocDBElastic</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.DOCE.AddDOCEResourceTagCmdlet"> <summary> Adds metadata tags to a Elastic DocumentDB resource </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DOCE.AddDOCEResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The arn of the Elastic DocumentDB resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DOCE.AddDOCEResourceTagCmdlet.Tag"> <summary> <para> <para>The tags to be assigned to the Elastic DocumentDB resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DOCE.AddDOCEResourceTagCmdlet.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.DocDBElastic.Model.TagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DOCE.AddDOCEResourceTagCmdlet.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.DOCE.AddDOCEResourceTagCmdlet.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.DOCE.GetDOCEClusterCmdlet"> <summary> Returns information about a specific Elastic DocumentDB cluster. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DOCE.GetDOCEClusterCmdlet.ClusterArn"> <summary> <para> <para>The arn of the Elastic DocumentDB cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DOCE.GetDOCEClusterCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Cluster'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DocDBElastic.Model.GetClusterResponse). Specifying the name of a property of type Amazon.DocDBElastic.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.DOCE.GetDOCEClusterCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ClusterArn parameter. The -PassThru parameter is deprecated, use -Select '^ClusterArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DOCE.GetDOCEClusterListCmdlet"> <summary> Returns information about provisioned Elastic DocumentDB clusters. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DOCE.GetDOCEClusterListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of entries to recieve in the response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DOCE.GetDOCEClusterListCmdlet.NextToken"> <summary> <para> <para>The nextToken which is used the get the next page of data.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DOCE.GetDOCEClusterListCmdlet.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.DocDBElastic.Model.ListClustersResponse). Specifying the name of a property of type Amazon.DocDBElastic.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.DOCE.GetDOCEClusterSnapshotCmdlet"> <summary> Returns information about a specific Elastic DocumentDB snapshot </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DOCE.GetDOCEClusterSnapshotCmdlet.SnapshotArn"> <summary> <para> <para>The arn of the Elastic DocumentDB snapshot.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DOCE.GetDOCEClusterSnapshotCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Snapshot'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DocDBElastic.Model.GetClusterSnapshotResponse). Specifying the name of a property of type Amazon.DocDBElastic.Model.GetClusterSnapshotResponse 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.DOCE.GetDOCEClusterSnapshotCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the SnapshotArn parameter. The -PassThru parameter is deprecated, use -Select '^SnapshotArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DOCE.GetDOCEClusterSnapshotListCmdlet"> <summary> Returns information about Elastic DocumentDB snapshots for a specified cluster. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DOCE.GetDOCEClusterSnapshotListCmdlet.ClusterArn"> <summary> <para> <para>The arn of the Elastic DocumentDB cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DOCE.GetDOCEClusterSnapshotListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of entries to recieve in the response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DOCE.GetDOCEClusterSnapshotListCmdlet.NextToken"> <summary> <para> <para>The nextToken which is used the get the next page of data.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DOCE.GetDOCEClusterSnapshotListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Snapshots'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DocDBElastic.Model.ListClusterSnapshotsResponse). Specifying the name of a property of type Amazon.DocDBElastic.Model.ListClusterSnapshotsResponse 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.DOCE.GetDOCEClusterSnapshotListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ClusterArn parameter. The -PassThru parameter is deprecated, use -Select '^ClusterArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DOCE.GetDOCEResourceTagCmdlet"> <summary> Lists all tags on a Elastic DocumentDB resource </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DOCE.GetDOCEResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The arn of the Elastic DocumentDB resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DOCE.GetDOCEResourceTagCmdlet.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.DocDBElastic.Model.ListTagsForResourceResponse). Specifying the name of a property of type Amazon.DocDBElastic.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.DOCE.GetDOCEResourceTagCmdlet.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.DOCE.NewDOCEClusterCmdlet"> <summary> Creates a new Elastic DocumentDB cluster and returns its Cluster structure. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DOCE.NewDOCEClusterCmdlet.AdminUserName"> <summary> <para> <para>The name of the Elastic DocumentDB cluster administrator.</para><para><i>Constraints</i>:</para><ul><li><para>Must be from 1 to 63 letters or numbers.</para></li><li><para>The first character must be a letter.</para></li><li><para>Cannot be a reserved word.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DOCE.NewDOCEClusterCmdlet.AdminUserPassword"> <summary> <para> <para>The password for the Elastic DocumentDB cluster administrator and can contain any printable ASCII characters.</para><para><i>Constraints</i>:</para><ul><li><para>Must contain from 8 to 100 characters.</para></li><li><para>Cannot contain a forward slash (/), double quote ("), or the "at" symbol (@).</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DOCE.NewDOCEClusterCmdlet.AuthType"> <summary> <para> <para>The authentication type for the Elastic DocumentDB cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DOCE.NewDOCEClusterCmdlet.ClusterName"> <summary> <para> <para>The name of the new Elastic DocumentDB cluster. This parameter is stored as a lowercase string.</para><para><i>Constraints</i>:</para><ul><li><para>Must contain from 1 to 63 letters, numbers, or hyphens.</para></li><li><para>The first character must be a letter.</para></li><li><para>Cannot end with a hyphen or contain two consecutive hyphens.</para></li></ul><para><i>Example</i>: <code>my-cluster</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DOCE.NewDOCEClusterCmdlet.KmsKeyId"> <summary> <para> <para>The KMS key identifier to use to encrypt the new Elastic DocumentDB cluster.</para><para>The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a cluster using the same Amazon account that owns this KMS encryption key, you can use the KMS key alias instead of the ARN as the KMS encryption key.</para><para>If an encryption key is not specified, Elastic DocumentDB uses the default encryption key that KMS creates for your account. Your account has a different default encryption key for each Amazon Region.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DOCE.NewDOCEClusterCmdlet.PreferredMaintenanceWindow"> <summary> <para> <para>The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).</para><para><i>Format</i>: <code>ddd:hh24:mi-ddd:hh24:mi</code></para><para><i>Default</i>: a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week.</para><para><i>Valid days</i>: Mon, Tue, Wed, Thu, Fri, Sat, Sun</para><para><i>Constraints</i>: Minimum 30-minute window.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DOCE.NewDOCEClusterCmdlet.ShardCapacity"> <summary> <para> <para>The capacity of each shard in the new Elastic DocumentDB cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DOCE.NewDOCEClusterCmdlet.ShardCount"> <summary> <para> <para>The number of shards to create in the new Elastic DocumentDB cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DOCE.NewDOCEClusterCmdlet.SubnetId"> <summary> <para> <para>The Amazon EC2 subnet IDs for the new Elastic DocumentDB cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DOCE.NewDOCEClusterCmdlet.Tag"> <summary> <para> <para>The tags to be assigned to the new Elastic DocumentDB cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DOCE.NewDOCEClusterCmdlet.VpcSecurityGroupId"> <summary> <para> <para>A list of EC2 VPC security groups to associate with the new Elastic DocumentDB cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DOCE.NewDOCEClusterCmdlet.ClientToken"> <summary> <para> <para>The client token for the Elastic DocumentDB cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DOCE.NewDOCEClusterCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Cluster'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DocDBElastic.Model.CreateClusterResponse). Specifying the name of a property of type Amazon.DocDBElastic.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.DOCE.NewDOCEClusterCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ClusterName parameter. The -PassThru parameter is deprecated, use -Select '^ClusterName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DOCE.NewDOCEClusterCmdlet.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.DOCE.NewDOCEClusterSnapshotCmdlet"> <summary> Creates a snapshot of a cluster. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DOCE.NewDOCEClusterSnapshotCmdlet.ClusterArn"> <summary> <para> <para>The arn of the Elastic DocumentDB cluster that the snapshot will be taken from.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DOCE.NewDOCEClusterSnapshotCmdlet.SnapshotName"> <summary> <para> <para>The name of the Elastic DocumentDB snapshot.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DOCE.NewDOCEClusterSnapshotCmdlet.Tag"> <summary> <para> <para>The tags to be assigned to the new Elastic DocumentDB snapshot.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DOCE.NewDOCEClusterSnapshotCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Snapshot'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DocDBElastic.Model.CreateClusterSnapshotResponse). Specifying the name of a property of type Amazon.DocDBElastic.Model.CreateClusterSnapshotResponse 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.DOCE.NewDOCEClusterSnapshotCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ClusterArn parameter. The -PassThru parameter is deprecated, use -Select '^ClusterArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DOCE.NewDOCEClusterSnapshotCmdlet.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.DOCE.RemoveDOCEClusterCmdlet"> <summary> Delete a Elastic DocumentDB cluster. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DOCE.RemoveDOCEClusterCmdlet.ClusterArn"> <summary> <para> <para>The arn of the Elastic DocumentDB cluster that is to be deleted.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DOCE.RemoveDOCEClusterCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Cluster'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DocDBElastic.Model.DeleteClusterResponse). Specifying the name of a property of type Amazon.DocDBElastic.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.DOCE.RemoveDOCEClusterCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ClusterArn parameter. The -PassThru parameter is deprecated, use -Select '^ClusterArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DOCE.RemoveDOCEClusterCmdlet.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.DOCE.RemoveDOCEClusterSnapshotCmdlet"> <summary> Delete a Elastic DocumentDB snapshot. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DOCE.RemoveDOCEClusterSnapshotCmdlet.SnapshotArn"> <summary> <para> <para>The arn of the Elastic DocumentDB snapshot that is to be deleted.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DOCE.RemoveDOCEClusterSnapshotCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Snapshot'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DocDBElastic.Model.DeleteClusterSnapshotResponse). Specifying the name of a property of type Amazon.DocDBElastic.Model.DeleteClusterSnapshotResponse 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.DOCE.RemoveDOCEClusterSnapshotCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the SnapshotArn parameter. The -PassThru parameter is deprecated, use -Select '^SnapshotArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DOCE.RemoveDOCEClusterSnapshotCmdlet.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.DOCE.RemoveDOCEResourceTagCmdlet"> <summary> Removes metadata tags to a Elastic DocumentDB resource </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DOCE.RemoveDOCEResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The arn of the Elastic DocumentDB resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DOCE.RemoveDOCEResourceTagCmdlet.TagKey"> <summary> <para> <para>The tag keys to be removed from the Elastic DocumentDB resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DOCE.RemoveDOCEResourceTagCmdlet.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.DocDBElastic.Model.UntagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DOCE.RemoveDOCEResourceTagCmdlet.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.DOCE.RemoveDOCEResourceTagCmdlet.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.DOCE.RestoreDOCEClusterFromSnapshotCmdlet"> <summary> Restores a Elastic DocumentDB cluster from a snapshot. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DOCE.RestoreDOCEClusterFromSnapshotCmdlet.ClusterName"> <summary> <para> <para>The name of the Elastic DocumentDB cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DOCE.RestoreDOCEClusterFromSnapshotCmdlet.KmsKeyId"> <summary> <para> <para>The KMS key identifier to use to encrypt the new Elastic DocumentDB cluster.</para><para>The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a cluster using the same Amazon account that owns this KMS encryption key, you can use the KMS key alias instead of the ARN as the KMS encryption key.</para><para>If an encryption key is not specified here, Elastic DocumentDB uses the default encryption key that KMS creates for your account. Your account has a different default encryption key for each Amazon Region.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DOCE.RestoreDOCEClusterFromSnapshotCmdlet.SnapshotArn"> <summary> <para> <para>The arn of the Elastic DocumentDB snapshot.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DOCE.RestoreDOCEClusterFromSnapshotCmdlet.SubnetId"> <summary> <para> <para>The Amazon EC2 subnet IDs for the Elastic DocumentDB cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DOCE.RestoreDOCEClusterFromSnapshotCmdlet.Tag"> <summary> <para> <para>A list of the tag names to be assigned to the restored DB cluster, in the form of an array of key-value pairs in which the key is the tag name and the value is the key value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DOCE.RestoreDOCEClusterFromSnapshotCmdlet.VpcSecurityGroupId"> <summary> <para> <para>A list of EC2 VPC security groups to associate with the Elastic DocumentDB cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DOCE.RestoreDOCEClusterFromSnapshotCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Cluster'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DocDBElastic.Model.RestoreClusterFromSnapshotResponse). Specifying the name of a property of type Amazon.DocDBElastic.Model.RestoreClusterFromSnapshotResponse 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.DOCE.RestoreDOCEClusterFromSnapshotCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the SnapshotArn parameter. The -PassThru parameter is deprecated, use -Select '^SnapshotArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DOCE.RestoreDOCEClusterFromSnapshotCmdlet.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.DOCE.UpdateDOCEClusterCmdlet"> <summary> Modifies a Elastic DocumentDB cluster. This includes updating admin-username/password, upgrading API version setting up a backup window and maintenance window </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DOCE.UpdateDOCEClusterCmdlet.AdminUserPassword"> <summary> <para> <para>The password for the Elastic DocumentDB cluster administrator. This password can contain any printable ASCII character except forward slash (/), double quote ("), or the "at" symbol (@).</para><para><i>Constraints</i>: Must contain from 8 to 100 characters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DOCE.UpdateDOCEClusterCmdlet.AuthType"> <summary> <para> <para>The authentication type for the Elastic DocumentDB cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DOCE.UpdateDOCEClusterCmdlet.ClusterArn"> <summary> <para> <para>The arn of the Elastic DocumentDB cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DOCE.UpdateDOCEClusterCmdlet.PreferredMaintenanceWindow"> <summary> <para> <para>The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).</para><para><i>Format</i>: <code>ddd:hh24:mi-ddd:hh24:mi</code></para><para><i>Default</i>: a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week.</para><para><i>Valid days</i>: Mon, Tue, Wed, Thu, Fri, Sat, Sun</para><para><i>Constraints</i>: Minimum 30-minute window.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DOCE.UpdateDOCEClusterCmdlet.ShardCapacity"> <summary> <para> <para>The capacity of each shard in the Elastic DocumentDB cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DOCE.UpdateDOCEClusterCmdlet.ShardCount"> <summary> <para> <para>The number of shards to create in the Elastic DocumentDB cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DOCE.UpdateDOCEClusterCmdlet.SubnetId"> <summary> <para> <para>The number of shards to create in the Elastic DocumentDB cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DOCE.UpdateDOCEClusterCmdlet.VpcSecurityGroupId"> <summary> <para> <para>A list of EC2 VPC security groups to associate with the new Elastic DocumentDB cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DOCE.UpdateDOCEClusterCmdlet.ClientToken"> <summary> <para> <para>The client token for the Elastic DocumentDB cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DOCE.UpdateDOCEClusterCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Cluster'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DocDBElastic.Model.UpdateClusterResponse). Specifying the name of a property of type Amazon.DocDBElastic.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.DOCE.UpdateDOCEClusterCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ClusterArn parameter. The -PassThru parameter is deprecated, use -Select '^ClusterArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DOCE.UpdateDOCEClusterCmdlet.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> |