software.amazon.awssdk.services.quicksight.model

Class CreateIamPolicyAssignmentRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.quicksight.model.QuickSightRequest

software.amazon.awssdk.services.quicksight.model.CreateIamPolicyAssignmentRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateIamPolicyAssignmentRequest.Builder,CreateIamPolicyAssignmentRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateIamPolicyAssignmentRequest
extends QuickSightRequest
implements ToCopyableBuilder<CreateIamPolicyAssignmentRequest.Builder,CreateIamPolicyAssignmentRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateIamPolicyAssignmentRequest.Builder

Method Summary

Modifier and Type	Method and Description
String	assignmentName() The name of the assignment, also called a rule.
AssignmentStatus	assignmentStatus() The status of the assignment.
String	assignmentStatusAsString() The status of the assignment.
String	awsAccountId() The ID of the AWS account where you want to assign an IAM policy to QuickSight users or groups.
static CreateIamPolicyAssignmentRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasIdentities() Returns true if the Identities property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
Map<String,List<String>>	identities() The QuickSight users, groups, or both that you want to assign the policy to.
String	namespace() The namespace that contains the assignment.
String	policyArn() The ARN for the IAM policy to apply to the QuickSight users and groups specified in this assignment.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateIamPolicyAssignmentRequest.Builder>	serializableBuilderClass()
CreateIamPolicyAssignmentRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

awsAccountId

public String awsAccountId()

The ID of the AWS account where you want to assign an IAM policy to QuickSight users or groups.

Returns:

The ID of the AWS account where you want to assign an IAM policy to QuickSight users or groups.

assignmentName

public String assignmentName()

The name of the assignment, also called a rule. It must be unique within an AWS account.

Returns:

The name of the assignment, also called a rule. It must be unique within an AWS account.

assignmentStatus

public AssignmentStatus assignmentStatus()

The status of the assignment. Possible values are as follows:

• ENABLED - Anything specified in this assignment is used when creating the data source.

• DISABLED - This assignment isn't used when creating the data source.

• DRAFT - This assignment is an unfinished draft and isn't used when creating the data source.

If the service returns an enum value that is not available in the current SDK version, assignmentStatus will return AssignmentStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from assignmentStatusAsString().

Returns:

The status of the assignment. Possible values are as follows:

• ENABLED - Anything specified in this assignment is used when creating the data source.

• DISABLED - This assignment isn't used when creating the data source.

• DRAFT - This assignment is an unfinished draft and isn't used when creating the data source.

See Also:

AssignmentStatus

assignmentStatusAsString

public String assignmentStatusAsString()

The status of the assignment. Possible values are as follows:

• ENABLED - Anything specified in this assignment is used when creating the data source.

• DISABLED - This assignment isn't used when creating the data source.

• DRAFT - This assignment is an unfinished draft and isn't used when creating the data source.

If the service returns an enum value that is not available in the current SDK version, assignmentStatus will return AssignmentStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from assignmentStatusAsString().

Returns:

The status of the assignment. Possible values are as follows:

• ENABLED - Anything specified in this assignment is used when creating the data source.

• DISABLED - This assignment isn't used when creating the data source.

• DRAFT - This assignment is an unfinished draft and isn't used when creating the data source.

See Also:

AssignmentStatus

policyArn

public String policyArn()

The ARN for the IAM policy to apply to the QuickSight users and groups specified in this assignment.

Returns:

The ARN for the IAM policy to apply to the QuickSight users and groups specified in this assignment.

hasIdentities

public boolean hasIdentities()

Returns true if the Identities property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

identities

public Map<String,List<String>> identities()

The QuickSight users, groups, or both that you want to assign the policy to.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasIdentities() to see if a value was sent in this field.

Returns:

The QuickSight users, groups, or both that you want to assign the policy to.

namespace

public String namespace()

The namespace that contains the assignment.

Returns:

The namespace that contains the assignment.

toBuilder

public CreateIamPolicyAssignmentRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateIamPolicyAssignmentRequest.Builder,CreateIamPolicyAssignmentRequest>

Specified by:

toBuilder in class QuickSightRequest

builder

public static CreateIamPolicyAssignmentRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateIamPolicyAssignmentRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo