AWS.Tools.Finspace.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.Finspace</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.FINSP.AddFINSPResourceTagCmdlet"> <summary> Adds metadata tags to a FinSpace resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.AddFINSPResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) for the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.AddFINSPResourceTagCmdlet.Tag"> <summary> <para> <para>One or more tags to be assigned to the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.AddFINSPResourceTagCmdlet.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.Finspace.Model.TagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.AddFINSPResourceTagCmdlet.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.FINSP.AddFINSPResourceTagCmdlet.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.FINSP.GetFINSPEnvironmentCmdlet"> <summary> Returns the FinSpace environment object. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.GetFINSPEnvironmentCmdlet.EnvironmentId"> <summary> <para> <para>The identifier of the FinSpace environment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.GetFINSPEnvironmentCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Environment'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Finspace.Model.GetEnvironmentResponse). Specifying the name of a property of type Amazon.Finspace.Model.GetEnvironmentResponse 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.FINSP.GetFINSPEnvironmentCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the EnvironmentId parameter. The -PassThru parameter is deprecated, use -Select '^EnvironmentId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.FINSP.GetFINSPEnvironmentListCmdlet"> <summary> A list of all of your FinSpace environments. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.GetFINSPEnvironmentListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return in this request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.GetFINSPEnvironmentListCmdlet.NextToken"> <summary> <para> <para>A token generated by FinSpace that specifies where to continue pagination if a previous request was truncated. To get the next set of pages, pass in the <code>nextToken</code>nextToken value from the response object of the previous page call.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.GetFINSPEnvironmentListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Environments'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Finspace.Model.ListEnvironmentsResponse). Specifying the name of a property of type Amazon.Finspace.Model.ListEnvironmentsResponse 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.FINSP.GetFINSPKxChangesetCmdlet"> <summary> Returns information about a kdb changeset. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.GetFINSPKxChangesetCmdlet.ChangesetId"> <summary> <para> <para>A unique identifier of the changeset for which you want to retrieve data.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.GetFINSPKxChangesetCmdlet.DatabaseName"> <summary> <para> <para>The name of the kdb database.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.GetFINSPKxChangesetCmdlet.EnvironmentId"> <summary> <para> <para>A unique identifier for the kdb environment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.GetFINSPKxChangesetCmdlet.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.Finspace.Model.GetKxChangesetResponse). Specifying the name of a property of type Amazon.Finspace.Model.GetKxChangesetResponse 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.FINSP.GetFINSPKxChangesetCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ChangesetId parameter. The -PassThru parameter is deprecated, use -Select '^ChangesetId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.FINSP.GetFINSPKxChangesetListCmdlet"> <summary> Returns a list of all the changesets for a database. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.GetFINSPKxChangesetListCmdlet.DatabaseName"> <summary> <para> <para>The name of the kdb database.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.GetFINSPKxChangesetListCmdlet.EnvironmentId"> <summary> <para> <para>A unique identifier for the kdb environment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.GetFINSPKxChangesetListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return in this request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.GetFINSPKxChangesetListCmdlet.NextToken"> <summary> <para> <para>A token that indicates where a results page should begin.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.GetFINSPKxChangesetListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'KxChangesets'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Finspace.Model.ListKxChangesetsResponse). Specifying the name of a property of type Amazon.Finspace.Model.ListKxChangesetsResponse 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.FINSP.GetFINSPKxClusterCmdlet"> <summary> Retrieves information about a kdb cluster. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.GetFINSPKxClusterCmdlet.ClusterName"> <summary> <para> <para>The name of the cluster that you want to retrieve.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.GetFINSPKxClusterCmdlet.EnvironmentId"> <summary> <para> <para>A unique identifier for the kdb environment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.GetFINSPKxClusterCmdlet.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.Finspace.Model.GetKxClusterResponse). Specifying the name of a property of type Amazon.Finspace.Model.GetKxClusterResponse 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.FINSP.GetFINSPKxClusterCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ClusterName parameter. The -PassThru parameter is deprecated, use -Select '^ClusterName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.FINSP.GetFINSPKxClusterListCmdlet"> <summary> Returns a list of clusters. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.GetFINSPKxClusterListCmdlet.ClusterType"> <summary> <para> <para>Specifies the type of KDB database that is being created. The following types are available: </para><ul><li><para>HDB – A Historical Database. The data is only accessible with read-only permissions from one of the FinSpace managed kdb databases mounted to the cluster.</para></li><li><para>RDB – A Realtime Database. This type of database captures all the data from a ticker plant and stores it in memory until the end of day, after which it writes all of its data to a disk and reloads the HDB. This cluster type requires local storage for temporary storage of data during the savedown process. If you specify this field in your request, you must provide the <code>savedownStorageConfiguration</code> parameter.</para></li><li><para>GATEWAY – A gateway cluster allows you to access data across processes in kdb systems. It allows you to create your own routing logic using the initialization scripts and custom code. This type of cluster does not require a writable local storage.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.GetFINSPKxClusterListCmdlet.EnvironmentId"> <summary> <para> <para>A unique identifier for the kdb environment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.GetFINSPKxClusterListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return in this request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.GetFINSPKxClusterListCmdlet.NextToken"> <summary> <para> <para>A token that indicates where a results page should begin.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.GetFINSPKxClusterListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'KxClusterSummaries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Finspace.Model.ListKxClustersResponse). Specifying the name of a property of type Amazon.Finspace.Model.ListKxClustersResponse 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.FINSP.GetFINSPKxClusterNodeListCmdlet"> <summary> Lists all the nodes in a kdb cluster. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.GetFINSPKxClusterNodeListCmdlet.ClusterName"> <summary> <para> <para>A unique name for the cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.GetFINSPKxClusterNodeListCmdlet.EnvironmentId"> <summary> <para> <para>A unique identifier for the kdb environment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.GetFINSPKxClusterNodeListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return in this request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.GetFINSPKxClusterNodeListCmdlet.NextToken"> <summary> <para> <para>A token that indicates where a results page should begin.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.GetFINSPKxClusterNodeListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Nodes'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Finspace.Model.ListKxClusterNodesResponse). Specifying the name of a property of type Amazon.Finspace.Model.ListKxClusterNodesResponse 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.FINSP.GetFINSPKxConnectionStringCmdlet"> <summary> Retrieves a connection string for a user to connect to a kdb cluster. You must call this API using the same role that you have defined while creating a user. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.GetFINSPKxConnectionStringCmdlet.ClusterName"> <summary> <para> <para>A name of the kdb cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.GetFINSPKxConnectionStringCmdlet.EnvironmentId"> <summary> <para> <para>A unique identifier for the kdb environment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.GetFINSPKxConnectionStringCmdlet.UserArn"> <summary> <para> <para> The Amazon Resource Name (ARN) that identifies the user. For more information about ARNs and how to use ARNs in policies, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html">IAM Identifiers</a> in the <i>IAM User Guide</i>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.GetFINSPKxConnectionStringCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'SignedConnectionString'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Finspace.Model.GetKxConnectionStringResponse). Specifying the name of a property of type Amazon.Finspace.Model.GetKxConnectionStringResponse 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.FINSP.GetFINSPKxDatabaseCmdlet"> <summary> Returns database information for the specified environment ID. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.GetFINSPKxDatabaseCmdlet.DatabaseName"> <summary> <para> <para>The name of the kdb database.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.GetFINSPKxDatabaseCmdlet.EnvironmentId"> <summary> <para> <para>A unique identifier for the kdb environment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.GetFINSPKxDatabaseCmdlet.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.Finspace.Model.GetKxDatabaseResponse). Specifying the name of a property of type Amazon.Finspace.Model.GetKxDatabaseResponse 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.FINSP.GetFINSPKxDatabaseCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DatabaseName parameter. The -PassThru parameter is deprecated, use -Select '^DatabaseName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.FINSP.GetFINSPKxDatabasisListCmdlet"> <summary> Returns a list of all the databases in the kdb environment. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.GetFINSPKxDatabasisListCmdlet.EnvironmentId"> <summary> <para> <para>A unique identifier for the kdb environment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.GetFINSPKxDatabasisListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return in this request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.GetFINSPKxDatabasisListCmdlet.NextToken"> <summary> <para> <para>A token that indicates where a results page should begin.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.GetFINSPKxDatabasisListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'KxDatabases'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Finspace.Model.ListKxDatabasesResponse). Specifying the name of a property of type Amazon.Finspace.Model.ListKxDatabasesResponse 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.FINSP.GetFINSPKxEnvironmentCmdlet"> <summary> Retrieves all the information for the specified kdb environment. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.GetFINSPKxEnvironmentCmdlet.EnvironmentId"> <summary> <para> <para>A unique identifier for the kdb environment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.GetFINSPKxEnvironmentCmdlet.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.Finspace.Model.GetKxEnvironmentResponse). Specifying the name of a property of type Amazon.Finspace.Model.GetKxEnvironmentResponse 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.FINSP.GetFINSPKxEnvironmentCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the EnvironmentId parameter. The -PassThru parameter is deprecated, use -Select '^EnvironmentId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.FINSP.GetFINSPKxEnvironmentListCmdlet"> <summary> Returns a list of kdb environments created in an account. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.GetFINSPKxEnvironmentListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return in this request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.GetFINSPKxEnvironmentListCmdlet.NextToken"> <summary> <para> <para>A token that indicates where a results page should begin.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.GetFINSPKxEnvironmentListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Environments'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Finspace.Model.ListKxEnvironmentsResponse). Specifying the name of a property of type Amazon.Finspace.Model.ListKxEnvironmentsResponse 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.FINSP.GetFINSPKxUserCmdlet"> <summary> Retrieves information about the specified kdb user. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.GetFINSPKxUserCmdlet.EnvironmentId"> <summary> <para> <para>A unique identifier for the kdb environment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.GetFINSPKxUserCmdlet.UserName"> <summary> <para> <para>A unique identifier for the user.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.GetFINSPKxUserCmdlet.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.Finspace.Model.GetKxUserResponse). Specifying the name of a property of type Amazon.Finspace.Model.GetKxUserResponse 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.FINSP.GetFINSPKxUserCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the UserName parameter. The -PassThru parameter is deprecated, use -Select '^UserName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.FINSP.GetFINSPKxUserListCmdlet"> <summary> Lists all the users in a kdb environment. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.GetFINSPKxUserListCmdlet.EnvironmentId"> <summary> <para> <para>A unique identifier for the kdb environment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.GetFINSPKxUserListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return in this request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.GetFINSPKxUserListCmdlet.NextToken"> <summary> <para> <para>A token that indicates where a results page should begin.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.GetFINSPKxUserListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Users'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Finspace.Model.ListKxUsersResponse). Specifying the name of a property of type Amazon.Finspace.Model.ListKxUsersResponse 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.FINSP.GetFINSPResourceTagCmdlet"> <summary> A list of all tags for a resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.GetFINSPResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name of the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.GetFINSPResourceTagCmdlet.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.Finspace.Model.ListTagsForResourceResponse). Specifying the name of a property of type Amazon.Finspace.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.FINSP.GetFINSPResourceTagCmdlet.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.FINSP.NewFINSPEnvironmentCmdlet"> <summary> Create a new FinSpace environment. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.NewFINSPEnvironmentCmdlet.FederationParameters_ApplicationCallBackURL"> <summary> <para> <para>The redirect or sign-in URL that should be entered into the SAML 2.0 compliant identity provider configuration (IdP).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.NewFINSPEnvironmentCmdlet.FederationParameters_AttributeMap"> <summary> <para> <para>SAML attribute name and value. The name must always be <code>Email</code> and the value should be set to the attribute definition in which user email is set. For example, name would be <code>Email</code> and value <code>http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress</code>. Please check your SAML 2.0 compliant identity provider (IdP) documentation for details.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.NewFINSPEnvironmentCmdlet.DataBundle"> <summary> <para> <para>The list of Amazon Resource Names (ARN) of the data bundles to install. Currently supported data bundle ARNs:</para><ul><li><para><code>arn:aws:finspace:${Region}::data-bundle/capital-markets-sample</code> - Contains sample Capital Markets datasets, categories and controlled vocabularies.</para></li><li><para><code>arn:aws:finspace:${Region}::data-bundle/taq</code> (default) - Contains trades and quotes data in addition to sample Capital Markets data.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.NewFINSPEnvironmentCmdlet.Description"> <summary> <para> <para>The description of the FinSpace environment to be created.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.NewFINSPEnvironmentCmdlet.SuperuserParameters_EmailAddress"> <summary> <para> <para>The email address of the superuser.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.NewFINSPEnvironmentCmdlet.FederationMode"> <summary> <para> <para>Authentication mode for the environment.</para><ul><li><para><code>FEDERATED</code> - Users access FinSpace through Single Sign On (SSO) via your Identity provider.</para></li><li><para><code>LOCAL</code> - Users access FinSpace via email and password managed within the FinSpace environment.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.NewFINSPEnvironmentCmdlet.FederationParameters_FederationProviderName"> <summary> <para> <para>Name of the identity provider (IdP).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.NewFINSPEnvironmentCmdlet.FederationParameters_FederationURN"> <summary> <para> <para>The Uniform Resource Name (URN). Also referred as Service Provider URN or Audience URI or Service Provider Entity ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.NewFINSPEnvironmentCmdlet.SuperuserParameters_FirstName"> <summary> <para> <para>The first name of the superuser.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.NewFINSPEnvironmentCmdlet.KmsKeyId"> <summary> <para> <para>The KMS key id to encrypt your data in the FinSpace environment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.NewFINSPEnvironmentCmdlet.SuperuserParameters_LastName"> <summary> <para> <para>The last name of the superuser.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.NewFINSPEnvironmentCmdlet.Name"> <summary> <para> <para>The name of the FinSpace environment to be created.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.NewFINSPEnvironmentCmdlet.FederationParameters_SamlMetadataDocument"> <summary> <para> <para>SAML 2.0 Metadata document from identity provider (IdP).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.NewFINSPEnvironmentCmdlet.FederationParameters_SamlMetadataURL"> <summary> <para> <para>Provide the metadata URL from your SAML 2.0 compliant identity provider (IdP).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.NewFINSPEnvironmentCmdlet.Tag"> <summary> <para> <para>Add tags to your FinSpace environment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.NewFINSPEnvironmentCmdlet.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.Finspace.Model.CreateEnvironmentResponse). Specifying the name of a property of type Amazon.Finspace.Model.CreateEnvironmentResponse 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.FINSP.NewFINSPEnvironmentCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.NewFINSPEnvironmentCmdlet.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.FINSP.NewFINSPKxChangesetCmdlet"> <summary> Creates a changeset for a kdb database. A changeset allows you to add and delete existing files by using an ordered list of change requests. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.NewFINSPKxChangesetCmdlet.ChangeRequest"> <summary> <para> <para>A list of change request objects that are run in order. A change request object consists of changeType , s3Path, and a dbPath. A changeType can has the following values: </para><ul><li><para>PUT – Adds or updates files in a database.</para></li><li><para>DELETE – Deletes files in a database.</para></li></ul><para>All the change requests require a mandatory <i>dbPath</i> attribute that defines the path within the database directory. The <i>s3Path</i> attribute defines the s3 source file path and is required for a PUT change type.</para><para>Here is an example of how you can use the change request object:</para><para><code>[ { "changeType": "PUT", "s3Path":"s3://bucket/db/2020.01.02/", "dbPath":"/2020.01.02/"}, { "changeType": "PUT", "s3Path":"s3://bucket/db/sym", "dbPath":"/"}, { "changeType": "DELETE", "dbPath": "/2020.01.01/"} ]</code></para><para>In this example, the first request with <i>PUT</i> change type allows you to add files in the given s3Path under the <i>2020.01.02</i> partition of the database. The second request with <i>PUT</i> change type allows you to add a single sym file at database root location. The last request with <i>DELETE</i> change type allows you to delete the files under the <i>2020.01.01</i> partition of the database. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.NewFINSPKxChangesetCmdlet.DatabaseName"> <summary> <para> <para>The name of the kdb database.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.NewFINSPKxChangesetCmdlet.EnvironmentId"> <summary> <para> <para>A unique identifier of the kdb environment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.NewFINSPKxChangesetCmdlet.ClientToken"> <summary> <para> <para>A token that ensures idempotency. This token expires in 10 minutes.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.NewFINSPKxChangesetCmdlet.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.Finspace.Model.CreateKxChangesetResponse). Specifying the name of a property of type Amazon.Finspace.Model.CreateKxChangesetResponse 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.FINSP.NewFINSPKxChangesetCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DatabaseName parameter. The -PassThru parameter is deprecated, use -Select '^DatabaseName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.NewFINSPKxChangesetCmdlet.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.FINSP.NewFINSPKxClusterCmdlet"> <summary> Creates a new kdb cluster. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.NewFINSPKxClusterCmdlet.AutoScalingConfiguration_AutoScalingMetric"> <summary> <para> <para> The metric your cluster will track in order to scale in and out. For example, <code>CPU_UTILIZATION_PERCENTAGE</code> is the average CPU usage across all the nodes in a cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.NewFINSPKxClusterCmdlet.AvailabilityZoneId"> <summary> <para> <para>The availability zone identifiers for the requested regions.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.NewFINSPKxClusterCmdlet.AzMode"> <summary> <para> <para>The number of availability zones you want to assign per cluster. This can be one of the following </para><ul><li><para><code>SINGLE</code> – Assigns one availability zone per cluster.</para></li><li><para><code>MULTI</code> – Assigns all the availability zones per cluster.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.NewFINSPKxClusterCmdlet.CacheStorageConfiguration"> <summary> <para> <para>The configurations for a read only cache storage associated with a cluster. This cache will be stored as an FSx Lustre that reads from the S3 store. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.NewFINSPKxClusterCmdlet.ClusterDescription"> <summary> <para> <para>A description of the cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.NewFINSPKxClusterCmdlet.ClusterName"> <summary> <para> <para>A unique name for the cluster that you want to create.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.NewFINSPKxClusterCmdlet.ClusterType"> <summary> <para> <para>Specifies the type of KDB database that is being created. The following types are available: </para><ul><li><para>HDB – A Historical Database. The data is only accessible with read-only permissions from one of the FinSpace managed kdb databases mounted to the cluster.</para></li><li><para>RDB – A Realtime Database. This type of database captures all the data from a ticker plant and stores it in memory until the end of day, after which it writes all of its data to a disk and reloads the HDB. This cluster type requires local storage for temporary storage of data during the savedown process. If you specify this field in your request, you must provide the <code>savedownStorageConfiguration</code> parameter.</para></li><li><para>GATEWAY – A gateway cluster allows you to access data across processes in kdb systems. It allows you to create your own routing logic using the initialization scripts and custom code. This type of cluster does not require a writable local storage.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.NewFINSPKxClusterCmdlet.CommandLineArgument"> <summary> <para> <para>Defines the key-value pairs to make them available inside the cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.NewFINSPKxClusterCmdlet.Databases"> <summary> <para> <para>A list of databases that will be available for querying.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.NewFINSPKxClusterCmdlet.EnvironmentId"> <summary> <para> <para>A unique identifier for the kdb environment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.NewFINSPKxClusterCmdlet.ExecutionRole"> <summary> <para> <para>An IAM role that defines a set of permissions associated with a cluster. These permissions are assumed when a cluster attempts to access another cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.NewFINSPKxClusterCmdlet.InitializationScript"> <summary> <para> <para>Specifies a Q program that will be run at launch of a cluster. It is a relative path within <i>.zip</i> file that contains the custom code, which will be loaded on the cluster. It must include the file name itself. For example, <code>somedir/init.q</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.NewFINSPKxClusterCmdlet.VpcConfiguration_IpAddressType"> <summary> <para> <para>The IP address type for cluster network configuration parameters. The following type is available:</para><ul><li><para>IP_V4 – IP address version 4</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.NewFINSPKxClusterCmdlet.AutoScalingConfiguration_MaxNodeCount"> <summary> <para> <para>The highest number of nodes to scale. This value cannot be greater than 5.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.NewFINSPKxClusterCmdlet.AutoScalingConfiguration_MetricTarget"> <summary> <para> <para>The desired value of the chosen <code>autoScalingMetric</code>. When the metric drops below this value, the cluster will scale in. When the metric goes above this value, the cluster will scale out. You can set the target value between 1 and 100 percent.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.NewFINSPKxClusterCmdlet.AutoScalingConfiguration_MinNodeCount"> <summary> <para> <para>The lowest number of nodes to scale. This value must be at least 1 and less than the <code>maxNodeCount</code>. If the nodes in a cluster belong to multiple availability zones, then <code>minNodeCount</code> must be at least 3.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.NewFINSPKxClusterCmdlet.CapacityConfiguration_NodeCount"> <summary> <para> <para>The number of instances running in a cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.NewFINSPKxClusterCmdlet.CapacityConfiguration_NodeType"> <summary> <para> <para>The type that determines the hardware of the host computer used for your cluster instance. Each node type offers different memory and storage capabilities. Choose a node type based on the requirements of the application or software that you plan to run on your instance.</para><para>You can only specify one of the following values:</para><ul><li><para><code>kx.s.large</code> – The node type with a configuration of 12 GiB memory and 2 vCPUs.</para></li><li><para><code>kx.s.xlarge</code> – The node type with a configuration of 27 GiB memory and 4 vCPUs.</para></li><li><para><code>kx.s.2xlarge</code> – The node type with a configuration of 54 GiB memory and 8 vCPUs.</para></li><li><para><code>kx.s.4xlarge</code> – The node type with a configuration of 108 GiB memory and 16 vCPUs.</para></li><li><para><code>kx.s.8xlarge</code> – The node type with a configuration of 216 GiB memory and 32 vCPUs.</para></li><li><para><code>kx.s.16xlarge</code> – The node type with a configuration of 432 GiB memory and 64 vCPUs.</para></li><li><para><code>kx.s.32xlarge</code> – The node type with a configuration of 864 GiB memory and 128 vCPUs.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.NewFINSPKxClusterCmdlet.ReleaseLabel"> <summary> <para> <para>The version of FinSpace managed kdb to run.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.NewFINSPKxClusterCmdlet.Code_S3Bucket"> <summary> <para> <para>A unique name for the S3 bucket.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.NewFINSPKxClusterCmdlet.Code_S3Key"> <summary> <para> <para>The full S3 path (excluding bucket) to the .zip file. This file contains the code that is loaded onto the cluster when it's started.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.NewFINSPKxClusterCmdlet.Code_S3ObjectVersion"> <summary> <para> <para>The version of an S3 object.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.NewFINSPKxClusterCmdlet.AutoScalingConfiguration_ScaleInCooldownSecond"> <summary> <para> <para>The duration in seconds that FinSpace will wait after a scale in event before initiating another scaling event.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.NewFINSPKxClusterCmdlet.AutoScalingConfiguration_ScaleOutCooldownSecond"> <summary> <para> <para>The duration in seconds that FinSpace will wait after a scale out event before initiating another scaling event.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.NewFINSPKxClusterCmdlet.VpcConfiguration_SecurityGroupId"> <summary> <para> <para>The unique identifier of the VPC security group applied to the VPC endpoint ENI for the cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.NewFINSPKxClusterCmdlet.SavedownStorageConfiguration_Size"> <summary> <para> <para>The size of temporary storage in gibibytes.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.NewFINSPKxClusterCmdlet.VpcConfiguration_SubnetId"> <summary> <para> <para>The identifier of the subnet that the Privatelink VPC endpoint uses to connect to the cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.NewFINSPKxClusterCmdlet.Tag"> <summary> <para> <para>A list of key-value pairs to label the cluster. You can add up to 50 tags to a cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.NewFINSPKxClusterCmdlet.SavedownStorageConfiguration_Type"> <summary> <para> <para>The type of writeable storage space for temporarily storing your savedown data. The valid values are:</para><ul><li><para>SDS01 – This type represents 3000 IOPS and io2 ebs volume type.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.NewFINSPKxClusterCmdlet.VpcConfiguration_VpcId"> <summary> <para> <para>The identifier of the VPC endpoint.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.NewFINSPKxClusterCmdlet.ClientToken"> <summary> <para> <para>A token that ensures idempotency. This token expires in 10 minutes.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.NewFINSPKxClusterCmdlet.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.Finspace.Model.CreateKxClusterResponse). Specifying the name of a property of type Amazon.Finspace.Model.CreateKxClusterResponse 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.FINSP.NewFINSPKxClusterCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ClusterName parameter. The -PassThru parameter is deprecated, use -Select '^ClusterName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.NewFINSPKxClusterCmdlet.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.FINSP.NewFINSPKxDatabaseCmdlet"> <summary> Creates a new kdb database in the environment. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.NewFINSPKxDatabaseCmdlet.DatabaseName"> <summary> <para> <para>The name of the kdb database.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.NewFINSPKxDatabaseCmdlet.Description"> <summary> <para> <para>A description of the database.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.NewFINSPKxDatabaseCmdlet.EnvironmentId"> <summary> <para> <para>A unique identifier for the kdb environment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.NewFINSPKxDatabaseCmdlet.Tag"> <summary> <para> <para>A list of key-value pairs to label the kdb database. You can add up to 50 tags to your kdb database</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.NewFINSPKxDatabaseCmdlet.ClientToken"> <summary> <para> <para>A token that ensures idempotency. This token expires in 10 minutes.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.NewFINSPKxDatabaseCmdlet.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.Finspace.Model.CreateKxDatabaseResponse). Specifying the name of a property of type Amazon.Finspace.Model.CreateKxDatabaseResponse 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.FINSP.NewFINSPKxDatabaseCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DatabaseName parameter. The -PassThru parameter is deprecated, use -Select '^DatabaseName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.NewFINSPKxDatabaseCmdlet.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.FINSP.NewFINSPKxEnvironmentCmdlet"> <summary> Creates a managed kdb environment for the account. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.NewFINSPKxEnvironmentCmdlet.Description"> <summary> <para> <para>A description for the kdb environment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.NewFINSPKxEnvironmentCmdlet.KmsKeyId"> <summary> <para> <para>The KMS key ID to encrypt your data in the FinSpace environment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.NewFINSPKxEnvironmentCmdlet.Name"> <summary> <para> <para>The name of the kdb environment that you want to create.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.NewFINSPKxEnvironmentCmdlet.Tag"> <summary> <para> <para>A list of key-value pairs to label the kdb environment. You can add up to 50 tags to your kdb environment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.NewFINSPKxEnvironmentCmdlet.ClientToken"> <summary> <para> <para>A token that ensures idempotency. This token expires in 10 minutes.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.NewFINSPKxEnvironmentCmdlet.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.Finspace.Model.CreateKxEnvironmentResponse). Specifying the name of a property of type Amazon.Finspace.Model.CreateKxEnvironmentResponse 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.FINSP.NewFINSPKxEnvironmentCmdlet.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.FINSP.NewFINSPKxUserCmdlet"> <summary> Creates a user in FinSpace kdb environment with an associated IAM role. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.NewFINSPKxUserCmdlet.EnvironmentId"> <summary> <para> <para>A unique identifier for the kdb environment where you want to create a user.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.NewFINSPKxUserCmdlet.IamRole"> <summary> <para> <para>The IAM role ARN that will be associated with the user.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.NewFINSPKxUserCmdlet.Tag"> <summary> <para> <para>A list of key-value pairs to label the user. You can add up to 50 tags to a user.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.NewFINSPKxUserCmdlet.UserName"> <summary> <para> <para>A unique identifier for the user.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.NewFINSPKxUserCmdlet.ClientToken"> <summary> <para> <para>A token that ensures idempotency. This token expires in 10 minutes.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.NewFINSPKxUserCmdlet.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.Finspace.Model.CreateKxUserResponse). Specifying the name of a property of type Amazon.Finspace.Model.CreateKxUserResponse 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.FINSP.NewFINSPKxUserCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the UserName parameter. The -PassThru parameter is deprecated, use -Select '^UserName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.NewFINSPKxUserCmdlet.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.FINSP.RemoveFINSPEnvironmentCmdlet"> <summary> Delete an FinSpace environment. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.RemoveFINSPEnvironmentCmdlet.EnvironmentId"> <summary> <para> <para>The identifier for the FinSpace environment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.RemoveFINSPEnvironmentCmdlet.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.Finspace.Model.DeleteEnvironmentResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.RemoveFINSPEnvironmentCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the EnvironmentId parameter. The -PassThru parameter is deprecated, use -Select '^EnvironmentId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.RemoveFINSPEnvironmentCmdlet.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.FINSP.RemoveFINSPKxClusterCmdlet"> <summary> Deletes a kdb cluster. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.RemoveFINSPKxClusterCmdlet.ClusterName"> <summary> <para> <para>The name of the cluster that you want to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.RemoveFINSPKxClusterCmdlet.EnvironmentId"> <summary> <para> <para>A unique identifier for the kdb environment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.RemoveFINSPKxClusterCmdlet.ClientToken"> <summary> <para> <para>A token that ensures idempotency. This token expires in 10 minutes.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.RemoveFINSPKxClusterCmdlet.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.Finspace.Model.DeleteKxClusterResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.RemoveFINSPKxClusterCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ClusterName parameter. The -PassThru parameter is deprecated, use -Select '^ClusterName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.RemoveFINSPKxClusterCmdlet.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.FINSP.RemoveFINSPKxDatabaseCmdlet"> <summary> Deletes the specified database and all of its associated data. This action is irreversible. You must copy any data out of the database before deleting it if the data is to be retained. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.RemoveFINSPKxDatabaseCmdlet.DatabaseName"> <summary> <para> <para>The name of the kdb database that you want to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.RemoveFINSPKxDatabaseCmdlet.EnvironmentId"> <summary> <para> <para>A unique identifier for the kdb environment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.RemoveFINSPKxDatabaseCmdlet.ClientToken"> <summary> <para> <para>A token that ensures idempotency. This token expires in 10 minutes.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.RemoveFINSPKxDatabaseCmdlet.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.Finspace.Model.DeleteKxDatabaseResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.RemoveFINSPKxDatabaseCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DatabaseName parameter. The -PassThru parameter is deprecated, use -Select '^DatabaseName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.RemoveFINSPKxDatabaseCmdlet.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.FINSP.RemoveFINSPKxEnvironmentCmdlet"> <summary> Deletes the kdb environment. This action is irreversible. Deleting a kdb environment will remove all the associated data and any services running in it. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.RemoveFINSPKxEnvironmentCmdlet.EnvironmentId"> <summary> <para> <para>A unique identifier for the kdb environment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.RemoveFINSPKxEnvironmentCmdlet.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.Finspace.Model.DeleteKxEnvironmentResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.RemoveFINSPKxEnvironmentCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the EnvironmentId parameter. The -PassThru parameter is deprecated, use -Select '^EnvironmentId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.RemoveFINSPKxEnvironmentCmdlet.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.FINSP.RemoveFINSPKxUserCmdlet"> <summary> Deletes a user in the specified kdb environment. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.RemoveFINSPKxUserCmdlet.EnvironmentId"> <summary> <para> <para>A unique identifier for the kdb environment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.RemoveFINSPKxUserCmdlet.UserName"> <summary> <para> <para>A unique identifier for the user that you want to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.RemoveFINSPKxUserCmdlet.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.Finspace.Model.DeleteKxUserResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.RemoveFINSPKxUserCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the UserName parameter. The -PassThru parameter is deprecated, use -Select '^UserName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.RemoveFINSPKxUserCmdlet.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.FINSP.RemoveFINSPResourceTagCmdlet"> <summary> Removes metadata tags from a FinSpace resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.RemoveFINSPResourceTagCmdlet.ResourceArn"> <summary> <para> <para>A FinSpace resource from which you want to remove a tag or tags. The value for this parameter is an Amazon Resource Name (ARN).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.RemoveFINSPResourceTagCmdlet.TagKey"> <summary> <para> <para>The tag keys (names) of one or more tags to be removed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.RemoveFINSPResourceTagCmdlet.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.Finspace.Model.UntagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.RemoveFINSPResourceTagCmdlet.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.FINSP.RemoveFINSPResourceTagCmdlet.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.FINSP.UpdateFINSPEnvironmentCmdlet"> <summary> Update your FinSpace environment. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.UpdateFINSPEnvironmentCmdlet.FederationParameters_ApplicationCallBackURL"> <summary> <para> <para>The redirect or sign-in URL that should be entered into the SAML 2.0 compliant identity provider configuration (IdP).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.UpdateFINSPEnvironmentCmdlet.FederationParameters_AttributeMap"> <summary> <para> <para>SAML attribute name and value. The name must always be <code>Email</code> and the value should be set to the attribute definition in which user email is set. For example, name would be <code>Email</code> and value <code>http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress</code>. Please check your SAML 2.0 compliant identity provider (IdP) documentation for details.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.UpdateFINSPEnvironmentCmdlet.Description"> <summary> <para> <para>The description of the environment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.UpdateFINSPEnvironmentCmdlet.EnvironmentId"> <summary> <para> <para>The identifier of the FinSpace environment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.UpdateFINSPEnvironmentCmdlet.FederationMode"> <summary> <para> <para>Authentication mode for the environment.</para><ul><li><para><code>FEDERATED</code> - Users access FinSpace through Single Sign On (SSO) via your Identity provider.</para></li><li><para><code>LOCAL</code> - Users access FinSpace via email and password managed within the FinSpace environment.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.UpdateFINSPEnvironmentCmdlet.FederationParameters_FederationProviderName"> <summary> <para> <para>Name of the identity provider (IdP).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.UpdateFINSPEnvironmentCmdlet.FederationParameters_FederationURN"> <summary> <para> <para>The Uniform Resource Name (URN). Also referred as Service Provider URN or Audience URI or Service Provider Entity ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.UpdateFINSPEnvironmentCmdlet.Name"> <summary> <para> <para>The name of the environment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.UpdateFINSPEnvironmentCmdlet.FederationParameters_SamlMetadataDocument"> <summary> <para> <para>SAML 2.0 Metadata document from identity provider (IdP).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.UpdateFINSPEnvironmentCmdlet.FederationParameters_SamlMetadataURL"> <summary> <para> <para>Provide the metadata URL from your SAML 2.0 compliant identity provider (IdP).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.UpdateFINSPEnvironmentCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Environment'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Finspace.Model.UpdateEnvironmentResponse). Specifying the name of a property of type Amazon.Finspace.Model.UpdateEnvironmentResponse 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.FINSP.UpdateFINSPEnvironmentCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the EnvironmentId parameter. The -PassThru parameter is deprecated, use -Select '^EnvironmentId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.UpdateFINSPEnvironmentCmdlet.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.FINSP.UpdateFINSPKxClusterCodeConfigurationCmdlet"> <summary> Allows you to update code configuration on a running cluster. By using this API you can update the code, the initialization script path, and the command line arguments for a specific cluster. The configuration that you want to update will override any existing configurations on the cluster. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.UpdateFINSPKxClusterCodeConfigurationCmdlet.ClusterName"> <summary> <para> <para>The name of the cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.UpdateFINSPKxClusterCodeConfigurationCmdlet.CommandLineArgument"> <summary> <para> <para>Specifies the key-value pairs to make them available inside the cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.UpdateFINSPKxClusterCodeConfigurationCmdlet.DeploymentConfiguration_DeploymentStrategy"> <summary> <para> <para> The type of deployment that you want on a cluster. </para><ul><li><para>ROLLING – This options updates the cluster by stopping the exiting q process and starting a new q process with updated configuration.</para></li><li><para>FORCE – This option updates the cluster by immediately stopping all the running processes before starting up new ones with the updated configuration. </para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.UpdateFINSPKxClusterCodeConfigurationCmdlet.EnvironmentId"> <summary> <para> <para> A unique identifier of the kdb environment. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.UpdateFINSPKxClusterCodeConfigurationCmdlet.InitializationScript"> <summary> <para> <para>Specifies a Q program that will be run at launch of a cluster. It is a relative path within <i>.zip</i> file that contains the custom code, which will be loaded on the cluster. It must include the file name itself. For example, <code>somedir/init.q</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.UpdateFINSPKxClusterCodeConfigurationCmdlet.Code_S3Bucket"> <summary> <para> <para>A unique name for the S3 bucket.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.UpdateFINSPKxClusterCodeConfigurationCmdlet.Code_S3Key"> <summary> <para> <para>The full S3 path (excluding bucket) to the .zip file. This file contains the code that is loaded onto the cluster when it's started.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.UpdateFINSPKxClusterCodeConfigurationCmdlet.Code_S3ObjectVersion"> <summary> <para> <para>The version of an S3 object.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.UpdateFINSPKxClusterCodeConfigurationCmdlet.ClientToken"> <summary> <para> <para>A token that ensures idempotency. This token expires in 10 minutes.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.UpdateFINSPKxClusterCodeConfigurationCmdlet.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.Finspace.Model.UpdateKxClusterCodeConfigurationResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.UpdateFINSPKxClusterCodeConfigurationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ClusterName parameter. The -PassThru parameter is deprecated, use -Select '^ClusterName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.UpdateFINSPKxClusterCodeConfigurationCmdlet.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.FINSP.UpdateFINSPKxClusterDatabasisCmdlet"> <summary> Updates the databases mounted on a kdb cluster, which includes the <code>changesetId</code> and all the dbPaths to be cached. This API does not allow you to change a database name or add a database if you created a cluster without one. <para> Using this API you can point a cluster to a different changeset and modify a list of partitions being cached. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.UpdateFINSPKxClusterDatabasisCmdlet.ClusterName"> <summary> <para> <para>A unique name for the cluster that you want to modify.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.UpdateFINSPKxClusterDatabasisCmdlet.Databases"> <summary> <para> <para> The structure of databases mounted on the cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.UpdateFINSPKxClusterDatabasisCmdlet.DeploymentConfiguration_DeploymentStrategy"> <summary> <para> <para> The type of deployment that you want on a cluster. </para><ul><li><para>ROLLING – This options updates the cluster by stopping the exiting q process and starting a new q process with updated configuration.</para></li><li><para>NO_RESTART – This option updates the cluster without stopping the running q process. It is only available for <code>HDB</code> type cluster. This option is quicker as it reduces the turn around time to update configuration on a cluster. </para><para>With this deployment mode, you cannot update the <code>initializationScript</code> and <code>commandLineArguments</code> parameters.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.UpdateFINSPKxClusterDatabasisCmdlet.EnvironmentId"> <summary> <para> <para>The unique identifier of a kdb environment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.UpdateFINSPKxClusterDatabasisCmdlet.ClientToken"> <summary> <para> <para>A token that ensures idempotency. This token expires in 10 minutes.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.UpdateFINSPKxClusterDatabasisCmdlet.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.Finspace.Model.UpdateKxClusterDatabasesResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.UpdateFINSPKxClusterDatabasisCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ClusterName parameter. The -PassThru parameter is deprecated, use -Select '^ClusterName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.UpdateFINSPKxClusterDatabasisCmdlet.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.FINSP.UpdateFINSPKxDatabaseCmdlet"> <summary> Updates information for the given kdb database. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.UpdateFINSPKxDatabaseCmdlet.DatabaseName"> <summary> <para> <para>The name of the kdb database.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.UpdateFINSPKxDatabaseCmdlet.Description"> <summary> <para> <para>A description of the database.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.UpdateFINSPKxDatabaseCmdlet.EnvironmentId"> <summary> <para> <para>A unique identifier for the kdb environment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.UpdateFINSPKxDatabaseCmdlet.ClientToken"> <summary> <para> <para>A token that ensures idempotency. This token expires in 10 minutes.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.UpdateFINSPKxDatabaseCmdlet.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.Finspace.Model.UpdateKxDatabaseResponse). Specifying the name of a property of type Amazon.Finspace.Model.UpdateKxDatabaseResponse 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.FINSP.UpdateFINSPKxDatabaseCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DatabaseName parameter. The -PassThru parameter is deprecated, use -Select '^DatabaseName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.UpdateFINSPKxDatabaseCmdlet.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.FINSP.UpdateFINSPKxEnvironmentCmdlet"> <summary> Updates information for the given kdb environment. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.UpdateFINSPKxEnvironmentCmdlet.Description"> <summary> <para> <para>A description of the kdb environment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.UpdateFINSPKxEnvironmentCmdlet.EnvironmentId"> <summary> <para> <para>A unique identifier for the kdb environment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.UpdateFINSPKxEnvironmentCmdlet.Name"> <summary> <para> <para>The name of the kdb environment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.UpdateFINSPKxEnvironmentCmdlet.ClientToken"> <summary> <para> <para>A token that ensures idempotency. This token expires in 10 minutes.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.UpdateFINSPKxEnvironmentCmdlet.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.Finspace.Model.UpdateKxEnvironmentResponse). Specifying the name of a property of type Amazon.Finspace.Model.UpdateKxEnvironmentResponse 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.FINSP.UpdateFINSPKxEnvironmentCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the EnvironmentId parameter. The -PassThru parameter is deprecated, use -Select '^EnvironmentId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.UpdateFINSPKxEnvironmentCmdlet.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.FINSP.UpdateFINSPKxEnvironmentNetworkCmdlet"> <summary> Updates environment network to connect to your internal network by using a transit gateway. This API supports request to create a transit gateway attachment from FinSpace VPC to your transit gateway ID and create a custom Route-53 outbound resolvers. <para> Once you send a request to update a network, you cannot change it again. Network update might require termination of any clusters that are running in the existing network. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.UpdateFINSPKxEnvironmentNetworkCmdlet.TransitGatewayConfiguration_AttachmentNetworkAclConfiguration"> <summary> <para> <para> The rules that define how you manage the outbound traffic from kdb network to your internal network. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.UpdateFINSPKxEnvironmentNetworkCmdlet.CustomDNSConfiguration"> <summary> <para> <para>A list of DNS server name and server IP. This is used to set up Route-53 outbound resolvers.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.UpdateFINSPKxEnvironmentNetworkCmdlet.EnvironmentId"> <summary> <para> <para>A unique identifier for the kdb environment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.UpdateFINSPKxEnvironmentNetworkCmdlet.TransitGatewayConfiguration_RoutableCIDRSpace"> <summary> <para> <para>The routing CIDR on behalf of kdb environment. It could be any "/26 range in the 100.64.0.0 CIDR space. After providing, it will be added to the customer's transit gateway routing table so that the traffics could be routed to kdb network.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.UpdateFINSPKxEnvironmentNetworkCmdlet.TransitGatewayConfiguration_TransitGatewayID"> <summary> <para> <para>The identifier of the transit gateway created by the customer to connect outbound traffics from kdb network to your internal network.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.UpdateFINSPKxEnvironmentNetworkCmdlet.ClientToken"> <summary> <para> <para>A token that ensures idempotency. This token expires in 10 minutes.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.UpdateFINSPKxEnvironmentNetworkCmdlet.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.Finspace.Model.UpdateKxEnvironmentNetworkResponse). Specifying the name of a property of type Amazon.Finspace.Model.UpdateKxEnvironmentNetworkResponse 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.FINSP.UpdateFINSPKxEnvironmentNetworkCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the EnvironmentId parameter. The -PassThru parameter is deprecated, use -Select '^EnvironmentId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.UpdateFINSPKxEnvironmentNetworkCmdlet.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.FINSP.UpdateFINSPKxUserCmdlet"> <summary> Updates the user details. You can only update the IAM role associated with a user. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.UpdateFINSPKxUserCmdlet.EnvironmentId"> <summary> <para> <para>A unique identifier for the kdb environment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.UpdateFINSPKxUserCmdlet.IamRole"> <summary> <para> <para>The IAM role ARN that is associated with the user.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.UpdateFINSPKxUserCmdlet.UserName"> <summary> <para> <para>A unique identifier for the user.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.UpdateFINSPKxUserCmdlet.ClientToken"> <summary> <para> <para>A token that ensures idempotency. This token expires in 10 minutes.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.UpdateFINSPKxUserCmdlet.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.Finspace.Model.UpdateKxUserResponse). Specifying the name of a property of type Amazon.Finspace.Model.UpdateKxUserResponse 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.FINSP.UpdateFINSPKxUserCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the UserName parameter. The -PassThru parameter is deprecated, use -Select '^UserName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FINSP.UpdateFINSPKxUserCmdlet.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> |