Package software.amazon.awscdk.services.sso

Class CfnAssignment

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.sso.CfnAssignment
All Implemented Interfaces:
IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)", date="2024-10-11T15:56:06.590Z") @Stability(Stable) public class CfnAssignment extends CfnResource implements IInspectable
Assigns access to a Principal for a specified AWS account using a specified permission set.

The term principal here refers to a user or group that is defined in IAM Identity Center .

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.*;
 CfnAssignment cfnAssignment = CfnAssignment.Builder.create(this, "MyCfnAssignment")
         .instanceArn("instanceArn")
         .permissionSetArn("permissionSetArn")
         .principalId("principalId")
         .principalType("principalType")
         .targetId("targetId")
         .targetType("targetType")
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnAssignment

      protected CfnAssignment(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnAssignment

      protected CfnAssignment(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnAssignment

      @Stability(Stable) public CfnAssignment(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnAssignmentProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getInstanceArn

      @Stability(Stable) @NotNull public String getInstanceArn()
      The ARN of the IAM Identity Center instance under which the operation will be executed.

    • setInstanceArn

      @Stability(Stable) public void setInstanceArn(@NotNull String value)
      The ARN of the IAM Identity Center instance under which the operation will be executed.

    • getPermissionSetArn

      @Stability(Stable) @NotNull public String getPermissionSetArn()
      The ARN of the permission set.

    • setPermissionSetArn

      @Stability(Stable) public void setPermissionSetArn(@NotNull String value)
      The ARN of the permission set.

    • getPrincipalId

      @Stability(Stable) @NotNull public String getPrincipalId()
      An identifier for an object in IAM Identity Center, such as a user or group.

    • setPrincipalId

      @Stability(Stable) public void setPrincipalId(@NotNull String value)
      An identifier for an object in IAM Identity Center, such as a user or group.

    • getPrincipalType

      @Stability(Stable) @NotNull public String getPrincipalType()
      The entity type for which the assignment will be created.

    • setPrincipalType

      @Stability(Stable) public void setPrincipalType(@NotNull String value)
      The entity type for which the assignment will be created.

    • getTargetId

      @Stability(Stable) @NotNull public String getTargetId()
      TargetID is an AWS account identifier, (For example, 123456789012).

    • setTargetId

      @Stability(Stable) public void setTargetId(@NotNull String value)
      TargetID is an AWS account identifier, (For example, 123456789012).

    • getTargetType

      @Stability(Stable) @NotNull public String getTargetType()
      The entity type for which the assignment will be created.

    • setTargetType

      @Stability(Stable) public void setTargetType(@NotNull String value)
      The entity type for which the assignment will be created.