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, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:42.362Z")
 @Stability(value=Stable)
public class CfnPermissionSet
extends CfnResource
implements IInspectable

A CloudFormation `AWS::SSO::PermissionSet`.

Specifies a permission set within a specified SSO 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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnPermissionSet.Builder A fluent builder for CfnPermissionSet.
static interface	CfnPermissionSet.CustomerManagedPolicyReferenceProperty Example:
static interface	CfnPermissionSet.PermissionsBoundaryProperty Example:

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnPermissionSet(software.constructs.Construct scope, String id, CfnPermissionSetProps props) Create a new `AWS::SSO::PermissionSet`.
protected	CfnPermissionSet(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnPermissionSet(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrPermissionSetArn() The permission set ARN of the permission set, such as `arn:aws:sso:::permissionSet/ins-instanceid/ps-permissionsetid` .
protected Map<String,Object>	getCfnProperties()
Object	getCustomerManagedPolicyReferences() `AWS::SSO::PermissionSet.CustomerManagedPolicyReferences`.
String	getDescription() The description of the `PermissionSet` .
Object	getInlinePolicy() The IAM inline policy that is attached to the permission set.
String	getInstanceArn() The ARN of the SSO instance under which the operation will be executed.
List<String>	getManagedPolicies() A structure that stores the details of the IAM managed policy.
String	getName() The name of the permission set.
Object	getPermissionsBoundary() `AWS::SSO::PermissionSet.PermissionsBoundary`.
String	getRelayStateType() Used to redirect users within the application during the federation authentication process.
String	getSessionDuration() The length of time that the application user sessions are valid for in the ISO-8601 standard.
TagManager	getTags() The tags to attach to the new `PermissionSet` .
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setCustomerManagedPolicyReferences(IResolvable value) `AWS::SSO::PermissionSet.CustomerManagedPolicyReferences`.
void	setCustomerManagedPolicyReferences(List<Object> value) `AWS::SSO::PermissionSet.CustomerManagedPolicyReferences`.
void	setDescription(String value) The description of the `PermissionSet` .
void	setInlinePolicy(Object value) The IAM inline policy that is attached to the permission set.
void	setInstanceArn(String value) The ARN of the SSO instance under which the operation will be executed.
void	setManagedPolicies(List<String> value) A structure that stores the details of the IAM managed policy.
void	setName(String value) The name of the permission set.
void	setPermissionsBoundary(CfnPermissionSet.PermissionsBoundaryProperty value) `AWS::SSO::PermissionSet.PermissionsBoundary`.
void	setPermissionsBoundary(IResolvable value) `AWS::SSO::PermissionSet.PermissionsBoundary`.
void	setRelayStateType(String value) Used to redirect users within the application during the federation authentication process.
void	setSessionDuration(String value) The length of time that the application user sessions are valid for in the ISO-8601 standard.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnPermissionSet

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

CfnPermissionSet

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

CfnPermissionSet

@Stability(value=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 - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=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(value=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(value=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(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

The tags to attach to the new `PermissionSet` .

getInlinePolicy

@Stability(value=Stable)
 @NotNull
public Object getInlinePolicy()

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

setInlinePolicy

@Stability(value=Stable)
public void setInlinePolicy(@NotNull
                                                     Object value)

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

getInstanceArn

@Stability(value=Stable)
 @NotNull
public String getInstanceArn()

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 .

setInstanceArn

@Stability(value=Stable)
public void setInstanceArn(@NotNull
                                                    String value)

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 .

getName

@Stability(value=Stable)
 @NotNull
public String getName()

The name of the permission set.

setName

@Stability(value=Stable)
public void setName(@NotNull
                                             String value)

The name of the permission set.

getCustomerManagedPolicyReferences

@Stability(value=Stable)
 @Nullable
public Object getCustomerManagedPolicyReferences()

`AWS::SSO::PermissionSet.CustomerManagedPolicyReferences`.

setCustomerManagedPolicyReferences

@Stability(value=Stable)
public void setCustomerManagedPolicyReferences(@Nullable
                                                                        IResolvable value)

`AWS::SSO::PermissionSet.CustomerManagedPolicyReferences`.

setCustomerManagedPolicyReferences

@Stability(value=Stable)
public void setCustomerManagedPolicyReferences(@Nullable
                                                                        List<Object> value)

`AWS::SSO::PermissionSet.CustomerManagedPolicyReferences`.

getDescription

@Stability(value=Stable)
 @Nullable
public String getDescription()

The description of the `PermissionSet` .

setDescription

@Stability(value=Stable)
public void setDescription(@Nullable
                                                    String value)

The description of the `PermissionSet` .

getManagedPolicies

@Stability(value=Stable)
 @Nullable
public List<String> getManagedPolicies()

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

setManagedPolicies

@Stability(value=Stable)
public void setManagedPolicies(@Nullable
                                                        List<String> value)

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

getPermissionsBoundary

@Stability(value=Stable)
 @Nullable
public Object getPermissionsBoundary()

`AWS::SSO::PermissionSet.PermissionsBoundary`.

setPermissionsBoundary

@Stability(value=Stable)
public void setPermissionsBoundary(@Nullable
                                                            CfnPermissionSet.PermissionsBoundaryProperty value)

`AWS::SSO::PermissionSet.PermissionsBoundary`.

setPermissionsBoundary

@Stability(value=Stable)
public void setPermissionsBoundary(@Nullable
                                                            IResolvable value)

`AWS::SSO::PermissionSet.PermissionsBoundary`.

getRelayStateType

@Stability(value=Stable)
 @Nullable
public String getRelayStateType()

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

setRelayStateType

@Stability(value=Stable)
public void setRelayStateType(@Nullable
                                                       String value)

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

getSessionDuration

@Stability(value=Stable)
 @Nullable
public String getSessionDuration()

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

setSessionDuration

@Stability(value=Stable)
public void setSessionDuration(@Nullable
                                                        String value)

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