software.amazon.awscdk.services.sso

Class CfnAssignment

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

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.347Z")
 @Stability(value=Stable)
public class CfnAssignment
extends CfnResource
implements IInspectable

A CloudFormation `AWS::SSO::Assignment`.

Assigns access to a Principal for a specified AWS account using a specified permission set.

The term principal here refers to a user or group that is defined in AWS SSO .

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.*;
 CfnAssignment cfnAssignment = CfnAssignment.Builder.create(this, "MyCfnAssignment")
         .instanceArn("instanceArn")
         .permissionSetArn("permissionSetArn")
         .principalId("principalId")
         .principalType("principalType")
         .targetId("targetId")
         .targetType("targetType")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnAssignment.Builder A fluent builder for CfnAssignment.

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
	CfnAssignment(software.constructs.Construct scope, String id, CfnAssignmentProps props) Create a new `AWS::SSO::Assignment`.
protected	CfnAssignment(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnAssignment(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
protected Map<String,Object>	getCfnProperties()
String	getInstanceArn() The ARN of the SSO instance under which the operation will be executed.
String	getPermissionSetArn() The ARN of the permission set.
String	getPrincipalId() An identifier for an object in AWS SSO , such as a user or group.
String	getPrincipalType() The entity type for which the assignment will be created.
String	getTargetId() TargetID is an AWS account identifier, typically a 10-12 digit string (For example, 123456789012).
String	getTargetType() The entity type for which the assignment will be created.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setInstanceArn(String value) The ARN of the SSO instance under which the operation will be executed.
void	setPermissionSetArn(String value) The ARN of the permission set.
void	setPrincipalId(String value) An identifier for an object in AWS SSO , such as a user or group.
void	setPrincipalType(String value) The entity type for which the assignment will be created.
void	setTargetId(String value) TargetID is an AWS account identifier, typically a 10-12 digit string (For example, 123456789012).
void	setTargetType(String value) The entity type for which the assignment will be created.

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

CfnAssignment

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

CfnAssignment

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

CfnAssignment

@Stability(value=Stable)
public CfnAssignment(@NotNull
                                              software.constructs.Construct scope,
                                              @NotNull
                                              String id,
                                              @NotNull
                                              CfnAssignmentProps props)

Create a new `AWS::SSO::Assignment`.

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.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

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 .

getPermissionSetArn

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

The ARN of the permission set.

setPermissionSetArn

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

The ARN of the permission set.

getPrincipalId

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

An identifier for an object in AWS SSO , such as a user or group.

PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6). For more information about PrincipalIds in AWS SSO , see the AWS SSO Identity Store API Reference .

setPrincipalId

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

An identifier for an object in AWS SSO , such as a user or group.

PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6). For more information about PrincipalIds in AWS SSO , see the AWS SSO Identity Store API Reference .

getPrincipalType

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

The entity type for which the assignment will be created.

setPrincipalType

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

The entity type for which the assignment will be created.

getTargetId

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

TargetID is an AWS account identifier, typically a 10-12 digit string (For example, 123456789012).

setTargetId

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

TargetID is an AWS account identifier, typically a 10-12 digit string (For example, 123456789012).

getTargetType

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

The entity type for which the assignment will be created.

setTargetType

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

The entity type for which the assignment will be created.