Package software.amazon.awscdk.services.sso

Class CfnPermissionSet

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.CfnPermissionSet
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.858Z") @Stability(Stable) public class CfnPermissionSet extends CfnResource implements IInspectable
A CloudFormation AWS::SSO::PermissionSet.

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

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

    • 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

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      The tags to attach to the new PermissionSet .

    • getInlinePolicy

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

      For Length Constraints , if a valid ARN is provided for a permission set, it is possible for an empty inline policy to be returned.

    • setInlinePolicy

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

      For Length Constraints , if a valid ARN is provided for a permission set, it is possible for an empty inline policy to be returned.

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

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

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

    • getManagedPolicies

      @Stability(Stable) @Nullable public List<String> getManagedPolicies()
      A structure that stores the details of the AWS managed policy.

    • setManagedPolicies

      @Stability(Stable) public void setManagedPolicies(@Nullable List<String> value)
      A structure that stores the details of the 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.

      Specify either CustomerManagedPolicyReference to use the name and path of a customer managed policy, or ManagedPolicyArn to use the ARN of an AWS managed policy. A permissions boundary represents the maximum permissions that any policy can grant your role. For more information, see Permissions boundaries for IAM entities in the IAM User Guide .

      Policies used as permissions boundaries don't provide permissions. You must also attach an IAM policy to the role. To learn how the effective permissions for a role are evaluated, see IAM JSON policy evaluation logic in the IAM User Guide .

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

      Specify either CustomerManagedPolicyReference to use the name and path of a customer managed policy, or ManagedPolicyArn to use the ARN of an AWS managed policy. A permissions boundary represents the maximum permissions that any policy can grant your role. For more information, see Permissions boundaries for IAM entities in the IAM User Guide .

      Policies used as permissions boundaries don't provide permissions. You must also attach an IAM policy to the role. To learn how the effective permissions for a role are evaluated, see IAM JSON policy evaluation logic in the IAM User Guide .

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

      Specify either CustomerManagedPolicyReference to use the name and path of a customer managed policy, or ManagedPolicyArn to use the ARN of an AWS managed policy. A permissions boundary represents the maximum permissions that any policy can grant your role. For more information, see Permissions boundaries for IAM entities in the IAM User Guide .

      Policies used as permissions boundaries don't provide permissions. You must also attach an IAM policy to the role. To learn how the effective permissions for a role are evaluated, see IAM JSON policy evaluation logic in the IAM User Guide .

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