1. Registry
  2. Packages
  3. AWS Cloud Control
  4. API Docs
  5. quicksight
  6. Flow

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.86.0
published on Wednesday, Nov 18, 2026 by Pulumi
aws-native logo aws-native logo AWS Cloud Control

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.86.0
published on Wednesday, Nov 18, 2026 by Pulumi

    Definition of AWS::QuickSight::Flow Resource Type

    Create Flow Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Flow(name: string, args: FlowArgs, opts?: CustomResourceOptions);
    @overload
    def Flow(resource_name: str,
             args: FlowArgs,
             opts: Optional[ResourceOptions] = None)
    
    @overload
    def Flow(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             aws_account_id: Optional[str] = None,
             flow_definition: Optional[Any] = None,
             description: Optional[str] = None,
             name: Optional[str] = None,
             permissions: Optional[Sequence[FlowPermissionArgs]] = None)
    func NewFlow(ctx *Context, name string, args FlowArgs, opts ...ResourceOption) (*Flow, error)
    public Flow(string name, FlowArgs args, CustomResourceOptions? opts = null)
    public Flow(String name, FlowArgs args)
    public Flow(String name, FlowArgs args, CustomResourceOptions options)
    
    type: aws-native:quicksight:Flow
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "aws-native_quicksight_flow" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args FlowArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args FlowArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args FlowArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args FlowArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args FlowArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Flow Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Flow resource accepts the following input properties:

    AwsAccountId string
    FlowDefinition object
    Search the CloudFormation User Guide for AWS::QuickSight::Flow for more information about the expected schema for this property.
    Description string
    Name string
    Permissions List<Pulumi.AwsNative.QuickSight.Inputs.FlowPermission>
    AwsAccountId string
    FlowDefinition interface{}
    Search the CloudFormation User Guide for AWS::QuickSight::Flow for more information about the expected schema for this property.
    Description string
    Name string
    Permissions []FlowPermissionArgs
    aws_account_id string
    flow_definition any
    Search the CloudFormation User Guide for AWS::QuickSight::Flow for more information about the expected schema for this property.
    description string
    name string
    permissions list(object)
    awsAccountId String
    flowDefinition Object
    Search the CloudFormation User Guide for AWS::QuickSight::Flow for more information about the expected schema for this property.
    description String
    name String
    permissions List<FlowPermission>
    awsAccountId string
    flowDefinition any
    Search the CloudFormation User Guide for AWS::QuickSight::Flow for more information about the expected schema for this property.
    description string
    name string
    permissions FlowPermission[]
    aws_account_id str
    flow_definition Any
    Search the CloudFormation User Guide for AWS::QuickSight::Flow for more information about the expected schema for this property.
    description str
    name str
    permissions Sequence[FlowPermissionArgs]
    awsAccountId String
    flowDefinition Any
    Search the CloudFormation User Guide for AWS::QuickSight::Flow for more information about the expected schema for this property.
    description String
    name String
    permissions List<Property Map>

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Flow resource produces the following output properties:

    Arn string
    CreatedTime string
    FlowId string
    Id string
    The provider-assigned unique ID for this managed resource.
    LastUpdatedTime string
    PublishState FlowPublishState
    StepAliases []FlowStepAliasMapping
    arn string
    created_time string
    flow_id string
    id string
    The provider-assigned unique ID for this managed resource.
    last_updated_time string
    publish_state "PUBLISHED" | "DRAFT" | "PENDING_APPROVAL"
    step_aliases list(object)
    arn String
    createdTime String
    flowId String
    id String
    The provider-assigned unique ID for this managed resource.
    lastUpdatedTime String
    publishState FlowPublishState
    stepAliases List<FlowStepAliasMapping>
    arn string
    createdTime string
    flowId string
    id string
    The provider-assigned unique ID for this managed resource.
    lastUpdatedTime string
    publishState FlowPublishState
    stepAliases FlowStepAliasMapping[]
    arn str
    created_time str
    flow_id str
    id str
    The provider-assigned unique ID for this managed resource.
    last_updated_time str
    publish_state FlowPublishState
    step_aliases Sequence[FlowStepAliasMapping]
    arn String
    createdTime String
    flowId String
    id String
    The provider-assigned unique ID for this managed resource.
    lastUpdatedTime String
    publishState "PUBLISHED" | "DRAFT" | "PENDING_APPROVAL"
    stepAliases List<Property Map>

    Look up Existing Flow Resource

    Get an existing Flow resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, opts?: CustomResourceOptions): Flow
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None) -> Flow
    func GetFlow(ctx *Context, name string, id IDInput, state *FlowState, opts ...ResourceOption) (*Flow, error)
    public static Flow Get(string name, Input<string> id, CustomResourceOptions? opts = null)
    public static Flow get(String name, Output<String> id, CustomResourceOptions options)
    resources:  existingFlow:    type: aws-native:quicksight:Flow    get:      id: ${id}
    import {
      to = aws-native_quicksight_flow.example
      id = "${id}"
    }
    
    name string
    The unique name of the resulting resource.
    id Input<ID>
    The unique provider ID of the resource to look up.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resulting resource.
    id str
    The unique provider ID of the resource to look up.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resulting resource.
    id IDInput
    The unique provider ID of the resource to look up.
    state FlowState
    Pass nil. This resource has no state arguments.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resulting resource.
    id Input<string>
    The unique provider ID of the resource to look up.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resulting resource.
    id Output<String>
    The unique provider ID of the resource to look up.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Supporting Types

    FlowPermission, FlowPermissionArgs

    Actions List<string>
    Principal string
    Actions []string
    Principal string
    actions list(string)
    principal string
    actions List<String>
    principal String
    actions string[]
    principal string
    actions Sequence[str]
    principal str
    actions List<String>
    principal String

    FlowPublishState

    NameValue
    PublishedPUBLISHED
    DraftDRAFT
    PendingApprovalPENDING_APPROVAL
    NameValue
    FlowPublishStatePublishedPUBLISHED
    FlowPublishStateDraftDRAFT
    FlowPublishStatePendingApprovalPENDING_APPROVAL
    Value
    PUBLISHED
    DRAFT
    PENDING_APPROVAL
    NameValue
    PublishedPUBLISHED
    DraftDRAFT
    PendingApprovalPENDING_APPROVAL
    NameValue
    PublishedPUBLISHED
    DraftDRAFT
    PendingApprovalPENDING_APPROVAL
    NameValue
    PUBLISHEDPUBLISHED
    DRAFTDRAFT
    PENDING_APPROVALPENDING_APPROVAL
    Value
    PUBLISHED
    DRAFT
    PENDING_APPROVAL

    FlowStepAliasMapping

    StepAlias string
    StepId string
    StepAlias string
    StepId string
    step_alias string
    step_id string
    stepAlias String
    stepId String
    stepAlias string
    stepId string
    stepAlias String
    stepId String

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo aws-native logo AWS Cloud Control

    We recommend new projects start with resources from the AWS provider.

    Viewing docs for AWS Cloud Control v1.86.0
    published on Wednesday, Nov 18, 2026 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial