Class: Aws::QuickSight::Types::CreateIAMPolicyAssignmentRequest

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 CreateIAMPolicyAssignmentRequest data as a hash:

{
  aws_account_id: "AwsAccountId", # required
  assignment_name: "IAMPolicyAssignmentName", # required
  assignment_status: "ENABLED", # required, accepts ENABLED, DRAFT, DISABLED
  policy_arn: "Arn",
  identities: {
    "String" => ["IdentityName"],
  },
  namespace: "Namespace", # required
}

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#assignment_name ⇒ String

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

Returns:

  • (String) 


2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 2368

class CreateIAMPolicyAssignmentRequest < Struct.new(
  :aws_account_id,
  :assignment_name,
  :assignment_status,
  :policy_arn,
  :identities,
  :namespace)
  SENSITIVE = []
  include Aws::Structure
end

#assignment_status ⇒ String

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.

Returns:

  • (String) 


2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 2368

class CreateIAMPolicyAssignmentRequest < Struct.new(
  :aws_account_id,
  :assignment_name,
  :assignment_status,
  :policy_arn,
  :identities,
  :namespace)
  SENSITIVE = []
  include Aws::Structure
end

#aws_account_id ⇒ String

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

Returns:

  • (String) 


2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 2368

class CreateIAMPolicyAssignmentRequest < Struct.new(
  :aws_account_id,
  :assignment_name,
  :assignment_status,
  :policy_arn,
  :identities,
  :namespace)
  SENSITIVE = []
  include Aws::Structure
end

#identities ⇒ Hash<String,Array<String>>

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

Returns:

  • (Hash<String,Array<String>>) 


2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 2368

class CreateIAMPolicyAssignmentRequest < Struct.new(
  :aws_account_id,
  :assignment_name,
  :assignment_status,
  :policy_arn,
  :identities,
  :namespace)
  SENSITIVE = []
  include Aws::Structure
end

#namespace ⇒ String

The namespace that contains the assignment.

Returns:

  • (String) 


2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 2368

class CreateIAMPolicyAssignmentRequest < Struct.new(
  :aws_account_id,
  :assignment_name,
  :assignment_status,
  :policy_arn,
  :identities,
  :namespace)
  SENSITIVE = []
  include Aws::Structure
end

#policy_arn ⇒ String

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

Returns:

  • (String) 


2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 2368

class CreateIAMPolicyAssignmentRequest < Struct.new(
  :aws_account_id,
  :assignment_name,
  :assignment_status,
  :policy_arn,
  :identities,
  :namespace)
  SENSITIVE = []
  include Aws::Structure
end