aws_sdk_finspace/client/
get_kx_connection_string.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`GetKxConnectionString`](crate::operation::get_kx_connection_string::builders::GetKxConnectionStringFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`user_arn(impl Into<String>)`](crate::operation::get_kx_connection_string::builders::GetKxConnectionStringFluentBuilder::user_arn) / [`set_user_arn(Option<String>)`](crate::operation::get_kx_connection_string::builders::GetKxConnectionStringFluentBuilder::set_user_arn):<br>required: **true**<br><p>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>.</p><br>
7    ///   - [`environment_id(impl Into<String>)`](crate::operation::get_kx_connection_string::builders::GetKxConnectionStringFluentBuilder::environment_id) / [`set_environment_id(Option<String>)`](crate::operation::get_kx_connection_string::builders::GetKxConnectionStringFluentBuilder::set_environment_id):<br>required: **true**<br><p>A unique identifier for the kdb environment.</p><br>
8    ///   - [`cluster_name(impl Into<String>)`](crate::operation::get_kx_connection_string::builders::GetKxConnectionStringFluentBuilder::cluster_name) / [`set_cluster_name(Option<String>)`](crate::operation::get_kx_connection_string::builders::GetKxConnectionStringFluentBuilder::set_cluster_name):<br>required: **true**<br><p>A name of the kdb cluster.</p><br>
9    /// - On success, responds with [`GetKxConnectionStringOutput`](crate::operation::get_kx_connection_string::GetKxConnectionStringOutput) with field(s):
10    ///   - [`signed_connection_string(Option<String>)`](crate::operation::get_kx_connection_string::GetKxConnectionStringOutput::signed_connection_string): <p>The signed connection string that you can use to connect to clusters.</p>
11    /// - On failure, responds with [`SdkError<GetKxConnectionStringError>`](crate::operation::get_kx_connection_string::GetKxConnectionStringError)
12    pub fn get_kx_connection_string(&self) -> crate::operation::get_kx_connection_string::builders::GetKxConnectionStringFluentBuilder {
13        crate::operation::get_kx_connection_string::builders::GetKxConnectionStringFluentBuilder::new(self.handle.clone())
14    }
15}