/**
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0.
*/
#pragma once
#include The request parameters to get cluster credentials.See Also:
* AWS
* API Reference
The name of a database user. If a user name matching DbUser
* exists in the database, the temporary user credentials have the same permissions
* as the existing user. If DbUser
doesn't exist in the database and
* Autocreate
is True
, a new user is created using the
* value for DbUser
with PUBLIC permissions. If a database user
* matching the value for DbUser
doesn't exist and
* Autocreate
is False
, then the command succeeds but the
* connection attempt will fail because the user doesn't exist in the database.
For more information, see CREATE * USER in the Amazon Redshift Database Developer Guide.
*Constraints:
Must be 1 to 64 alphanumeric characters or
* hyphens. The user name can't be PUBLIC
.
Must * contain uppercase or lowercase letters, numbers, underscore, plus sign, period * (dot), at symbol (@), or hyphen.
First character must be a * letter.
Must not contain a colon ( : ) or slash ( / ).
*Cannot be a reserved word. A list of reserved words can be found * in Reserved * Words in the Amazon Redshift Database Developer Guide.
The name of a database user. If a user name matching DbUser
* exists in the database, the temporary user credentials have the same permissions
* as the existing user. If DbUser
doesn't exist in the database and
* Autocreate
is True
, a new user is created using the
* value for DbUser
with PUBLIC permissions. If a database user
* matching the value for DbUser
doesn't exist and
* Autocreate
is False
, then the command succeeds but the
* connection attempt will fail because the user doesn't exist in the database.
For more information, see CREATE * USER in the Amazon Redshift Database Developer Guide.
*Constraints:
Must be 1 to 64 alphanumeric characters or
* hyphens. The user name can't be PUBLIC
.
Must * contain uppercase or lowercase letters, numbers, underscore, plus sign, period * (dot), at symbol (@), or hyphen.
First character must be a * letter.
Must not contain a colon ( : ) or slash ( / ).
*Cannot be a reserved word. A list of reserved words can be found * in Reserved * Words in the Amazon Redshift Database Developer Guide.
The name of a database user. If a user name matching DbUser
* exists in the database, the temporary user credentials have the same permissions
* as the existing user. If DbUser
doesn't exist in the database and
* Autocreate
is True
, a new user is created using the
* value for DbUser
with PUBLIC permissions. If a database user
* matching the value for DbUser
doesn't exist and
* Autocreate
is False
, then the command succeeds but the
* connection attempt will fail because the user doesn't exist in the database.
For more information, see CREATE * USER in the Amazon Redshift Database Developer Guide.
*Constraints:
Must be 1 to 64 alphanumeric characters or
* hyphens. The user name can't be PUBLIC
.
Must * contain uppercase or lowercase letters, numbers, underscore, plus sign, period * (dot), at symbol (@), or hyphen.
First character must be a * letter.
Must not contain a colon ( : ) or slash ( / ).
*Cannot be a reserved word. A list of reserved words can be found * in Reserved * Words in the Amazon Redshift Database Developer Guide.
The name of a database user. If a user name matching DbUser
* exists in the database, the temporary user credentials have the same permissions
* as the existing user. If DbUser
doesn't exist in the database and
* Autocreate
is True
, a new user is created using the
* value for DbUser
with PUBLIC permissions. If a database user
* matching the value for DbUser
doesn't exist and
* Autocreate
is False
, then the command succeeds but the
* connection attempt will fail because the user doesn't exist in the database.
For more information, see CREATE * USER in the Amazon Redshift Database Developer Guide.
*Constraints:
Must be 1 to 64 alphanumeric characters or
* hyphens. The user name can't be PUBLIC
.
Must * contain uppercase or lowercase letters, numbers, underscore, plus sign, period * (dot), at symbol (@), or hyphen.
First character must be a * letter.
Must not contain a colon ( : ) or slash ( / ).
*Cannot be a reserved word. A list of reserved words can be found * in Reserved * Words in the Amazon Redshift Database Developer Guide.
The name of a database user. If a user name matching DbUser
* exists in the database, the temporary user credentials have the same permissions
* as the existing user. If DbUser
doesn't exist in the database and
* Autocreate
is True
, a new user is created using the
* value for DbUser
with PUBLIC permissions. If a database user
* matching the value for DbUser
doesn't exist and
* Autocreate
is False
, then the command succeeds but the
* connection attempt will fail because the user doesn't exist in the database.
For more information, see CREATE * USER in the Amazon Redshift Database Developer Guide.
*Constraints:
Must be 1 to 64 alphanumeric characters or
* hyphens. The user name can't be PUBLIC
.
Must * contain uppercase or lowercase letters, numbers, underscore, plus sign, period * (dot), at symbol (@), or hyphen.
First character must be a * letter.
Must not contain a colon ( : ) or slash ( / ).
*Cannot be a reserved word. A list of reserved words can be found * in Reserved * Words in the Amazon Redshift Database Developer Guide.
The name of a database user. If a user name matching DbUser
* exists in the database, the temporary user credentials have the same permissions
* as the existing user. If DbUser
doesn't exist in the database and
* Autocreate
is True
, a new user is created using the
* value for DbUser
with PUBLIC permissions. If a database user
* matching the value for DbUser
doesn't exist and
* Autocreate
is False
, then the command succeeds but the
* connection attempt will fail because the user doesn't exist in the database.
For more information, see CREATE * USER in the Amazon Redshift Database Developer Guide.
*Constraints:
Must be 1 to 64 alphanumeric characters or
* hyphens. The user name can't be PUBLIC
.
Must * contain uppercase or lowercase letters, numbers, underscore, plus sign, period * (dot), at symbol (@), or hyphen.
First character must be a * letter.
Must not contain a colon ( : ) or slash ( / ).
*Cannot be a reserved word. A list of reserved words can be found * in Reserved * Words in the Amazon Redshift Database Developer Guide.
The name of a database user. If a user name matching DbUser
* exists in the database, the temporary user credentials have the same permissions
* as the existing user. If DbUser
doesn't exist in the database and
* Autocreate
is True
, a new user is created using the
* value for DbUser
with PUBLIC permissions. If a database user
* matching the value for DbUser
doesn't exist and
* Autocreate
is False
, then the command succeeds but the
* connection attempt will fail because the user doesn't exist in the database.
For more information, see CREATE * USER in the Amazon Redshift Database Developer Guide.
*Constraints:
Must be 1 to 64 alphanumeric characters or
* hyphens. The user name can't be PUBLIC
.
Must * contain uppercase or lowercase letters, numbers, underscore, plus sign, period * (dot), at symbol (@), or hyphen.
First character must be a * letter.
Must not contain a colon ( : ) or slash ( / ).
*Cannot be a reserved word. A list of reserved words can be found * in Reserved * Words in the Amazon Redshift Database Developer Guide.
The name of a database user. If a user name matching DbUser
* exists in the database, the temporary user credentials have the same permissions
* as the existing user. If DbUser
doesn't exist in the database and
* Autocreate
is True
, a new user is created using the
* value for DbUser
with PUBLIC permissions. If a database user
* matching the value for DbUser
doesn't exist and
* Autocreate
is False
, then the command succeeds but the
* connection attempt will fail because the user doesn't exist in the database.
For more information, see CREATE * USER in the Amazon Redshift Database Developer Guide.
*Constraints:
Must be 1 to 64 alphanumeric characters or
* hyphens. The user name can't be PUBLIC
.
Must * contain uppercase or lowercase letters, numbers, underscore, plus sign, period * (dot), at symbol (@), or hyphen.
First character must be a * letter.
Must not contain a colon ( : ) or slash ( / ).
*Cannot be a reserved word. A list of reserved words can be found * in Reserved * Words in the Amazon Redshift Database Developer Guide.
The name of a database that DbUser
is authorized to log on to.
* If DbName
is not specified, DbUser
can log on to any
* existing database.
Constraints:
Must be 1 to 64 * alphanumeric characters or hyphens
Must contain uppercase or * lowercase letters, numbers, underscore, plus sign, period (dot), at symbol (@), * or hyphen.
First character must be a letter.
Must not contain a colon ( : ) or slash ( / ).
Cannot be a * reserved word. A list of reserved words can be found in Reserved * Words in the Amazon Redshift Database Developer Guide.
The name of a database that DbUser
is authorized to log on to.
* If DbName
is not specified, DbUser
can log on to any
* existing database.
Constraints:
Must be 1 to 64 * alphanumeric characters or hyphens
Must contain uppercase or * lowercase letters, numbers, underscore, plus sign, period (dot), at symbol (@), * or hyphen.
First character must be a letter.
Must not contain a colon ( : ) or slash ( / ).
Cannot be a * reserved word. A list of reserved words can be found in Reserved * Words in the Amazon Redshift Database Developer Guide.
The name of a database that DbUser
is authorized to log on to.
* If DbName
is not specified, DbUser
can log on to any
* existing database.
Constraints:
Must be 1 to 64 * alphanumeric characters or hyphens
Must contain uppercase or * lowercase letters, numbers, underscore, plus sign, period (dot), at symbol (@), * or hyphen.
First character must be a letter.
Must not contain a colon ( : ) or slash ( / ).
Cannot be a * reserved word. A list of reserved words can be found in Reserved * Words in the Amazon Redshift Database Developer Guide.
The name of a database that DbUser
is authorized to log on to.
* If DbName
is not specified, DbUser
can log on to any
* existing database.
Constraints:
Must be 1 to 64 * alphanumeric characters or hyphens
Must contain uppercase or * lowercase letters, numbers, underscore, plus sign, period (dot), at symbol (@), * or hyphen.
First character must be a letter.
Must not contain a colon ( : ) or slash ( / ).
Cannot be a * reserved word. A list of reserved words can be found in Reserved * Words in the Amazon Redshift Database Developer Guide.
The name of a database that DbUser
is authorized to log on to.
* If DbName
is not specified, DbUser
can log on to any
* existing database.
Constraints:
Must be 1 to 64 * alphanumeric characters or hyphens
Must contain uppercase or * lowercase letters, numbers, underscore, plus sign, period (dot), at symbol (@), * or hyphen.
First character must be a letter.
Must not contain a colon ( : ) or slash ( / ).
Cannot be a * reserved word. A list of reserved words can be found in Reserved * Words in the Amazon Redshift Database Developer Guide.
The name of a database that DbUser
is authorized to log on to.
* If DbName
is not specified, DbUser
can log on to any
* existing database.
Constraints:
Must be 1 to 64 * alphanumeric characters or hyphens
Must contain uppercase or * lowercase letters, numbers, underscore, plus sign, period (dot), at symbol (@), * or hyphen.
First character must be a letter.
Must not contain a colon ( : ) or slash ( / ).
Cannot be a * reserved word. A list of reserved words can be found in Reserved * Words in the Amazon Redshift Database Developer Guide.
The name of a database that DbUser
is authorized to log on to.
* If DbName
is not specified, DbUser
can log on to any
* existing database.
Constraints:
Must be 1 to 64 * alphanumeric characters or hyphens
Must contain uppercase or * lowercase letters, numbers, underscore, plus sign, period (dot), at symbol (@), * or hyphen.
First character must be a letter.
Must not contain a colon ( : ) or slash ( / ).
Cannot be a * reserved word. A list of reserved words can be found in Reserved * Words in the Amazon Redshift Database Developer Guide.
The name of a database that DbUser
is authorized to log on to.
* If DbName
is not specified, DbUser
can log on to any
* existing database.
Constraints:
Must be 1 to 64 * alphanumeric characters or hyphens
Must contain uppercase or * lowercase letters, numbers, underscore, plus sign, period (dot), at symbol (@), * or hyphen.
First character must be a letter.
Must not contain a colon ( : ) or slash ( / ).
Cannot be a * reserved word. A list of reserved words can be found in Reserved * Words in the Amazon Redshift Database Developer Guide.
The unique identifier of the cluster that contains the database for which you * are requesting credentials. This parameter is case sensitive.
*/ inline const Aws::String& GetClusterIdentifier() const{ return m_clusterIdentifier; } /** *The unique identifier of the cluster that contains the database for which you * are requesting credentials. This parameter is case sensitive.
*/ inline bool ClusterIdentifierHasBeenSet() const { return m_clusterIdentifierHasBeenSet; } /** *The unique identifier of the cluster that contains the database for which you * are requesting credentials. This parameter is case sensitive.
*/ inline void SetClusterIdentifier(const Aws::String& value) { m_clusterIdentifierHasBeenSet = true; m_clusterIdentifier = value; } /** *The unique identifier of the cluster that contains the database for which you * are requesting credentials. This parameter is case sensitive.
*/ inline void SetClusterIdentifier(Aws::String&& value) { m_clusterIdentifierHasBeenSet = true; m_clusterIdentifier = std::move(value); } /** *The unique identifier of the cluster that contains the database for which you * are requesting credentials. This parameter is case sensitive.
*/ inline void SetClusterIdentifier(const char* value) { m_clusterIdentifierHasBeenSet = true; m_clusterIdentifier.assign(value); } /** *The unique identifier of the cluster that contains the database for which you * are requesting credentials. This parameter is case sensitive.
*/ inline GetClusterCredentialsRequest& WithClusterIdentifier(const Aws::String& value) { SetClusterIdentifier(value); return *this;} /** *The unique identifier of the cluster that contains the database for which you * are requesting credentials. This parameter is case sensitive.
*/ inline GetClusterCredentialsRequest& WithClusterIdentifier(Aws::String&& value) { SetClusterIdentifier(std::move(value)); return *this;} /** *The unique identifier of the cluster that contains the database for which you * are requesting credentials. This parameter is case sensitive.
*/ inline GetClusterCredentialsRequest& WithClusterIdentifier(const char* value) { SetClusterIdentifier(value); return *this;} /** *The number of seconds until the returned temporary password expires.
*Constraint: minimum 900, maximum 3600.
Default: 900
*/ inline int GetDurationSeconds() const{ return m_durationSeconds; } /** *The number of seconds until the returned temporary password expires.
*Constraint: minimum 900, maximum 3600.
Default: 900
*/ inline bool DurationSecondsHasBeenSet() const { return m_durationSecondsHasBeenSet; } /** *The number of seconds until the returned temporary password expires.
*Constraint: minimum 900, maximum 3600.
Default: 900
*/ inline void SetDurationSeconds(int value) { m_durationSecondsHasBeenSet = true; m_durationSeconds = value; } /** *The number of seconds until the returned temporary password expires.
*Constraint: minimum 900, maximum 3600.
Default: 900
*/ inline GetClusterCredentialsRequest& WithDurationSeconds(int value) { SetDurationSeconds(value); return *this;} /** *Create a database user with the name specified for the user named in
* DbUser
if one does not exist.
Create a database user with the name specified for the user named in
* DbUser
if one does not exist.
Create a database user with the name specified for the user named in
* DbUser
if one does not exist.
Create a database user with the name specified for the user named in
* DbUser
if one does not exist.
A list of the names of existing database groups that the user named in
* DbUser
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.
Database group name constraints
Must be 1 to 64 * alphanumeric characters or hyphens
Must contain only lowercase * letters, numbers, underscore, plus sign, period (dot), at symbol (@), or * hyphen.
First character must be a letter.
Must not contain a colon ( : ) or slash ( / ).
Cannot be a * reserved word. A list of reserved words can be found in Reserved * Words in the Amazon Redshift Database Developer Guide.
A list of the names of existing database groups that the user named in
* DbUser
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.
Database group name constraints
Must be 1 to 64 * alphanumeric characters or hyphens
Must contain only lowercase * letters, numbers, underscore, plus sign, period (dot), at symbol (@), or * hyphen.
First character must be a letter.
Must not contain a colon ( : ) or slash ( / ).
Cannot be a * reserved word. A list of reserved words can be found in Reserved * Words in the Amazon Redshift Database Developer Guide.
A list of the names of existing database groups that the user named in
* DbUser
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.
Database group name constraints
Must be 1 to 64 * alphanumeric characters or hyphens
Must contain only lowercase * letters, numbers, underscore, plus sign, period (dot), at symbol (@), or * hyphen.
First character must be a letter.
Must not contain a colon ( : ) or slash ( / ).
Cannot be a * reserved word. A list of reserved words can be found in Reserved * Words in the Amazon Redshift Database Developer Guide.
A list of the names of existing database groups that the user named in
* DbUser
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.
Database group name constraints
Must be 1 to 64 * alphanumeric characters or hyphens
Must contain only lowercase * letters, numbers, underscore, plus sign, period (dot), at symbol (@), or * hyphen.
First character must be a letter.
Must not contain a colon ( : ) or slash ( / ).
Cannot be a * reserved word. A list of reserved words can be found in Reserved * Words in the Amazon Redshift Database Developer Guide.
A list of the names of existing database groups that the user named in
* DbUser
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.
Database group name constraints
Must be 1 to 64 * alphanumeric characters or hyphens
Must contain only lowercase * letters, numbers, underscore, plus sign, period (dot), at symbol (@), or * hyphen.
First character must be a letter.
Must not contain a colon ( : ) or slash ( / ).
Cannot be a * reserved word. A list of reserved words can be found in Reserved * Words in the Amazon Redshift Database Developer Guide.
A list of the names of existing database groups that the user named in
* DbUser
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.
Database group name constraints
Must be 1 to 64 * alphanumeric characters or hyphens
Must contain only lowercase * letters, numbers, underscore, plus sign, period (dot), at symbol (@), or * hyphen.
First character must be a letter.
Must not contain a colon ( : ) or slash ( / ).
Cannot be a * reserved word. A list of reserved words can be found in Reserved * Words in the Amazon Redshift Database Developer Guide.
A list of the names of existing database groups that the user named in
* DbUser
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.
Database group name constraints
Must be 1 to 64 * alphanumeric characters or hyphens
Must contain only lowercase * letters, numbers, underscore, plus sign, period (dot), at symbol (@), or * hyphen.
First character must be a letter.
Must not contain a colon ( : ) or slash ( / ).
Cannot be a * reserved word. A list of reserved words can be found in Reserved * Words in the Amazon Redshift Database Developer Guide.
A list of the names of existing database groups that the user named in
* DbUser
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.
Database group name constraints
Must be 1 to 64 * alphanumeric characters or hyphens
Must contain only lowercase * letters, numbers, underscore, plus sign, period (dot), at symbol (@), or * hyphen.
First character must be a letter.
Must not contain a colon ( : ) or slash ( / ).
Cannot be a * reserved word. A list of reserved words can be found in Reserved * Words in the Amazon Redshift Database Developer Guide.
A list of the names of existing database groups that the user named in
* DbUser
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.
Database group name constraints
Must be 1 to 64 * alphanumeric characters or hyphens
Must contain only lowercase * letters, numbers, underscore, plus sign, period (dot), at symbol (@), or * hyphen.
First character must be a letter.
Must not contain a colon ( : ) or slash ( / ).
Cannot be a * reserved word. A list of reserved words can be found in Reserved * Words in the Amazon Redshift Database Developer Guide.
The custom domain name for the cluster credentials.
*/ inline const Aws::String& GetCustomDomainName() const{ return m_customDomainName; } /** *The custom domain name for the cluster credentials.
*/ inline bool CustomDomainNameHasBeenSet() const { return m_customDomainNameHasBeenSet; } /** *The custom domain name for the cluster credentials.
*/ inline void SetCustomDomainName(const Aws::String& value) { m_customDomainNameHasBeenSet = true; m_customDomainName = value; } /** *The custom domain name for the cluster credentials.
*/ inline void SetCustomDomainName(Aws::String&& value) { m_customDomainNameHasBeenSet = true; m_customDomainName = std::move(value); } /** *The custom domain name for the cluster credentials.
*/ inline void SetCustomDomainName(const char* value) { m_customDomainNameHasBeenSet = true; m_customDomainName.assign(value); } /** *The custom domain name for the cluster credentials.
*/ inline GetClusterCredentialsRequest& WithCustomDomainName(const Aws::String& value) { SetCustomDomainName(value); return *this;} /** *The custom domain name for the cluster credentials.
*/ inline GetClusterCredentialsRequest& WithCustomDomainName(Aws::String&& value) { SetCustomDomainName(std::move(value)); return *this;} /** *The custom domain name for the cluster credentials.
*/ inline GetClusterCredentialsRequest& WithCustomDomainName(const char* value) { SetCustomDomainName(value); return *this;} private: Aws::String m_dbUser; bool m_dbUserHasBeenSet = false; Aws::String m_dbName; bool m_dbNameHasBeenSet = false; Aws::String m_clusterIdentifier; bool m_clusterIdentifierHasBeenSet = false; int m_durationSeconds; bool m_durationSecondsHasBeenSet = false; bool m_autoCreate; bool m_autoCreateHasBeenSet = false; Aws::Vector