software.amazon.awscdk.services.connect

Class CfnInstance

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.connect.CfnInstance

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-28T21:34:14.714Z")
public class CfnInstance
extends CfnResource
implements IInspectable

A CloudFormation `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

Nested Classes

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.

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

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)

Method Summary

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.

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 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnInstance

protected CfnInstance(software.amazon.jsii.JsiiObjectRef objRef)

CfnInstance

protected CfnInstance(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnInstance

public CfnInstance(Construct scope,
                   java.lang.String id,
                   CfnInstanceProps props)

Create a new `AWS::Connect::Instance`.

Parameters:

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.

Method Detail

inspect

public void inspect(TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

public java.lang.String getAttrArn()

The Amazon Resource Name (ARN) of the instance.

getAttrCreatedTime

public java.lang.String getAttrCreatedTime()

When the instance was created.

getAttrId

public java.lang.String getAttrId()

The identifier of the Amazon Connect instance.

You can find the instanceId in the ARN of the instance.

getAttrInstanceStatus

public java.lang.String getAttrInstanceStatus()

The state of the instance.

getAttrServiceRole

public java.lang.String getAttrServiceRole()

The service role of the instance.

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getAttributes

public java.lang.Object getAttributes()

A toggle for an individual feature at the instance level.

setAttributes

public void setAttributes(IResolvable value)

A toggle for an individual feature at the instance level.

setAttributes

public void setAttributes(CfnInstance.AttributesProperty value)

A toggle for an individual feature at the instance level.

getIdentityManagementType

public java.lang.String getIdentityManagementType()

The identity management type.

setIdentityManagementType

public void setIdentityManagementType(java.lang.String value)

The identity management type.

getDirectoryId

public java.lang.String getDirectoryId()

The identifier for the directory.

setDirectoryId

public void setDirectoryId(java.lang.String value)

The identifier for the directory.

getInstanceAlias

public java.lang.String getInstanceAlias()

The alias of instance.

InstanceAlias is only required when IdentityManagementType is CONNECT_MANAGED or SAML . InstanceAlias is not required when IdentityManagementType is EXISTING_DIRECTORY .

setInstanceAlias

public void setInstanceAlias(java.lang.String value)

The alias of instance.

InstanceAlias is only required when IdentityManagementType is CONNECT_MANAGED or SAML . InstanceAlias is not required when IdentityManagementType is EXISTING_DIRECTORY .