Package software.amazon.awscdk.services.connect

Class CfnInstance

java.lang.Object
software.amazon.jsii.JsiiObject
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, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:55.977Z") @Stability(Stable) 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();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String 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 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 Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull 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

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The Amazon Resource Name (ARN) of the instance.

    • getAttrCreatedTime

      @Stability(Stable) @NotNull public String getAttrCreatedTime()
      When the instance was created.

    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()
      The identifier of the Amazon Connect instance.

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

    • getAttrInstanceStatus

      @Stability(Stable) @NotNull public String getAttrInstanceStatus()
      The state of the instance.

    • getAttrServiceRole

      @Stability(Stable) @NotNull public String getAttrServiceRole()
      The service role of the instance.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getAttributes

      @Stability(Stable) @NotNull public Object getAttributes()
      A toggle for an individual feature at the instance level.

    • setAttributes

      @Stability(Stable) public void setAttributes(@NotNull IResolvable value)
      A toggle for an individual feature at the instance level.

    • setAttributes

      @Stability(Stable) public void setAttributes(@NotNull CfnInstance.AttributesProperty value)
      A toggle for an individual feature at the instance level.

    • getIdentityManagementType

      @Stability(Stable) @NotNull public String getIdentityManagementType()
      The identity management type.

    • setIdentityManagementType

      @Stability(Stable) public void setIdentityManagementType(@NotNull String value)
      The identity management type.

    • getDirectoryId

      @Stability(Stable) @Nullable public String getDirectoryId()
      The identifier for the directory.

    • setDirectoryId

      @Stability(Stable) public void setDirectoryId(@Nullable String value)
      The identifier for the directory.

    • getInstanceAlias

      @Stability(Stable) @Nullable public 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

      @Stability(Stable) public void setInstanceAlias(@Nullable 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 .