Package software.amazon.awscdk.services.sso

Class CfnPermissionSet

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.CfnPermissionSet
All Implemented Interfaces:
IInspectable, IEnvironmentAware, IPermissionSetRef, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)", date="2025-12-05T22:26:46.197Z") @Stability(Stable) public class CfnPermissionSet extends CfnResource implements IInspectable, IPermissionSetRef, ITaggable
Specifies a permission set within a specified IAM Identity Center instance.

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.*;
 Object inlinePolicy;
 CfnPermissionSet cfnPermissionSet = CfnPermissionSet.Builder.create(this, "MyCfnPermissionSet")
         .instanceArn("instanceArn")
         .name("name")
         // the properties below are optional
         .customerManagedPolicyReferences(List.of(CustomerManagedPolicyReferenceProperty.builder()
                 .name("name")
                 // the properties below are optional
                 .path("path")
                 .build()))
         .description("description")
         .inlinePolicy(inlinePolicy)
         .managedPolicies(List.of("managedPolicies"))
         .permissionsBoundary(PermissionsBoundaryProperty.builder()
                 .customerManagedPolicyReference(CustomerManagedPolicyReferenceProperty.builder()
                         .name("name")
                         // the properties below are optional
                         .path("path")
                         .build())
                 .managedPolicyArn("managedPolicyArn")
                 .build())
         .relayStateType("relayStateType")
         .sessionDuration("sessionDuration")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .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

    • CfnPermissionSet

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

    • CfnPermissionSet

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

    • CfnPermissionSet

      @Stability(Stable) public CfnPermissionSet(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnPermissionSetProps props)
      Create a new AWS::SSO::PermissionSet.

      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

    • arnForPermissionSet

      @Stability(Stable) @NotNull public static String arnForPermissionSet(@NotNull IPermissionSetRef resource)
      Parameters:
      resource - This parameter is required.

    • isCfnPermissionSet

      @Stability(Stable) @NotNull public static Boolean isCfnPermissionSet(@NotNull Object x)
      Checks whether the given object is a CfnPermissionSet.

      Parameters:
      x - This parameter is required.

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

    • getAttrPermissionSetArn

      @Stability(Stable) @NotNull public String getAttrPermissionSetArn()
      The permission set ARN of the permission set, such as arn:aws:sso:::permissionSet/ins-instanceid/ps-permissionsetid .

    • getCfnProperties

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

    • getPermissionSetRef

      @Stability(Stable) @NotNull public PermissionSetReference getPermissionSetRef()
      A reference to a PermissionSet resource.
      Specified by:
      getPermissionSetRef in interface IPermissionSetRef

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

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

    • getName

      @Stability(Stable) @NotNull public String getName()
      The name of the permission set.

    • setName

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

    • getCustomerManagedPolicyReferences

      @Stability(Stable) @Nullable public Object getCustomerManagedPolicyReferences()
      Specifies the names and paths of the customer managed policies that you have attached to your permission set.

      Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnPermissionSet.CustomerManagedPolicyReferenceProperty>

    • setCustomerManagedPolicyReferences

      @Stability(Stable) public void setCustomerManagedPolicyReferences(@Nullable IResolvable value)
      Specifies the names and paths of the customer managed policies that you have attached to your permission set.

    • setCustomerManagedPolicyReferences

      @Stability(Stable) public void setCustomerManagedPolicyReferences(@Nullable List<Object> value)
      Specifies the names and paths of the customer managed policies that you have attached to your permission set.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      The description of the PermissionSet .

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      The description of the PermissionSet .

    • getInlinePolicy

      @Stability(Stable) @Nullable public Object getInlinePolicy()
      The inline policy that is attached to the permission set.

    • setInlinePolicy

      @Stability(Stable) public void setInlinePolicy(@Nullable Object value)
      The inline policy that is attached to the permission set.

    • getManagedPolicies

      @Stability(Stable) @Nullable public List<String> getManagedPolicies()
      A structure that stores a list of managed policy ARNs that describe the associated AWS managed policy.

    • setManagedPolicies

      @Stability(Stable) public void setManagedPolicies(@Nullable List<String> value)
      A structure that stores a list of managed policy ARNs that describe the associated AWS managed policy.

    • getPermissionsBoundary

      @Stability(Stable) @Nullable public Object getPermissionsBoundary()
      Specifies the configuration of the AWS managed or customer managed policy that you want to set as a permissions boundary.

      Returns union: either IResolvable or CfnPermissionSet.PermissionsBoundaryProperty

    • setPermissionsBoundary

      @Stability(Stable) public void setPermissionsBoundary(@Nullable IResolvable value)
      Specifies the configuration of the AWS managed or customer managed policy that you want to set as a permissions boundary.

    • setPermissionsBoundary

      @Stability(Stable) public void setPermissionsBoundary(@Nullable CfnPermissionSet.PermissionsBoundaryProperty value)
      Specifies the configuration of the AWS managed or customer managed policy that you want to set as a permissions boundary.

    • getRelayStateType

      @Stability(Stable) @Nullable public String getRelayStateType()
      Used to redirect users within the application during the federation authentication process.

    • setRelayStateType

      @Stability(Stable) public void setRelayStateType(@Nullable String value)
      Used to redirect users within the application during the federation authentication process.

    • getSessionDuration

      @Stability(Stable) @Nullable public String getSessionDuration()
      The length of time that the application user sessions are valid for in the ISO-8601 standard.

    • setSessionDuration

      @Stability(Stable) public void setSessionDuration(@Nullable String value)
      The length of time that the application user sessions are valid for in the ISO-8601 standard.

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      The tags to attach to the new PermissionSet .

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      The tags to attach to the new PermissionSet .