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.html#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 of the specified keyspace, the Amazon Resource Name (ARN), the replication strategy, the Amazon Web Services Regions of a multi-Region keyspace, and the status of newly added Regions after an <c>UpdateKeyspace</c> operation. </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> The <c>ListKeyspaces</c> operation 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 <c>NextToken</c> is provided in the output. To resume pagination, provide the <c>NextToken</c> 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 <c>NextToken</c> 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. <para> To read keyspace metadata using <c>ListTagsForResource</c>, the IAM principal needs <c>Select</c> action permissions for the specified resource and the system keyspace. </para> </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 <c>NextToken</c> is provided in the output. To resume pagination, provide the <c>NextToken</c> 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 <c>NextToken</c> 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 <c>GetTable</c>, the IAM principal needs <c>Select</c> action permissions for the table and the system keyspace. </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.GetKSTableAutoScalingSettingCmdlet"> <summary> Returns auto scaling related settings of the specified table in JSON format. If the table is a multi-Region table, the Amazon Web Services Region specific auto scaling settings of the table are included. <para> Amazon Keyspaces auto scaling helps you provision throughput capacity for variable workloads efficiently by increasing and decreasing your table's read and write capacity automatically in response to application traffic. For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/autoscaling.html">Managing throughput capacity automatically with Amazon Keyspaces auto scaling</a> in the <i>Amazon Keyspaces Developer Guide</i>. </para><important><para><c>GetTableAutoScalingSettings</c> can't be used as an action in an IAM policy. </para></important><para> To define permissions for <c>GetTableAutoScalingSettings</c>, you must allow the following two actions in the IAM policy statement's <c>Action</c> element: </para><ul><li><para><c>application-autoscaling:DescribeScalableTargets</c></para></li><li><para><c>application-autoscaling:DescribeScalingPolicies</c></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.GetKSTableAutoScalingSettingCmdlet.KeyspaceName"> <summary> <para> <para>The name of the keyspace.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.GetKSTableAutoScalingSettingCmdlet.TableName"> <summary> <para> <para>The name of the table.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.GetKSTableAutoScalingSettingCmdlet.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.GetTableAutoScalingSettingsResponse). Specifying the name of a property of type Amazon.Keyspaces.Model.GetTableAutoScalingSettingsResponse 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> The <c>ListTables</c> operation returns a list of tables for a specified keyspace. <para> To read keyspace metadata using <c>ListTables</c>, the IAM principal needs <c>Select</c> action permissions for the system keyspace. </para> </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 <c>NextToken</c> is provided in the output. To resume pagination, provide the <c>NextToken</c> 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 <c>NextToken</c> 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.GetKSTypeCmdlet"> <summary> The <c>GetType</c> operation returns information about the type, for example the field definitions, the timestamp when the type was last modified, the level of nesting, the status, and details about if the type is used in other types and tables. <para> To read keyspace metadata using <c>GetType</c>, the IAM principal needs <c>Select</c> action permissions for the system keyspace. To configure the required permissions, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/configure-udt-permissions.html#udt-permissions-view">Permissions to view a UDT</a> in the <i>Amazon Keyspaces Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.GetKSTypeCmdlet.KeyspaceName"> <summary> <para> <para> The name of the keyspace that contains this type. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.GetKSTypeCmdlet.TypeName"> <summary> <para> <para>The formatted name of the type. For example, if the name of the type was created without double quotes, Amazon Keyspaces saved the name in lower-case characters. If the name was created in double quotes, you must use double quotes to specify the type name. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.GetKSTypeCmdlet.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.GetTypeResponse). Specifying the name of a property of type Amazon.Keyspaces.Model.GetTypeResponse 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.GetKSTypeListCmdlet"> <summary> The <c>ListTypes</c> operation returns a list of types for a specified keyspace. <para> To read keyspace metadata using <c>ListTypes</c>, the IAM principal needs <c>Select</c> action permissions for the system keyspace. To configure the required permissions, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/configure-udt-permissions.html#udt-permissions-view">Permissions to view a UDT</a> in the <i>Amazon Keyspaces Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.GetKSTypeListCmdlet.KeyspaceName"> <summary> <para> <para> The name of the keyspace that contains the listed types. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.GetKSTypeListCmdlet.MaxResult"> <summary> <para> <para> The total number of types to return in the output. If the total number of types available is more than the value specified, a <c>NextToken</c> is provided in the output. To resume pagination, provide the <c>NextToken</c> value as an argument of a subsequent API invocation. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.GetKSTypeListCmdlet.NextToken"> <summary> <para> <para> The pagination token. To resume pagination, provide the <c>NextToken</c> value as an argument of a subsequent API invocation. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.GetKSTypeListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Types'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Keyspaces.Model.ListTypesResponse). Specifying the name of a property of type Amazon.Keyspaces.Model.ListTypesResponse 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.GetKSTypeListCmdlet.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 <c>CreateKeyspace</c> operation adds a new keyspace to your account. In an Amazon Web Services account, keyspace names must be unique within each Region. <para><c>CreateKeyspace</c> is an asynchronous operation. You can monitor the creation status of the new keyspace by using the <c>GetKeyspace</c> operation. </para><para> For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/getting-started.keyspaces.html">Create a keyspace</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.ReplicationSpecification_RegionList"> <summary> <para> <para> The <c>regionList</c> can contain up to six Amazon Web Services Regions where the keyspace is replicated in. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.NewKSKeyspaceCmdlet.ReplicationSpecification_ReplicationStrategy"> <summary> <para> <para> The <c>replicationStrategy</c> of a keyspace, the required value is <c>SINGLE_REGION</c> or <c>MULTI_REGION</c>. </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 <c>CreateTable</c> operation adds a new table to the specified keyspace. Within a keyspace, table names must be unique. <para><c>CreateTable</c> is an asynchronous operation. When the request is received, the status of the table is set to <c>CREATING</c>. You can monitor the creation status of the new table by using the <c>GetTable</c> operation, which returns the current <c>status</c> of the table. You can start using a table when the status is <c>ACTIVE</c>. </para><para> For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/getting-started.tables.html">Create a table</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.ReadCapacityAutoScaling_AutoScalingDisabled"> <summary> <para> <para>This optional parameter enables auto scaling for the table if set to <c>false</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.NewKSTableCmdlet.WriteCapacityAutoScaling_AutoScalingDisabled"> <summary> <para> <para>This optional parameter enables auto scaling for the table if set to <c>false</c>.</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.ReadCapacity_TargetTrackingScalingPolicyConfiguration_DisableScaleIn"> <summary> <para> <para>Specifies if <c>scale-in</c> is enabled.</para><para>When auto scaling automatically decreases capacity for a table, the table <i>scales in</i>. When scaling policies are set, they can't scale in the table lower than its minimum capacity.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.NewKSTableCmdlet.WriteCapacity_TargetTrackingScalingPolicyConfiguration_DisableScaleIn"> <summary> <para> <para>Specifies if <c>scale-in</c> is enabled.</para><para>When auto scaling automatically decreases capacity for a table, the table <i>scales in</i>. When scaling policies are set, they can't scale in the table lower than its minimum capacity.</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 <c>kms_key_identifier:ARN</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.NewKSTableCmdlet.ReadCapacityAutoScaling_MaximumUnit"> <summary> <para> <para>Manage costs by specifying the maximum amount of throughput to provision. The value must be between 1 and the max throughput per second quota for your account (40,000 by default).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.NewKSTableCmdlet.WriteCapacityAutoScaling_MaximumUnit"> <summary> <para> <para>Manage costs by specifying the maximum amount of throughput to provision. The value must be between 1 and the max throughput per second quota for your account (40,000 by default).</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.ReadCapacityAutoScaling_MinimumUnit"> <summary> <para> <para>The minimum level of throughput the table should always be ready to support. The value must be between 1 and the max throughput per second quota for your account (40,000 by default).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.NewKSTableCmdlet.WriteCapacityAutoScaling_MinimumUnit"> <summary> <para> <para>The minimum level of throughput the table should always be ready to support. The value must be between 1 and the max throughput per second quota for your account (40,000 by default).</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 <c>read</c> operations defined in <c>read capacity units</c><c>(RCUs)</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.NewKSTableCmdlet.ReplicaSpecification"> <summary> <para> <para>The optional Amazon Web Services Region specific settings of a multi-Region table. These settings overwrite the general settings of the table for the specified Region. </para><para>For a multi-Region table in provisioned capacity mode, you can configure the table's read capacity differently for each Region's replica. The write capacity, however, remains synchronized between all replicas to ensure that there's enough capacity to replicate writes across all Regions. To define the read capacity for a table replica in a specific Region, you can do so by configuring the following parameters.</para><ul><li><para><c>region</c>: The Region where these settings are applied. (Required)</para></li><li><para><c>readCapacityUnits</c>: The provisioned read capacity units. (Optional)</para></li><li><para><c>readCapacityAutoScaling</c>: The read capacity auto scaling settings for the table. (Optional) </para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.NewKSTableCmdlet.ReadCapacity_TargetTrackingScalingPolicyConfiguration_ScaleInCooldown"> <summary> <para> <para>Specifies a <c>scale-in</c> cool down period.</para><para>A cooldown period in seconds between scaling activities that lets the table stabilize before another scaling activity starts. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.NewKSTableCmdlet.WriteCapacity_TargetTrackingScalingPolicyConfiguration_ScaleInCooldown"> <summary> <para> <para>Specifies a <c>scale-in</c> cool down period.</para><para>A cooldown period in seconds between scaling activities that lets the table stabilize before another scaling activity starts. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.NewKSTableCmdlet.ReadCapacity_TargetTrackingScalingPolicyConfiguration_ScaleOutCooldown"> <summary> <para> <para>Specifies a scale out cool down period.</para><para>A cooldown period in seconds between scaling activities that lets the table stabilize before another scaling activity starts. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.NewKSTableCmdlet.WriteCapacity_TargetTrackingScalingPolicyConfiguration_ScaleOutCooldown"> <summary> <para> <para>Specifies a scale out cool down period.</para><para>A cooldown period in seconds between scaling activities that lets the table stabilize before another scaling activity starts. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.NewKSTableCmdlet.SchemaDefinition_StaticColumn"> <summary> <para> <para>The columns that have been defined as <c>STATIC</c>. 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.ClientSideTimestamps_Status"> <summary> <para> <para>Shows how to enable client-side timestamps settings for the specified table.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.NewKSTableCmdlet.PointInTimeRecovery_Status"> <summary> <para> <para>The options are:</para><ul><li><para><c>status=ENABLED</c></para></li><li><para><c>status=DISABLED</c></para></li></ul> </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.ReadCapacity_TargetTrackingScalingPolicyConfiguration_TargetValue"> <summary> <para> <para>Specifies the target value for the target tracking auto scaling policy.</para><para>Amazon Keyspaces auto scaling scales up capacity automatically when traffic exceeds this target utilization rate, and then back down when it falls below the target. This ensures that the ratio of consumed capacity to provisioned capacity stays at or near this value. You define <c>targetValue</c> as a percentage. A <c>double</c> between 20 and 90.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.NewKSTableCmdlet.WriteCapacity_TargetTrackingScalingPolicyConfiguration_TargetValue"> <summary> <para> <para>Specifies the target value for the target tracking auto scaling policy.</para><para>Amazon Keyspaces auto scaling scales up capacity automatically when traffic exceeds this target utilization rate, and then back down when it falls below the target. This ensures that the ratio of consumed capacity to provisioned capacity stays at or near this value. You define <c>targetValue</c> as a percentage. A <c>double</c> between 20 and 90.</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><ul><li><para><c>throughputMode:PAY_PER_REQUEST</c> and </para></li><li><para><c>throughputMode:PROVISIONED</c> - Provisioned capacity mode requires <c>readCapacityUnits</c> and <c>writeCapacityUnits</c> as input.</para></li></ul><para>The default is <c>throughput_mode:PAY_PER_REQUEST</c>.</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><ul><li><para><c>type:AWS_OWNED_KMS_KEY</c> - This key is owned by Amazon Keyspaces. </para></li><li><para><c>type:CUSTOMER_MANAGED_KMS_KEY</c> - This key is stored in your account and is created, owned, and managed by you. This option requires the <c>kms_key_identifier</c> of the KMS key in Amazon Resource Name (ARN) format as input. </para></li></ul><para>The default is <c>type:AWS_OWNED_KMS_KEY</c>. </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 <c>write</c> operations defined in <c>write capacity units</c><c>(WCUs)</c>.</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.NewKSTypeCmdlet"> <summary> The <c>CreateType</c> operation creates a new user-defined type in the specified keyspace. <para> To configure the required permissions, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/configure-udt-permissions.html#udt-permissions-create">Permissions to create a UDT</a> in the <i>Amazon Keyspaces Developer Guide</i>. </para><para> For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/udts.html">User-defined types (UDTs)</a> in the <i>Amazon Keyspaces Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.NewKSTypeCmdlet.FieldDefinition"> <summary> <para> <para> The field definitions, consisting of names and types, that define this type. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.NewKSTypeCmdlet.KeyspaceName"> <summary> <para> <para> The name of the keyspace. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.NewKSTypeCmdlet.TypeName"> <summary> <para> <para> The name of the user-defined type. </para><para>UDT names must contain 48 characters or less, must begin with an alphabetic character, and can only contain alpha-numeric characters and underscores. Amazon Keyspaces converts upper case characters automatically into lower case characters. </para><para>Alternatively, you can declare a UDT name in double quotes. When declaring a UDT name inside double quotes, Amazon Keyspaces preserves upper casing and allows special characters.</para><para>You can also use double quotes as part of the name when you create the UDT, but you must escape each double quote character with an additional double quote character.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.NewKSTypeCmdlet.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.CreateTypeResponse). Specifying the name of a property of type Amazon.Keyspaces.Model.CreateTypeResponse 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.NewKSTypeCmdlet.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 <c>DeleteKeyspace</c> 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 <c>DeleteTable</c> operation deletes a table and all of its data. After a <c>DeleteTable</c> request is received, the specified table is in the <c>DELETING</c> state until Amazon Keyspaces completes the deletion. If the table is in the <c>ACTIVE</c> state, you can delete it. If a table is either in the <c>CREATING</c> or <c>UPDATING</c> states, then Amazon Keyspaces returns a <c>ResourceInUseException</c>. If the specified table does not exist, Amazon Keyspaces returns a <c>ResourceNotFoundException</c>. If the table is already in the <c>DELETING</c> 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.RemoveKSTypeCmdlet"> <summary> The <c>DeleteType</c> operation deletes a user-defined type (UDT). You can only delete a type that is not used in a table or another UDT. <para> To configure the required permissions, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/configure-udt-permissions.html#udt-permissions-drop">Permissions to delete a UDT</a> in the <i>Amazon Keyspaces Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.RemoveKSTypeCmdlet.KeyspaceName"> <summary> <para> <para> The name of the keyspace of the to be deleted type. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.RemoveKSTypeCmdlet.TypeName"> <summary> <para> <para> The name of the type to be deleted. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.RemoveKSTypeCmdlet.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.DeleteTypeResponse). Specifying the name of a property of type Amazon.Keyspaces.Model.DeleteTypeResponse 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.RemoveKSTypeCmdlet.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 table to the specified point in time within the <c>earliest_restorable_timestamp</c> 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 <c>(day:hour:minute:second)</c> 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, <c>RestoreTable</c> restores the capacity mode, auto scaling settings, encryption settings, 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><ul><li><para> Read/write capacity mode </para></li><li><para> Provisioned throughput capacity units </para></li><li><para> Auto scaling settings </para></li><li><para> Point-in-time (PITR) settings </para></li><li><para> Tags </para></li></ul><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><ul><li><para> Identity and Access Management (IAM) policies </para></li><li><para> Amazon CloudWatch metrics and alarms </para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.RestoreKSTableCmdlet.ReadCapacityAutoScaling_AutoScalingDisabled"> <summary> <para> <para>This optional parameter enables auto scaling for the table if set to <c>false</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.RestoreKSTableCmdlet.WriteCapacityAutoScaling_AutoScalingDisabled"> <summary> <para> <para>This optional parameter enables auto scaling for the table if set to <c>false</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.RestoreKSTableCmdlet.ReadCapacity_TargetTrackingScalingPolicyConfiguration_DisableScaleIn"> <summary> <para> <para>Specifies if <c>scale-in</c> is enabled.</para><para>When auto scaling automatically decreases capacity for a table, the table <i>scales in</i>. When scaling policies are set, they can't scale in the table lower than its minimum capacity.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.RestoreKSTableCmdlet.WriteCapacity_TargetTrackingScalingPolicyConfiguration_DisableScaleIn"> <summary> <para> <para>Specifies if <c>scale-in</c> is enabled.</para><para>When auto scaling automatically decreases capacity for a table, the table <i>scales in</i>. When scaling policies are set, they can't scale in the table lower than its minimum capacity.</para> </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 <c>kms_key_identifier:ARN</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.RestoreKSTableCmdlet.ReadCapacityAutoScaling_MaximumUnit"> <summary> <para> <para>Manage costs by specifying the maximum amount of throughput to provision. The value must be between 1 and the max throughput per second quota for your account (40,000 by default).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.RestoreKSTableCmdlet.WriteCapacityAutoScaling_MaximumUnit"> <summary> <para> <para>Manage costs by specifying the maximum amount of throughput to provision. The value must be between 1 and the max throughput per second quota for your account (40,000 by default).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.RestoreKSTableCmdlet.ReadCapacityAutoScaling_MinimumUnit"> <summary> <para> <para>The minimum level of throughput the table should always be ready to support. The value must be between 1 and the max throughput per second quota for your account (40,000 by default).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.RestoreKSTableCmdlet.WriteCapacityAutoScaling_MinimumUnit"> <summary> <para> <para>The minimum level of throughput the table should always be ready to support. The value must be between 1 and the max throughput per second quota for your account (40,000 by default).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.RestoreKSTableCmdlet.CapacitySpecificationOverride_ReadCapacityUnit"> <summary> <para> <para>The throughput capacity specified for <c>read</c> operations defined in <c>read capacity units</c><c>(RCUs)</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.RestoreKSTableCmdlet.ReplicaSpecification"> <summary> <para> <para>The optional Region specific settings of a multi-Regional table.</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.ReadCapacity_TargetTrackingScalingPolicyConfiguration_ScaleInCooldown"> <summary> <para> <para>Specifies a <c>scale-in</c> cool down period.</para><para>A cooldown period in seconds between scaling activities that lets the table stabilize before another scaling activity starts. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.RestoreKSTableCmdlet.WriteCapacity_TargetTrackingScalingPolicyConfiguration_ScaleInCooldown"> <summary> <para> <para>Specifies a <c>scale-in</c> cool down period.</para><para>A cooldown period in seconds between scaling activities that lets the table stabilize before another scaling activity starts. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.RestoreKSTableCmdlet.ReadCapacity_TargetTrackingScalingPolicyConfiguration_ScaleOutCooldown"> <summary> <para> <para>Specifies a scale out cool down period.</para><para>A cooldown period in seconds between scaling activities that lets the table stabilize before another scaling activity starts. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.RestoreKSTableCmdlet.WriteCapacity_TargetTrackingScalingPolicyConfiguration_ScaleOutCooldown"> <summary> <para> <para>Specifies a scale out cool down period.</para><para>A cooldown period in seconds between scaling activities that lets the table stabilize before another scaling activity starts. </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><ul><li><para><c>status=ENABLED</c></para></li><li><para><c>status=DISABLED</c></para></li></ul> </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.ReadCapacity_TargetTrackingScalingPolicyConfiguration_TargetValue"> <summary> <para> <para>Specifies the target value for the target tracking auto scaling policy.</para><para>Amazon Keyspaces auto scaling scales up capacity automatically when traffic exceeds this target utilization rate, and then back down when it falls below the target. This ensures that the ratio of consumed capacity to provisioned capacity stays at or near this value. You define <c>targetValue</c> as a percentage. A <c>double</c> between 20 and 90.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.RestoreKSTableCmdlet.WriteCapacity_TargetTrackingScalingPolicyConfiguration_TargetValue"> <summary> <para> <para>Specifies the target value for the target tracking auto scaling policy.</para><para>Amazon Keyspaces auto scaling scales up capacity automatically when traffic exceeds this target utilization rate, and then back down when it falls below the target. This ensures that the ratio of consumed capacity to provisioned capacity stays at or near this value. You define <c>targetValue</c> as a percentage. A <c>double</c> between 20 and 90.</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><ul><li><para><c>throughputMode:PAY_PER_REQUEST</c> and </para></li><li><para><c>throughputMode:PROVISIONED</c> - Provisioned capacity mode requires <c>readCapacityUnits</c> and <c>writeCapacityUnits</c> as input.</para></li></ul><para>The default is <c>throughput_mode:PAY_PER_REQUEST</c>.</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><ul><li><para><c>type:AWS_OWNED_KMS_KEY</c> - This key is owned by Amazon Keyspaces. </para></li><li><para><c>type:CUSTOMER_MANAGED_KMS_KEY</c> - This key is stored in your account and is created, owned, and managed by you. This option requires the <c>kms_key_identifier</c> of the KMS key in Amazon Resource Name (ARN) format as input. </para></li></ul><para>The default is <c>type:AWS_OWNED_KMS_KEY</c>. </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 <c>write</c> operations defined in <c>write capacity units</c><c>(WCUs)</c>.</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.UpdateKSKeyspaceCmdlet"> <summary> Adds a new Amazon Web Services Region to the keyspace. You can add a new Region to a keyspace that is either a single or a multi-Region keyspace. Amazon Keyspaces is going to replicate all tables in the keyspace to the new Region. To successfully replicate all tables to the new Region, they must use client-side timestamps for conflict resolution. To enable client-side timestamps, specify <c>clientSideTimestamps.status = enabled</c> when invoking the API. For more information about client-side timestamps, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/client-side-timestamps.html">Client-side timestamps in Amazon Keyspaces</a> in the <i>Amazon Keyspaces Developer Guide</i>. <para> To add a Region to a keyspace using the <c>UpdateKeyspace</c> API, the IAM principal needs permissions for the following IAM actions: </para><ul><li><para><c>cassandra:Alter</c></para></li><li><para><c>cassandra:AlterMultiRegionResource</c></para></li><li><para><c>cassandra:Create</c></para></li><li><para><c>cassandra:CreateMultiRegionResource</c></para></li><li><para><c>cassandra:Select</c></para></li><li><para><c>cassandra:SelectMultiRegionResource</c></para></li><li><para><c>cassandra:Modify</c></para></li><li><para><c>cassandra:ModifyMultiRegionResource</c></para></li></ul><para> If the keyspace contains a table that is configured in provisioned mode with auto scaling enabled, the following additional IAM actions need to be allowed. </para><ul><li><para><c>application-autoscaling:RegisterScalableTarget</c></para></li><li><para><c>application-autoscaling:DeregisterScalableTarget</c></para></li><li><para><c>application-autoscaling:DescribeScalableTargets</c></para></li><li><para><c>application-autoscaling:PutScalingPolicy</c></para></li><li><para><c>application-autoscaling:DescribeScalingPolicies</c></para></li></ul><para> To use the <c>UpdateKeyspace</c> API, the IAM principal also needs permissions to create a service-linked role with the following elements: </para><ul><li><para><c>iam:CreateServiceLinkedRole</c> - The <b>action</b> the principal can perform. </para></li><li><para><c>arn:aws:iam::*:role/aws-service-role/replication.cassandra.amazonaws.com/AWSServiceRoleForKeyspacesReplication</c> - The <b>resource</b> that the action can be performed on. </para></li><li><para><c>iam:AWSServiceName: replication.cassandra.amazonaws.com</c> - The only Amazon Web Services service that this role can be attached to is Amazon Keyspaces. </para></li></ul><para> For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/howitworks_replication_permissions_addReplica.html">Configure the IAM permissions required to add an Amazon Web Services Region to a keyspace</a> in the <i>Amazon Keyspaces Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.UpdateKSKeyspaceCmdlet.KeyspaceName"> <summary> <para> <para> The name of the keyspace. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.UpdateKSKeyspaceCmdlet.ReplicationSpecification_RegionList"> <summary> <para> <para> The <c>regionList</c> can contain up to six Amazon Web Services Regions where the keyspace is replicated in. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.UpdateKSKeyspaceCmdlet.ReplicationSpecification_ReplicationStrategy"> <summary> <para> <para> The <c>replicationStrategy</c> of a keyspace, the required value is <c>SINGLE_REGION</c> or <c>MULTI_REGION</c>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.UpdateKSKeyspaceCmdlet.ClientSideTimestamps_Status"> <summary> <para> <para>Shows how to enable client-side timestamps settings for the specified table.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.UpdateKSKeyspaceCmdlet.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.UpdateKeyspaceResponse). Specifying the name of a property of type Amazon.Keyspaces.Model.UpdateKeyspaceResponse 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.UpdateKSKeyspaceCmdlet.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.UpdateKSKeyspaceCmdlet.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, auto scaling, 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><ul><li><para><c>name</c> - The name of the column.</para></li><li><para><c>type</c> - 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></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.UpdateKSTableCmdlet.ReadCapacityAutoScaling_AutoScalingDisabled"> <summary> <para> <para>This optional parameter enables auto scaling for the table if set to <c>false</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.UpdateKSTableCmdlet.WriteCapacityAutoScaling_AutoScalingDisabled"> <summary> <para> <para>This optional parameter enables auto scaling for the table if set to <c>false</c>.</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.ReadCapacity_TargetTrackingScalingPolicyConfiguration_DisableScaleIn"> <summary> <para> <para>Specifies if <c>scale-in</c> is enabled.</para><para>When auto scaling automatically decreases capacity for a table, the table <i>scales in</i>. When scaling policies are set, they can't scale in the table lower than its minimum capacity.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.UpdateKSTableCmdlet.WriteCapacity_TargetTrackingScalingPolicyConfiguration_DisableScaleIn"> <summary> <para> <para>Specifies if <c>scale-in</c> is enabled.</para><para>When auto scaling automatically decreases capacity for a table, the table <i>scales in</i>. When scaling policies are set, they can't scale in the table lower than its minimum capacity.</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 <c>kms_key_identifier:ARN</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.UpdateKSTableCmdlet.ReadCapacityAutoScaling_MaximumUnit"> <summary> <para> <para>Manage costs by specifying the maximum amount of throughput to provision. The value must be between 1 and the max throughput per second quota for your account (40,000 by default).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.UpdateKSTableCmdlet.WriteCapacityAutoScaling_MaximumUnit"> <summary> <para> <para>Manage costs by specifying the maximum amount of throughput to provision. The value must be between 1 and the max throughput per second quota for your account (40,000 by default).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.UpdateKSTableCmdlet.ReadCapacityAutoScaling_MinimumUnit"> <summary> <para> <para>The minimum level of throughput the table should always be ready to support. The value must be between 1 and the max throughput per second quota for your account (40,000 by default).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.UpdateKSTableCmdlet.WriteCapacityAutoScaling_MinimumUnit"> <summary> <para> <para>The minimum level of throughput the table should always be ready to support. The value must be between 1 and the max throughput per second quota for your account (40,000 by default).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.UpdateKSTableCmdlet.CapacitySpecification_ReadCapacityUnit"> <summary> <para> <para>The throughput capacity specified for <c>read</c> operations defined in <c>read capacity units</c><c>(RCUs)</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.UpdateKSTableCmdlet.ReplicaSpecification"> <summary> <para> <para>The Region specific settings of a multi-Regional table.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.UpdateKSTableCmdlet.ReadCapacity_TargetTrackingScalingPolicyConfiguration_ScaleInCooldown"> <summary> <para> <para>Specifies a <c>scale-in</c> cool down period.</para><para>A cooldown period in seconds between scaling activities that lets the table stabilize before another scaling activity starts. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.UpdateKSTableCmdlet.WriteCapacity_TargetTrackingScalingPolicyConfiguration_ScaleInCooldown"> <summary> <para> <para>Specifies a <c>scale-in</c> cool down period.</para><para>A cooldown period in seconds between scaling activities that lets the table stabilize before another scaling activity starts. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.UpdateKSTableCmdlet.ReadCapacity_TargetTrackingScalingPolicyConfiguration_ScaleOutCooldown"> <summary> <para> <para>Specifies a scale out cool down period.</para><para>A cooldown period in seconds between scaling activities that lets the table stabilize before another scaling activity starts. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.UpdateKSTableCmdlet.WriteCapacity_TargetTrackingScalingPolicyConfiguration_ScaleOutCooldown"> <summary> <para> <para>Specifies a scale out cool down period.</para><para>A cooldown period in seconds between scaling activities that lets the table stabilize before another scaling activity starts. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.UpdateKSTableCmdlet.ClientSideTimestamps_Status"> <summary> <para> <para>Shows how to enable client-side timestamps settings for the specified table.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.UpdateKSTableCmdlet.PointInTimeRecovery_Status"> <summary> <para> <para>The options are:</para><ul><li><para><c>status=ENABLED</c></para></li><li><para><c>status=DISABLED</c></para></li></ul> </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.ReadCapacity_TargetTrackingScalingPolicyConfiguration_TargetValue"> <summary> <para> <para>Specifies the target value for the target tracking auto scaling policy.</para><para>Amazon Keyspaces auto scaling scales up capacity automatically when traffic exceeds this target utilization rate, and then back down when it falls below the target. This ensures that the ratio of consumed capacity to provisioned capacity stays at or near this value. You define <c>targetValue</c> as a percentage. A <c>double</c> between 20 and 90.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KS.UpdateKSTableCmdlet.WriteCapacity_TargetTrackingScalingPolicyConfiguration_TargetValue"> <summary> <para> <para>Specifies the target value for the target tracking auto scaling policy.</para><para>Amazon Keyspaces auto scaling scales up capacity automatically when traffic exceeds this target utilization rate, and then back down when it falls below the target. This ensures that the ratio of consumed capacity to provisioned capacity stays at or near this value. You define <c>targetValue</c> as a percentage. A <c>double</c> between 20 and 90.</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><ul><li><para><c>throughputMode:PAY_PER_REQUEST</c> and </para></li><li><para><c>throughputMode:PROVISIONED</c> - Provisioned capacity mode requires <c>readCapacityUnits</c> and <c>writeCapacityUnits</c> as input.</para></li></ul><para>The default is <c>throughput_mode:PAY_PER_REQUEST</c>.</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><ul><li><para><c>type:AWS_OWNED_KMS_KEY</c> - This key is owned by Amazon Keyspaces. </para></li><li><para><c>type:CUSTOMER_MANAGED_KMS_KEY</c> - This key is stored in your account and is created, owned, and managed by you. This option requires the <c>kms_key_identifier</c> of the KMS key in Amazon Resource Name (ARN) format as input. </para></li></ul><para>The default is <c>type:AWS_OWNED_KMS_KEY</c>. </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 <c>write</c> operations defined in <c>write capacity units</c><c>(WCUs)</c>.</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> |