software.amazon.awscdk.services.connect

Class CfnContactFlow

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

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.758Z")
 @Stability(value=Stable)
public class CfnContactFlow
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Connect::ContactFlow`.

The AWS::Connect::ContactFlow resource specifies a contact flow 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.*;
 CfnContactFlow cfnContactFlow = CfnContactFlow.Builder.create(this, "MyCfnContactFlow")
         .content("content")
         .instanceArn("instanceArn")
         .name("name")
         .type("type")
         // the properties below are optional
         .description("description")
         .state("state")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnContactFlow.Builder A fluent builder for CfnContactFlow.

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
	CfnContactFlow(software.constructs.Construct scope, String id, CfnContactFlowProps props) Create a new `AWS::Connect::ContactFlow`.
protected	CfnContactFlow(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnContactFlow(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrContactFlowArn() `Ref` returns the contact flow Amazon Resource Name (ARN).
protected Map<String,Object>	getCfnProperties()
String	getContent() The content of the contact flow.
String	getDescription() The description of the contact flow.
String	getInstanceArn() The Amazon Resource Name (ARN) of the Amazon Connect instance.
String	getName() The name of the contact flow.
String	getState() The state of the contact flow.
TagManager	getTags() An array of key-value pairs to apply to this resource.
String	getType() The type of the contact flow.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setContent(String value) The content of the contact flow.
void	setDescription(String value) The description of the contact flow.
void	setInstanceArn(String value) The Amazon Resource Name (ARN) of the Amazon Connect instance.
void	setName(String value) The name of the contact flow.
void	setState(String value) The state of the contact flow.
void	setType(String value) The type of the contact flow.

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

CfnContactFlow

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

CfnContactFlow

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

CfnContactFlow

@Stability(value=Stable)
public CfnContactFlow(@NotNull
                                               software.constructs.Construct scope,
                                               @NotNull
                                               String id,
                                               @NotNull
                                               CfnContactFlowProps props)

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

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.

getAttrContactFlowArn

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

`Ref` returns the contact flow Amazon Resource Name (ARN). For example:.

{ "Ref": "myContactFlowArn" }

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getTags

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

An array of key-value pairs to apply to this resource.

For more information, see Tag .

getContent

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

The content of the contact flow.

setContent

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

The content of the contact flow.

getInstanceArn

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

The Amazon Resource Name (ARN) of the Amazon Connect instance.

setInstanceArn

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

The Amazon Resource Name (ARN) of the Amazon Connect instance.

getName

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

The name of the contact flow.

setName

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

The name of the contact flow.

getType

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

The type of the contact flow.

For descriptions of the available types, see Choose a Contact Flow Type in the Amazon Connect Administrator Guide .

setType

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

The type of the contact flow.

For descriptions of the available types, see Choose a Contact Flow Type in the Amazon Connect Administrator Guide .

getDescription

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

The description of the contact flow.

setDescription

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

The description of the contact flow.

getState

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

The state of the contact flow.

setState

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

The state of the contact flow.