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 an elastic cluster resource </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DOCE.AddDOCEResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The ARN identifier of the elastic cluster resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DOCE.AddDOCEResourceTagCmdlet.Tag"> <summary> <para> <para>The tags that are assigned to the elastic cluster resource.</para><para /> Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. </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.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.CopyDOCEClusterSnapshotCmdlet"> <summary> Copies a snapshot of an elastic cluster. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DOCE.CopyDOCEClusterSnapshotCmdlet.CopyTag"> <summary> <para> <para>Set to <c>true</c> to copy all tags from the source cluster snapshot to the target elastic cluster snapshot. The default is <c>false</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DOCE.CopyDOCEClusterSnapshotCmdlet.KmsKeyId"> <summary> <para> <para>The Amazon Web Services KMS key ID for an encrypted elastic cluster snapshot. The Amazon Web Services KMS key ID is the Amazon Resource Name (ARN), Amazon Web Services KMS key identifier, or the Amazon Web Services KMS key alias for the Amazon Web Services KMS encryption key.</para><para>If you copy an encrypted elastic cluster snapshot from your Amazon Web Services account, you can specify a value for <c>KmsKeyId</c> to encrypt the copy with a new Amazon Web ServicesS KMS encryption key. If you don't specify a value for <c>KmsKeyId</c>, then the copy of the elastic cluster snapshot is encrypted with the same <c>AWS</c> KMS key as the source elastic cluster snapshot.</para><para>To copy an encrypted elastic cluster snapshot to another Amazon Web Services region, set <c>KmsKeyId</c> to the Amazon Web Services KMS key ID that you want to use to encrypt the copy of the elastic cluster snapshot in the destination region. Amazon Web Services KMS encryption keys are specific to the Amazon Web Services region that they are created in, and you can't use encryption keys from one Amazon Web Services region in another Amazon Web Services region.</para><para>If you copy an unencrypted elastic cluster snapshot and specify a value for the <c>KmsKeyId</c> parameter, an error is returned.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DOCE.CopyDOCEClusterSnapshotCmdlet.SnapshotArn"> <summary> <para> <para>The Amazon Resource Name (ARN) identifier of the elastic cluster snapshot.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DOCE.CopyDOCEClusterSnapshotCmdlet.Tag"> <summary> <para> <para>The tags to be assigned to the elastic cluster snapshot.</para><para /> Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DOCE.CopyDOCEClusterSnapshotCmdlet.TargetSnapshotName"> <summary> <para> <para>The identifier of the new elastic cluster snapshot to create from the source cluster snapshot. This parameter is not case sensitive.</para><para>Constraints:</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>Example: <c>elastic-cluster-snapshot-5</c></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DOCE.CopyDOCEClusterSnapshotCmdlet.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.CopyClusterSnapshotResponse). Specifying the name of a property of type Amazon.DocDBElastic.Model.CopyClusterSnapshotResponse 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.CopyDOCEClusterSnapshotCmdlet.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 cluster. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DOCE.GetDOCEClusterCmdlet.ClusterArn"> <summary> <para> <para>The ARN identifier of the elastic 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="T:Amazon.PowerShell.Cmdlets.DOCE.GetDOCEClusterListCmdlet"> <summary> Returns information about provisioned Amazon DocumentDB elastic 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.DOCE.GetDOCEClusterListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of elastic cluster snapshot results to receive in the response.</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.DOCE.GetDOCEClusterListCmdlet.NextToken"> <summary> <para> <para>A pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond this token, up to the value specified by <c>max-results</c>.</para><para>If there is no more data in the responce, the <c>nextToken</c> will not be returned.</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.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="P:Amazon.PowerShell.Cmdlets.DOCE.GetDOCEClusterListCmdlet.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.DOCE.GetDOCEClusterSnapshotCmdlet"> <summary> Returns information about a specific elastic cluster snapshot </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DOCE.GetDOCEClusterSnapshotCmdlet.SnapshotArn"> <summary> <para> <para>The ARN identifier of the elastic cluster 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="T:Amazon.PowerShell.Cmdlets.DOCE.GetDOCEClusterSnapshotListCmdlet"> <summary> Returns information about snapshots for a specified elastic cluster.<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.DOCE.GetDOCEClusterSnapshotListCmdlet.ClusterArn"> <summary> <para> <para>The ARN identifier of the elastic cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DOCE.GetDOCEClusterSnapshotListCmdlet.SnapshotType"> <summary> <para> <para>The type of cluster snapshots to be returned. You can specify one of the following values:</para><ul><li><para><c>automated</c> - Return all cluster snapshots that Amazon DocumentDB has automatically created for your Amazon Web Services account.</para></li><li><para><c>manual</c> - Return all cluster snapshots that you have manually created for your Amazon Web Services account.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DOCE.GetDOCEClusterSnapshotListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of elastic cluster snapshot results to receive in the response.</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.DOCE.GetDOCEClusterSnapshotListCmdlet.NextToken"> <summary> <para> <para>A pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond this token, up to the value specified by <c>max-results</c>.</para><para>If there is no more data in the responce, the <c>nextToken</c> will not be returned.</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.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.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.DOCE.GetDOCEPendingMaintenanceActionCmdlet"> <summary> Retrieves all maintenance actions that are pending. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DOCE.GetDOCEPendingMaintenanceActionCmdlet.ResourceArn"> <summary> <para> <para>Retrieves pending maintenance actions for a specific Amazon Resource Name (ARN).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DOCE.GetDOCEPendingMaintenanceActionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ResourcePendingMaintenanceAction'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DocDBElastic.Model.GetPendingMaintenanceActionResponse). Specifying the name of a property of type Amazon.DocDBElastic.Model.GetPendingMaintenanceActionResponse 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.GetDOCEPendingMaintenanceActionListCmdlet"> <summary> Retrieves a list of all maintenance actions that are pending.<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.DOCE.GetDOCEPendingMaintenanceActionListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to include in the response. If more records exist than the specified <c>maxResults</c> value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.</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.DOCE.GetDOCEPendingMaintenanceActionListCmdlet.NextToken"> <summary> <para> <para>An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <c>maxResults</c>.</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.DOCE.GetDOCEPendingMaintenanceActionListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ResourcePendingMaintenanceActions'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DocDBElastic.Model.ListPendingMaintenanceActionsResponse). Specifying the name of a property of type Amazon.DocDBElastic.Model.ListPendingMaintenanceActionsResponse 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.GetDOCEPendingMaintenanceActionListCmdlet.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.DOCE.GetDOCEResourceTagCmdlet"> <summary> Lists all tags on a elastic cluster resource </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DOCE.GetDOCEResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The ARN identifier of the elastic cluster 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="T:Amazon.PowerShell.Cmdlets.DOCE.NewDOCEClusterCmdlet"> <summary> Creates a new Amazon DocumentDB elastic cluster and returns its cluster structure. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DOCE.NewDOCEClusterCmdlet.AdminUserName"> <summary> <para> <para>The name of the Amazon DocumentDB elastic clusters 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 Amazon DocumentDB elastic clusters administrator. The password 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 used to determine where to fetch the password used for accessing the elastic cluster. Valid types are <c>PLAIN_TEXT</c> or <c>SECRET_ARN</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DOCE.NewDOCEClusterCmdlet.BackupRetentionPeriod"> <summary> <para> <para>The number of days for which automatic snapshots are retained.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DOCE.NewDOCEClusterCmdlet.ClusterName"> <summary> <para> <para>The name of the new elastic 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>: <c>my-cluster</c></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 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, Amazon 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.PreferredBackupWindow"> <summary> <para> <para>The daily time range during which automated backups are created if automated backups are enabled, as determined by the <c>backupRetentionPeriod</c>.</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>: <c>ddd:hh24:mi-ddd:hh24:mi</c></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 number of vCPUs assigned to each elastic cluster shard. Maximum is 64. Allowed values are 2, 4, 8, 16, 32, 64.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DOCE.NewDOCEClusterCmdlet.ShardCount"> <summary> <para> <para>The number of shards assigned to the elastic cluster. Maximum is 32.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DOCE.NewDOCEClusterCmdlet.ShardInstanceCount"> <summary> <para> <para>The number of replica instances applying to all shards in the elastic cluster. A <c>shardInstanceCount</c> value of 1 means there is one writer instance, and any additional instances are replicas that can be used for reads and to improve availability.</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 cluster.</para><para /> Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DOCE.NewDOCEClusterCmdlet.Tag"> <summary> <para> <para>The tags to be assigned to the new elastic cluster.</para><para /> Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. </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 cluster.</para><para /> Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DOCE.NewDOCEClusterCmdlet.ClientToken"> <summary> <para> <para>The client token for the elastic 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.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 an elastic cluster. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DOCE.NewDOCEClusterSnapshotCmdlet.ClusterArn"> <summary> <para> <para>The ARN identifier of the elastic cluster of which you want to create a snapshot.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DOCE.NewDOCEClusterSnapshotCmdlet.SnapshotName"> <summary> <para> <para>The name of the new elastic cluster 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 cluster snapshot.</para><para /> Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. </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.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 an elastic cluster. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DOCE.RemoveDOCEClusterCmdlet.ClusterArn"> <summary> <para> <para>The ARN identifier of the elastic 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.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 an elastic cluster snapshot. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DOCE.RemoveDOCEClusterSnapshotCmdlet.SnapshotArn"> <summary> <para> <para>The ARN identifier of the elastic cluster 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.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 from an elastic cluster resource </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DOCE.RemoveDOCEResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The ARN identifier of the elastic cluster 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 cluster resource.</para><para /> Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. </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.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 an elastic cluster from a snapshot. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DOCE.RestoreDOCEClusterFromSnapshotCmdlet.ClusterName"> <summary> <para> <para>The name of the elastic 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 Amazon DocumentDB elastic clusters 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, Amazon 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.ShardCapacity"> <summary> <para> <para>The capacity of each shard in the new restored elastic cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DOCE.RestoreDOCEClusterFromSnapshotCmdlet.ShardInstanceCount"> <summary> <para> <para>The number of replica instances applying to all shards in the elastic cluster. A <c>shardInstanceCount</c> value of 1 means there is one writer instance, and any additional instances are replicas that can be used for reads and to improve availability.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DOCE.RestoreDOCEClusterFromSnapshotCmdlet.SnapshotArn"> <summary> <para> <para>The ARN identifier of the elastic cluster 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 cluster.</para><para /> Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. </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 elastic 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 /> Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. </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 cluster.</para><para /> Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. </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.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.SetDOCEPendingMaintenanceActionCmdlet"> <summary> The type of pending maintenance action to be applied to the resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DOCE.SetDOCEPendingMaintenanceActionCmdlet.ApplyAction"> <summary> <para> <para>The pending maintenance action to apply to the resource.</para><para>Valid actions are:</para><ul><li><para><c>ENGINE_UPDATE<i /></c></para></li><li><para><c>ENGINE_UPGRADE</c></para></li><li><para><c>SECURITY_UPDATE</c></para></li><li><para><c>OS_UPDATE</c></para></li><li><para><c>MASTER_USER_PASSWORD_UPDATE</c></para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DOCE.SetDOCEPendingMaintenanceActionCmdlet.ApplyOn"> <summary> <para> <para>A specific date to apply the pending maintenance action. Required if opt-in-type is <c>APPLY_ON</c>. Format: <c>yyyy/MM/dd HH:mm-yyyy/MM/dd HH:mm</c></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DOCE.SetDOCEPendingMaintenanceActionCmdlet.OptInType"> <summary> <para> <para>A value that specifies the type of opt-in request, or undoes an opt-in request. An opt-in request of type <c>IMMEDIATE</c> can't be undone.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DOCE.SetDOCEPendingMaintenanceActionCmdlet.ResourceArn"> <summary> <para> <para>The Amazon DocumentDB Amazon Resource Name (ARN) of the resource to which the pending maintenance action applies.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DOCE.SetDOCEPendingMaintenanceActionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ResourcePendingMaintenanceAction'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DocDBElastic.Model.ApplyPendingMaintenanceActionResponse). Specifying the name of a property of type Amazon.DocDBElastic.Model.ApplyPendingMaintenanceActionResponse 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.SetDOCEPendingMaintenanceActionCmdlet.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.StartDOCEClusterCmdlet"> <summary> Restarts the stopped elastic cluster that is specified by <c>clusterARN</c>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DOCE.StartDOCEClusterCmdlet.ClusterArn"> <summary> <para> <para>The ARN identifier of the elastic cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DOCE.StartDOCEClusterCmdlet.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.StartClusterResponse). Specifying the name of a property of type Amazon.DocDBElastic.Model.StartClusterResponse 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.StartDOCEClusterCmdlet.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.StopDOCEClusterCmdlet"> <summary> Stops the running elastic cluster that is specified by <c>clusterArn</c>. The elastic cluster must be in the <i>available</i> state. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DOCE.StopDOCEClusterCmdlet.ClusterArn"> <summary> <para> <para>The ARN identifier of the elastic cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DOCE.StopDOCEClusterCmdlet.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.StopClusterResponse). Specifying the name of a property of type Amazon.DocDBElastic.Model.StopClusterResponse 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.StopDOCEClusterCmdlet.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 an elastic cluster. This includes updating admin-username/password, upgrading the API version, and setting up a backup window and maintenance window </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DOCE.UpdateDOCEClusterCmdlet.AdminUserPassword"> <summary> <para> <para>The password associated with the elastic 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 used to determine where to fetch the password used for accessing the elastic cluster. Valid types are <c>PLAIN_TEXT</c> or <c>SECRET_ARN</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DOCE.UpdateDOCEClusterCmdlet.BackupRetentionPeriod"> <summary> <para> <para>The number of days for which automatic snapshots are retained.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DOCE.UpdateDOCEClusterCmdlet.ClusterArn"> <summary> <para> <para>The ARN identifier of the elastic cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DOCE.UpdateDOCEClusterCmdlet.PreferredBackupWindow"> <summary> <para> <para>The daily time range during which automated backups are created if automated backups are enabled, as determined by the <c>backupRetentionPeriod</c>.</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>: <c>ddd:hh24:mi-ddd:hh24:mi</c></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 number of vCPUs assigned to each elastic cluster shard. Maximum is 64. Allowed values are 2, 4, 8, 16, 32, 64.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DOCE.UpdateDOCEClusterCmdlet.ShardCount"> <summary> <para> <para>The number of shards assigned to the elastic cluster. Maximum is 32.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DOCE.UpdateDOCEClusterCmdlet.ShardInstanceCount"> <summary> <para> <para>The number of replica instances applying to all shards in the elastic cluster. A <c>shardInstanceCount</c> value of 1 means there is one writer instance, and any additional instances are replicas that can be used for reads and to improve availability.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DOCE.UpdateDOCEClusterCmdlet.SubnetId"> <summary> <para> <para>The Amazon EC2 subnet IDs for the elastic cluster.</para><para /> Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. </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 elastic cluster.</para><para /> Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DOCE.UpdateDOCEClusterCmdlet.ClientToken"> <summary> <para> <para>The client token for the elastic 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.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> |