AWS.Tools.QLDB.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.QLDB</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.QLDB.AddQLDBResourceTagCmdlet"> <summary> Adds one or more tags to a specified Amazon QLDB resource. <para> A resource can have up to 50 tags. If you try to create more than 50 tags for a resource, your request fails and returns an error. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.AddQLDBResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) to which you want to add the tags. For example:</para><para><code>arn:aws:qldb:us-east-1:123456789012:ledger/exampleLedger</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.AddQLDBResourceTagCmdlet.Tag"> <summary> <para> <para>The key-value pairs to add as tags to the specified QLDB resource. Tag keys are case sensitive. If you specify a key that already exists for the resource, your request fails and returns an error. Tag values are case sensitive and can be null.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.AddQLDBResourceTagCmdlet.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.QLDB.Model.TagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.AddQLDBResourceTagCmdlet.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.QLDB.AddQLDBResourceTagCmdlet.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.QLDB.ExportQLDBJournalToS3Cmdlet"> <summary> Exports journal contents within a date and time range from a ledger into a specified Amazon Simple Storage Service (Amazon S3) bucket. A journal export job can write the data objects in either the text or binary representation of Amazon Ion format, or in <i>JSON Lines</i> text format. <para> If the ledger with the given <code>Name</code> doesn't exist, then throws <code>ResourceNotFoundException</code>. </para><para> If the ledger with the given <code>Name</code> is in <code>CREATING</code> status, then throws <code>ResourcePreconditionNotMetException</code>. </para><para> You can initiate up to two concurrent journal export requests for each ledger. Beyond this limit, journal export requests throw <code>LimitExceededException</code>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.ExportQLDBJournalToS3Cmdlet.S3ExportConfiguration_Bucket"> <summary> <para> <para>The Amazon S3 bucket name in which a journal export job writes the journal contents.</para><para>The bucket name must comply with the Amazon S3 bucket naming conventions. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/BucketRestrictions.html">Bucket Restrictions and Limitations</a> in the <i>Amazon S3 Developer Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.ExportQLDBJournalToS3Cmdlet.ExclusiveEndTime"> <summary> <para> <para>The exclusive end date and time for the range of journal contents to export.</para><para>The <code>ExclusiveEndTime</code> must be in <code>ISO 8601</code> date and time format and in Universal Coordinated Time (UTC). For example: <code>2019-06-13T21:36:34Z</code>.</para><para>The <code>ExclusiveEndTime</code> must be less than or equal to the current UTC date and time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.ExportQLDBJournalToS3Cmdlet.InclusiveStartTime"> <summary> <para> <para>The inclusive start date and time for the range of journal contents to export.</para><para>The <code>InclusiveStartTime</code> must be in <code>ISO 8601</code> date and time format and in Universal Coordinated Time (UTC). For example: <code>2019-06-13T21:36:34Z</code>.</para><para>The <code>InclusiveStartTime</code> must be before <code>ExclusiveEndTime</code>.</para><para>If you provide an <code>InclusiveStartTime</code> that is before the ledger's <code>CreationDateTime</code>, Amazon QLDB defaults it to the ledger's <code>CreationDateTime</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.ExportQLDBJournalToS3Cmdlet.EncryptionConfiguration_KmsKeyArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of a symmetric encryption key in Key Management Service (KMS). Amazon S3 does not support asymmetric KMS keys.</para><para>You must provide a <code>KmsKeyArn</code> if you specify <code>SSE_KMS</code> as the <code>ObjectEncryptionType</code>.</para><para><code>KmsKeyArn</code> is not required if you specify <code>SSE_S3</code> as the <code>ObjectEncryptionType</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.ExportQLDBJournalToS3Cmdlet.Name"> <summary> <para> <para>The name of the ledger.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.ExportQLDBJournalToS3Cmdlet.EncryptionConfiguration_ObjectEncryptionType"> <summary> <para> <para>The Amazon S3 object encryption type.</para><para>To learn more about server-side encryption options in Amazon S3, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/serv-side-encryption.html">Protecting Data Using Server-Side Encryption</a> in the <i>Amazon S3 Developer Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.ExportQLDBJournalToS3Cmdlet.OutputFormat"> <summary> <para> <para>The output format of your exported journal data. A journal export job can write the data objects in either the text or binary representation of <a href="https://docs.aws.amazon.com/qldb/latest/developerguide/ion.html">Amazon Ion</a> format, or in <a href="https://jsonlines.org/">JSON Lines</a> text format.</para><para>Default: <code>ION_TEXT</code></para><para>In JSON Lines format, each journal block in an exported data object is a valid JSON object that is delimited by a newline. You can use this format to directly integrate JSON exports with analytics tools such as Amazon Athena and Glue because these services can parse newline-delimited JSON automatically.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.ExportQLDBJournalToS3Cmdlet.S3ExportConfiguration_Prefix"> <summary> <para> <para>The prefix for the Amazon S3 bucket in which a journal export job writes the journal contents.</para><para>The prefix must comply with Amazon S3 key naming rules and restrictions. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html">Object Key and Metadata</a> in the <i>Amazon S3 Developer Guide</i>.</para><para>The following are examples of valid <code>Prefix</code> values:</para><ul><li><para><code>JournalExports-ForMyLedger/Testing/</code></para></li><li><para><code>JournalExports</code></para></li><li><para><code>My:Tests/</code></para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.ExportQLDBJournalToS3Cmdlet.RoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the IAM role that grants QLDB permissions for a journal export job to do the following:</para><ul><li><para>Write objects into your Amazon S3 bucket.</para></li><li><para>(Optional) Use your customer managed key in Key Management Service (KMS) for server-side encryption of your exported data.</para></li></ul><para>To pass a role to QLDB when requesting a journal export, you must have permissions to perform the <code>iam:PassRole</code> action on the IAM role resource. This is required for all journal export requests.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.ExportQLDBJournalToS3Cmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ExportId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QLDB.Model.ExportJournalToS3Response). Specifying the name of a property of type Amazon.QLDB.Model.ExportJournalToS3Response 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.QLDB.ExportQLDBJournalToS3Cmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.ExportQLDBJournalToS3Cmdlet.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.QLDB.GetQLDBBlockCmdlet"> <summary> Returns a block object at a specified address in a journal. Also returns a proof of the specified block for verification if <code>DigestTipAddress</code> is provided. <para> For information about the data contents in a block, see <a href="https://docs.aws.amazon.com/qldb/latest/developerguide/journal-contents.html">Journal contents</a> in the <i>Amazon QLDB Developer Guide</i>. </para><para> If the specified ledger doesn't exist or is in <code>DELETING</code> status, then throws <code>ResourceNotFoundException</code>. </para><para> If the specified ledger is in <code>CREATING</code> status, then throws <code>ResourcePreconditionNotMetException</code>. </para><para> If no block exists with the specified address, then throws <code>InvalidParameterException</code>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.GetQLDBBlockCmdlet.BlockAddress_IonText"> <summary> <para> <para>An Amazon Ion plaintext value contained in a <code>ValueHolder</code> structure.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.GetQLDBBlockCmdlet.DigestTipAddress_IonText"> <summary> <para> <para>An Amazon Ion plaintext value contained in a <code>ValueHolder</code> structure.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.GetQLDBBlockCmdlet.Name"> <summary> <para> <para>The name of the ledger.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.GetQLDBBlockCmdlet.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.QLDB.Model.GetBlockResponse). Specifying the name of a property of type Amazon.QLDB.Model.GetBlockResponse 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.QLDB.GetQLDBBlockCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QLDB.GetQLDBDigestCmdlet"> <summary> Returns the digest of a ledger at the latest committed block in the journal. The response includes a 256-bit hash value and a block address. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.GetQLDBDigestCmdlet.Name"> <summary> <para> <para>The name of the ledger.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.GetQLDBDigestCmdlet.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.QLDB.Model.GetDigestResponse). Specifying the name of a property of type Amazon.QLDB.Model.GetDigestResponse 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.QLDB.GetQLDBDigestCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QLDB.GetQLDBJournalKinesisStreamCmdlet"> <summary> Returns detailed information about a given Amazon QLDB journal stream. The output includes the Amazon Resource Name (ARN), stream name, current status, creation time, and the parameters of the original stream creation request. <para> This action does not return any expired journal streams. For more information, see <a href="https://docs.aws.amazon.com/qldb/latest/developerguide/streams.create.html#streams.create.states.expiration">Expiration for terminal streams</a> in the <i>Amazon QLDB Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.GetQLDBJournalKinesisStreamCmdlet.LedgerName"> <summary> <para> <para>The name of the ledger.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.GetQLDBJournalKinesisStreamCmdlet.StreamId"> <summary> <para> <para>The UUID (represented in Base62-encoded text) of the QLDB journal stream to describe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.GetQLDBJournalKinesisStreamCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Stream'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QLDB.Model.DescribeJournalKinesisStreamResponse). Specifying the name of a property of type Amazon.QLDB.Model.DescribeJournalKinesisStreamResponse 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.QLDB.GetQLDBJournalKinesisStreamCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the StreamId parameter. The -PassThru parameter is deprecated, use -Select '^StreamId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QLDB.GetQLDBJournalKinesisStreamsForLedgerListCmdlet"> <summary> Returns all Amazon QLDB journal streams for a given ledger. <para> This action does not return any expired journal streams. For more information, see <a href="https://docs.aws.amazon.com/qldb/latest/developerguide/streams.create.html#streams.create.states.expiration">Expiration for terminal streams</a> in the <i>Amazon QLDB Developer Guide</i>. </para><para> This action returns a maximum of <code>MaxResults</code> items. It is paginated so that you can retrieve all the items by calling <code>ListJournalKinesisStreamsForLedger</code> multiple times. </para><br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.GetQLDBJournalKinesisStreamsForLedgerListCmdlet.LedgerName"> <summary> <para> <para>The name of the ledger.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.GetQLDBJournalKinesisStreamsForLedgerListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return in a single <code>ListJournalKinesisStreamsForLedger</code> request. (The actual number of results returned might be fewer.)</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.GetQLDBJournalKinesisStreamsForLedgerListCmdlet.NextToken"> <summary> <para> <para>A pagination token, indicating that you want to retrieve the next page of results. If you received a value for <code>NextToken</code> in the response from a previous <code>ListJournalKinesisStreamsForLedger</code> call, you should use that value as input here.</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/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.GetQLDBJournalKinesisStreamsForLedgerListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Streams'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QLDB.Model.ListJournalKinesisStreamsForLedgerResponse). Specifying the name of a property of type Amazon.QLDB.Model.ListJournalKinesisStreamsForLedgerResponse 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.QLDB.GetQLDBJournalKinesisStreamsForLedgerListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the LedgerName parameter. The -PassThru parameter is deprecated, use -Select '^LedgerName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.GetQLDBJournalKinesisStreamsForLedgerListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QLDB.GetQLDBJournalS3ExportCmdlet"> <summary> Returns information about a journal export job, including the ledger name, export ID, creation time, current status, and the parameters of the original export creation request. <para> This action does not return any expired export jobs. For more information, see <a href="https://docs.aws.amazon.com/qldb/latest/developerguide/export-journal.request.html#export-journal.request.expiration">Export job expiration</a> in the <i>Amazon QLDB Developer Guide</i>. </para><para> If the export job with the given <code>ExportId</code> doesn't exist, then throws <code>ResourceNotFoundException</code>. </para><para> If the ledger with the given <code>Name</code> doesn't exist, then throws <code>ResourceNotFoundException</code>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.GetQLDBJournalS3ExportCmdlet.ExportId"> <summary> <para> <para>The UUID (represented in Base62-encoded text) of the journal export job to describe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.GetQLDBJournalS3ExportCmdlet.Name"> <summary> <para> <para>The name of the ledger.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.GetQLDBJournalS3ExportCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ExportDescription'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QLDB.Model.DescribeJournalS3ExportResponse). Specifying the name of a property of type Amazon.QLDB.Model.DescribeJournalS3ExportResponse 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.QLDB.GetQLDBJournalS3ExportCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ExportId parameter. The -PassThru parameter is deprecated, use -Select '^ExportId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QLDB.GetQLDBJournalS3ExportListCmdlet"> <summary> Returns all journal export jobs for all ledgers that are associated with the current Amazon Web Services account and Region. <para> This action returns a maximum of <code>MaxResults</code> items, and is paginated so that you can retrieve all the items by calling <code>ListJournalS3Exports</code> multiple times. </para><para> This action does not return any expired export jobs. For more information, see <a href="https://docs.aws.amazon.com/qldb/latest/developerguide/export-journal.request.html#export-journal.request.expiration">Export job expiration</a> in the <i>Amazon QLDB Developer Guide</i>. </para><br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.GetQLDBJournalS3ExportListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return in a single <code>ListJournalS3Exports</code> request. (The actual number of results returned might be fewer.)</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.QLDB.GetQLDBJournalS3ExportListCmdlet.NextToken"> <summary> <para> <para>A pagination token, indicating that you want to retrieve the next page of results. If you received a value for <code>NextToken</code> in the response from a previous <code>ListJournalS3Exports</code> call, then you should use that value as input here.</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/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.GetQLDBJournalS3ExportListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'JournalS3Exports'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QLDB.Model.ListJournalS3ExportsResponse). Specifying the name of a property of type Amazon.QLDB.Model.ListJournalS3ExportsResponse 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.QLDB.GetQLDBJournalS3ExportListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QLDB.GetQLDBJournalS3ExportsForLedgerListCmdlet"> <summary> Returns all journal export jobs for a specified ledger. <para> This action returns a maximum of <code>MaxResults</code> items, and is paginated so that you can retrieve all the items by calling <code>ListJournalS3ExportsForLedger</code> multiple times. </para><para> This action does not return any expired export jobs. For more information, see <a href="https://docs.aws.amazon.com/qldb/latest/developerguide/export-journal.request.html#export-journal.request.expiration">Export job expiration</a> in the <i>Amazon QLDB Developer Guide</i>. </para><br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.GetQLDBJournalS3ExportsForLedgerListCmdlet.Name"> <summary> <para> <para>The name of the ledger.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.GetQLDBJournalS3ExportsForLedgerListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return in a single <code>ListJournalS3ExportsForLedger</code> request. (The actual number of results returned might be fewer.)</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.QLDB.GetQLDBJournalS3ExportsForLedgerListCmdlet.NextToken"> <summary> <para> <para>A pagination token, indicating that you want to retrieve the next page of results. If you received a value for <code>NextToken</code> in the response from a previous <code>ListJournalS3ExportsForLedger</code> call, then you should use that value as input here.</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/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.GetQLDBJournalS3ExportsForLedgerListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'JournalS3Exports'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QLDB.Model.ListJournalS3ExportsForLedgerResponse). Specifying the name of a property of type Amazon.QLDB.Model.ListJournalS3ExportsForLedgerResponse 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.QLDB.GetQLDBJournalS3ExportsForLedgerListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.GetQLDBJournalS3ExportsForLedgerListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QLDB.GetQLDBLedgerCmdlet"> <summary> Returns information about a ledger, including its state, permissions mode, encryption at rest settings, and when it was created. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.GetQLDBLedgerCmdlet.Name"> <summary> <para> <para>The name of the ledger that you want to describe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.GetQLDBLedgerCmdlet.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.QLDB.Model.DescribeLedgerResponse). Specifying the name of a property of type Amazon.QLDB.Model.DescribeLedgerResponse 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.QLDB.GetQLDBLedgerCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QLDB.GetQLDBLedgerListCmdlet"> <summary> Returns all ledgers that are associated with the current Amazon Web Services account and Region. <para> This action returns a maximum of <code>MaxResults</code> items and is paginated so that you can retrieve all the items by calling <code>ListLedgers</code> multiple times. </para><br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.GetQLDBLedgerListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return in a single <code>ListLedgers</code> request. (The actual number of results returned might be fewer.)</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.QLDB.GetQLDBLedgerListCmdlet.NextToken"> <summary> <para> <para>A pagination token, indicating that you want to retrieve the next page of results. If you received a value for <code>NextToken</code> in the response from a previous <code>ListLedgers</code> call, then you should use that value as input here.</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/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.GetQLDBLedgerListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Ledgers'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QLDB.Model.ListLedgersResponse). Specifying the name of a property of type Amazon.QLDB.Model.ListLedgersResponse 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.QLDB.GetQLDBLedgerListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QLDB.GetQLDBResourceTagCmdlet"> <summary> Returns all tags for a specified Amazon QLDB resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.GetQLDBResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) for which to list the tags. For example:</para><para><code>arn:aws:qldb:us-east-1:123456789012:ledger/exampleLedger</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.GetQLDBResourceTagCmdlet.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.QLDB.Model.ListTagsForResourceResponse). Specifying the name of a property of type Amazon.QLDB.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.QLDB.GetQLDBResourceTagCmdlet.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.QLDB.GetQLDBRevisionCmdlet"> <summary> Returns a revision data object for a specified document ID and block address. Also returns a proof of the specified revision for verification if <code>DigestTipAddress</code> is provided. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.GetQLDBRevisionCmdlet.DocumentId"> <summary> <para> <para>The UUID (represented in Base62-encoded text) of the document to be verified.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.GetQLDBRevisionCmdlet.BlockAddress_IonText"> <summary> <para> <para>An Amazon Ion plaintext value contained in a <code>ValueHolder</code> structure.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.GetQLDBRevisionCmdlet.DigestTipAddress_IonText"> <summary> <para> <para>An Amazon Ion plaintext value contained in a <code>ValueHolder</code> structure.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.GetQLDBRevisionCmdlet.Name"> <summary> <para> <para>The name of the ledger.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.GetQLDBRevisionCmdlet.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.QLDB.Model.GetRevisionResponse). Specifying the name of a property of type Amazon.QLDB.Model.GetRevisionResponse 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.QLDB.GetQLDBRevisionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DocumentId parameter. The -PassThru parameter is deprecated, use -Select '^DocumentId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QLDB.NewQLDBLedgerCmdlet"> <summary> Creates a new ledger in your Amazon Web Services account in the current Region. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.NewQLDBLedgerCmdlet.DeletionProtection"> <summary> <para> <para>Specifies whether the ledger is protected from being deleted by any user. If not defined during ledger creation, this feature is enabled (<code>true</code>) by default.</para><para>If deletion protection is enabled, you must first disable it before you can delete the ledger. You can disable it by calling the <code>UpdateLedger</code> operation to set this parameter to <code>false</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.NewQLDBLedgerCmdlet.KmsKey"> <summary> <para> <para>The key in Key Management Service (KMS) to use for encryption of data at rest in the ledger. For more information, see <a href="https://docs.aws.amazon.com/qldb/latest/developerguide/encryption-at-rest.html">Encryption at rest</a> in the <i>Amazon QLDB Developer Guide</i>.</para><para>Use one of the following options to specify this parameter:</para><ul><li><para><code>AWS_OWNED_KMS_KEY</code>: Use an KMS key that is owned and managed by Amazon Web Services on your behalf.</para></li><li><para><b>Undefined</b>: By default, use an Amazon Web Services owned KMS key.</para></li><li><para><b>A valid symmetric customer managed KMS key</b>: Use the specified symmetric encryption KMS key in your account that you create, own, and manage.</para><para>Amazon QLDB does not support asymmetric keys. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html">Using symmetric and asymmetric keys</a> in the <i>Key Management Service Developer Guide</i>.</para></li></ul><para>To specify a customer managed KMS key, you can use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with <code>"alias/"</code>. To specify a key in a different Amazon Web Services account, you must use the key ARN or alias ARN.</para><para>For example:</para><ul><li><para>Key ID: <code>1234abcd-12ab-34cd-56ef-1234567890ab</code></para></li><li><para>Key ARN: <code>arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code></para></li><li><para>Alias name: <code>alias/ExampleAlias</code></para></li><li><para>Alias ARN: <code>arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias</code></para></li></ul><para>For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id">Key identifiers (KeyId)</a> in the <i>Key Management Service Developer Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.NewQLDBLedgerCmdlet.Name"> <summary> <para> <para>The name of the ledger that you want to create. The name must be unique among all of the ledgers in your Amazon Web Services account in the current Region.</para><para>Naming constraints for ledger names are defined in <a href="https://docs.aws.amazon.com/qldb/latest/developerguide/limits.html#limits.naming">Quotas in Amazon QLDB</a> in the <i>Amazon QLDB Developer Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.NewQLDBLedgerCmdlet.PermissionsMode"> <summary> <para> <para>The permissions mode to assign to the ledger that you want to create. This parameter can have one of the following values:</para><ul><li><para><code>ALLOW_ALL</code>: A legacy permissions mode that enables access control with API-level granularity for ledgers.</para><para>This mode allows users who have the <code>SendCommand</code> API permission for this ledger to run all PartiQL commands (hence, <code>ALLOW_ALL</code>) on any tables in the specified ledger. This mode disregards any table-level or command-level IAM permissions policies that you create for the ledger.</para></li><li><para><code>STANDARD</code>: (<i>Recommended</i>) A permissions mode that enables access control with finer granularity for ledgers, tables, and PartiQL commands.</para><para>By default, this mode denies all user requests to run any PartiQL commands on any tables in this ledger. To allow PartiQL commands to run, you must create IAM permissions policies for specific table resources and PartiQL actions, in addition to the <code>SendCommand</code> API permission for the ledger. For information, see <a href="https://docs.aws.amazon.com/qldb/latest/developerguide/getting-started-standard-mode.html">Getting started with the standard permissions mode</a> in the <i>Amazon QLDB Developer Guide</i>.</para></li></ul><note><para>We strongly recommend using the <code>STANDARD</code> permissions mode to maximize the security of your ledger data.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.NewQLDBLedgerCmdlet.Tag"> <summary> <para> <para>The key-value pairs to add as tags to the ledger that you want to create. Tag keys are case sensitive. Tag values are case sensitive and can be null.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.NewQLDBLedgerCmdlet.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.QLDB.Model.CreateLedgerResponse). Specifying the name of a property of type Amazon.QLDB.Model.CreateLedgerResponse 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.QLDB.NewQLDBLedgerCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.NewQLDBLedgerCmdlet.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.QLDB.RemoveQLDBLedgerCmdlet"> <summary> Deletes a ledger and all of its contents. This action is irreversible. <para> If deletion protection is enabled, you must first disable it before you can delete the ledger. You can disable it by calling the <code>UpdateLedger</code> operation to set this parameter to <code>false</code>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.RemoveQLDBLedgerCmdlet.Name"> <summary> <para> <para>The name of the ledger that you want to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.RemoveQLDBLedgerCmdlet.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.QLDB.Model.DeleteLedgerResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.RemoveQLDBLedgerCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.RemoveQLDBLedgerCmdlet.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.QLDB.RemoveQLDBResourceTagCmdlet"> <summary> Removes one or more tags from a specified Amazon QLDB resource. You can specify up to 50 tag keys to remove. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.RemoveQLDBResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) from which to remove the tags. For example:</para><para><code>arn:aws:qldb:us-east-1:123456789012:ledger/exampleLedger</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.RemoveQLDBResourceTagCmdlet.TagKey"> <summary> <para> <para>The list of tag keys to remove.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.RemoveQLDBResourceTagCmdlet.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.QLDB.Model.UntagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.RemoveQLDBResourceTagCmdlet.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.QLDB.RemoveQLDBResourceTagCmdlet.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.QLDB.StartQLDBStreamJournalToKinesiCmdlet"> <summary> Creates a journal stream for a given Amazon QLDB ledger. The stream captures every document revision that is committed to the ledger's journal and delivers the data to a specified Amazon Kinesis Data Streams resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.StartQLDBStreamJournalToKinesiCmdlet.KinesisConfiguration_AggregationEnabled"> <summary> <para> <para>Enables QLDB to publish multiple data records in a single Kinesis Data Streams record, increasing the number of records sent per API call.</para><para>Default: <code>True</code></para><important><para>Record aggregation has important implications for processing records and requires de-aggregation in your stream consumer. To learn more, see <a href="https://docs.aws.amazon.com/streams/latest/dev/kinesis-kpl-concepts.html">KPL Key Concepts</a> and <a href="https://docs.aws.amazon.com/streams/latest/dev/kinesis-kpl-consumer-deaggregation.html">Consumer De-aggregation</a> in the <i>Amazon Kinesis Data Streams Developer Guide</i>.</para></important> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.StartQLDBStreamJournalToKinesiCmdlet.ExclusiveEndTime"> <summary> <para> <para>The exclusive date and time that specifies when the stream ends. If you don't define this parameter, the stream runs indefinitely until you cancel it.</para><para>The <code>ExclusiveEndTime</code> must be in <code>ISO 8601</code> date and time format and in Universal Coordinated Time (UTC). For example: <code>2019-06-13T21:36:34Z</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.StartQLDBStreamJournalToKinesiCmdlet.InclusiveStartTime"> <summary> <para> <para>The inclusive start date and time from which to start streaming journal data. This parameter must be in <code>ISO 8601</code> date and time format and in Universal Coordinated Time (UTC). For example: <code>2019-06-13T21:36:34Z</code>.</para><para>The <code>InclusiveStartTime</code> cannot be in the future and must be before <code>ExclusiveEndTime</code>.</para><para>If you provide an <code>InclusiveStartTime</code> that is before the ledger's <code>CreationDateTime</code>, QLDB effectively defaults it to the ledger's <code>CreationDateTime</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.StartQLDBStreamJournalToKinesiCmdlet.LedgerName"> <summary> <para> <para>The name of the ledger.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.StartQLDBStreamJournalToKinesiCmdlet.RoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the IAM role that grants QLDB permissions for a journal stream to write data records to a Kinesis Data Streams resource.</para><para>To pass a role to QLDB when requesting a journal stream, you must have permissions to perform the <code>iam:PassRole</code> action on the IAM role resource. This is required for all journal stream requests.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.StartQLDBStreamJournalToKinesiCmdlet.KinesisConfiguration_StreamArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the Kinesis Data Streams resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.StartQLDBStreamJournalToKinesiCmdlet.StreamName"> <summary> <para> <para>The name that you want to assign to the QLDB journal stream. User-defined names can help identify and indicate the purpose of a stream.</para><para>Your stream name must be unique among other <i>active</i> streams for a given ledger. Stream names have the same naming constraints as ledger names, as defined in <a href="https://docs.aws.amazon.com/qldb/latest/developerguide/limits.html#limits.naming">Quotas in Amazon QLDB</a> in the <i>Amazon QLDB Developer Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.StartQLDBStreamJournalToKinesiCmdlet.Tag"> <summary> <para> <para>The key-value pairs to add as tags to the stream that you want to create. Tag keys are case sensitive. Tag values are case sensitive and can be null.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.StartQLDBStreamJournalToKinesiCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'StreamId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QLDB.Model.StreamJournalToKinesisResponse). Specifying the name of a property of type Amazon.QLDB.Model.StreamJournalToKinesisResponse 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.QLDB.StartQLDBStreamJournalToKinesiCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the LedgerName parameter. The -PassThru parameter is deprecated, use -Select '^LedgerName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.StartQLDBStreamJournalToKinesiCmdlet.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.QLDB.StopQLDBJournalKinesisStreamCmdlet"> <summary> Ends a given Amazon QLDB journal stream. Before a stream can be canceled, its current status must be <code>ACTIVE</code>. <para> You can't restart a stream after you cancel it. Canceled QLDB stream resources are subject to a 7-day retention period, so they are automatically deleted after this limit expires. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.StopQLDBJournalKinesisStreamCmdlet.LedgerName"> <summary> <para> <para>The name of the ledger.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.StopQLDBJournalKinesisStreamCmdlet.StreamId"> <summary> <para> <para>The UUID (represented in Base62-encoded text) of the QLDB journal stream to be canceled.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.StopQLDBJournalKinesisStreamCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'StreamId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QLDB.Model.CancelJournalKinesisStreamResponse). Specifying the name of a property of type Amazon.QLDB.Model.CancelJournalKinesisStreamResponse 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.QLDB.StopQLDBJournalKinesisStreamCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the StreamId parameter. The -PassThru parameter is deprecated, use -Select '^StreamId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.StopQLDBJournalKinesisStreamCmdlet.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.QLDB.UpdateQLDBLedgerCmdlet"> <summary> Updates properties on a ledger. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.UpdateQLDBLedgerCmdlet.DeletionProtection"> <summary> <para> <para>Specifies whether the ledger is protected from being deleted by any user. If not defined during ledger creation, this feature is enabled (<code>true</code>) by default.</para><para>If deletion protection is enabled, you must first disable it before you can delete the ledger. You can disable it by calling the <code>UpdateLedger</code> operation to set this parameter to <code>false</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.UpdateQLDBLedgerCmdlet.KmsKey"> <summary> <para> <para>The key in Key Management Service (KMS) to use for encryption of data at rest in the ledger. For more information, see <a href="https://docs.aws.amazon.com/qldb/latest/developerguide/encryption-at-rest.html">Encryption at rest</a> in the <i>Amazon QLDB Developer Guide</i>.</para><para>Use one of the following options to specify this parameter:</para><ul><li><para><code>AWS_OWNED_KMS_KEY</code>: Use an KMS key that is owned and managed by Amazon Web Services on your behalf.</para></li><li><para><b>Undefined</b>: Make no changes to the KMS key of the ledger.</para></li><li><para><b>A valid symmetric customer managed KMS key</b>: Use the specified symmetric encryption KMS key in your account that you create, own, and manage.</para><para>Amazon QLDB does not support asymmetric keys. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html">Using symmetric and asymmetric keys</a> in the <i>Key Management Service Developer Guide</i>.</para></li></ul><para>To specify a customer managed KMS key, you can use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with <code>"alias/"</code>. To specify a key in a different Amazon Web Services account, you must use the key ARN or alias ARN.</para><para>For example:</para><ul><li><para>Key ID: <code>1234abcd-12ab-34cd-56ef-1234567890ab</code></para></li><li><para>Key ARN: <code>arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code></para></li><li><para>Alias name: <code>alias/ExampleAlias</code></para></li><li><para>Alias ARN: <code>arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias</code></para></li></ul><para>For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id">Key identifiers (KeyId)</a> in the <i>Key Management Service Developer Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.UpdateQLDBLedgerCmdlet.Name"> <summary> <para> <para>The name of the ledger.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.UpdateQLDBLedgerCmdlet.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.QLDB.Model.UpdateLedgerResponse). Specifying the name of a property of type Amazon.QLDB.Model.UpdateLedgerResponse 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.QLDB.UpdateQLDBLedgerCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.UpdateQLDBLedgerCmdlet.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.QLDB.UpdateQLDBLedgerPermissionsModeCmdlet"> <summary> Updates the permissions mode of a ledger. <important><para> Before you switch to the <code>STANDARD</code> permissions mode, you must first create all required IAM policies and table tags to avoid disruption to your users. To learn more, see <a href="https://docs.aws.amazon.com/qldb/latest/developerguide/ledger-management.basics.html#ledger-mgmt.basics.update-permissions.migrating">Migrating to the standard permissions mode</a> in the <i>Amazon QLDB Developer Guide</i>. </para></important> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.UpdateQLDBLedgerPermissionsModeCmdlet.Name"> <summary> <para> <para>The name of the ledger.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.UpdateQLDBLedgerPermissionsModeCmdlet.PermissionsMode"> <summary> <para> <para>The permissions mode to assign to the ledger. This parameter can have one of the following values:</para><ul><li><para><code>ALLOW_ALL</code>: A legacy permissions mode that enables access control with API-level granularity for ledgers.</para><para>This mode allows users who have the <code>SendCommand</code> API permission for this ledger to run all PartiQL commands (hence, <code>ALLOW_ALL</code>) on any tables in the specified ledger. This mode disregards any table-level or command-level IAM permissions policies that you create for the ledger.</para></li><li><para><code>STANDARD</code>: (<i>Recommended</i>) A permissions mode that enables access control with finer granularity for ledgers, tables, and PartiQL commands.</para><para>By default, this mode denies all user requests to run any PartiQL commands on any tables in this ledger. To allow PartiQL commands to run, you must create IAM permissions policies for specific table resources and PartiQL actions, in addition to the <code>SendCommand</code> API permission for the ledger. For information, see <a href="https://docs.aws.amazon.com/qldb/latest/developerguide/getting-started-standard-mode.html">Getting started with the standard permissions mode</a> in the <i>Amazon QLDB Developer Guide</i>.</para></li></ul><note><para>We strongly recommend using the <code>STANDARD</code> permissions mode to maximize the security of your ledger data.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.UpdateQLDBLedgerPermissionsModeCmdlet.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.QLDB.Model.UpdateLedgerPermissionsModeResponse). Specifying the name of a property of type Amazon.QLDB.Model.UpdateLedgerPermissionsModeResponse 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.QLDB.UpdateQLDBLedgerPermissionsModeCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QLDB.UpdateQLDBLedgerPermissionsModeCmdlet.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> |