Class CfnRule
Creates a rule for the specified Amazon Connect instance.
Inherited Members
Namespace: Amazon.CDK.AWS.Connect
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnRule : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnRule
Inherits CfnResource
Implements IInspectable, ITaggable
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-connect-rule.html
CloudformationResource: AWS::Connect::Rule
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Connect;
var assignContactCategoryActions;
var emptyValue;
var endAssociatedTasksActions;
var cfnRule = new CfnRule(this, "MyCfnRule", new CfnRuleProps {
Actions = new ActionsProperty {
AssignContactCategoryActions = new [] { assignContactCategoryActions },
CreateCaseActions = new [] { new CreateCaseActionProperty {
Fields = new [] { new FieldProperty {
Id = "id",
Value = new FieldValueProperty {
BooleanValue = false,
DoubleValue = 123,
EmptyValue = emptyValue,
StringValue = "stringValue"
}
} },
TemplateId = "templateId"
} },
EndAssociatedTasksActions = new [] { endAssociatedTasksActions },
EventBridgeActions = new [] { new EventBridgeActionProperty {
Name = "name"
} },
SendNotificationActions = new [] { new SendNotificationActionProperty {
Content = "content",
ContentType = "contentType",
DeliveryMethod = "deliveryMethod",
Recipient = new NotificationRecipientTypeProperty {
UserArns = new [] { "userArns" },
UserTags = new Dictionary<string, string> {
{ "userTagsKey", "userTags" }
}
},
// the properties below are optional
Subject = "subject"
} },
TaskActions = new [] { new TaskActionProperty {
ContactFlowArn = "contactFlowArn",
Name = "name",
// the properties below are optional
Description = "description",
References = new Dictionary<string, object> {
{ "referencesKey", new ReferenceProperty {
Type = "type",
Value = "value"
} }
}
} },
UpdateCaseActions = new [] { new UpdateCaseActionProperty {
Fields = new [] { new FieldProperty {
Id = "id",
Value = new FieldValueProperty {
BooleanValue = false,
DoubleValue = 123,
EmptyValue = emptyValue,
StringValue = "stringValue"
}
} }
} }
},
Function = "function",
InstanceArn = "instanceArn",
Name = "name",
PublishStatus = "publishStatus",
TriggerEventSource = new RuleTriggerEventSourceProperty {
EventSourceName = "eventSourceName",
// the properties below are optional
IntegrationAssociationArn = "integrationAssociationArn"
},
// the properties below are optional
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
CfnRule(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnRule(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnRule(Construct, String, ICfnRuleProps) |
Properties
Actions | A list of actions to be run when the rule is triggered. |
AttrRuleArn | The Amazon Resource Name (ARN) of the rule. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
Function | The conditions of the rule. |
InstanceArn | The Amazon Resource Name (ARN) of the instance. |
Name | The name of the rule. |
PublishStatus | The publish status of the rule. |
Tags | Tag Manager which manages the tags for this resource. |
TagsRaw | The tags used to organize, track, or control access for this resource. |
TriggerEventSource | The event source to trigger the rule. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnRule(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnRule(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnRule(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnRule(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnRule(Construct, String, ICfnRuleProps)
public CfnRule(Construct scope, string id, ICfnRuleProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnRuleProps
Resource properties.
Properties
Actions
A list of actions to be run when the rule is triggered.
public virtual object Actions { get; set; }
Property Value
System.Object
AttrRuleArn
The Amazon Resource Name (ARN) of the rule.
public virtual string AttrRuleArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: RuleArn
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
Function
The conditions of the rule.
public virtual string Function { get; set; }
Property Value
System.String
InstanceArn
The Amazon Resource Name (ARN) of the instance.
public virtual string InstanceArn { get; set; }
Property Value
System.String
Name
The name of the rule.
public virtual string Name { get; set; }
Property Value
System.String
PublishStatus
The publish status of the rule.
public virtual string PublishStatus { get; set; }
Property Value
System.String
Tags
Tag Manager which manages the tags for this resource.
public virtual TagManager Tags { get; }
Property Value
TagsRaw
The tags used to organize, track, or control access for this resource.
public virtual ICfnTag[] TagsRaw { get; set; }
Property Value
ICfnTag[]
TriggerEventSource
The event source to trigger the rule.
public virtual object TriggerEventSource { get; set; }
Property Value
System.Object
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>