Package software.amazon.awscdk.services.sso

Interface CfnAssignmentProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnAssignmentProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-15T10:25:07.843Z")
@Stability(Stable)
public interface CfnAssignmentProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnAssignment.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.sso.*;
 CfnAssignmentProps cfnAssignmentProps = CfnAssignmentProps.builder()
         .instanceArn("instanceArn")
         .permissionSetArn("permissionSetArn")
         .principalId("principalId")
         .principalType("principalType")
         .targetId("targetId")
         .targetType("targetType")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnAssignmentProps.Builder	A builder for CfnAssignmentProps
static final class	CfnAssignmentProps.Jsii$Proxy	An implementation for CfnAssignmentProps

Method Summary

Modifier and Type	Method	Description
static CfnAssignmentProps.Builder	builder()
String	getInstanceArn()	The ARN of the IAM Identity Center instance under which the operation will be executed.
String	getPermissionSetArn()	The ARN of the permission set.
String	getPrincipalId()	An identifier for an object in IAM Identity Center, such as a user or group.
String	getPrincipalType()	The entity type for which the assignment will be created.
String	getTargetId()	TargetID is an AWS account identifier, (For example, 123456789012).
String	getTargetType()	The entity type for which the assignment will be created.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getInstanceArn

@Stability(Stable)
@NotNull
String getInstanceArn()

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 .

See Also:

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

getPermissionSetArn

@Stability(Stable)
@NotNull
String getPermissionSetArn()

The ARN of the permission set.

See Also:

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

getPrincipalId

@Stability(Stable)
@NotNull
String getPrincipalId()

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 .

See Also:

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

getPrincipalType

@Stability(Stable)
@NotNull
String getPrincipalType()

The entity type for which the assignment will be created.

See Also:

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

getTargetId

@Stability(Stable)
@NotNull
String getTargetId()

TargetID is an AWS account identifier, (For example, 123456789012).

See Also:

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

getTargetType

@Stability(Stable)
@NotNull
String getTargetType()

The entity type for which the assignment will be created.

See Also:

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

builder

@Stability(Stable)
static CfnAssignmentProps.Builder builder()

Returns:

a CfnAssignmentProps.Builder of CfnAssignmentProps