Class CfnInstance
Creates an instance of IAM Identity Center for a standalone AWS account that is not managed by AWS Organizations or a member AWS account in an organization.
Inherited Members
Namespace: Amazon.CDK.AWS.SSO
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnInstance : CfnResource, IInspectable, ITaggableV2
Syntax (vb)
Public Class CfnInstance
Inherits CfnResource
Implements IInspectable, ITaggableV2
Remarks
You can create only one instance per account and across all AWS Regions .
The CreateInstance request is rejected if the following apply:
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sso-instance.html
CloudformationResource: AWS::SSO::Instance
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 cfnInstance = new CfnInstance(this, "MyCfnInstance", new CfnInstanceProps {
Name = "name",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
CfnInstance(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnInstance(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnInstance(Construct, String, ICfnInstanceProps) |
Properties
AttrIdentityStoreId | The identifier of the identity store that is connected to the Identity Center instance. |
AttrInstanceArn | The ARN of the Identity Center instance under which the operation will be executed. |
AttrOwnerAccountId | The AWS account ID number of the owner of the Identity Center instance. |
AttrStatus | The current status of this Identity Center instance. |
CdkTagManager | Tag Manager which manages the tags for this resource. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
Name | The name of the Identity Center instance. |
Tags | Specifies tags to be attached to the instance of IAM Identity Center. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnInstance(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnInstance(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnInstance(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnInstance(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnInstance(Construct, String, ICfnInstanceProps)
public CfnInstance(Construct scope, string id, ICfnInstanceProps props = null)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnInstanceProps
Resource properties.
Properties
AttrIdentityStoreId
The identifier of the identity store that is connected to the Identity Center instance.
public virtual string AttrIdentityStoreId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: IdentityStoreId
AttrInstanceArn
The ARN of the Identity Center instance under which the operation will be executed.
public virtual string AttrInstanceArn { get; }
Property Value
System.String
Remarks
For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference .
CloudformationAttribute: InstanceArn
AttrOwnerAccountId
The AWS account ID number of the owner of the Identity Center instance.
public virtual string AttrOwnerAccountId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: OwnerAccountId
AttrStatus
The current status of this Identity Center instance.
public virtual string AttrStatus { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Status
CdkTagManager
Tag Manager which manages the tags for this resource.
public virtual TagManager CdkTagManager { get; }
Property Value
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
Name
The name of the Identity Center instance.
public virtual string Name { get; set; }
Property Value
System.String
Tags
Specifies tags to be attached to the instance of IAM Identity Center.
public virtual ICfnTag[] Tags { get; set; }
Property Value
ICfnTag[]
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>