software.amazon.awscdk.services.connect

Class CfnQuickConnect

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.connect.CfnQuickConnect

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:37.772Z")
 @Stability(value=Stable)
public class CfnQuickConnect
extends CfnResource
implements IInspectable

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

The AWS::Connect::QuickConnnect resource specifies a quick connect for the specified 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 class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnQuickConnect(software.constructs.Construct scope, 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
String	getAttrQuickConnectArn() The Amazon Resource Name (ARN) of the quick connect.
protected Map<String,Object>	getCfnProperties()
String	getDescription() The description of the quick connect.
String	getInstanceArn() The Amazon Resource Name (ARN) of the instance.
String	getName() The name of the quick connect.
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 Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDescription(String value) The description of the quick connect.
void	setInstanceArn(String value) The Amazon Resource Name (ARN) of the instance.
void	setName(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.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

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

@Stability(value=Stable)
public CfnQuickConnect(@NotNull
                                                software.constructs.Construct scope,
                                                @NotNull
                                                String id,
                                                @NotNull
                                                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

@Stability(value=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(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrQuickConnectArn

@Stability(value=Stable)
 @NotNull
public String getAttrQuickConnectArn()

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

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

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

getInstanceArn

@Stability(value=Stable)
 @NotNull
public String getInstanceArn()

The Amazon Resource Name (ARN) of the instance.

setInstanceArn

@Stability(value=Stable)
public void setInstanceArn(@NotNull
                                                    String value)

The Amazon Resource Name (ARN) of the instance.

getName

@Stability(value=Stable)
 @NotNull
public String getName()

The name of the quick connect.

setName

@Stability(value=Stable)
public void setName(@NotNull
                                             String value)

The name of the quick connect.

getQuickConnectConfig

@Stability(value=Stable)
 @NotNull
public Object getQuickConnectConfig()

Contains information about the quick connect.

setQuickConnectConfig

@Stability(value=Stable)
public void setQuickConnectConfig(@NotNull
                                                           CfnQuickConnect.QuickConnectConfigProperty value)

Contains information about the quick connect.

setQuickConnectConfig

@Stability(value=Stable)
public void setQuickConnectConfig(@NotNull
                                                           IResolvable value)

Contains information about the quick connect.

getDescription

@Stability(value=Stable)
 @Nullable
public String getDescription()

The description of the quick connect.

setDescription

@Stability(value=Stable)
public void setDescription(@Nullable
                                                    String value)

The description of the quick connect.