software.amazon.awscdk.services.connect

Class CfnQuickConnect

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.CfnQuickConnect

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-12-07T17:24:34.397Z")
public class CfnQuickConnect
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Connect::QuickConnect`.

Specifies a quick connect for an Amazon Connect instance.

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.*;
 CfnQuickConnect cfnQuickConnect = CfnQuickConnect.Builder.create(this, "MyCfnQuickConnect")
         .instanceArn("instanceArn")
         .name("name")
         .quickConnectConfig(QuickConnectConfigProperty.builder()
                 .quickConnectType("quickConnectType")
                 // the properties below are optional
                 .phoneConfig(PhoneNumberQuickConnectConfigProperty.builder()
                         .phoneNumber("phoneNumber")
                         .build())
                 .queueConfig(QueueQuickConnectConfigProperty.builder()
                         .contactFlowArn("contactFlowArn")
                         .queueArn("queueArn")
                         .build())
                 .userConfig(UserQuickConnectConfigProperty.builder()
                         .contactFlowArn("contactFlowArn")
                         .userArn("userArn")
                         .build())
                 .build())
         // the properties below are optional
         .description("description")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnQuickConnect.Builder A fluent builder for CfnQuickConnect.
static interface	CfnQuickConnect.PhoneNumberQuickConnectConfigProperty Contains information about a phone number for a quick connect.
static interface	CfnQuickConnect.QueueQuickConnectConfigProperty Contains information about a queue for a quick connect.
static interface	CfnQuickConnect.QuickConnectConfigProperty Contains configuration settings for a quick connect.
static interface	CfnQuickConnect.UserQuickConnectConfigProperty Contains information about the quick connect configuration settings for a user.

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
	CfnQuickConnect(Construct scope, java.lang.String id, CfnQuickConnectProps props) Create a new `AWS::Connect::QuickConnect`.
protected	CfnQuickConnect(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnQuickConnect(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAttrQuickConnectArn() The Amazon Resource Name (ARN) of the quick connect.
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.String	getDescription() The description of the quick connect.
java.lang.String	getInstanceArn() The Amazon Resource Name (ARN) of the instance.
java.lang.String	getName() The name of the quick connect.
java.lang.Object	getQuickConnectConfig() Contains information about the quick connect.
TagManager	getTags() The tags used to organize, track, or control access for this resource.
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	setDescription(java.lang.String value) The description of the quick connect.
void	setInstanceArn(java.lang.String value) The Amazon Resource Name (ARN) of the instance.
void	setName(java.lang.String value) The name of the quick connect.
void	setQuickConnectConfig(CfnQuickConnect.QuickConnectConfigProperty value) Contains information about the quick connect.
void	setQuickConnectConfig(IResolvable value) Contains information about the quick connect.

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

CfnQuickConnect

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

CfnQuickConnect

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

CfnQuickConnect

public CfnQuickConnect(Construct scope,
                       java.lang.String id,
                       CfnQuickConnectProps props)

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

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.

getAttrQuickConnectArn

public java.lang.String getAttrQuickConnectArn()

The Amazon Resource Name (ARN) of the quick connect.

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getTags

public TagManager getTags()

The tags used to organize, track, or control access for this resource.

For example, { "tags": {"key1":"value1", "key2":"value2"} }.

getInstanceArn

public java.lang.String getInstanceArn()

The Amazon Resource Name (ARN) of the instance.

setInstanceArn

public void setInstanceArn(java.lang.String value)

The Amazon Resource Name (ARN) of the instance.

getName

public java.lang.String getName()

The name of the quick connect.

setName

public void setName(java.lang.String value)

The name of the quick connect.

getQuickConnectConfig

public java.lang.Object getQuickConnectConfig()

Contains information about the quick connect.

setQuickConnectConfig

public void setQuickConnectConfig(IResolvable value)

Contains information about the quick connect.

setQuickConnectConfig

public void setQuickConnectConfig(CfnQuickConnect.QuickConnectConfigProperty value)

Contains information about the quick connect.

getDescription

public java.lang.String getDescription()

The description of the quick connect.

setDescription

public void setDescription(java.lang.String value)

The description of the quick connect.