CreateInstanceRequest (aws-android-sdk-connect 2.81.1 API)

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.connect.model.CreateInstanceRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable
```
public class CreateInstanceRequest
extends com.amazonaws.AmazonWebServiceRequest
implements java.io.Serializable
```
This API is in preview release for Amazon Connect and 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. It also does not allow for any configurations on features, such as Contact Lens for Amazon Connect.

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 Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

CreateInstanceRequest()

Constructors
Constructor and Description
`CreateInstanceRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object obj)`
`java.lang.String`	`getClientToken()` The idempotency token.
`java.lang.String`	`getDirectoryId()` The identifier for the directory.
`java.lang.String`	`getIdentityManagementType()` The type of identity management for your Amazon Connect users.
`java.lang.Boolean`	`getInboundCallsEnabled()` Your contact center handles incoming contacts.
`java.lang.String`	`getInstanceAlias()` The name for your instance.
`java.lang.Boolean`	`getOutboundCallsEnabled()` Your contact center allows outbound calls.
`int`	`hashCode()`
`java.lang.Boolean`	`isInboundCallsEnabled()` Your contact center handles incoming contacts.
`java.lang.Boolean`	`isOutboundCallsEnabled()` Your contact center allows outbound calls.
`void`	`setClientToken(java.lang.String clientToken)` The idempotency token.
`void`	`setDirectoryId(java.lang.String directoryId)` The identifier for the directory.
`void`	`setIdentityManagementType(DirectoryType identityManagementType)` The type of identity management for your Amazon Connect users.
`void`	`setIdentityManagementType(java.lang.String identityManagementType)` The type of identity management for your Amazon Connect users.
`void`	`setInboundCallsEnabled(java.lang.Boolean inboundCallsEnabled)` Your contact center handles incoming contacts.
`void`	`setInstanceAlias(java.lang.String instanceAlias)` The name for your instance.
`void`	`setOutboundCallsEnabled(java.lang.Boolean outboundCallsEnabled)` Your contact center allows outbound calls.
`java.lang.String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`CreateInstanceRequest`	`withClientToken(java.lang.String clientToken)` The idempotency token.
`CreateInstanceRequest`	`withDirectoryId(java.lang.String directoryId)` The identifier for the directory.
`CreateInstanceRequest`	`withIdentityManagementType(DirectoryType identityManagementType)` The type of identity management for your Amazon Connect users.
`CreateInstanceRequest`	`withIdentityManagementType(java.lang.String identityManagementType)` The type of identity management for your Amazon Connect users.
`CreateInstanceRequest`	`withInboundCallsEnabled(java.lang.Boolean inboundCallsEnabled)` Your contact center handles incoming contacts.
`CreateInstanceRequest`	`withInstanceAlias(java.lang.String instanceAlias)` The name for your instance.
`CreateInstanceRequest`	`withOutboundCallsEnabled(java.lang.Boolean outboundCallsEnabled)` Your contact center allows outbound calls.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest
clone, copyBaseTo, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - CreateInstanceRequest
```
public CreateInstanceRequest()
```
- Method Detail
  - getClientToken
```
public java.lang.String getClientToken()
```
    The idempotency token.
    
    Constraints:
    Length: - 500
    
    Returns:
    
    The idempotency token.
  - setClientToken
```
public void setClientToken(java.lang.String clientToken)
```
    The idempotency token.
    
    Constraints:
    Length: - 500
    
    Parameters:
    
    clientToken -
    The idempotency token.
  - withClientToken
```
public CreateInstanceRequest withClientToken(java.lang.String clientToken)
```
    The idempotency token.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: - 500
    
    Parameters:
    
    clientToken -
    The idempotency token.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getIdentityManagementType
```
public java.lang.String getIdentityManagementType()
```
    The type of identity management for your Amazon Connect users.
    
    Constraints:
    Allowed Values: SAML, CONNECT_MANAGED, EXISTING_DIRECTORY
    
    Returns:
    
    The type of identity management for your Amazon Connect users.
    
    See Also:
    
    DirectoryType
  - setIdentityManagementType
```
public void setIdentityManagementType(java.lang.String identityManagementType)
```
    The type of identity management for your Amazon Connect users.
    
    Constraints:
    Allowed Values: SAML, CONNECT_MANAGED, EXISTING_DIRECTORY
    
    Parameters:
    
    identityManagementType -
    The type of identity management for your Amazon Connect users.
    
    See Also:
    
    DirectoryType
  - withIdentityManagementType
```
public CreateInstanceRequest withIdentityManagementType(java.lang.String identityManagementType)
```
    The type of identity management for your Amazon Connect users.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: SAML, CONNECT_MANAGED, EXISTING_DIRECTORY
    
    Parameters:
    
    identityManagementType -
    The type of identity management for your Amazon Connect users.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    DirectoryType
  - setIdentityManagementType
```
public void setIdentityManagementType(DirectoryType identityManagementType)
```
    The type of identity management for your Amazon Connect users.
    
    Constraints:
    Allowed Values: SAML, CONNECT_MANAGED, EXISTING_DIRECTORY
    
    Parameters:
    
    identityManagementType -
    The type of identity management for your Amazon Connect users.
    
    See Also:
    
    DirectoryType
  - withIdentityManagementType
```
public CreateInstanceRequest withIdentityManagementType(DirectoryType identityManagementType)
```
    The type of identity management for your Amazon Connect users.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: SAML, CONNECT_MANAGED, EXISTING_DIRECTORY
    
    Parameters:
    
    identityManagementType -
    The type of identity management for your Amazon Connect users.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    DirectoryType
  - getInstanceAlias
```
public java.lang.String getInstanceAlias()
```
    The name for your instance.
    
    Constraints:
    Length: 1 - 45
    Pattern: ^(?!d-)([\da-zA-Z]+)([-]*[\da-zA-Z])*$
    
    Returns:
    
    The name for your instance.
  - setInstanceAlias
```
public void setInstanceAlias(java.lang.String instanceAlias)
```
    The name for your instance.
    
    Constraints:
    Length: 1 - 45
    Pattern: ^(?!d-)([\da-zA-Z]+)([-]*[\da-zA-Z])*$
    
    Parameters:
    
    instanceAlias -
    The name for your instance.
  - withInstanceAlias
```
public CreateInstanceRequest withInstanceAlias(java.lang.String instanceAlias)
```
    The name for your instance.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 45
    Pattern: ^(?!d-)([\da-zA-Z]+)([-]*[\da-zA-Z])*$
    
    Parameters:
    
    instanceAlias -
    The name for your instance.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getDirectoryId
```
public java.lang.String getDirectoryId()
```
    The identifier for the directory.
    
    Constraints:
    Length: 12 - 12
    Pattern: ^d-[0-9a-f]{10}$
    
    Returns:
    
    The identifier for the directory.
  - setDirectoryId
```
public void setDirectoryId(java.lang.String directoryId)
```
    The identifier for the directory.
    
    Constraints:
    Length: 12 - 12
    Pattern: ^d-[0-9a-f]{10}$
    
    Parameters:
    
    directoryId -
    The identifier for the directory.
  - withDirectoryId
```
public CreateInstanceRequest withDirectoryId(java.lang.String directoryId)
```
    The identifier for the directory.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 12 - 12
    Pattern: ^d-[0-9a-f]{10}$
    
    Parameters:
    
    directoryId -
    The identifier for the directory.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - isInboundCallsEnabled
```
public java.lang.Boolean isInboundCallsEnabled()
```
    Your contact center handles incoming contacts.
    
    Returns:
    
    Your contact center handles incoming contacts.
  - getInboundCallsEnabled
```
public java.lang.Boolean getInboundCallsEnabled()
```
    Your contact center handles incoming contacts.
    
    Returns:
    
    Your contact center handles incoming contacts.
  - setInboundCallsEnabled
```
public void setInboundCallsEnabled(java.lang.Boolean inboundCallsEnabled)
```
    Your contact center handles incoming contacts.
    
    Parameters:
    
    inboundCallsEnabled -
    Your contact center handles incoming contacts.
  - withInboundCallsEnabled
```
public CreateInstanceRequest withInboundCallsEnabled(java.lang.Boolean inboundCallsEnabled)
```
    Your contact center handles incoming contacts.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    inboundCallsEnabled -
    Your contact center handles incoming contacts.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - isOutboundCallsEnabled
```
public java.lang.Boolean isOutboundCallsEnabled()
```
    Your contact center allows outbound calls.
    
    Returns:
    
    Your contact center allows outbound calls.
  - getOutboundCallsEnabled
```
public java.lang.Boolean getOutboundCallsEnabled()
```
    Your contact center allows outbound calls.
    
    Returns:
    
    Your contact center allows outbound calls.
  - setOutboundCallsEnabled
```
public void setOutboundCallsEnabled(java.lang.Boolean outboundCallsEnabled)
```
    Your contact center allows outbound calls.
    
    Parameters:
    
    outboundCallsEnabled -
    Your contact center allows outbound calls.
  - withOutboundCallsEnabled
```
public CreateInstanceRequest withOutboundCallsEnabled(java.lang.Boolean outboundCallsEnabled)
```
    Your contact center allows outbound calls.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    outboundCallsEnabled -
    Your contact center allows outbound calls.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - toString
```
public java.lang.String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object

Class CreateInstanceRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

CreateInstanceRequest

Method Detail

getClientToken

setClientToken

withClientToken

getIdentityManagementType

setIdentityManagementType

withIdentityManagementType

setIdentityManagementType

withIdentityManagementType

getInstanceAlias

setInstanceAlias

withInstanceAlias

getDirectoryId

setDirectoryId

withDirectoryId

isInboundCallsEnabled

getInboundCallsEnabled

setInboundCallsEnabled

withInboundCallsEnabled

isOutboundCallsEnabled

getOutboundCallsEnabled

setOutboundCallsEnabled

withOutboundCallsEnabled

toString

hashCode

equals