Struct aws_sdk_quicksight::types::RedshiftIamParameters
source · #[non_exhaustive]pub struct RedshiftIamParameters {
pub role_arn: String,
pub database_user: String,
pub database_groups: Option<Vec<String>>,
pub auto_create_database_user: bool,
}
Expand description
A structure that grants Amazon QuickSight access to your cluster and make a call to the redshift:GetClusterCredentials
API. For more information on the redshift:GetClusterCredentials
API, see GetClusterCredentials
.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.role_arn: String
Use the RoleArn
structure to allow Amazon QuickSight to call redshift:GetClusterCredentials
on your cluster. The calling principal must have iam:PassRole
access to pass the role to Amazon QuickSight. The role's trust policy must allow the Amazon QuickSight service principal to assume the role.
database_user: String
The user whose permissions and group memberships will be used by Amazon QuickSight to access the cluster. If this user already exists in your database, Amazon QuickSight is granted the same permissions that the user has. If the user doesn't exist, set the value of AutoCreateDatabaseUser
to True
to create a new user with PUBLIC permissions.
database_groups: Option<Vec<String>>
A list of groups whose permissions will be granted to Amazon QuickSight to access the cluster. These permissions are combined with the permissions granted to Amazon QuickSight by the DatabaseUser
. If you choose to include this parameter, the RoleArn
must grant access to redshift:JoinGroup
.
auto_create_database_user: bool
Automatically creates a database user. If your database doesn't have a DatabaseUser
, set this parameter to True
. If there is no DatabaseUser
, Amazon QuickSight can't connect to your cluster. The RoleArn
that you use for this operation must grant access to redshift:CreateClusterUser
to successfully create the user.
Implementations§
source§impl RedshiftIamParameters
impl RedshiftIamParameters
sourcepub fn role_arn(&self) -> &str
pub fn role_arn(&self) -> &str
Use the RoleArn
structure to allow Amazon QuickSight to call redshift:GetClusterCredentials
on your cluster. The calling principal must have iam:PassRole
access to pass the role to Amazon QuickSight. The role's trust policy must allow the Amazon QuickSight service principal to assume the role.
sourcepub fn database_user(&self) -> &str
pub fn database_user(&self) -> &str
The user whose permissions and group memberships will be used by Amazon QuickSight to access the cluster. If this user already exists in your database, Amazon QuickSight is granted the same permissions that the user has. If the user doesn't exist, set the value of AutoCreateDatabaseUser
to True
to create a new user with PUBLIC permissions.
sourcepub fn database_groups(&self) -> &[String]
pub fn database_groups(&self) -> &[String]
A list of groups whose permissions will be granted to Amazon QuickSight to access the cluster. These permissions are combined with the permissions granted to Amazon QuickSight by the DatabaseUser
. If you choose to include this parameter, the RoleArn
must grant access to redshift:JoinGroup
.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .database_groups.is_none()
.
sourcepub fn auto_create_database_user(&self) -> bool
pub fn auto_create_database_user(&self) -> bool
Automatically creates a database user. If your database doesn't have a DatabaseUser
, set this parameter to True
. If there is no DatabaseUser
, Amazon QuickSight can't connect to your cluster. The RoleArn
that you use for this operation must grant access to redshift:CreateClusterUser
to successfully create the user.
source§impl RedshiftIamParameters
impl RedshiftIamParameters
sourcepub fn builder() -> RedshiftIamParametersBuilder
pub fn builder() -> RedshiftIamParametersBuilder
Creates a new builder-style object to manufacture RedshiftIamParameters
.
Trait Implementations§
source§impl Clone for RedshiftIamParameters
impl Clone for RedshiftIamParameters
source§fn clone(&self) -> RedshiftIamParameters
fn clone(&self) -> RedshiftIamParameters
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for RedshiftIamParameters
impl Debug for RedshiftIamParameters
source§impl PartialEq for RedshiftIamParameters
impl PartialEq for RedshiftIamParameters
source§fn eq(&self, other: &RedshiftIamParameters) -> bool
fn eq(&self, other: &RedshiftIamParameters) -> bool
self
and other
values to be equal, and is used
by ==
.impl StructuralPartialEq for RedshiftIamParameters
Auto Trait Implementations§
impl Freeze for RedshiftIamParameters
impl RefUnwindSafe for RedshiftIamParameters
impl Send for RedshiftIamParameters
impl Sync for RedshiftIamParameters
impl Unpin for RedshiftIamParameters
impl UnwindSafe for RedshiftIamParameters
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more