java.lang.Object
- software.amazon.awssdk.services.quicksight.model.RedshiftIAMParameters

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<RedshiftIAMParameters.Builder,RedshiftIAMParameters>
```
@Generated("software.amazon.awssdk:codegen")
public final class RedshiftIAMParameters
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<RedshiftIAMParameters.Builder,RedshiftIAMParameters>
```
A structure that grants QuickSight access to your cluster and make a call to the redshift:GetClusterCredentials API. For more information on the redshift:GetClusterCredentials API, see GetClusterCredentials .

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface RedshiftIAMParameters.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Boolean`	`autoCreateDatabaseUser()`	Automatically creates a database user.
`static RedshiftIAMParameters.Builder`	`builder()`
`List<String>`	`databaseGroups()`	A list of groups whose permissions will be granted to QuickSight to access the cluster.
`String`	`databaseUser()`	The user whose permissions and group memberships will be used by QuickSight to access the cluster.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasDatabaseGroups()`	For responses, this returns true if the service returned a value for the DatabaseGroups property.
`int`	`hashCode()`
`String`	`roleArn()`	Use the `RoleArn` structure to allow QuickSight to call `redshift:GetClusterCredentials` on your cluster.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends RedshiftIAMParameters.Builder>`	`serializableBuilderClass()`
`RedshiftIAMParameters.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - roleArn
```
public final String roleArn()
```
    Use the RoleArn structure to allow QuickSight to call redshift:GetClusterCredentials on your cluster. The calling principal must have iam:PassRole access to pass the role to QuickSight. The role's trust policy must allow the QuickSight service principal to assume the role.
    
    Returns:
    
    Use the RoleArn structure to allow QuickSight to call redshift:GetClusterCredentials on your cluster. The calling principal must have iam:PassRole access to pass the role to QuickSight. The role's trust policy must allow the QuickSight service principal to assume the role.
  - databaseUser
```
public final String databaseUser()
```
    The user whose permissions and group memberships will be used by QuickSight to access the cluster. If this user already exists in your database, 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.
    
    Returns:
    
    The user whose permissions and group memberships will be used by QuickSight to access the cluster. If this user already exists in your database, 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.
  - hasDatabaseGroups
```
public final boolean hasDatabaseGroups()
```
    For responses, this returns true if the service returned a value for the DatabaseGroups property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - databaseGroups
```
public final List<String> databaseGroups()
```
    A list of groups whose permissions will be granted to QuickSight to access the cluster. These permissions are combined with the permissions granted to QuickSight by the DatabaseUser. If you choose to include this parameter, the RoleArn must grant access to redshift:JoinGroup.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasDatabaseGroups() method.
    
    Returns:
    
    A list of groups whose permissions will be granted to QuickSight to access the cluster. These permissions are combined with the permissions granted to QuickSight by the DatabaseUser. If you choose to include this parameter, the RoleArn must grant access to redshift:JoinGroup.
  - autoCreateDatabaseUser
```
public final Boolean autoCreateDatabaseUser()
```
    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.
    
    Returns:
    
    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.
  - toBuilder
```
public RedshiftIAMParameters.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<RedshiftIAMParameters.Builder,RedshiftIAMParameters>
  - builder
```
public static RedshiftIAMParameters.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends RedshiftIAMParameters.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class RedshiftIAMParameters

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

roleArn

databaseUser

hasDatabaseGroups

databaseGroups

autoCreateDatabaseUser

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField