Package software.amazon.awscdk.services.connect

Interface CfnRuleProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnRuleProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.89.0 (build 2f74b3e)",
           date="2023-10-26T00:56:06.124Z")
@Stability(Stable)
public interface CfnRuleProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnRule.

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;
 CfnRuleProps cfnRuleProps = CfnRuleProps.builder()
         .actions(ActionsProperty.builder()
                 .assignContactCategoryActions(List.of(assignContactCategoryActions))
                 .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()))
                 .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()))
                 .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	Interface	Description
static final class	CfnRuleProps.Builder	A builder for CfnRuleProps
static final class	CfnRuleProps.Jsii$Proxy	An implementation for CfnRuleProps

Method Summary

Modifier and Type	Method	Description
static CfnRuleProps.Builder	builder()
Object	getActions()	A list of actions to be run when the rule is triggered.
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.
default List<CfnTag>	getTags()	The tags used to organize, track, or control access for this resource.
Object	getTriggerEventSource()	The event source to trigger the rule.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getActions

@Stability(Stable)
@NotNull
Object getActions()

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

See Also:

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

getFunction

@Stability(Stable)
@NotNull
String getFunction()

The conditions of the rule.

See Also:

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

getInstanceArn

@Stability(Stable)
@NotNull
String getInstanceArn()

The Amazon Resource Name (ARN) of the instance.

See Also:

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

getName

@Stability(Stable)
@NotNull
String getName()

The name of the rule.

See Also:

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

getPublishStatus

@Stability(Stable)
@NotNull
String getPublishStatus()

The publish status of the rule.

Allowed values : DRAFT | PUBLISHED

See Also:

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

getTriggerEventSource

@Stability(Stable)
@NotNull
Object getTriggerEventSource()

The event source to trigger the rule.

See Also:

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

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

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

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

See Also:

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

builder

@Stability(Stable)
static CfnRuleProps.Builder builder()

Returns:

a CfnRuleProps.Builder of CfnRuleProps