AWS.Tools.Keyspaces.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.Keyspaces</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.KS.AddKSResourceTagCmdlet"> <summary> Associates a set of tags with a Amazon Keyspaces resource. You can then activate these user-defined tags so that they appear on the Cost Management Console for cost allocation tracking. For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/tagging-keyspaces.html">Adding tags and labels to Amazon Keyspaces resources</a> in the <i>Amazon Keyspaces Developer Guide</i>. <para> For IAM policy examples that show how to control access to Amazon Keyspaces resources based on tags, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/security_iam_id-based-policy-examples-tags">Amazon Keyspaces resource access based on tags</a> in the <i>Amazon Keyspaces Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.AddKSResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the Amazon Keyspaces resource to which to add tags.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.AddKSResourceTagCmdlet.Tag"> <summary> <para> <para>The tags to be assigned to the Amazon Keyspaces resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.AddKSResourceTagCmdlet.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.Keyspaces.Model.TagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.AddKSResourceTagCmdlet.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.KS.AddKSResourceTagCmdlet.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.KS.GetKSKeyspaceCmdlet"> <summary> Returns the name and the Amazon Resource Name (ARN) of the specified table. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.GetKSKeyspaceCmdlet.KeyspaceName"> <summary> <para> <para>The name of the keyspace.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.GetKSKeyspaceCmdlet.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.Keyspaces.Model.GetKeyspaceResponse). Specifying the name of a property of type Amazon.Keyspaces.Model.GetKeyspaceResponse 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.KS.GetKSKeyspaceCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the KeyspaceName parameter. The -PassThru parameter is deprecated, use -Select '^KeyspaceName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.KS.GetKSKeyspaceListCmdlet"> <summary> Returns a list of keyspaces. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.GetKSKeyspaceListCmdlet.MaxResult"> <summary> <para> <para>The total number of keyspaces to return in the output. If the total number of keyspaces available is more than the value specified, a <code>NextToken</code> is provided in the output. To resume pagination, provide the <code>NextToken</code> value as an argument of a subsequent API invocation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.GetKSKeyspaceListCmdlet.NextToken"> <summary> <para> <para>The pagination token. To resume pagination, provide the <code>NextToken</code> value as argument of a subsequent API invocation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.GetKSKeyspaceListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Keyspaces'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Keyspaces.Model.ListKeyspacesResponse). Specifying the name of a property of type Amazon.Keyspaces.Model.ListKeyspacesResponse 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.KS.GetKSResourceTagCmdlet"> <summary> Returns a list of all tags associated with the specified Amazon Keyspaces resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.GetKSResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the Amazon Keyspaces resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.GetKSResourceTagCmdlet.MaxResult"> <summary> <para> <para>The total number of tags to return in the output. If the total number of tags available is more than the value specified, a <code>NextToken</code> is provided in the output. To resume pagination, provide the <code>NextToken</code> value as an argument of a subsequent API invocation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.GetKSResourceTagCmdlet.NextToken"> <summary> <para> <para>The pagination token. To resume pagination, provide the <code>NextToken</code> value as argument of a subsequent API invocation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.GetKSResourceTagCmdlet.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.Keyspaces.Model.ListTagsForResourceResponse). Specifying the name of a property of type Amazon.Keyspaces.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.KS.GetKSResourceTagCmdlet.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.KS.GetKSTableCmdlet"> <summary> Returns information about the table, including the table's name and current status, the keyspace name, configuration settings, and metadata. <para> To read table metadata using <code>GetTable</code>, <code>Select</code> action permissions for the table and system tables are required to complete the operation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.GetKSTableCmdlet.KeyspaceName"> <summary> <para> <para>The name of the keyspace that the table is stored in.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.GetKSTableCmdlet.TableName"> <summary> <para> <para>The name of the table.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.GetKSTableCmdlet.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.Keyspaces.Model.GetTableResponse). Specifying the name of a property of type Amazon.Keyspaces.Model.GetTableResponse 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.KS.GetKSTableListCmdlet"> <summary> Returns a list of tables for a specified keyspace. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.GetKSTableListCmdlet.KeyspaceName"> <summary> <para> <para>The name of the keyspace.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.GetKSTableListCmdlet.MaxResult"> <summary> <para> <para>The total number of tables to return in the output. If the total number of tables available is more than the value specified, a <code>NextToken</code> is provided in the output. To resume pagination, provide the <code>NextToken</code> value as an argument of a subsequent API invocation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.GetKSTableListCmdlet.NextToken"> <summary> <para> <para>The pagination token. To resume pagination, provide the <code>NextToken</code> value as an argument of a subsequent API invocation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.GetKSTableListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Tables'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Keyspaces.Model.ListTablesResponse). Specifying the name of a property of type Amazon.Keyspaces.Model.ListTablesResponse 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.KS.GetKSTableListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the KeyspaceName parameter. The -PassThru parameter is deprecated, use -Select '^KeyspaceName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.KS.NewKSKeyspaceCmdlet"> <summary> The <code>CreateKeyspace</code> operation adds a new keyspace to your account. In an Amazon Web Services account, keyspace names must be unique within each Region. <para><code>CreateKeyspace</code> is an asynchronous operation. You can monitor the creation status of the new keyspace by using the <code>GetKeyspace</code> operation. </para><para> For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/working-with-keyspaces.html#keyspaces-create">Creating keyspaces</a> in the <i>Amazon Keyspaces Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.NewKSKeyspaceCmdlet.KeyspaceName"> <summary> <para> <para>The name of the keyspace to be created.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.NewKSKeyspaceCmdlet.Tag"> <summary> <para> <para>A list of key-value pair tags to be attached to the keyspace.</para><para>For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/tagging-keyspaces.html">Adding tags and labels to Amazon Keyspaces resources</a> in the <i>Amazon Keyspaces Developer Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.NewKSKeyspaceCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ResourceArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Keyspaces.Model.CreateKeyspaceResponse). Specifying the name of a property of type Amazon.Keyspaces.Model.CreateKeyspaceResponse 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.KS.NewKSKeyspaceCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the KeyspaceName parameter. The -PassThru parameter is deprecated, use -Select '^KeyspaceName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.NewKSKeyspaceCmdlet.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.KS.NewKSTableCmdlet"> <summary> The <code>CreateTable</code> operation adds a new table to the specified keyspace. Within a keyspace, table names must be unique. <para><code>CreateTable</code> is an asynchronous operation. When the request is received, the status of the table is set to <code>CREATING</code>. You can monitor the creation status of the new table by using the <code>GetTable</code> operation, which returns the current <code>status</code> of the table. You can start using a table when the status is <code>ACTIVE</code>. </para><para> For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/working-with-tables.html#tables-create">Creating tables</a> in the <i>Amazon Keyspaces Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.NewKSTableCmdlet.SchemaDefinition_AllColumn"> <summary> <para> <para>The regular columns of the table.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.NewKSTableCmdlet.SchemaDefinition_ClusteringKey"> <summary> <para> <para>The columns that are part of the clustering key of the table.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.NewKSTableCmdlet.DefaultTimeToLive"> <summary> <para> <para>The default Time to Live setting in seconds for the table.</para><para>For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/TTL-how-it-works.html#ttl-howitworks_default_ttl">Setting the default TTL value for a table</a> in the <i>Amazon Keyspaces Developer Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.NewKSTableCmdlet.KeyspaceName"> <summary> <para> <para>The name of the keyspace that the table is going to be created in.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.NewKSTableCmdlet.EncryptionSpecification_KmsKeyIdentifier"> <summary> <para> <para>The Amazon Resource Name (ARN) of the customer managed KMS key, for example <code>kms_key_identifier:ARN</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.NewKSTableCmdlet.Comment_Message"> <summary> <para> <para>An optional description of the table.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.NewKSTableCmdlet.SchemaDefinition_PartitionKey"> <summary> <para> <para>The columns that are part of the partition key of the table .</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.NewKSTableCmdlet.CapacitySpecification_ReadCapacityUnit"> <summary> <para> <para>The throughput capacity specified for <code>read</code> operations defined in <code>read capacity units</code><code>(RCUs)</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.NewKSTableCmdlet.SchemaDefinition_StaticColumn"> <summary> <para> <para>The columns that have been defined as <code>STATIC</code>. Static columns store values that are shared by all rows in the same partition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.NewKSTableCmdlet.PointInTimeRecovery_Status"> <summary> <para> <para>The options are:</para><para>• <code>ENABLED</code></para><para>• <code>DISABLED</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.NewKSTableCmdlet.Ttl_Status"> <summary> <para> <para>Shows how to enable custom Time to Live (TTL) settings for the specified table.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.NewKSTableCmdlet.TableName"> <summary> <para> <para>The name of the table.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.NewKSTableCmdlet.Tag"> <summary> <para> <para>A list of key-value pair tags to be attached to the resource. </para><para>For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/tagging-keyspaces.html">Adding tags and labels to Amazon Keyspaces resources</a> in the <i>Amazon Keyspaces Developer Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.NewKSTableCmdlet.CapacitySpecification_ThroughputMode"> <summary> <para> <para>The read/write throughput capacity mode for a table. The options are:</para><para>• <code>throughputMode:PAY_PER_REQUEST</code> and </para><para>• <code>throughputMode:PROVISIONED</code> - Provisioned capacity mode requires <code>readCapacityUnits</code> and <code>writeCapacityUnits</code> as input.</para><para>The default is <code>throughput_mode:PAY_PER_REQUEST</code>.</para><para>For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/ReadWriteCapacityMode.html">Read/write capacity modes</a> in the <i>Amazon Keyspaces Developer Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.NewKSTableCmdlet.EncryptionSpecification_Type"> <summary> <para> <para>The encryption option specified for the table. You can choose one of the following KMS keys (KMS keys):</para><para>• <code>type:AWS_OWNED_KMS_KEY</code> - This key is owned by Amazon Keyspaces. </para><para>• <code>type:CUSTOMER_MANAGED_KMS_KEY</code> - This key is stored in your account and is created, owned, and managed by you. This option requires the <code>kms_key_identifier</code> of the KMS key in Amazon Resource Name (ARN) format as input. </para><para>The default is <code>type:AWS_OWNED_KMS_KEY</code>. </para><para>For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/EncryptionAtRest.html">Encryption at rest</a> in the <i>Amazon Keyspaces Developer Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.NewKSTableCmdlet.CapacitySpecification_WriteCapacityUnit"> <summary> <para> <para>The throughput capacity specified for <code>write</code> operations defined in <code>write capacity units</code><code>(WCUs)</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.NewKSTableCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ResourceArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Keyspaces.Model.CreateTableResponse). Specifying the name of a property of type Amazon.Keyspaces.Model.CreateTableResponse 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.KS.NewKSTableCmdlet.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.KS.RemoveKSKeyspaceCmdlet"> <summary> The <code>DeleteKeyspace</code> operation deletes a keyspace and all of its tables. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.RemoveKSKeyspaceCmdlet.KeyspaceName"> <summary> <para> <para>The name of the keyspace to be deleted.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.RemoveKSKeyspaceCmdlet.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.Keyspaces.Model.DeleteKeyspaceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.RemoveKSKeyspaceCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the KeyspaceName parameter. The -PassThru parameter is deprecated, use -Select '^KeyspaceName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.RemoveKSKeyspaceCmdlet.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.KS.RemoveKSResourceTagCmdlet"> <summary> Removes the association of tags from a Amazon Keyspaces resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.RemoveKSResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Keyspaces resource that the tags will be removed from. This value is an Amazon Resource Name (ARN).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.RemoveKSResourceTagCmdlet.Tag"> <summary> <para> <para>A list of existing tags to be removed from the Amazon Keyspaces resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.RemoveKSResourceTagCmdlet.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.Keyspaces.Model.UntagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.RemoveKSResourceTagCmdlet.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.KS.RemoveKSResourceTagCmdlet.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.KS.RemoveKSTableCmdlet"> <summary> The <code>DeleteTable</code> operation deletes a table and all of its data. After a <code>DeleteTable</code> request is received, the specified table is in the <code>DELETING</code> state until Amazon Keyspaces completes the deletion. If the table is in the <code>ACTIVE</code> state, you can delete it. If a table is either in the <code>CREATING</code> or <code>UPDATING</code> states, then Amazon Keyspaces returns a <code>ResourceInUseException</code>. If the specified table does not exist, Amazon Keyspaces returns a <code>ResourceNotFoundException</code>. If the table is already in the <code>DELETING</code> state, no error is returned. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.RemoveKSTableCmdlet.KeyspaceName"> <summary> <para> <para>The name of the keyspace of the to be deleted table.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.RemoveKSTableCmdlet.TableName"> <summary> <para> <para>The name of the table to be deleted.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.RemoveKSTableCmdlet.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.Keyspaces.Model.DeleteTableResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.RemoveKSTableCmdlet.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.KS.RestoreKSTableCmdlet"> <summary> Restores the specified table to the specified point in time within the <code>earliest_restorable_timestamp</code> and the current time. For more information about restore points, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/PointInTimeRecovery_HowItWorks.html#howitworks_backup_window"> Time window for PITR continuous backups</a> in the <i>Amazon Keyspaces Developer Guide</i>. <para> Any number of users can execute up to 4 concurrent restores (any type of restore) in a given account. </para><para> When you restore using point in time recovery, Amazon Keyspaces restores your source table's schema and data to the state based on the selected timestamp <code>(day:hour:minute:second)</code> to a new table. The Time to Live (TTL) settings are also restored to the state based on the selected timestamp. </para><para> In addition to the table's schema, data, and TTL settings, <code>RestoreTable</code> restores the capacity mode, encryption, and point-in-time recovery settings from the source table. Unlike the table's schema data and TTL settings, which are restored based on the selected timestamp, these settings are always restored based on the table's settings as of the current time or when the table was deleted. </para><para> You can also overwrite these settings during restore: </para><para> • Read/write capacity mode </para><para> • Provisioned throughput capacity settings </para><para> • Point-in-time (PITR) settings </para><para> • Tags </para><para> For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/PointInTimeRecovery_HowItWorks.html#howitworks_backup_settings">PITR restore settings</a> in the <i>Amazon Keyspaces Developer Guide</i>. </para><para> Note that the following settings are not restored, and you must configure them manually for the new table: </para><para> • Automatic scaling policies (for tables that use provisioned capacity mode) </para><para> • Identity and Access Management (IAM) policies </para><para> • Amazon CloudWatch metrics and alarms </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.RestoreKSTableCmdlet.EncryptionSpecificationOverride_KmsKeyIdentifier"> <summary> <para> <para>The Amazon Resource Name (ARN) of the customer managed KMS key, for example <code>kms_key_identifier:ARN</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.RestoreKSTableCmdlet.CapacitySpecificationOverride_ReadCapacityUnit"> <summary> <para> <para>The throughput capacity specified for <code>read</code> operations defined in <code>read capacity units</code><code>(RCUs)</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.RestoreKSTableCmdlet.RestoreTimestamp"> <summary> <para> <para>The restore timestamp in ISO 8601 format.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.RestoreKSTableCmdlet.SourceKeyspaceName"> <summary> <para> <para>The keyspace name of the source table.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.RestoreKSTableCmdlet.SourceTableName"> <summary> <para> <para>The name of the source table.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.RestoreKSTableCmdlet.PointInTimeRecoveryOverride_Status"> <summary> <para> <para>The options are:</para><para>• <code>ENABLED</code></para><para>• <code>DISABLED</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.RestoreKSTableCmdlet.TagsOverride"> <summary> <para> <para>A list of key-value pair tags to be attached to the restored table. </para><para>For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/tagging-keyspaces.html">Adding tags and labels to Amazon Keyspaces resources</a> in the <i>Amazon Keyspaces Developer Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.RestoreKSTableCmdlet.TargetKeyspaceName"> <summary> <para> <para>The name of the target keyspace.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.RestoreKSTableCmdlet.TargetTableName"> <summary> <para> <para>The name of the target table.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.RestoreKSTableCmdlet.CapacitySpecificationOverride_ThroughputMode"> <summary> <para> <para>The read/write throughput capacity mode for a table. The options are:</para><para>• <code>throughputMode:PAY_PER_REQUEST</code> and </para><para>• <code>throughputMode:PROVISIONED</code> - Provisioned capacity mode requires <code>readCapacityUnits</code> and <code>writeCapacityUnits</code> as input.</para><para>The default is <code>throughput_mode:PAY_PER_REQUEST</code>.</para><para>For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/ReadWriteCapacityMode.html">Read/write capacity modes</a> in the <i>Amazon Keyspaces Developer Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.RestoreKSTableCmdlet.EncryptionSpecificationOverride_Type"> <summary> <para> <para>The encryption option specified for the table. You can choose one of the following KMS keys (KMS keys):</para><para>• <code>type:AWS_OWNED_KMS_KEY</code> - This key is owned by Amazon Keyspaces. </para><para>• <code>type:CUSTOMER_MANAGED_KMS_KEY</code> - This key is stored in your account and is created, owned, and managed by you. This option requires the <code>kms_key_identifier</code> of the KMS key in Amazon Resource Name (ARN) format as input. </para><para>The default is <code>type:AWS_OWNED_KMS_KEY</code>. </para><para>For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/EncryptionAtRest.html">Encryption at rest</a> in the <i>Amazon Keyspaces Developer Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.RestoreKSTableCmdlet.CapacitySpecificationOverride_WriteCapacityUnit"> <summary> <para> <para>The throughput capacity specified for <code>write</code> operations defined in <code>write capacity units</code><code>(WCUs)</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.RestoreKSTableCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'RestoredTableARN'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Keyspaces.Model.RestoreTableResponse). Specifying the name of a property of type Amazon.Keyspaces.Model.RestoreTableResponse 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.KS.RestoreKSTableCmdlet.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.KS.UpdateKSTableCmdlet"> <summary> Adds new columns to the table or updates one of the table's settings, for example capacity mode, encryption, point-in-time recovery, or ttl settings. Note that you can only update one specific table setting per update operation. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.UpdateKSTableCmdlet.AddColumn"> <summary> <para> <para>For each column to be added to the specified table:</para><para>• <code>name</code> - The name of the column.</para><para>• <code>type</code> - An Amazon Keyspaces data type. For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/cql.elements.html#cql.data-types">Data types</a> in the <i>Amazon Keyspaces Developer Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.UpdateKSTableCmdlet.DefaultTimeToLive"> <summary> <para> <para>The default Time to Live setting in seconds for the table.</para><para>For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/TTL-how-it-works.html#ttl-howitworks_default_ttl">Setting the default TTL value for a table</a> in the <i>Amazon Keyspaces Developer Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.UpdateKSTableCmdlet.KeyspaceName"> <summary> <para> <para>The name of the keyspace the specified table is stored in.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.UpdateKSTableCmdlet.EncryptionSpecification_KmsKeyIdentifier"> <summary> <para> <para>The Amazon Resource Name (ARN) of the customer managed KMS key, for example <code>kms_key_identifier:ARN</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.UpdateKSTableCmdlet.CapacitySpecification_ReadCapacityUnit"> <summary> <para> <para>The throughput capacity specified for <code>read</code> operations defined in <code>read capacity units</code><code>(RCUs)</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.UpdateKSTableCmdlet.PointInTimeRecovery_Status"> <summary> <para> <para>The options are:</para><para>• <code>ENABLED</code></para><para>• <code>DISABLED</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.UpdateKSTableCmdlet.Ttl_Status"> <summary> <para> <para>Shows how to enable custom Time to Live (TTL) settings for the specified table.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.UpdateKSTableCmdlet.TableName"> <summary> <para> <para>The name of the table.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.UpdateKSTableCmdlet.CapacitySpecification_ThroughputMode"> <summary> <para> <para>The read/write throughput capacity mode for a table. The options are:</para><para>• <code>throughputMode:PAY_PER_REQUEST</code> and </para><para>• <code>throughputMode:PROVISIONED</code> - Provisioned capacity mode requires <code>readCapacityUnits</code> and <code>writeCapacityUnits</code> as input.</para><para>The default is <code>throughput_mode:PAY_PER_REQUEST</code>.</para><para>For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/ReadWriteCapacityMode.html">Read/write capacity modes</a> in the <i>Amazon Keyspaces Developer Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.UpdateKSTableCmdlet.EncryptionSpecification_Type"> <summary> <para> <para>The encryption option specified for the table. You can choose one of the following KMS keys (KMS keys):</para><para>• <code>type:AWS_OWNED_KMS_KEY</code> - This key is owned by Amazon Keyspaces. </para><para>• <code>type:CUSTOMER_MANAGED_KMS_KEY</code> - This key is stored in your account and is created, owned, and managed by you. This option requires the <code>kms_key_identifier</code> of the KMS key in Amazon Resource Name (ARN) format as input. </para><para>The default is <code>type:AWS_OWNED_KMS_KEY</code>. </para><para>For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/EncryptionAtRest.html">Encryption at rest</a> in the <i>Amazon Keyspaces Developer Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.UpdateKSTableCmdlet.CapacitySpecification_WriteCapacityUnit"> <summary> <para> <para>The throughput capacity specified for <code>write</code> operations defined in <code>write capacity units</code><code>(WCUs)</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.UpdateKSTableCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ResourceArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Keyspaces.Model.UpdateTableResponse). Specifying the name of a property of type Amazon.Keyspaces.Model.UpdateTableResponse 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.KS.UpdateKSTableCmdlet.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> |