@Generated(value="jsii-pacmak/1.60.0 (build ebcefe6)", date="2022-06-22T23:27:52.937Z") public class CfnAssignment extends CfnResource implements IInspectable
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();
Modifier and Type | Class and Description |
---|---|
static class |
CfnAssignment.Builder
A fluent builder for
CfnAssignment . |
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
Modifier | Constructor and Description |
---|---|
|
CfnAssignment(Construct scope,
java.lang.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) |
Modifier and Type | Method and Description |
---|---|
protected java.util.Map<java.lang.String,java.lang.Object> |
getCfnProperties() |
java.lang.String |
getInstanceArn()
The ARN of the SSO instance under which the operation will be executed.
|
java.lang.String |
getPermissionSetArn()
The ARN of the permission set.
|
java.lang.String |
getPrincipalId()
An identifier for an object in AWS SSO , such as a user or group.
|
java.lang.String |
getPrincipalType()
The entity type for which the assignment will be created.
|
java.lang.String |
getTargetId()
TargetID is an AWS account identifier, typically a 10-12 digit string (For example, 123456789012).
|
java.lang.String |
getTargetType()
The entity type for which the assignment will be created.
|
void |
inspect(TreeInspector inspector)
Examines the CloudFormation resource and discloses attributes.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
renderProperties(java.util.Map<java.lang.String,java.lang.Object> props) |
void |
setInstanceArn(java.lang.String value)
The ARN of the SSO instance under which the operation will be executed.
|
void |
setPermissionSetArn(java.lang.String value)
The ARN of the permission set.
|
void |
setPrincipalId(java.lang.String value)
An identifier for an object in AWS SSO , such as a user or group.
|
void |
setPrincipalType(java.lang.String value)
The entity type for which the assignment will be created.
|
void |
setTargetId(java.lang.String value)
TargetID is an AWS account identifier, typically a 10-12 digit string (For example, 123456789012).
|
void |
setTargetType(java.lang.String value)
The entity type for which the assignment will be created.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnAssignment(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnAssignment(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnAssignment(Construct scope, java.lang.String id, CfnAssignmentProps props)
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.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public java.lang.String getInstanceArn()
For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference .
public void setInstanceArn(java.lang.String value)
For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference .
public java.lang.String getPermissionSetArn()
public void setPermissionSetArn(java.lang.String value)
public java.lang.String getPrincipalId()
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 .
public void setPrincipalId(java.lang.String value)
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 .
public java.lang.String getPrincipalType()
public void setPrincipalType(java.lang.String value)
public java.lang.String getTargetId()
public void setTargetId(java.lang.String value)
public java.lang.String getTargetType()
public void setTargetType(java.lang.String value)