@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)", date="2023-03-28T21:34:14.714Z") public class CfnInstance extends CfnResource implements IInspectable
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();
Modifier and Type | Class and Description |
---|---|
static interface |
CfnInstance.AttributesProperty
*This is a preview release for Amazon Connect .
|
static class |
CfnInstance.Builder
A fluent builder for
CfnInstance . |
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 |
---|---|
|
CfnInstance(Construct scope,
java.lang.String id,
CfnInstanceProps props)
Create a new `AWS::Connect::Instance`.
|
protected |
CfnInstance(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) |
protected |
CfnInstance(software.amazon.jsii.JsiiObjectRef objRef) |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getAttrArn()
The Amazon Resource Name (ARN) of the instance.
|
java.lang.String |
getAttrCreatedTime()
When the instance was created.
|
java.lang.Object |
getAttributes()
A toggle for an individual feature at the instance level.
|
java.lang.String |
getAttrId()
The identifier of the Amazon Connect instance.
|
java.lang.String |
getAttrInstanceStatus()
The state of the instance.
|
java.lang.String |
getAttrServiceRole()
The service role of the instance.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
getCfnProperties() |
java.lang.String |
getDirectoryId()
The identifier for the directory.
|
java.lang.String |
getIdentityManagementType()
The identity management type.
|
java.lang.String |
getInstanceAlias()
The alias of instance.
|
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 |
setAttributes(CfnInstance.AttributesProperty value)
A toggle for an individual feature at the instance level.
|
void |
setAttributes(IResolvable value)
A toggle for an individual feature at the instance level.
|
void |
setDirectoryId(java.lang.String value)
The identifier for the directory.
|
void |
setIdentityManagementType(java.lang.String value)
The identity management type.
|
void |
setInstanceAlias(java.lang.String value)
The alias of instance.
|
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 CfnInstance(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnInstance(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnInstance(Construct scope, java.lang.String id, CfnInstanceProps 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.public java.lang.String getAttrArn()
public java.lang.String getAttrCreatedTime()
public java.lang.String getAttrId()
You can find the instanceId in the ARN of the instance.
public java.lang.String getAttrInstanceStatus()
public java.lang.String getAttrServiceRole()
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public java.lang.Object getAttributes()
public void setAttributes(IResolvable value)
public void setAttributes(CfnInstance.AttributesProperty value)
public java.lang.String getIdentityManagementType()
public void setIdentityManagementType(java.lang.String value)
public java.lang.String getDirectoryId()
public void setDirectoryId(java.lang.String value)
public java.lang.String getInstanceAlias()
InstanceAlias
is only required when IdentityManagementType
is CONNECT_MANAGED
or SAML
. InstanceAlias
is not required when IdentityManagementType
is EXISTING_DIRECTORY
.
public void setInstanceAlias(java.lang.String value)
InstanceAlias
is only required when IdentityManagementType
is CONNECT_MANAGED
or SAML
. InstanceAlias
is not required when IdentityManagementType
is EXISTING_DIRECTORY
.