Class CfnAssignment
A CloudFormation AWS::SSO::Assignment
.
Inherited Members
Namespace: Amazon.CDK.AWS.SSO
Assembly: Amazon.CDK.AWS.SSO.dll
Syntax (csharp)
public class CfnAssignment : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnAssignment
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
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 IAM Identity Center .
CloudformationResource: AWS::SSO::Assignment
Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sso-assignment.html
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.SSO;
var cfnAssignment = new CfnAssignment(this, "MyCfnAssignment", new CfnAssignmentProps {
InstanceArn = "instanceArn",
PermissionSetArn = "permissionSetArn",
PrincipalId = "principalId",
PrincipalType = "principalType",
TargetId = "targetId",
TargetType = "targetType"
});
Synopsis
Constructors
CfnAssignment(Construct, String, ICfnAssignmentProps) | Create a new |
CfnAssignment(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnAssignment(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
InstanceArn | The ARN of the IAM Identity Center instance under which the operation will be executed. |
PermissionSetArn | The ARN of the permission set. |
PrincipalId | An identifier for an object in IAM Identity Center, such as a user or group. |
PrincipalType | The entity type for which the assignment will be created. |
TargetId | TargetID is an AWS account identifier, (For example, 123456789012). |
TargetType | The entity type for which the assignment will be created. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnAssignment(Construct, String, ICfnAssignmentProps)
Create a new AWS::SSO::Assignment
.
public CfnAssignment(Construct scope, string id, ICfnAssignmentProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnAssignmentProps
- resource properties.
CfnAssignment(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnAssignment(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnAssignment(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnAssignment(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
InstanceArn
The ARN of the IAM Identity Center instance under which the operation will be executed.
public virtual string InstanceArn { get; set; }
Property Value
System.String
Remarks
For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference .
PermissionSetArn
The ARN of the permission set.
public virtual string PermissionSetArn { get; set; }
Property Value
System.String
Remarks
PrincipalId
An identifier for an object in IAM Identity Center, such as a user or group.
public virtual string PrincipalId { get; set; }
Property Value
System.String
Remarks
PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6). For more information about PrincipalIds in IAM Identity Center, see the IAM Identity Center Identity Store API Reference .
PrincipalType
The entity type for which the assignment will be created.
public virtual string PrincipalType { get; set; }
Property Value
System.String
Remarks
TargetId
TargetID is an AWS account identifier, (For example, 123456789012).
public virtual string TargetId { get; set; }
Property Value
System.String
Remarks
TargetType
The entity type for which the assignment will be created.
public virtual string TargetType { get; set; }
Property Value
System.String
Remarks
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
- tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>