Skip to content
v2.275.0

CfnAssignmentProps Struct Added in v2.275.0 ​

Properties for defining a CfnAssignment.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_quicksight as quicksight } from 'aws-cdk-lib';
const cfnAssignmentProps: quicksight.CfnAssignmentProps = {
  assignmentName: 'assignmentName',
  assignmentStatus: 'assignmentStatus',
  namespace: 'namespace',

  // the properties below are optional
  identities: {
    identitiesKey: ['identities'],
  },
  policyArn: 'policyArn',
};

Properties ​

assignmentNamestringassignment_namestrassignmentNameStringAssignmentNamestringAssignmentName*stringrequired#
The name of the assignment, also called a rule.

The name must be unique within the AWS account.

assignmentStatusstringassignment_statusstrassignmentStatusStringAssignmentStatusstringAssignmentStatus*stringrequired#
The status of the assignment.
identitiesoptionalIResolvable | { [key: string]: string[] }identitiesoptionaltyping.Union[IResolvable, typing.Mapping[str, typing.List[str]]]identitiesoptionalIResolvableIdentitiesoptionalIResolvableIdentitiesoptionalinterface{}#
The QuickSight users, groups, or both that you want to assign the policy to.

This maps identity type to a list of identity names.

namespacestringnamespacestrnamespaceStringNamespacestringNamespace*stringrequired#
The namespace that contains the assignment.
policyArnoptionalstringpolicy_arnoptionalstrpolicyArnoptionalStringPolicyArnoptionalstringPolicyArnoptional*string#
The ARN for the IAM policy to apply to the QuickSight users and groups specified in this assignment.