CfnRulePropsMixin
- class aws_cdk.mixins_preview.aws_connect.mixins.CfnRulePropsMixin(props, *, strategy=None)
Bases:
MixinCreates a rule for the specified Amazon Connect instance.
- See:
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-connect-rule.html
- CloudformationResource:
AWS::Connect::Rule
- Mixin:
true
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview import mixins from aws_cdk.mixins_preview.aws_connect import mixins as connect_mixins # assign_contact_category_actions: Any # empty_value: Any # end_associated_tasks_actions: Any cfn_rule_props_mixin = connect_mixins.CfnRulePropsMixin(connect_mixins.CfnRuleMixinProps( actions=connect_mixins.CfnRulePropsMixin.ActionsProperty( assign_contact_category_actions=[assign_contact_category_actions], create_case_actions=[connect_mixins.CfnRulePropsMixin.CreateCaseActionProperty( fields=[connect_mixins.CfnRulePropsMixin.FieldProperty( id="id", value=connect_mixins.CfnRulePropsMixin.FieldValueProperty( boolean_value=False, double_value=123, empty_value=empty_value, string_value="stringValue" ) )], template_id="templateId" )], end_associated_tasks_actions=[end_associated_tasks_actions], event_bridge_actions=[connect_mixins.CfnRulePropsMixin.EventBridgeActionProperty( name="name" )], send_notification_actions=[connect_mixins.CfnRulePropsMixin.SendNotificationActionProperty( content="content", content_type="contentType", delivery_method="deliveryMethod", recipient=connect_mixins.CfnRulePropsMixin.NotificationRecipientTypeProperty( user_arns=["userArns"], user_tags={ "user_tags_key": "userTags" } ), subject="subject" )], submit_auto_evaluation_actions=[connect_mixins.CfnRulePropsMixin.SubmitAutoEvaluationActionProperty( evaluation_form_arn="evaluationFormArn" )], task_actions=[connect_mixins.CfnRulePropsMixin.TaskActionProperty( contact_flow_arn="contactFlowArn", description="description", name="name", references={ "references_key": connect_mixins.CfnRulePropsMixin.ReferenceProperty( type="type", value="value" ) } )], update_case_actions=[connect_mixins.CfnRulePropsMixin.UpdateCaseActionProperty( fields=[connect_mixins.CfnRulePropsMixin.FieldProperty( id="id", value=connect_mixins.CfnRulePropsMixin.FieldValueProperty( boolean_value=False, double_value=123, empty_value=empty_value, string_value="stringValue" ) )] )] ), function="function", instance_arn="instanceArn", name="name", publish_status="publishStatus", tags=[CfnTag( key="key", value="value" )], trigger_event_source=connect_mixins.CfnRulePropsMixin.RuleTriggerEventSourceProperty( event_source_name="eventSourceName", integration_association_arn="integrationAssociationArn" ) ), strategy=mixins.PropertyMergeStrategy.OVERRIDE )
Create a mixin to apply properties to
AWS::Connect::Rule.- Parameters:
props (
Union[CfnRuleMixinProps,Dict[str,Any]]) – L1 properties to apply.strategy (
Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE
Methods
- apply_to(construct)
Apply the mixin properties to the construct.
- Parameters:
construct (
IConstruct)- Return type:
- supports(construct)
Check if this mixin supports the given construct.
- Parameters:
construct (
IConstruct)- Return type:
bool
Attributes
- CFN_PROPERTY_KEYS = ['actions', 'function', 'instanceArn', 'name', 'publishStatus', 'tags', 'triggerEventSource']
Static Methods
- classmethod is_mixin(x)
(experimental) Checks if
xis a Mixin.- Parameters:
x (
Any) – Any object.- Return type:
bool- Returns:
true if
xis an object created from a class which extendsMixin.- Stability:
experimental
ActionsProperty
- class CfnRulePropsMixin.ActionsProperty(*, assign_contact_category_actions=None, create_case_actions=None, end_associated_tasks_actions=None, event_bridge_actions=None, send_notification_actions=None, submit_auto_evaluation_actions=None, task_actions=None, update_case_actions=None)
Bases:
objectA list of actions to be run when the rule is triggered.
- Parameters:
assign_contact_category_actions (
Union[Sequence[Any],IResolvable,None]) – Information about the contact category action. The syntax can be empty, for example,{}.create_case_actions (
Union[IResolvable,Sequence[Union[IResolvable,CreateCaseActionProperty,Dict[str,Any]]],None]) – This action will create a case when a rule is triggered.end_associated_tasks_actions (
Union[Sequence[Any],IResolvable,None]) – This action will end associated tasks when a rule is triggered.event_bridge_actions (
Union[IResolvable,Sequence[Union[IResolvable,EventBridgeActionProperty,Dict[str,Any]]],None]) – Information about the EventBridge action.send_notification_actions (
Union[IResolvable,Sequence[Union[IResolvable,SendNotificationActionProperty,Dict[str,Any]]],None]) – Information about the send notification action.submit_auto_evaluation_actions (
Union[IResolvable,Sequence[Union[IResolvable,SubmitAutoEvaluationActionProperty,Dict[str,Any]]],None]) – This action will submit an auto contact evaluation when a rule is triggered.task_actions (
Union[IResolvable,Sequence[Union[IResolvable,TaskActionProperty,Dict[str,Any]]],None]) – Information about the task action. This field is required ifTriggerEventSourceis one of the following values:OnZendeskTicketCreate|OnZendeskTicketStatusUpdate|OnSalesforceCaseCreateupdate_case_actions (
Union[IResolvable,Sequence[Union[IResolvable,UpdateCaseActionProperty,Dict[str,Any]]],None]) – This action will update a case when a rule is triggered.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview.aws_connect import mixins as connect_mixins # assign_contact_category_actions: Any # empty_value: Any # end_associated_tasks_actions: Any actions_property = connect_mixins.CfnRulePropsMixin.ActionsProperty( assign_contact_category_actions=[assign_contact_category_actions], create_case_actions=[connect_mixins.CfnRulePropsMixin.CreateCaseActionProperty( fields=[connect_mixins.CfnRulePropsMixin.FieldProperty( id="id", value=connect_mixins.CfnRulePropsMixin.FieldValueProperty( boolean_value=False, double_value=123, empty_value=empty_value, string_value="stringValue" ) )], template_id="templateId" )], end_associated_tasks_actions=[end_associated_tasks_actions], event_bridge_actions=[connect_mixins.CfnRulePropsMixin.EventBridgeActionProperty( name="name" )], send_notification_actions=[connect_mixins.CfnRulePropsMixin.SendNotificationActionProperty( content="content", content_type="contentType", delivery_method="deliveryMethod", recipient=connect_mixins.CfnRulePropsMixin.NotificationRecipientTypeProperty( user_arns=["userArns"], user_tags={ "user_tags_key": "userTags" } ), subject="subject" )], submit_auto_evaluation_actions=[connect_mixins.CfnRulePropsMixin.SubmitAutoEvaluationActionProperty( evaluation_form_arn="evaluationFormArn" )], task_actions=[connect_mixins.CfnRulePropsMixin.TaskActionProperty( contact_flow_arn="contactFlowArn", description="description", name="name", references={ "references_key": connect_mixins.CfnRulePropsMixin.ReferenceProperty( type="type", value="value" ) } )], update_case_actions=[connect_mixins.CfnRulePropsMixin.UpdateCaseActionProperty( fields=[connect_mixins.CfnRulePropsMixin.FieldProperty( id="id", value=connect_mixins.CfnRulePropsMixin.FieldValueProperty( boolean_value=False, double_value=123, empty_value=empty_value, string_value="stringValue" ) )] )] )
Attributes
- assign_contact_category_actions
Information about the contact category action.
The syntax can be empty, for example,
{}.
- create_case_actions
This action will create a case when a rule is triggered.
- end_associated_tasks_actions
This action will end associated tasks when a rule is triggered.
- event_bridge_actions
Information about the EventBridge action.
- send_notification_actions
Information about the send notification action.
- submit_auto_evaluation_actions
This action will submit an auto contact evaluation when a rule is triggered.
- task_actions
Information about the task action.
This field is required if
TriggerEventSourceis one of the following values:OnZendeskTicketCreate|OnZendeskTicketStatusUpdate|OnSalesforceCaseCreate
- update_case_actions
This action will update a case when a rule is triggered.
CreateCaseActionProperty
- class CfnRulePropsMixin.CreateCaseActionProperty(*, fields=None, template_id=None)
Bases:
object- Parameters:
fields (
Union[IResolvable,Sequence[Union[IResolvable,FieldProperty,Dict[str,Any]]],None]) – An array of case fields.template_id (
Optional[str])
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview.aws_connect import mixins as connect_mixins # empty_value: Any create_case_action_property = connect_mixins.CfnRulePropsMixin.CreateCaseActionProperty( fields=[connect_mixins.CfnRulePropsMixin.FieldProperty( id="id", value=connect_mixins.CfnRulePropsMixin.FieldValueProperty( boolean_value=False, double_value=123, empty_value=empty_value, string_value="stringValue" ) )], template_id="templateId" )
Attributes
- fields
An array of case fields.
EventBridgeActionProperty
- class CfnRulePropsMixin.EventBridgeActionProperty(*, name=None)
Bases:
objectThe EventBridge action definition.
- Parameters:
name (
Optional[str]) – The name.- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview.aws_connect import mixins as connect_mixins event_bridge_action_property = connect_mixins.CfnRulePropsMixin.EventBridgeActionProperty( name="name" )
Attributes
FieldProperty
- class CfnRulePropsMixin.FieldProperty(*, id=None, value=None)
Bases:
object- Parameters:
id (
Optional[str])value (
Union[IResolvable,FieldValueProperty,Dict[str,Any],None]) – Object for case field values.
- See:
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-rule-field.html
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview.aws_connect import mixins as connect_mixins # empty_value: Any field_property = connect_mixins.CfnRulePropsMixin.FieldProperty( id="id", value=connect_mixins.CfnRulePropsMixin.FieldValueProperty( boolean_value=False, double_value=123, empty_value=empty_value, string_value="stringValue" ) )
Attributes
- id
-
- Type:
see
- value
Object for case field values.
FieldValueProperty
- class CfnRulePropsMixin.FieldValueProperty(*, boolean_value=None, double_value=None, empty_value=None, string_value=None)
Bases:
objectObject for case field values.
- Parameters:
boolean_value (
Union[bool,IResolvable,None])double_value (
Union[int,float,None])empty_value (
Any)string_value (
Optional[str])
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview.aws_connect import mixins as connect_mixins # empty_value: Any field_value_property = connect_mixins.CfnRulePropsMixin.FieldValueProperty( boolean_value=False, double_value=123, empty_value=empty_value, string_value="stringValue" )
Attributes
- boolean_value
-
- Type:
see
- double_value
-
- Type:
see
- empty_value
-
- Type:
see
NotificationRecipientTypeProperty
- class CfnRulePropsMixin.NotificationRecipientTypeProperty(*, user_arns=None, user_tags=None)
Bases:
objectThe type of notification recipient.
- Parameters:
user_arns (
Optional[Sequence[str]]) – The Amazon Resource Name (ARN) of the user account.user_tags (
Union[Mapping[str,str],IResolvable,None]) – The tags used to organize, track, or control access for this resource. For example, { “tags”: {“key1”:”value1”, “key2”:”value2”} }. Amazon Connect users with the specified tags will be notified.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview.aws_connect import mixins as connect_mixins notification_recipient_type_property = connect_mixins.CfnRulePropsMixin.NotificationRecipientTypeProperty( user_arns=["userArns"], user_tags={ "user_tags_key": "userTags" } )
Attributes
- user_arns
The Amazon Resource Name (ARN) of the user account.
- user_tags
The tags used to organize, track, or control access for this resource.
For example, { “tags”: {“key1”:”value1”, “key2”:”value2”} }. Amazon Connect users with the specified tags will be notified.
ReferenceProperty
- class CfnRulePropsMixin.ReferenceProperty(*, type=None, value=None)
Bases:
objectInformation about the reference when the
referenceTypeisURL.Otherwise, null. (Supports variable injection in the
Valuefield.)- Parameters:
type (
Optional[str]) – The type of the reference.DATEmust be of type Epoch timestamp. Allowed values :URL|ATTACHMENT|NUMBER|STRING|DATE|EMAILvalue (
Optional[str]) – A valid value for the reference. For example, for a URL reference, a formatted URL that is displayed to an agent in the Contact Control Panel (CCP).
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview.aws_connect import mixins as connect_mixins reference_property = connect_mixins.CfnRulePropsMixin.ReferenceProperty( type="type", value="value" )
Attributes
- type
The type of the reference.
DATEmust be of type Epoch timestamp.Allowed values :
URL|ATTACHMENT|NUMBER|STRING|DATE|EMAIL
- value
A valid value for the reference.
For example, for a URL reference, a formatted URL that is displayed to an agent in the Contact Control Panel (CCP).
RuleTriggerEventSourceProperty
- class CfnRulePropsMixin.RuleTriggerEventSourceProperty(*, event_source_name=None, integration_association_arn=None)
Bases:
objectThe name of the event source.
- Parameters:
event_source_name (
Optional[str]) – The name of the event source.integration_association_arn (
Optional[str]) – The Amazon Resource Name (ARN) of the integration association.IntegrationAssociationArnis required ifTriggerEventSourceis one of the following values:OnZendeskTicketCreate|OnZendeskTicketStatusUpdate|OnSalesforceCaseCreate
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview.aws_connect import mixins as connect_mixins rule_trigger_event_source_property = connect_mixins.CfnRulePropsMixin.RuleTriggerEventSourceProperty( event_source_name="eventSourceName", integration_association_arn="integrationAssociationArn" )
Attributes
- event_source_name
The name of the event source.
- integration_association_arn
The Amazon Resource Name (ARN) of the integration association.
IntegrationAssociationArnis required ifTriggerEventSourceis one of the following values:OnZendeskTicketCreate|OnZendeskTicketStatusUpdate|OnSalesforceCaseCreate
SendNotificationActionProperty
- class CfnRulePropsMixin.SendNotificationActionProperty(*, content=None, content_type=None, delivery_method=None, recipient=None, subject=None)
Bases:
objectInformation about the send notification action.
- Parameters:
content (
Optional[str]) – Notification content. Supports variable injection. For more information, see JSONPath reference in the Amazon Connect Administrators Guide .content_type (
Optional[str]) – Content type format. Allowed value :PLAIN_TEXTdelivery_method (
Optional[str]) – Notification delivery method. Allowed value :EMAILrecipient (
Union[IResolvable,NotificationRecipientTypeProperty,Dict[str,Any],None]) – Notification recipient.subject (
Optional[str]) –The subject of the email if the delivery method is
EMAIL. Supports variable injection. For more information, see JSONPath reference in the Amazon Connect Administrators Guide .
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview.aws_connect import mixins as connect_mixins send_notification_action_property = connect_mixins.CfnRulePropsMixin.SendNotificationActionProperty( content="content", content_type="contentType", delivery_method="deliveryMethod", recipient=connect_mixins.CfnRulePropsMixin.NotificationRecipientTypeProperty( user_arns=["userArns"], user_tags={ "user_tags_key": "userTags" } ), subject="subject" )
Attributes
- content
Notification content.
Supports variable injection. For more information, see JSONPath reference in the Amazon Connect Administrators Guide .
- content_type
Content type format.
Allowed value :
PLAIN_TEXT
- delivery_method
Notification delivery method.
Allowed value :
EMAIL
- recipient
Notification recipient.
- subject
The subject of the email if the delivery method is
EMAIL.Supports variable injection. For more information, see JSONPath reference in the Amazon Connect Administrators Guide .
SubmitAutoEvaluationActionProperty
- class CfnRulePropsMixin.SubmitAutoEvaluationActionProperty(*, evaluation_form_arn=None)
Bases:
object- Parameters:
evaluation_form_arn (
Optional[str])- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview.aws_connect import mixins as connect_mixins submit_auto_evaluation_action_property = connect_mixins.CfnRulePropsMixin.SubmitAutoEvaluationActionProperty( evaluation_form_arn="evaluationFormArn" )
Attributes
TaskActionProperty
- class CfnRulePropsMixin.TaskActionProperty(*, contact_flow_arn=None, description=None, name=None, references=None)
Bases:
objectInformation about the task action.
This field is required if
TriggerEventSourceis one of the following values:OnZendeskTicketCreate|OnZendeskTicketStatusUpdate|OnSalesforceCaseCreate- Parameters:
contact_flow_arn (
Optional[str]) – The Amazon Resource Name (ARN) of the flow.description (
Optional[str]) –The description. Supports variable injection. For more information, see JSONPath reference in the Amazon Connect Administrators Guide .
name (
Optional[str]) –The name. Supports variable injection. For more information, see JSONPath reference in the Amazon Connect Administrators Guide .
references (
Union[IResolvable,Mapping[str,Union[IResolvable,ReferenceProperty,Dict[str,Any]]],None]) – Information about the reference when thereferenceTypeisURL. Otherwise, null.URLis the only accepted type. (Supports variable injection in theValuefield.)
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview.aws_connect import mixins as connect_mixins task_action_property = connect_mixins.CfnRulePropsMixin.TaskActionProperty( contact_flow_arn="contactFlowArn", description="description", name="name", references={ "references_key": connect_mixins.CfnRulePropsMixin.ReferenceProperty( type="type", value="value" ) } )
Attributes
- contact_flow_arn
The Amazon Resource Name (ARN) of the flow.
- description
The description.
Supports variable injection. For more information, see JSONPath reference in the Amazon Connect Administrators Guide .
- name
The name.
Supports variable injection. For more information, see JSONPath reference in the Amazon Connect Administrators Guide .
- references
Information about the reference when the
referenceTypeisURL.Otherwise, null.
URLis the only accepted type. (Supports variable injection in theValuefield.)
UpdateCaseActionProperty
- class CfnRulePropsMixin.UpdateCaseActionProperty(*, fields=None)
Bases:
object- Parameters:
fields (
Union[IResolvable,Sequence[Union[IResolvable,FieldProperty,Dict[str,Any]]],None]) – An array of case fields.- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview.aws_connect import mixins as connect_mixins # empty_value: Any update_case_action_property = connect_mixins.CfnRulePropsMixin.UpdateCaseActionProperty( fields=[connect_mixins.CfnRulePropsMixin.FieldProperty( id="id", value=connect_mixins.CfnRulePropsMixin.FieldValueProperty( boolean_value=False, double_value=123, empty_value=empty_value, string_value="stringValue" ) )] )
Attributes