flow

Gets an individual flow resource

Overview

Name	flow
Type	Resource
Description	flow
Id	awscc.appflow.flow

Fields

Name	Datatype	Description
flow_arn	string	ARN identifier of the flow.
flow_name	string	Name of the flow.
description	string	Description of the flow.
kms_arn	string	The ARN of the AWS Key Management Service (AWS KMS) key that's used to encrypt your function's environment variables. If it's not provided, AWS Lambda uses a default service key.
trigger_config	object	Trigger settings of the flow.
flow_status	string	Flow activation status for Scheduled- and Event-triggered flows
source_flow_config	object	Configurations of Source connector of the flow.
destination_flow_config_list	array	List of Destination connectors of the flow.
tasks	array	List of tasks for the flow.
tags	array	List of Tags.
metadata_catalog_config	object	Configurations of metadata catalog of the flow.
region	string	AWS region.

Methods

Currently only SELECT is supported for this resource resource.

Example

SELECT
region,
flow_arn,
flow_name,
description,
kms_arn,
trigger_config,
flow_status,
source_flow_config,
destination_flow_config_list,
tasks,
tags,
metadata_catalog_config
FROM awscc.appflow.flow
WHERE data__Identifier = '<FlowName>';

Permissions

To operate on the flow resource, the following permissions are required:

Read

appflow:DescribeFlow,
appflow:ListTagsForResource

Update

appflow:UpdateFlow,
appflow:StartFlow,
appflow:StopFlow,
appflow:TagResource,
appflow:UntagResource,
appflow:ListTagsForResource,
appflow:UseConnectorProfile,
iam:PassRole,
s3:ListAllMyBuckets,
s3:GetBucketLocation,
s3:GetBucketPolicy,
kms:ListGrants,
secretsmanager:CreateSecret,
secretsmanager:PutResourcePolicy

Delete

appflow:DeleteFlow