CfnAssignmentProps

class aws_cdk.aws_sso.CfnAssignmentProps(*, instance_arn, permission_set_arn, principal_id, principal_type, target_id, target_type)

Bases: object

Properties for defining a CfnAssignment.

Parameters
  • instance_arn (str) – The ARN of the IAM Identity Center 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 .

  • permission_set_arn (str) – The ARN of the permission set.

  • principal_id (str) – An identifier for an object in IAM Identity Center, such as a user or group. 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 .

  • principal_type (str) – The entity type for which the assignment will be created.

  • target_id (str) – TargetID is an AWS account identifier, typically a 10-12 digit string (For example, 123456789012).

  • target_type (str) – The entity type for which the assignment will be created.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sso-assignment.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_sso as sso

cfn_assignment_props = sso.CfnAssignmentProps(
    instance_arn="instanceArn",
    permission_set_arn="permissionSetArn",
    principal_id="principalId",
    principal_type="principalType",
    target_id="targetId",
    target_type="targetType"
)

Attributes

instance_arn

The ARN of the IAM Identity Center 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 .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sso-assignment.html#cfn-sso-assignment-instancearn

Return type

str

permission_set_arn

The ARN of the permission set.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sso-assignment.html#cfn-sso-assignment-permissionsetarn

Return type

str

principal_id

An identifier for an object in IAM Identity Center, such as a user or group.

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 .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sso-assignment.html#cfn-sso-assignment-principalid

Return type

str

principal_type

The entity type for which the assignment will be created.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sso-assignment.html#cfn-sso-assignment-principaltype

Return type

str

target_id

TargetID is an AWS account identifier, typically a 10-12 digit string (For example, 123456789012).

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sso-assignment.html#cfn-sso-assignment-targetid

Return type

str

target_type

The entity type for which the assignment will be created.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sso-assignment.html#cfn-sso-assignment-targettype

Return type

str