Interface UpdateResourcePermissionsRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<UpdateResourcePermissionsRequest.Builder,UpdateResourcePermissionsRequest>, QuickSightRequest.Builder, SdkBuilder<UpdateResourcePermissionsRequest.Builder,UpdateResourcePermissionsRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
UpdateResourcePermissionsRequest
@Mutable @NotThreadSafe public static interface UpdateResourcePermissionsRequest.Builder extends QuickSightRequest.Builder, SdkPojo, CopyableBuilder<UpdateResourcePermissionsRequest.Builder,UpdateResourcePermissionsRequest>

  • Method Details

    • awsAccountId

      UpdateResourcePermissionsRequest.Builder awsAccountId(String awsAccountId)

      The ID of the Amazon Web Services account whose service role configuration you want to update.

      Parameters:
      awsAccountId - The ID of the Amazon Web Services account whose service role configuration you want to update.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • roleType

      UpdateResourcePermissionsRequest.Builder roleType(String roleType)

      The type of service role that you want Amazon Quick Sight to use. The only supported value for this operation is CUSTOMER_MANAGED. Requests that specify QUICKSIGHT_MANAGED are rejected.

      Parameters:
      roleType - The type of service role that you want Amazon Quick Sight to use. The only supported value for this operation is CUSTOMER_MANAGED. Requests that specify QUICKSIGHT_MANAGED are rejected.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • roleType

      UpdateResourcePermissionsRequest.Builder roleType(ServiceRoleType roleType)

      The type of service role that you want Amazon Quick Sight to use. The only supported value for this operation is CUSTOMER_MANAGED. Requests that specify QUICKSIGHT_MANAGED are rejected.

      Parameters:
      roleType - The type of service role that you want Amazon Quick Sight to use. The only supported value for this operation is CUSTOMER_MANAGED. Requests that specify QUICKSIGHT_MANAGED are rejected.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • customerManagedRoleArn

      UpdateResourcePermissionsRequest.Builder customerManagedRoleArn(String customerManagedRoleArn)

      The ARN of the customer-managed role that you want Amazon Quick Sight to use. To use this operation, you must have the iam:PassRole permission for the role.

      Configure the role as follows:

      • The role must belong to the Amazon Web Services account specified by AwsAccountId.

      • Configure the role trust policy to allow the Amazon Quick Sight service principal to call sts:AssumeRole.

      • Attach a permissions policy that allows access to the resources that you want Amazon Quick Sight to use.

      • To use features that rely on session tags, configure the role trust policy to allow the Amazon Quick Sight service principal to call sts:TagSession.

      If the role doesn't exist or its trust policy doesn't allow sts:AssumeRole, the request returns an AccessDeniedException.

      When you call this operation, Amazon Quick Sight attempts to assume the role with session tags and records whether the attempt succeeds. If you later add or remove sts:TagSession from the trust policy, call this operation again with the same role ARN to refresh the stored capability.

      Parameters:
      customerManagedRoleArn - The ARN of the customer-managed role that you want Amazon Quick Sight to use. To use this operation, you must have the iam:PassRole permission for the role.

      Configure the role as follows:

      • The role must belong to the Amazon Web Services account specified by AwsAccountId.

      • Configure the role trust policy to allow the Amazon Quick Sight service principal to call sts:AssumeRole.

      • Attach a permissions policy that allows access to the resources that you want Amazon Quick Sight to use.

      • To use features that rely on session tags, configure the role trust policy to allow the Amazon Quick Sight service principal to call sts:TagSession.

      If the role doesn't exist or its trust policy doesn't allow sts:AssumeRole, the request returns an AccessDeniedException.

      When you call this operation, Amazon Quick Sight attempts to assume the role with session tags and records whether the attempt succeeds. If you later add or remove sts:TagSession from the trust policy, call this operation again with the same role ARN to refresh the stored capability.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      UpdateResourcePermissionsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      UpdateResourcePermissionsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.