Package software.amazon.awscdk.services.sso

Class CfnAssignment

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.sso.CfnAssignment
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:35.855Z") @Stability(Stable) public class CfnAssignment extends CfnResource implements IInspectable
A CloudFormation AWS::SSO::Assignment.

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();

  • 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 Construct scope, @NotNull String id, @NotNull CfnAssignmentProps props)
      Create a new AWS::SSO::Assignment.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      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.

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

    • setInstanceArn

      @Stability(Stable) public void setInstanceArn(@NotNull String value)
      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 .

    • 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.

      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 .

    • setPrincipalId

      @Stability(Stable) public void setPrincipalId(@NotNull String value)
      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 .

    • 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.