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
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#assignment_nameString

The name of the assignment. It must be unique within an AWS account.

Returns:

  • (String)


1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 1970

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

#assignment_statusString

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)


1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 1970

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

#aws_account_idString

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

Returns:

  • (String)


1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 1970

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

#identitiesHash<String,Array<String>>

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

Returns:

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


1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 1970

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

#namespaceString

The namespace that contains the assignment.

Returns:

  • (String)


1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 1970

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

#policy_arnString

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

Returns:

  • (String)


1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 1970

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