Class CfnInstance
This is a preview release for Amazon Connect . It is subject to change..
Inherited Members
Namespace: Amazon.CDK.AWS.Connect
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnInstance : CfnResource, IInspectable, ITaggableV2
Syntax (vb)
Public Class CfnInstance
Inherits CfnResource
Implements IInspectable, ITaggableV2
Remarks
Initiates an Amazon Connect instance with all the supported channels enabled. It does not attach any storage, such as Amazon Simple Storage Service (Amazon S3) or Amazon Kinesis.
Amazon Connect enforces a limit on the total number of instances that you can create or delete in 30 days. If you exceed this limit, you will get an error message indicating there has been an excessive number of attempts at creating or deleting instances. You must wait 30 days before you can restart creating and deleting instances in your account.
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-connect-instance.html
CloudformationResource: AWS::Connect::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.Connect;
var cfnInstance = new CfnInstance(this, "MyCfnInstance", new CfnInstanceProps {
Attributes = new AttributesProperty {
InboundCalls = false,
OutboundCalls = false,
// the properties below are optional
AutoResolveBestVoices = false,
ContactflowLogs = false,
ContactLens = false,
EarlyMedia = false,
UseCustomTtsVoices = false
},
IdentityManagementType = "identityManagementType",
// the properties below are optional
DirectoryId = "directoryId",
InstanceAlias = "instanceAlias",
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
AttrArn | The Amazon Resource Name (ARN) of the instance. |
AttrCreatedTime | When the instance was created. |
Attributes | A toggle for an individual feature at the instance level. |
AttrId | The identifier of the Amazon Connect instance. |
AttrInstanceStatus | The state of the instance. |
AttrServiceRole | The service role of the 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 | |
DirectoryId | The identifier for the directory. |
IdentityManagementType | The identity management type. |
InstanceAlias | The alias of instance. |
Tags | An array of key-value pairs to apply to this resource. |
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)
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
AttrArn
The Amazon Resource Name (ARN) of the instance.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Arn
AttrCreatedTime
When the instance was created.
public virtual string AttrCreatedTime { get; }
Property Value
System.String
Remarks
CloudformationAttribute: CreatedTime
Attributes
A toggle for an individual feature at the instance level.
public virtual object Attributes { get; set; }
Property Value
System.Object
AttrId
The identifier of the Amazon Connect instance.
public virtual string AttrId { get; }
Property Value
System.String
Remarks
You can find the instanceId in the ARN of the instance.
CloudformationAttribute: Id
AttrInstanceStatus
The state of the instance.
public virtual string AttrInstanceStatus { get; }
Property Value
System.String
Remarks
CloudformationAttribute: InstanceStatus
AttrServiceRole
The service role of the instance.
public virtual string AttrServiceRole { get; }
Property Value
System.String
Remarks
CloudformationAttribute: ServiceRole
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
DirectoryId
The identifier for the directory.
public virtual string DirectoryId { get; set; }
Property Value
System.String
IdentityManagementType
The identity management type.
public virtual string IdentityManagementType { get; set; }
Property Value
System.String
InstanceAlias
The alias of instance.
public virtual string InstanceAlias { get; set; }
Property Value
System.String
Tags
An array of key-value pairs to apply to this resource.
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>