Interface RedshiftIAMParameters.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<RedshiftIAMParameters.Builder,
,RedshiftIAMParameters> SdkBuilder<RedshiftIAMParameters.Builder,
,RedshiftIAMParameters> SdkPojo
- Enclosing class:
RedshiftIAMParameters
-
Method Summary
Modifier and TypeMethodDescriptionautoCreateDatabaseUser
(Boolean autoCreateDatabaseUser) Automatically creates a database user.databaseGroups
(String... databaseGroups) A list of groups whose permissions will be granted to Amazon QuickSight to access the cluster.databaseGroups
(Collection<String> databaseGroups) A list of groups whose permissions will be granted to Amazon QuickSight to access the cluster.databaseUser
(String databaseUser) The user whose permissions and group memberships will be used by Amazon QuickSight to access the cluster.Use theRoleArn
structure to allow Amazon QuickSight to callredshift:GetClusterCredentials
on your cluster.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
roleArn
Use the
RoleArn
structure to allow Amazon QuickSight to callredshift:GetClusterCredentials
on your cluster. The calling principal must haveiam: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.- Parameters:
roleArn
- Use theRoleArn
structure to allow Amazon QuickSight to callredshift:GetClusterCredentials
on your cluster. The calling principal must haveiam: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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
databaseUser
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
toTrue
to create a new user with PUBLIC permissions.- Parameters:
databaseUser
- 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 ofAutoCreateDatabaseUser
toTrue
to create a new user with PUBLIC permissions.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
databaseGroups
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, theRoleArn
must grant access toredshift:JoinGroup
.- Parameters:
databaseGroups
- 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 theDatabaseUser
. If you choose to include this parameter, theRoleArn
must grant access toredshift:JoinGroup
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
databaseGroups
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, theRoleArn
must grant access toredshift:JoinGroup
.- Parameters:
databaseGroups
- 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 theDatabaseUser
. If you choose to include this parameter, theRoleArn
must grant access toredshift:JoinGroup
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
autoCreateDatabaseUser
Automatically creates a database user. If your database doesn't have a
DatabaseUser
, set this parameter toTrue
. If there is noDatabaseUser
, Amazon QuickSight can't connect to your cluster. TheRoleArn
that you use for this operation must grant access toredshift:CreateClusterUser
to successfully create the user.- Parameters:
autoCreateDatabaseUser
- Automatically creates a database user. If your database doesn't have aDatabaseUser
, set this parameter toTrue
. If there is noDatabaseUser
, Amazon QuickSight can't connect to your cluster. TheRoleArn
that you use for this operation must grant access toredshift:CreateClusterUser
to successfully create the user.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-