Class CfnInstance
- All Implemented Interfaces:
IConstruct
,IDependable
,IInspectable
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
AWS::Connect::Instance
.
This is a preview release for Amazon Connect . It is subject to change.
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.
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.connect.*; CfnInstance cfnInstance = CfnInstance.Builder.create(this, "MyCfnInstance") .attributes(AttributesProperty.builder() .inboundCalls(false) .outboundCalls(false) // the properties below are optional .autoResolveBestVoices(false) .contactflowLogs(false) .contactLens(false) .earlyMedia(false) .useCustomTtsVoices(false) .build()) .identityManagementType("identityManagementType") // the properties below are optional .directoryId("directoryId") .instanceAlias("instanceAlias") .build();
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic interface
*This is a preview release for Amazon Connect .static final class
A fluent builder forCfnInstance
.Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct
IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ModifierConstructorDescriptionCfnInstance
(Construct scope, String id, CfnInstanceProps props) Create a newAWS::Connect::Instance
.protected
CfnInstance
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnInstance
(software.amazon.jsii.JsiiObjectRef objRef) -
Method Summary
Modifier and TypeMethodDescriptionThe Amazon Resource Name (ARN) of the instance.When the instance was created.A toggle for an individual feature at the instance level.The identifier of the Amazon Connect instance.The state of the instance.The service role of the instance.The identifier for the directory.The identity management type.The alias of instance.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties
(Map<String, Object> props) void
setAttributes
(IResolvable value) A toggle for an individual feature at the instance level.void
A toggle for an individual feature at the instance level.void
setDirectoryId
(String value) The identifier for the directory.void
setIdentityManagementType
(String value) The identity management type.void
setInstanceAlias
(String value) The alias of instance.Methods inherited from class software.amazon.awscdk.core.CfnResource
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
Methods inherited from class software.amazon.awscdk.core.CfnRefElement
getRef
Methods inherited from class software.amazon.awscdk.core.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
Methods inherited from class software.amazon.awscdk.core.Construct
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
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 Details
-
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
-
-
Constructor Details
-
CfnInstance
protected CfnInstance(software.amazon.jsii.JsiiObjectRef objRef) -
CfnInstance
protected CfnInstance(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
CfnInstance
@Stability(Stable) public CfnInstance(@NotNull Construct scope, @NotNull String id, @NotNull CfnInstanceProps props) Create a newAWS::Connect::Instance
.- Parameters:
scope
-- scope in which this resource is defined.
id
-- scoped id of the resource.
props
-- resource properties.
-
-
Method Details
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- Parameters:
inspector
-- tree inspector to collect and process attributes.
-
renderProperties
@Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String, Object> props) - Overrides:
renderProperties
in classCfnResource
- Parameters:
props
- This parameter is required.
-
getAttrArn
The Amazon Resource Name (ARN) of the instance. -
getAttrCreatedTime
When the instance was created. -
getAttrId
The identifier of the Amazon Connect instance.You can find the instanceId in the ARN of the instance.
-
getAttrInstanceStatus
The state of the instance. -
getAttrServiceRole
The service role of the instance. -
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getAttributes
A toggle for an individual feature at the instance level. -
setAttributes
A toggle for an individual feature at the instance level. -
setAttributes
A toggle for an individual feature at the instance level. -
getIdentityManagementType
The identity management type. -
setIdentityManagementType
The identity management type. -
getDirectoryId
The identifier for the directory. -
setDirectoryId
The identifier for the directory. -
getInstanceAlias
The alias of instance.InstanceAlias
is only required whenIdentityManagementType
isCONNECT_MANAGED
orSAML
.InstanceAlias
is not required whenIdentityManagementType
isEXISTING_DIRECTORY
. -
setInstanceAlias
The alias of instance.InstanceAlias
is only required whenIdentityManagementType
isCONNECT_MANAGED
orSAML
.InstanceAlias
is not required whenIdentityManagementType
isEXISTING_DIRECTORY
.
-