contact_flow_module_alias

Creates, updates, deletes, gets or lists a contact_flow_module_alias resource.

Overview

Name	contact_flow_module_alias
Type	Resource
Id	aws.connect.contact_flow_module_alias

Fields

The following fields are returned by SELECT queries:

describe_contact_flow_module_alias

Name	Datatype	Description
alias_id	string	The identifier of the alias. (pattern: <code>^([$0-9a-zA-Z][_-]?)+$</code>)
contact_flow_module_arn	string	The Amazon Resource Name (ARN) of the flow module.
contact_flow_module_id	string	The identifier of the flow module.
description	string	The description of the alias. (pattern: <code>.\S.</code>)
last_modified_region	string	The Amazon Web Services Region where this resource was last modified. (pattern: <code>[a-z]{2}(-[a-z]+){1,2}(-[0-9])?</code>)
last_modified_time	string (date-time)	The timestamp when this resource was last modified.
name	string	The name of the alias. (pattern: <code>^([$0-9a-zA-Z][_-]?)+$</code>)
version	integer (int64)	The version of the flow module.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_contact_flow_module_alias	select	instance_id, contact_flow_module_id, alias_id, region		Retrieves detailed information about a specific alias, including which version it currently points to and its metadata.
create_contact_flow_module_alias	insert	instance_id, contact_flow_module_id, region, ContactFlowModuleVersion, AliasName		Creates a named alias that points to a specific version of a contact flow module.
update_contact_flow_module_alias	update	instance_id, contact_flow_module_id, alias_id, region		Updates a specific Aliases metadata, including the version it’s tied to, it’s name, and description.
delete_contact_flow_module_alias	delete	instance_id, contact_flow_module_id, alias_id, region		Removes an alias reference, breaking the named connection to the underlying module version without affecting the version itself.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
alias_id	string	The identifier of the alias.
contact_flow_module_id	string	The identifier of the flow module.
instance_id	string	The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
region	string	AWS region (default: us-east-1)

SELECT examples

describe_contact_flow_module_alias

Retrieves detailed information about a specific alias, including which version it currently points to and its metadata.

SELECT
alias_id,
contact_flow_module_arn,
contact_flow_module_id,
description,
last_modified_region,
last_modified_time,
name,
version
FROM aws.connect.contact_flow_module_alias
WHERE instance_id = '{{ instance_id }}' -- required
AND contact_flow_module_id = '{{ contact_flow_module_id }}' -- required
AND alias_id = '{{ alias_id }}' -- required
AND region = '{{ region }}' -- required
;

INSERT examples

create_contact_flow_module_alias

Creates a named alias that points to a specific version of a contact flow module.

INSERT INTO aws.connect.contact_flow_module_alias (
Description,
ContactFlowModuleVersion,
AliasName,
instance_id,
contact_flow_module_id,
region
)
SELECT 
'{{ Description }}',
{{ ContactFlowModuleVersion }} /* required */,
'{{ AliasName }}' /* required */,
'{{ instance_id }}',
'{{ contact_flow_module_id }}',
'{{ region }}'
RETURNING
contact_flow_module_arn,
id
;

Manifest

# Description fields are for documentation purposes
- name: contact_flow_module_alias
props:
  - name: instance_id
    value: "{{ instance_id }}"
    description: Required parameter for the contact_flow_module_alias resource.
  - name: contact_flow_module_id
    value: "{{ contact_flow_module_id }}"
    description: Required parameter for the contact_flow_module_alias resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the contact_flow_module_alias resource.
  - name: Description
    value: "{{ Description }}"
  - name: ContactFlowModuleVersion
    value: {{ ContactFlowModuleVersion }}
  - name: AliasName
    value: "{{ AliasName }}"

UPDATE examples

update_contact_flow_module_alias

Updates a specific Aliases metadata, including the version it’s tied to, it’s name, and description.

UPDATE aws.connect.contact_flow_module_alias
SET 
Name = '{{ Name }}',
Description = '{{ Description }}',
ContactFlowModuleVersion = {{ ContactFlowModuleVersion }}
WHERE 
instance_id = '{{ instance_id }}' --required
AND contact_flow_module_id = '{{ contact_flow_module_id }}' --required
AND alias_id = '{{ alias_id }}' --required
AND region = '{{ region }}' --required;

DELETE examples

delete_contact_flow_module_alias

Removes an alias reference, breaking the named connection to the underlying module version without affecting the version itself.

DELETE FROM aws.connect.contact_flow_module_alias
WHERE instance_id = '{{ instance_id }}' --required
AND contact_flow_module_id = '{{ contact_flow_module_id }}' --required
AND alias_id = '{{ alias_id }}' --required
AND region = '{{ region }}' --required
;