Package software.amazon.awscdk.services.quicksight

Class CfnFlow

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.quicksight.CfnFlow
All Implemented Interfaces:
IInspectable, IEnvironmentAware, IFlowRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.138.0 (build 0ca7ee8)", date="2026-07-22T17:37:32.279Z") @Stability(Stable) public class CfnFlow extends CfnResource implements IInspectable, IFlowRef
Definition of AWS::QuickSight::Flow Resource Type.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.quicksight.*;
 Object flowDefinition;
 CfnFlow cfnFlow = CfnFlow.Builder.create(this, "MyCfnFlow")
         .awsAccountId("awsAccountId")
         .flowDefinition(flowDefinition)
         .name("name")
         // the properties below are optional
         .description("description")
         .permissions(List.of(PermissionProperty.builder()
                 .actions(List.of("actions"))
                 .principal("principal")
                 .build()))
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnFlow

      protected CfnFlow(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnFlow

      protected CfnFlow(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnFlow

      @Stability(Stable) public CfnFlow(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnFlowProps props)
      Create a new AWS::QuickSight::Flow.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • arnForFlow

      @Stability(Stable) @NotNull public static String arnForFlow(@NotNull IFlowRef resource)
      Parameters:
      resource - This parameter is required.

    • isCfnFlow

      @Stability(Stable) @NotNull public static Boolean isCfnFlow(@NotNull Object x)
      Checks whether the given object is a CfnFlow.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()

    • getAttrCreatedTime

      @Stability(Stable) @NotNull public String getAttrCreatedTime()

    • getAttrFlowId

      @Stability(Stable) @NotNull public String getAttrFlowId()

    • getAttrLastUpdatedTime

      @Stability(Stable) @NotNull public String getAttrLastUpdatedTime()

    • getAttrPublishState

      @Stability(Stable) @NotNull public String getAttrPublishState()

    • getAttrStepAliases

      @Stability(Stable) @NotNull public IResolvable getAttrStepAliases()

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getCfnPropertyNames

      @Stability(Stable) @NotNull protected Map<String,String> getCfnPropertyNames()
      Overrides:
      getCfnPropertyNames in class CfnResource

    • getFlowRef

      @Stability(Stable) @NotNull public FlowReference getFlowRef()
      A reference to a Flow resource.
      Specified by:
      getFlowRef in interface IFlowRef

    • getAwsAccountId

      @Stability(Stable) @NotNull public String getAwsAccountId()

    • setAwsAccountId

      @Stability(Stable) public void setAwsAccountId(@NotNull String value)

    • getFlowDefinition

      @Stability(Stable) @NotNull public Object getFlowDefinition()

    • setFlowDefinition

      @Stability(Stable) public void setFlowDefinition(@NotNull Object value)

    • getName

      @Stability(Stable) @NotNull public String getName()

    • setName

      @Stability(Stable) public void setName(@NotNull String value)

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)

    • getPermissions

      @Stability(Stable) @Nullable public Object getPermissions()
      Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnFlow.PermissionProperty>

    • setPermissions

      @Stability(Stable) public void setPermissions(@Nullable IResolvable value)

    • setPermissions

      @Stability(Stable) public void setPermissions(@Nullable List<Object> value)