AWS CDK Reference

Appearance

v2.274.0

CfnAssignmentProps Struct ​

Properties for defining a CfnAssignment.

Source
Generated code

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_sso as sso } from 'aws-cdk-lib';
const cfnAssignmentProps: sso.CfnAssignmentProps = {
  instanceArn: 'instanceArn',
  permissionSetArn: 'permissionSetArn',
  principalId: 'principalId',
  principalType: 'principalType',
  targetId: 'targetId',
  targetType: 'targetType',
};

Properties ​

instanceArnstringinstance_arnstrinstanceArnStringInstanceArnstringInstanceArn*stringrequired#
The ARN of the instance under which the operation will be executed.

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference .

permissionSetArnstringpermission_set_arnstrpermissionSetArnStringPermissionSetArnstringPermissionSetArn*stringrequired#
The ARN of the permission set.
principalIdstringprincipal_idstrprincipalIdStringPrincipalIdstringPrincipalId*stringrequired#
An identifier for an object in IAM Identity Center, such as a user or group.
notes

PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6). For more information about PrincipalIds in IAM Identity Center, see the IAM Identity Center Identity Store API Reference .

principalTypestringprincipal_typestrprincipalTypeStringPrincipalTypestringPrincipalType*stringrequired#
The entity type for which the assignment will be created.
targetIdstringtarget_idstrtargetIdStringTargetIdstringTargetId*stringrequired#
TargetID is an AWS account identifier, (For example, 123456789012).
targetTypestringtarget_typestrtargetTypeStringTargetTypestringTargetType*stringrequired#
The entity type for which the assignment will be created.