1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
pub use crate::operation::get_cluster_credentials::_get_cluster_credentials_output::GetClusterCredentialsOutputBuilder;
pub use crate::operation::get_cluster_credentials::_get_cluster_credentials_input::GetClusterCredentialsInputBuilder;
impl GetClusterCredentialsInputBuilder {
/// Sends a request with this input using the given client.
pub async fn send_with(
self,
client: &crate::Client,
) -> ::std::result::Result<
crate::operation::get_cluster_credentials::GetClusterCredentialsOutput,
::aws_smithy_runtime_api::client::result::SdkError<
crate::operation::get_cluster_credentials::GetClusterCredentialsError,
::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
>,
> {
let mut fluent_builder = client.get_cluster_credentials();
fluent_builder.inner = self;
fluent_builder.send().await
}
}
/// Fluent builder constructing a request to `GetClusterCredentials`.
///
/// <p>Returns a database user name and temporary password with temporary authorization to log on to an Amazon Redshift database. The action returns the database user name prefixed with <code>IAM:</code> if <code>AutoCreate</code> is <code>False</code> or <code>IAMA:</code> if <code>AutoCreate</code> is <code>True</code>. You can optionally specify one or more database user groups that the user will join at log on. By default, the temporary credentials expire in 900 seconds. You can optionally specify a duration between 900 seconds (15 minutes) and 3600 seconds (60 minutes). For more information, see <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/generating-user-credentials.html">Using IAM Authentication to Generate Database User Credentials</a> in the Amazon Redshift Cluster Management Guide.</p>
/// <p>The Identity and Access Management (IAM) user or role that runs GetClusterCredentials must have an IAM policy attached that allows access to all necessary actions and resources. For more information about permissions, see <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/redshift-iam-access-control-identity-based.html#redshift-policy-resources.getclustercredentials-resources">Resource Policies for GetClusterCredentials</a> in the Amazon Redshift Cluster Management Guide.</p>
/// <p>If the <code>DbGroups</code> parameter is specified, the IAM policy must allow the <code>redshift:JoinGroup</code> action with access to the listed <code>dbgroups</code>.</p>
/// <p>In addition, if the <code>AutoCreate</code> parameter is set to <code>True</code>, then the policy must include the <code>redshift:CreateClusterUser</code> permission.</p>
/// <p>If the <code>DbName</code> parameter is specified, the IAM policy must allow access to the resource <code>dbname</code> for the specified database name.</p>
#[derive(::std::clone::Clone, ::std::fmt::Debug)]
pub struct GetClusterCredentialsFluentBuilder {
handle: ::std::sync::Arc<crate::client::Handle>,
inner: crate::operation::get_cluster_credentials::builders::GetClusterCredentialsInputBuilder,
config_override: ::std::option::Option<crate::config::Builder>,
}
impl
crate::client::customize::internal::CustomizableSend<
crate::operation::get_cluster_credentials::GetClusterCredentialsOutput,
crate::operation::get_cluster_credentials::GetClusterCredentialsError,
> for GetClusterCredentialsFluentBuilder
{
fn send(
self,
config_override: crate::config::Builder,
) -> crate::client::customize::internal::BoxFuture<
crate::client::customize::internal::SendResult<
crate::operation::get_cluster_credentials::GetClusterCredentialsOutput,
crate::operation::get_cluster_credentials::GetClusterCredentialsError,
>,
> {
::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
}
}
impl GetClusterCredentialsFluentBuilder {
/// Creates a new `GetClusterCredentials`.
pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
Self {
handle,
inner: ::std::default::Default::default(),
config_override: ::std::option::Option::None,
}
}
/// Access the GetClusterCredentials as a reference.
pub fn as_input(&self) -> &crate::operation::get_cluster_credentials::builders::GetClusterCredentialsInputBuilder {
&self.inner
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> ::std::result::Result<
crate::operation::get_cluster_credentials::GetClusterCredentialsOutput,
::aws_smithy_runtime_api::client::result::SdkError<
crate::operation::get_cluster_credentials::GetClusterCredentialsError,
::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
>,
> {
let input = self
.inner
.build()
.map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
let runtime_plugins = crate::operation::get_cluster_credentials::GetClusterCredentials::operation_runtime_plugins(
self.handle.runtime_plugins.clone(),
&self.handle.conf,
self.config_override,
);
crate::operation::get_cluster_credentials::GetClusterCredentials::orchestrate(&runtime_plugins, input).await
}
/// Consumes this builder, creating a customizable operation that can be modified before being sent.
pub fn customize(
self,
) -> crate::client::customize::CustomizableOperation<
crate::operation::get_cluster_credentials::GetClusterCredentialsOutput,
crate::operation::get_cluster_credentials::GetClusterCredentialsError,
Self,
> {
crate::client::customize::CustomizableOperation::new(self)
}
pub(crate) fn config_override(mut self, config_override: impl Into<crate::config::Builder>) -> Self {
self.set_config_override(Some(config_override.into()));
self
}
pub(crate) fn set_config_override(&mut self, config_override: Option<crate::config::Builder>) -> &mut Self {
self.config_override = config_override;
self
}
/// <p>The name of a database user. If a user name matching <code>DbUser</code> exists in the database, the temporary user credentials have the same permissions as the existing user. If <code>DbUser</code> doesn't exist in the database and <code>Autocreate</code> is <code>True</code>, a new user is created using the value for <code>DbUser</code> with PUBLIC permissions. If a database user matching the value for <code>DbUser</code> doesn't exist and <code>Autocreate</code> is <code>False</code>, then the command succeeds but the connection attempt will fail because the user doesn't exist in the database.</p>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/redshift/latest/dg/r_CREATE_USER.html">CREATE USER</a> in the Amazon Redshift Database Developer Guide.</p>
/// <p>Constraints:</p>
/// <ul>
/// <li>
/// <p>Must be 1 to 64 alphanumeric characters or hyphens. The user name can't be <code>PUBLIC</code>.</p></li>
/// <li>
/// <p>Must contain uppercase or lowercase letters, numbers, underscore, plus sign, period (dot), at symbol (@), or hyphen.</p></li>
/// <li>
/// <p>First character must be a letter.</p></li>
/// <li>
/// <p>Must not contain a colon ( : ) or slash ( / ).</p></li>
/// <li>
/// <p>Cannot be a reserved word. A list of reserved words can be found in <a href="http://docs.aws.amazon.com/redshift/latest/dg/r_pg_keywords.html">Reserved Words</a> in the Amazon Redshift Database Developer Guide.</p></li>
/// </ul>
pub fn db_user(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.db_user(input.into());
self
}
/// <p>The name of a database user. If a user name matching <code>DbUser</code> exists in the database, the temporary user credentials have the same permissions as the existing user. If <code>DbUser</code> doesn't exist in the database and <code>Autocreate</code> is <code>True</code>, a new user is created using the value for <code>DbUser</code> with PUBLIC permissions. If a database user matching the value for <code>DbUser</code> doesn't exist and <code>Autocreate</code> is <code>False</code>, then the command succeeds but the connection attempt will fail because the user doesn't exist in the database.</p>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/redshift/latest/dg/r_CREATE_USER.html">CREATE USER</a> in the Amazon Redshift Database Developer Guide.</p>
/// <p>Constraints:</p>
/// <ul>
/// <li>
/// <p>Must be 1 to 64 alphanumeric characters or hyphens. The user name can't be <code>PUBLIC</code>.</p></li>
/// <li>
/// <p>Must contain uppercase or lowercase letters, numbers, underscore, plus sign, period (dot), at symbol (@), or hyphen.</p></li>
/// <li>
/// <p>First character must be a letter.</p></li>
/// <li>
/// <p>Must not contain a colon ( : ) or slash ( / ).</p></li>
/// <li>
/// <p>Cannot be a reserved word. A list of reserved words can be found in <a href="http://docs.aws.amazon.com/redshift/latest/dg/r_pg_keywords.html">Reserved Words</a> in the Amazon Redshift Database Developer Guide.</p></li>
/// </ul>
pub fn set_db_user(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_db_user(input);
self
}
/// <p>The name of a database user. If a user name matching <code>DbUser</code> exists in the database, the temporary user credentials have the same permissions as the existing user. If <code>DbUser</code> doesn't exist in the database and <code>Autocreate</code> is <code>True</code>, a new user is created using the value for <code>DbUser</code> with PUBLIC permissions. If a database user matching the value for <code>DbUser</code> doesn't exist and <code>Autocreate</code> is <code>False</code>, then the command succeeds but the connection attempt will fail because the user doesn't exist in the database.</p>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/redshift/latest/dg/r_CREATE_USER.html">CREATE USER</a> in the Amazon Redshift Database Developer Guide.</p>
/// <p>Constraints:</p>
/// <ul>
/// <li>
/// <p>Must be 1 to 64 alphanumeric characters or hyphens. The user name can't be <code>PUBLIC</code>.</p></li>
/// <li>
/// <p>Must contain uppercase or lowercase letters, numbers, underscore, plus sign, period (dot), at symbol (@), or hyphen.</p></li>
/// <li>
/// <p>First character must be a letter.</p></li>
/// <li>
/// <p>Must not contain a colon ( : ) or slash ( / ).</p></li>
/// <li>
/// <p>Cannot be a reserved word. A list of reserved words can be found in <a href="http://docs.aws.amazon.com/redshift/latest/dg/r_pg_keywords.html">Reserved Words</a> in the Amazon Redshift Database Developer Guide.</p></li>
/// </ul>
pub fn get_db_user(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_db_user()
}
/// <p>The name of a database that <code>DbUser</code> is authorized to log on to. If <code>DbName</code> is not specified, <code>DbUser</code> can log on to any existing database.</p>
/// <p>Constraints:</p>
/// <ul>
/// <li>
/// <p>Must be 1 to 64 alphanumeric characters or hyphens</p></li>
/// <li>
/// <p>Must contain uppercase or lowercase letters, numbers, underscore, plus sign, period (dot), at symbol (@), or hyphen.</p></li>
/// <li>
/// <p>First character must be a letter.</p></li>
/// <li>
/// <p>Must not contain a colon ( : ) or slash ( / ).</p></li>
/// <li>
/// <p>Cannot be a reserved word. A list of reserved words can be found in <a href="http://docs.aws.amazon.com/redshift/latest/dg/r_pg_keywords.html">Reserved Words</a> in the Amazon Redshift Database Developer Guide.</p></li>
/// </ul>
pub fn db_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.db_name(input.into());
self
}
/// <p>The name of a database that <code>DbUser</code> is authorized to log on to. If <code>DbName</code> is not specified, <code>DbUser</code> can log on to any existing database.</p>
/// <p>Constraints:</p>
/// <ul>
/// <li>
/// <p>Must be 1 to 64 alphanumeric characters or hyphens</p></li>
/// <li>
/// <p>Must contain uppercase or lowercase letters, numbers, underscore, plus sign, period (dot), at symbol (@), or hyphen.</p></li>
/// <li>
/// <p>First character must be a letter.</p></li>
/// <li>
/// <p>Must not contain a colon ( : ) or slash ( / ).</p></li>
/// <li>
/// <p>Cannot be a reserved word. A list of reserved words can be found in <a href="http://docs.aws.amazon.com/redshift/latest/dg/r_pg_keywords.html">Reserved Words</a> in the Amazon Redshift Database Developer Guide.</p></li>
/// </ul>
pub fn set_db_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_db_name(input);
self
}
/// <p>The name of a database that <code>DbUser</code> is authorized to log on to. If <code>DbName</code> is not specified, <code>DbUser</code> can log on to any existing database.</p>
/// <p>Constraints:</p>
/// <ul>
/// <li>
/// <p>Must be 1 to 64 alphanumeric characters or hyphens</p></li>
/// <li>
/// <p>Must contain uppercase or lowercase letters, numbers, underscore, plus sign, period (dot), at symbol (@), or hyphen.</p></li>
/// <li>
/// <p>First character must be a letter.</p></li>
/// <li>
/// <p>Must not contain a colon ( : ) or slash ( / ).</p></li>
/// <li>
/// <p>Cannot be a reserved word. A list of reserved words can be found in <a href="http://docs.aws.amazon.com/redshift/latest/dg/r_pg_keywords.html">Reserved Words</a> in the Amazon Redshift Database Developer Guide.</p></li>
/// </ul>
pub fn get_db_name(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_db_name()
}
/// <p>The unique identifier of the cluster that contains the database for which you are requesting credentials. This parameter is case sensitive.</p>
pub fn cluster_identifier(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.cluster_identifier(input.into());
self
}
/// <p>The unique identifier of the cluster that contains the database for which you are requesting credentials. This parameter is case sensitive.</p>
pub fn set_cluster_identifier(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_cluster_identifier(input);
self
}
/// <p>The unique identifier of the cluster that contains the database for which you are requesting credentials. This parameter is case sensitive.</p>
pub fn get_cluster_identifier(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_cluster_identifier()
}
/// <p>The number of seconds until the returned temporary password expires.</p>
/// <p>Constraint: minimum 900, maximum 3600.</p>
/// <p>Default: 900</p>
pub fn duration_seconds(mut self, input: i32) -> Self {
self.inner = self.inner.duration_seconds(input);
self
}
/// <p>The number of seconds until the returned temporary password expires.</p>
/// <p>Constraint: minimum 900, maximum 3600.</p>
/// <p>Default: 900</p>
pub fn set_duration_seconds(mut self, input: ::std::option::Option<i32>) -> Self {
self.inner = self.inner.set_duration_seconds(input);
self
}
/// <p>The number of seconds until the returned temporary password expires.</p>
/// <p>Constraint: minimum 900, maximum 3600.</p>
/// <p>Default: 900</p>
pub fn get_duration_seconds(&self) -> &::std::option::Option<i32> {
self.inner.get_duration_seconds()
}
/// <p>Create a database user with the name specified for the user named in <code>DbUser</code> if one does not exist.</p>
pub fn auto_create(mut self, input: bool) -> Self {
self.inner = self.inner.auto_create(input);
self
}
/// <p>Create a database user with the name specified for the user named in <code>DbUser</code> if one does not exist.</p>
pub fn set_auto_create(mut self, input: ::std::option::Option<bool>) -> Self {
self.inner = self.inner.set_auto_create(input);
self
}
/// <p>Create a database user with the name specified for the user named in <code>DbUser</code> if one does not exist.</p>
pub fn get_auto_create(&self) -> &::std::option::Option<bool> {
self.inner.get_auto_create()
}
/// Appends an item to `DbGroups`.
///
/// To override the contents of this collection use [`set_db_groups`](Self::set_db_groups).
///
/// <p>A list of the names of existing database groups that the user named in <code>DbUser</code> will join for the current session, in addition to any group memberships for an existing user. If not specified, a new user is added only to PUBLIC.</p>
/// <p>Database group name constraints</p>
/// <ul>
/// <li>
/// <p>Must be 1 to 64 alphanumeric characters or hyphens</p></li>
/// <li>
/// <p>Must contain only lowercase letters, numbers, underscore, plus sign, period (dot), at symbol (@), or hyphen.</p></li>
/// <li>
/// <p>First character must be a letter.</p></li>
/// <li>
/// <p>Must not contain a colon ( : ) or slash ( / ).</p></li>
/// <li>
/// <p>Cannot be a reserved word. A list of reserved words can be found in <a href="http://docs.aws.amazon.com/redshift/latest/dg/r_pg_keywords.html">Reserved Words</a> in the Amazon Redshift Database Developer Guide.</p></li>
/// </ul>
pub fn db_groups(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.db_groups(input.into());
self
}
/// <p>A list of the names of existing database groups that the user named in <code>DbUser</code> will join for the current session, in addition to any group memberships for an existing user. If not specified, a new user is added only to PUBLIC.</p>
/// <p>Database group name constraints</p>
/// <ul>
/// <li>
/// <p>Must be 1 to 64 alphanumeric characters or hyphens</p></li>
/// <li>
/// <p>Must contain only lowercase letters, numbers, underscore, plus sign, period (dot), at symbol (@), or hyphen.</p></li>
/// <li>
/// <p>First character must be a letter.</p></li>
/// <li>
/// <p>Must not contain a colon ( : ) or slash ( / ).</p></li>
/// <li>
/// <p>Cannot be a reserved word. A list of reserved words can be found in <a href="http://docs.aws.amazon.com/redshift/latest/dg/r_pg_keywords.html">Reserved Words</a> in the Amazon Redshift Database Developer Guide.</p></li>
/// </ul>
pub fn set_db_groups(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
self.inner = self.inner.set_db_groups(input);
self
}
/// <p>A list of the names of existing database groups that the user named in <code>DbUser</code> will join for the current session, in addition to any group memberships for an existing user. If not specified, a new user is added only to PUBLIC.</p>
/// <p>Database group name constraints</p>
/// <ul>
/// <li>
/// <p>Must be 1 to 64 alphanumeric characters or hyphens</p></li>
/// <li>
/// <p>Must contain only lowercase letters, numbers, underscore, plus sign, period (dot), at symbol (@), or hyphen.</p></li>
/// <li>
/// <p>First character must be a letter.</p></li>
/// <li>
/// <p>Must not contain a colon ( : ) or slash ( / ).</p></li>
/// <li>
/// <p>Cannot be a reserved word. A list of reserved words can be found in <a href="http://docs.aws.amazon.com/redshift/latest/dg/r_pg_keywords.html">Reserved Words</a> in the Amazon Redshift Database Developer Guide.</p></li>
/// </ul>
pub fn get_db_groups(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
self.inner.get_db_groups()
}
/// <p>The custom domain name for the cluster credentials.</p>
pub fn custom_domain_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.custom_domain_name(input.into());
self
}
/// <p>The custom domain name for the cluster credentials.</p>
pub fn set_custom_domain_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_custom_domain_name(input);
self
}
/// <p>The custom domain name for the cluster credentials.</p>
pub fn get_custom_domain_name(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_custom_domain_name()
}
}