CfnPermissionSetProps

class aws_cdk.aws_sso.CfnPermissionSetProps(*, instance_arn, name, customer_managed_policy_references=None, description=None, inline_policy=None, managed_policies=None, permissions_boundary=None, relay_state_type=None, session_duration=None, tags=None)

Bases: object

Properties for defining a CfnPermissionSet.

Parameters
  • instance_arn (str) – The ARN of the SSO 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 .

  • name (str) – The name of the permission set.

  • customer_managed_policy_references (Union[IResolvable, Sequence[Union[IResolvable, CustomerManagedPolicyReferenceProperty, Dict[str, Any]]], None]) – AWS::SSO::PermissionSet.CustomerManagedPolicyReferences.

  • description (Optional[str]) – The description of the PermissionSet .

  • inline_policy (Optional[Any]) – The IAM inline policy that is attached to the permission set.

  • managed_policies (Optional[Sequence[str]]) – A structure that stores the details of the IAM managed policy.

  • permissions_boundary (Union[IResolvable, PermissionsBoundaryProperty, Dict[str, Any], None]) – AWS::SSO::PermissionSet.PermissionsBoundary.

  • relay_state_type (Optional[str]) – Used to redirect users within the application during the federation authentication process.

  • session_duration (Optional[str]) – The length of time that the application user sessions are valid for in the ISO-8601 standard.

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – The tags to attach to the new PermissionSet .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sso-permissionset.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_sso as sso

# inline_policy: Any

cfn_permission_set_props = sso.CfnPermissionSetProps(
    instance_arn="instanceArn",
    name="name",

    # the properties below are optional
    customer_managed_policy_references=[sso.CfnPermissionSet.CustomerManagedPolicyReferenceProperty(
        name="name",

        # the properties below are optional
        path="path"
    )],
    description="description",
    inline_policy=inline_policy,
    managed_policies=["managedPolicies"],
    permissions_boundary=sso.CfnPermissionSet.PermissionsBoundaryProperty(
        customer_managed_policy_reference=sso.CfnPermissionSet.CustomerManagedPolicyReferenceProperty(
            name="name",

            # the properties below are optional
            path="path"
        ),
        managed_policy_arn="managedPolicyArn"
    ),
    relay_state_type="relayStateType",
    session_duration="sessionDuration",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

customer_managed_policy_references

AWS::SSO::PermissionSet.CustomerManagedPolicyReferences.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sso-permissionset.html#cfn-sso-permissionset-customermanagedpolicyreferences

Return type

Union[IResolvable, List[Union[IResolvable, CustomerManagedPolicyReferenceProperty]], None]

description

The description of the PermissionSet .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sso-permissionset.html#cfn-sso-permissionset-description

Return type

Optional[str]

inline_policy

The IAM inline policy that is attached to the permission set.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sso-permissionset.html#cfn-sso-permissionset-inlinepolicy

Return type

Any

instance_arn

The ARN of the SSO 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 .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sso-permissionset.html#cfn-sso-permissionset-instancearn

Return type

str

managed_policies

A structure that stores the details of the IAM managed policy.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sso-permissionset.html#cfn-sso-permissionset-managedpolicies

Return type

Optional[List[str]]

name

The name of the permission set.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sso-permissionset.html#cfn-sso-permissionset-name

Return type

str

permissions_boundary

AWS::SSO::PermissionSet.PermissionsBoundary.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sso-permissionset.html#cfn-sso-permissionset-permissionsboundary

Return type

Union[IResolvable, PermissionsBoundaryProperty, None]

relay_state_type

Used to redirect users within the application during the federation authentication process.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sso-permissionset.html#cfn-sso-permissionset-relaystatetype

Return type

Optional[str]

session_duration

The length of time that the application user sessions are valid for in the ISO-8601 standard.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sso-permissionset.html#cfn-sso-permissionset-sessionduration

Return type

Optional[str]

tags

The tags to attach to the new PermissionSet .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sso-permissionset.html#cfn-sso-permissionset-tags

Return type

Optional[List[CfnTag]]