Package software.amazon.awscdk.services.connect

Class CfnRule

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

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2025-01-07T10:36:04.530Z")
@Stability(Stable)
public class CfnRule
extends CfnResource
implements IInspectable, ITaggable

Creates a rule 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.*;
 Object assignContactCategoryActions;
 Object emptyValue;
 Object endAssociatedTasksActions;
 CfnRule cfnRule = CfnRule.Builder.create(this, "MyCfnRule")
         .actions(ActionsProperty.builder()
                 .assignContactCategoryActions(List.of(assignContactCategoryActions))
                 .createCaseActions(List.of(CreateCaseActionProperty.builder()
                         .fields(List.of(FieldProperty.builder()
                                 .id("id")
                                 .value(FieldValueProperty.builder()
                                         .booleanValue(false)
                                         .doubleValue(123)
                                         .emptyValue(emptyValue)
                                         .stringValue("stringValue")
                                         .build())
                                 .build()))
                         .templateId("templateId")
                         .build()))
                 .endAssociatedTasksActions(List.of(endAssociatedTasksActions))
                 .eventBridgeActions(List.of(EventBridgeActionProperty.builder()
                         .name("name")
                         .build()))
                 .sendNotificationActions(List.of(SendNotificationActionProperty.builder()
                         .content("content")
                         .contentType("contentType")
                         .deliveryMethod("deliveryMethod")
                         .recipient(NotificationRecipientTypeProperty.builder()
                                 .userArns(List.of("userArns"))
                                 .userTags(Map.of(
                                         "userTagsKey", "userTags"))
                                 .build())
                         // the properties below are optional
                         .subject("subject")
                         .build()))
                 .submitAutoEvaluationActions(List.of(SubmitAutoEvaluationActionProperty.builder()
                         .evaluationFormArn("evaluationFormArn")
                         .build()))
                 .taskActions(List.of(TaskActionProperty.builder()
                         .contactFlowArn("contactFlowArn")
                         .name("name")
                         // the properties below are optional
                         .description("description")
                         .references(Map.of(
                                 "referencesKey", ReferenceProperty.builder()
                                         .type("type")
                                         .value("value")
                                         .build()))
                         .build()))
                 .updateCaseActions(List.of(UpdateCaseActionProperty.builder()
                         .fields(List.of(FieldProperty.builder()
                                 .id("id")
                                 .value(FieldValueProperty.builder()
                                         .booleanValue(false)
                                         .doubleValue(123)
                                         .emptyValue(emptyValue)
                                         .stringValue("stringValue")
                                         .build())
                                 .build()))
                         .build()))
                 .build())
         .function("function")
         .instanceArn("instanceArn")
         .name("name")
         .publishStatus("publishStatus")
         .triggerEventSource(RuleTriggerEventSourceProperty.builder()
                 .eventSourceName("eventSourceName")
                 // the properties below are optional
                 .integrationAssociationArn("integrationAssociationArn")
                 .build())
         // the properties below are optional
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-connect-rule.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CfnRule.ActionsProperty	A list of actions to be run when the rule is triggered.
static final class	CfnRule.Builder	A fluent builder for CfnRule.
static interface	CfnRule.CreateCaseActionProperty	Example:
static interface	CfnRule.EventBridgeActionProperty	The EventBridge action definition.
static interface	CfnRule.FieldProperty	Example:
static interface	CfnRule.FieldValueProperty	Object for case field values.
static interface	CfnRule.NotificationRecipientTypeProperty	The type of notification recipient.
static interface	CfnRule.ReferenceProperty	Information about the reference when the referenceType is URL .
static interface	CfnRule.RuleTriggerEventSourceProperty	The name of the event source.
static interface	CfnRule.SendNotificationActionProperty	Information about the send notification action.
static interface	CfnRule.SubmitAutoEvaluationActionProperty	Example:
static interface	CfnRule.TaskActionProperty	Information about the task action.
static interface	CfnRule.UpdateCaseActionProperty	Example:

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

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

software.constructs.IConstruct.Jsii$Default

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

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

ITaggable.Jsii$Default, ITaggable.Jsii$Proxy

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnRule(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnRule(software.amazon.jsii.JsiiObjectRef objRef)
	CfnRule(software.constructs.Construct scope, String id, CfnRuleProps props)

Method Summary

Modifier and Type	Method	Description
Object	getActions()	A list of actions to be run when the rule is triggered.
String	getAttrRuleArn()	The Amazon Resource Name (ARN) of the rule.
protected Map<String,Object>	getCfnProperties()
String	getFunction()	The conditions of the rule.
String	getInstanceArn()	The Amazon Resource Name (ARN) of the instance.
String	getName()	The name of the rule.
String	getPublishStatus()	The publish status of the rule.
TagManager	getTags()	Tag Manager which manages the tags for this resource.
List<CfnTag>	getTagsRaw()	The tags used to organize, track, or control access for this resource.
Object	getTriggerEventSource()	The event source to trigger the rule.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setActions(IResolvable value)	A list of actions to be run when the rule is triggered.
void	setActions(CfnRule.ActionsProperty value)	A list of actions to be run when the rule is triggered.
void	setFunction(String value)	The conditions of the rule.
void	setInstanceArn(String value)	The Amazon Resource Name (ARN) of the instance.
void	setName(String value)	The name of the rule.
void	setPublishStatus(String value)	The publish status of the rule.
void	setTagsRaw(List<CfnTag> value)	The tags used to organize, track, or control access for this resource.
void	setTriggerEventSource(IResolvable value)	The event source to trigger the rule.
void	setTriggerEventSource(CfnRule.RuleTriggerEventSourceProperty value)	The event source to trigger the rule.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, 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 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

CfnRule

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

CfnRule

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

CfnRule

@Stability(Stable)
public CfnRule(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnRuleProps props)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). 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.

getAttrRuleArn

@Stability(Stable)
@NotNull
public String getAttrRuleArn()

The Amazon Resource Name (ARN) of the rule.

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getTags

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

Tag Manager which manages the tags for this resource.

Specified by:

getTags in interface ITaggable

getActions

@Stability(Stable)
@NotNull
public Object getActions()

A list of actions to be run when the rule is triggered.

setActions

@Stability(Stable)
public void setActions(@NotNull
 IResolvable value)

A list of actions to be run when the rule is triggered.

setActions

@Stability(Stable)
public void setActions(@NotNull
 CfnRule.ActionsProperty value)

A list of actions to be run when the rule is triggered.

getFunction

@Stability(Stable)
@NotNull
public String getFunction()

The conditions of the rule.

setFunction

@Stability(Stable)
public void setFunction(@NotNull
 String value)

The conditions of the rule.

getInstanceArn

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

The Amazon Resource Name (ARN) of the instance.

setInstanceArn

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

The Amazon Resource Name (ARN) of the instance.

getName

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

The name of the rule.

setName

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

The name of the rule.

getPublishStatus

@Stability(Stable)
@NotNull
public String getPublishStatus()

The publish status of the rule.

setPublishStatus

@Stability(Stable)
public void setPublishStatus(@NotNull
 String value)

The publish status of the rule.

getTriggerEventSource

@Stability(Stable)
@NotNull
public Object getTriggerEventSource()

The event source to trigger the rule.

setTriggerEventSource

@Stability(Stable)
public void setTriggerEventSource(@NotNull
 IResolvable value)

The event source to trigger the rule.

setTriggerEventSource

@Stability(Stable)
public void setTriggerEventSource(@NotNull
 CfnRule.RuleTriggerEventSourceProperty value)

The event source to trigger the rule.

getTagsRaw

@Stability(Stable)
@Nullable
public List<CfnTag> getTagsRaw()

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

setTagsRaw

@Stability(Stable)
public void setTagsRaw(@Nullable
 List<CfnTag> value)

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