AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Class: Aws::QuickSight::Types::RowLevelPermissionDataSet

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb

Overview

Note:

When making an API call, you may pass RowLevelPermissionDataSet data as a hash:

{
  namespace: "Namespace",
  arn: "Arn", # required
  permission_policy: "GRANT_ACCESS", # required, accepts GRANT_ACCESS, DENY_ACCESS
  format_version: "VERSION_1", # accepts VERSION_1, VERSION_2
  status: "ENABLED", # accepts ENABLED, DISABLED
}

Information about a dataset that contains permissions for row-level security (RLS). The permissions dataset maps fields to users or groups. For more information, see Using Row-Level Security (RLS) to Restrict Access to a Dataset in the Amazon QuickSight User Guide.

The option to deny permissions by setting PermissionPolicy to DENY_ACCESS is not supported for new RLS datasets.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#arnString

The Amazon Resource Name (ARN) of the dataset that contains permissions for RLS.

Returns:

  • (String)


10688
10689
10690
10691
10692
10693
10694
10695
10696
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 10688

class RowLevelPermissionDataSet < Struct.new(
  :namespace,
  :arn,
  :permission_policy,
  :format_version,
  :status)
  SENSITIVE = []
  include Aws::Structure
end

#format_versionString

The user or group rules associated with the dataset that contains permissions for RLS.

By default, FormatVersion is VERSION_1. When FormatVersion is VERSION_1, UserName and GroupName are required. When FormatVersion is VERSION_2, UserARN and GroupARN are required, and Namespace must not exist.

Returns:

  • (String)


10688
10689
10690
10691
10692
10693
10694
10695
10696
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 10688

class RowLevelPermissionDataSet < Struct.new(
  :namespace,
  :arn,
  :permission_policy,
  :format_version,
  :status)
  SENSITIVE = []
  include Aws::Structure
end

#namespaceString

The namespace associated with the dataset that contains permissions for RLS.

Returns:

  • (String)


10688
10689
10690
10691
10692
10693
10694
10695
10696
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 10688

class RowLevelPermissionDataSet < Struct.new(
  :namespace,
  :arn,
  :permission_policy,
  :format_version,
  :status)
  SENSITIVE = []
  include Aws::Structure
end

#permission_policyString

The type of permissions to use when interpreting the permissions for RLS. DENY_ACCESS is included for backward compatibility only.

Returns:

  • (String)


10688
10689
10690
10691
10692
10693
10694
10695
10696
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 10688

class RowLevelPermissionDataSet < Struct.new(
  :namespace,
  :arn,
  :permission_policy,
  :format_version,
  :status)
  SENSITIVE = []
  include Aws::Structure
end

#statusString

The status of the row-level security permission dataset. If enabled, the status is ENABLED. If disabled, the status is DISABLED.

Returns:

  • (String)


10688
10689
10690
10691
10692
10693
10694
10695
10696
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 10688

class RowLevelPermissionDataSet < Struct.new(
  :namespace,
  :arn,
  :permission_policy,
  :format_version,
  :status)
  SENSITIVE = []
  include Aws::Structure
end