Package software.amazon.awscdk.services.sso

Class CfnPermissionSet.Builder

java.lang.Object

software.amazon.awscdk.services.sso.CfnPermissionSet.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnPermissionSet>

Enclosing class:

CfnPermissionSet

@Stability(Stable)
public static final class CfnPermissionSet.Builder
extends Object
implements software.amazon.jsii.Builder<CfnPermissionSet>

A fluent builder for CfnPermissionSet.

Method Summary

Modifier and Type	Method	Description
CfnPermissionSet	build()
static CfnPermissionSet.Builder	create(software.constructs.Construct scope, String id)
CfnPermissionSet.Builder	customerManagedPolicyReferences(List<? extends Object> customerManagedPolicyReferences)	Specifies the names and paths of the customer managed policies that you have attached to your permission set.
CfnPermissionSet.Builder	customerManagedPolicyReferences(IResolvable customerManagedPolicyReferences)	Specifies the names and paths of the customer managed policies that you have attached to your permission set.
CfnPermissionSet.Builder	description(String description)	The description of the PermissionSet .
CfnPermissionSet.Builder	inlinePolicy(Object inlinePolicy)	The inline policy that is attached to the permission set.
CfnPermissionSet.Builder	instanceArn(String instanceArn)	The ARN of the IAM Identity Center instance under which the operation will be executed.
CfnPermissionSet.Builder	managedPolicies(List<String> managedPolicies)	A structure that stores the details of the AWS managed policy.
CfnPermissionSet.Builder	name(String name)	The name of the permission set.
CfnPermissionSet.Builder	permissionsBoundary(IResolvable permissionsBoundary)	Specifies the configuration of the AWS managed or customer managed policy that you want to set as a permissions boundary.
CfnPermissionSet.Builder	permissionsBoundary(CfnPermissionSet.PermissionsBoundaryProperty permissionsBoundary)	Specifies the configuration of the AWS managed or customer managed policy that you want to set as a permissions boundary.
CfnPermissionSet.Builder	relayStateType(String relayStateType)	Used to redirect users within the application during the federation authentication process.
CfnPermissionSet.Builder	sessionDuration(String sessionDuration)	The length of time that the application user sessions are valid for in the ISO-8601 standard.
CfnPermissionSet.Builder	tags(List<? extends CfnTag> tags)	The tags to attach to the new PermissionSet .

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static CfnPermissionSet.Builder create(software.constructs.Construct scope,
 String id)

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.

Returns:

a new instance of CfnPermissionSet.Builder.

instanceArn

@Stability(Stable)
public CfnPermissionSet.Builder instanceArn(String instanceArn)

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 .

Parameters:

instanceArn - The ARN of the IAM Identity Center instance under which the operation will be executed. This parameter is required.

Returns:

this

See Also:

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

name

@Stability(Stable)
public CfnPermissionSet.Builder name(String name)

The name of the permission set.

Parameters:

name - The name of the permission set. This parameter is required.

Returns:

this

See Also:

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

customerManagedPolicyReferences

@Stability(Stable)
public CfnPermissionSet.Builder customerManagedPolicyReferences(IResolvable customerManagedPolicyReferences)

Specifies the names and paths of the customer managed policies that you have attached to your permission set.

Parameters:

customerManagedPolicyReferences - Specifies the names and paths of the customer managed policies that you have attached to your permission set. This parameter is required.

Returns:

this

See Also:

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

customerManagedPolicyReferences

@Stability(Stable)
public CfnPermissionSet.Builder customerManagedPolicyReferences(List<? extends Object> customerManagedPolicyReferences)

Specifies the names and paths of the customer managed policies that you have attached to your permission set.

Parameters:

customerManagedPolicyReferences - Specifies the names and paths of the customer managed policies that you have attached to your permission set. This parameter is required.

Returns:

this

See Also:

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

description

@Stability(Stable)
public CfnPermissionSet.Builder description(String description)

The description of the PermissionSet .

Parameters:

description - The description of the PermissionSet . This parameter is required.

Returns:

this

See Also:

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

inlinePolicy

@Stability(Stable)
public CfnPermissionSet.Builder inlinePolicy(Object inlinePolicy)

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.

Parameters:

inlinePolicy - The inline policy that is attached to the permission set. This parameter is required.

Returns:

this

See Also:

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

managedPolicies

@Stability(Stable)
public CfnPermissionSet.Builder managedPolicies(List<String> managedPolicies)

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

Parameters:

managedPolicies - A structure that stores the details of the AWS managed policy. This parameter is required.

Returns:

this

See Also:

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

permissionsBoundary

@Stability(Stable)
public CfnPermissionSet.Builder permissionsBoundary(IResolvable permissionsBoundary)

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 .

Parameters:

permissionsBoundary - Specifies the configuration of the AWS managed or customer managed policy that you want to set as a permissions boundary. This parameter is required.

Returns:

this

See Also:

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

permissionsBoundary

@Stability(Stable)
public CfnPermissionSet.Builder permissionsBoundary(CfnPermissionSet.PermissionsBoundaryProperty permissionsBoundary)

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 .

Parameters:

permissionsBoundary - Specifies the configuration of the AWS managed or customer managed policy that you want to set as a permissions boundary. This parameter is required.

Returns:

this

See Also:

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

relayStateType

@Stability(Stable)
public CfnPermissionSet.Builder relayStateType(String relayStateType)

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

Parameters:

relayStateType - Used to redirect users within the application during the federation authentication process. This parameter is required.

Returns:

this

See Also:

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

sessionDuration

@Stability(Stable)
public CfnPermissionSet.Builder sessionDuration(String sessionDuration)

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

Parameters:

sessionDuration - The length of time that the application user sessions are valid for in the ISO-8601 standard. This parameter is required.

Returns:

this

See Also:

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

tags

@Stability(Stable)
public CfnPermissionSet.Builder tags(List<? extends CfnTag> tags)

The tags to attach to the new PermissionSet .

Parameters:

tags - The tags to attach to the new PermissionSet . This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnPermissionSet build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnPermissionSet>

Returns:

a newly built instance of CfnPermissionSet.