AWS CDK Reference

Appearance

v2.274.0

CfnPermissionSetProps Struct ​

Properties for defining a CfnPermissionSet.

Source
Generated code
Type last changed
v2.34.0 · 29 Jul 2022

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_sso as sso } from 'aws-cdk-lib';

declare const inlinePolicy: any;
const cfnPermissionSetProps: sso.CfnPermissionSetProps = {
  instanceArn: 'instanceArn',
  name: 'name',

  // the properties below are optional
  customerManagedPolicyReferences: [{
    name: 'name',

    // the properties below are optional
    path: 'path',
  }],
  description: 'description',
  inlinePolicy: inlinePolicy,
  managedPolicies: ['managedPolicies'],
  permissionsBoundary: {
    customerManagedPolicyReference: {
      name: 'name',

      // the properties below are optional
      path: 'path',
    },
    managedPolicyArn: 'managedPolicyArn',
  },
  relayStateType: 'relayStateType',
  sessionDuration: 'sessionDuration',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties ​

customerManagedPolicyReferencesoptionalIResolvable | IResolvable | CfnPermissionSet.CustomerManagedPolicyReferenceProperty[]customer_managed_policy_referencesoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, CustomerManagedPolicyReferenceProperty]]]customerManagedPolicyReferencesoptionalIResolvableCustomerManagedPolicyReferencesoptionalIResolvableCustomerManagedPolicyReferencesoptionalinterface{}#
Specifies the names and paths of the customer managed policies that you have attached to your permission set.
descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#
The description of the `PermissionSet` .
inlinePolicyoptionalanyinline_policyoptionalAnyinlinePolicyoptionalObjectInlinePolicyoptionalobjectInlinePolicyoptionalinterface{}#
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.

instanceArnstringinstance_arnstrinstanceArnStringInstanceArnstringInstanceArn*stringrequired#
The ARN of the 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 .

managedPoliciesoptionalstring[]managed_policiesoptionaltyping.List[str]managedPoliciesoptionalList<String>ManagedPoliciesoptionalstring[]ManagedPoliciesoptional*[]*string#
A structure that stores a list of managed policy ARNs that describe the associated AWS managed policy.
namestringnamestrnameStringNamestringName*stringrequired#
The name of the permission set.
permissionsBoundaryoptionalIResolvable | CfnPermissionSet.PermissionsBoundaryPropertypermissions_boundaryoptionaltyping.Union[IResolvable, PermissionsBoundaryProperty]permissionsBoundaryoptionalIResolvablePermissionsBoundaryoptionalIResolvablePermissionsBoundaryoptionalinterface{}#
Specifies the configuration of the AWS managed or customer managed policy that you want to set as a permissions boundary.
notes

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 .

relayStateTypeoptionalstringrelay_state_typeoptionalstrrelayStateTypeoptionalStringRelayStateTypeoptionalstringRelayStateTypeoptional*string#
Used to redirect users within the application during the federation authentication process.
sessionDurationoptionalstringsession_durationoptionalstrsessionDurationoptionalStringSessionDurationoptionalstringSessionDurationoptional*string#
The length of time that the application user sessions are valid for in the ISO-8601 standard.
tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag#
The tags to attach to the new `PermissionSet` .