1. Packages
  2. Alibaba Cloud
  3. API Docs
  4. nas
  5. DataFlow
Alibaba Cloud v3.59.0 published on Friday, Jul 12, 2024 by Pulumi

alicloud.nas.DataFlow

Explore with Pulumi AI

alicloud logo
Alibaba Cloud v3.59.0 published on Friday, Jul 12, 2024 by Pulumi

    Provides a Network Attached Storage (NAS) Data Flow resource.

    For information about Network Attached Storage (NAS) Data Flow and how to use it, see What is Data Flow.

    NOTE: Available since v1.153.0.

    Create DataFlow Resource

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

    Constructor syntax

    new DataFlow(name: string, args: DataFlowArgs, opts?: CustomResourceOptions);
    @overload
    def DataFlow(resource_name: str,
                 args: DataFlowArgs,
                 opts: Optional[ResourceOptions] = None)
    
    @overload
    def DataFlow(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 file_system_id: Optional[str] = None,
                 fset_id: Optional[str] = None,
                 source_storage: Optional[str] = None,
                 throughput: Optional[int] = None,
                 description: Optional[str] = None,
                 dry_run: Optional[bool] = None,
                 source_security_type: Optional[str] = None,
                 status: Optional[str] = None)
    func NewDataFlow(ctx *Context, name string, args DataFlowArgs, opts ...ResourceOption) (*DataFlow, error)
    public DataFlow(string name, DataFlowArgs args, CustomResourceOptions? opts = null)
    public DataFlow(String name, DataFlowArgs args)
    public DataFlow(String name, DataFlowArgs args, CustomResourceOptions options)
    
    type: alicloud:nas:DataFlow
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args DataFlowArgs
    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 DataFlowArgs
    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 DataFlowArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DataFlowArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DataFlowArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var dataFlowResource = new AliCloud.Nas.DataFlow("dataFlowResource", new()
    {
        FileSystemId = "string",
        FsetId = "string",
        SourceStorage = "string",
        Throughput = 0,
        Description = "string",
        DryRun = false,
        SourceSecurityType = "string",
        Status = "string",
    });
    
    example, err := nas.NewDataFlow(ctx, "dataFlowResource", &nas.DataFlowArgs{
    	FileSystemId:       pulumi.String("string"),
    	FsetId:             pulumi.String("string"),
    	SourceStorage:      pulumi.String("string"),
    	Throughput:         pulumi.Int(0),
    	Description:        pulumi.String("string"),
    	DryRun:             pulumi.Bool(false),
    	SourceSecurityType: pulumi.String("string"),
    	Status:             pulumi.String("string"),
    })
    
    var dataFlowResource = new DataFlow("dataFlowResource", DataFlowArgs.builder()
        .fileSystemId("string")
        .fsetId("string")
        .sourceStorage("string")
        .throughput(0)
        .description("string")
        .dryRun(false)
        .sourceSecurityType("string")
        .status("string")
        .build());
    
    data_flow_resource = alicloud.nas.DataFlow("dataFlowResource",
        file_system_id="string",
        fset_id="string",
        source_storage="string",
        throughput=0,
        description="string",
        dry_run=False,
        source_security_type="string",
        status="string")
    
    const dataFlowResource = new alicloud.nas.DataFlow("dataFlowResource", {
        fileSystemId: "string",
        fsetId: "string",
        sourceStorage: "string",
        throughput: 0,
        description: "string",
        dryRun: false,
        sourceSecurityType: "string",
        status: "string",
    });
    
    type: alicloud:nas:DataFlow
    properties:
        description: string
        dryRun: false
        fileSystemId: string
        fsetId: string
        sourceSecurityType: string
        sourceStorage: string
        status: string
        throughput: 0
    

    DataFlow Resource Properties

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

    Inputs

    The DataFlow resource accepts the following input properties:

    FileSystemId string
    The ID of the file system.
    FsetId string
    The ID of the Fileset.
    SourceStorage string
    The access path of the source store. Format: <storage type>://<path>. Among them:

    • storage type: currently only OSS is supported.
    • path: the bucket name of OSS.
    • Only lowercase letters, numbers, and dashes (-) are supported and must start and end with lowercase letters or numbers.
    Throughput int
    The maximum transmission bandwidth of data flow, unit: MB/s. Valid values: 1200, 1500, 600. NOTE: The transmission bandwidth of data flow must be less than the IO bandwidth of the file system.
    Description string
    The Description of the data flow. Restrictions:
    DryRun bool
    The dry run.
    SourceSecurityType string
    The security protection type of the source storage. If the source storage must be accessed through security protection, specify the security protection type of the source storage. Value:

    • NONE (default): Indicates that the source storage does not need to be accessed through security protection.
    • SSL: Protects access through SSL certificates.
    Status string
    The status of the Data flow. Valid values: Running, Stopped.
    FileSystemId string
    The ID of the file system.
    FsetId string
    The ID of the Fileset.
    SourceStorage string
    The access path of the source store. Format: <storage type>://<path>. Among them:

    • storage type: currently only OSS is supported.
    • path: the bucket name of OSS.
    • Only lowercase letters, numbers, and dashes (-) are supported and must start and end with lowercase letters or numbers.
    Throughput int
    The maximum transmission bandwidth of data flow, unit: MB/s. Valid values: 1200, 1500, 600. NOTE: The transmission bandwidth of data flow must be less than the IO bandwidth of the file system.
    Description string
    The Description of the data flow. Restrictions:
    DryRun bool
    The dry run.
    SourceSecurityType string
    The security protection type of the source storage. If the source storage must be accessed through security protection, specify the security protection type of the source storage. Value:

    • NONE (default): Indicates that the source storage does not need to be accessed through security protection.
    • SSL: Protects access through SSL certificates.
    Status string
    The status of the Data flow. Valid values: Running, Stopped.
    fileSystemId String
    The ID of the file system.
    fsetId String
    The ID of the Fileset.
    sourceStorage String
    The access path of the source store. Format: <storage type>://<path>. Among them:

    • storage type: currently only OSS is supported.
    • path: the bucket name of OSS.
    • Only lowercase letters, numbers, and dashes (-) are supported and must start and end with lowercase letters or numbers.
    throughput Integer
    The maximum transmission bandwidth of data flow, unit: MB/s. Valid values: 1200, 1500, 600. NOTE: The transmission bandwidth of data flow must be less than the IO bandwidth of the file system.
    description String
    The Description of the data flow. Restrictions:
    dryRun Boolean
    The dry run.
    sourceSecurityType String
    The security protection type of the source storage. If the source storage must be accessed through security protection, specify the security protection type of the source storage. Value:

    • NONE (default): Indicates that the source storage does not need to be accessed through security protection.
    • SSL: Protects access through SSL certificates.
    status String
    The status of the Data flow. Valid values: Running, Stopped.
    fileSystemId string
    The ID of the file system.
    fsetId string
    The ID of the Fileset.
    sourceStorage string
    The access path of the source store. Format: <storage type>://<path>. Among them:

    • storage type: currently only OSS is supported.
    • path: the bucket name of OSS.
    • Only lowercase letters, numbers, and dashes (-) are supported and must start and end with lowercase letters or numbers.
    throughput number
    The maximum transmission bandwidth of data flow, unit: MB/s. Valid values: 1200, 1500, 600. NOTE: The transmission bandwidth of data flow must be less than the IO bandwidth of the file system.
    description string
    The Description of the data flow. Restrictions:
    dryRun boolean
    The dry run.
    sourceSecurityType string
    The security protection type of the source storage. If the source storage must be accessed through security protection, specify the security protection type of the source storage. Value:

    • NONE (default): Indicates that the source storage does not need to be accessed through security protection.
    • SSL: Protects access through SSL certificates.
    status string
    The status of the Data flow. Valid values: Running, Stopped.
    file_system_id str
    The ID of the file system.
    fset_id str
    The ID of the Fileset.
    source_storage str
    The access path of the source store. Format: <storage type>://<path>. Among them:

    • storage type: currently only OSS is supported.
    • path: the bucket name of OSS.
    • Only lowercase letters, numbers, and dashes (-) are supported and must start and end with lowercase letters or numbers.
    throughput int
    The maximum transmission bandwidth of data flow, unit: MB/s. Valid values: 1200, 1500, 600. NOTE: The transmission bandwidth of data flow must be less than the IO bandwidth of the file system.
    description str
    The Description of the data flow. Restrictions:
    dry_run bool
    The dry run.
    source_security_type str
    The security protection type of the source storage. If the source storage must be accessed through security protection, specify the security protection type of the source storage. Value:

    • NONE (default): Indicates that the source storage does not need to be accessed through security protection.
    • SSL: Protects access through SSL certificates.
    status str
    The status of the Data flow. Valid values: Running, Stopped.
    fileSystemId String
    The ID of the file system.
    fsetId String
    The ID of the Fileset.
    sourceStorage String
    The access path of the source store. Format: <storage type>://<path>. Among them:

    • storage type: currently only OSS is supported.
    • path: the bucket name of OSS.
    • Only lowercase letters, numbers, and dashes (-) are supported and must start and end with lowercase letters or numbers.
    throughput Number
    The maximum transmission bandwidth of data flow, unit: MB/s. Valid values: 1200, 1500, 600. NOTE: The transmission bandwidth of data flow must be less than the IO bandwidth of the file system.
    description String
    The Description of the data flow. Restrictions:
    dryRun Boolean
    The dry run.
    sourceSecurityType String
    The security protection type of the source storage. If the source storage must be accessed through security protection, specify the security protection type of the source storage. Value:

    • NONE (default): Indicates that the source storage does not need to be accessed through security protection.
    • SSL: Protects access through SSL certificates.
    status String
    The status of the Data flow. Valid values: Running, Stopped.

    Outputs

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

    DataFlowId string
    The ID of the Data flow.
    Id string
    The provider-assigned unique ID for this managed resource.
    DataFlowId string
    The ID of the Data flow.
    Id string
    The provider-assigned unique ID for this managed resource.
    dataFlowId String
    The ID of the Data flow.
    id String
    The provider-assigned unique ID for this managed resource.
    dataFlowId string
    The ID of the Data flow.
    id string
    The provider-assigned unique ID for this managed resource.
    data_flow_id str
    The ID of the Data flow.
    id str
    The provider-assigned unique ID for this managed resource.
    dataFlowId String
    The ID of the Data flow.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing DataFlow Resource

    Get an existing DataFlow 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>, state?: DataFlowState, opts?: CustomResourceOptions): DataFlow
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            data_flow_id: Optional[str] = None,
            description: Optional[str] = None,
            dry_run: Optional[bool] = None,
            file_system_id: Optional[str] = None,
            fset_id: Optional[str] = None,
            source_security_type: Optional[str] = None,
            source_storage: Optional[str] = None,
            status: Optional[str] = None,
            throughput: Optional[int] = None) -> DataFlow
    func GetDataFlow(ctx *Context, name string, id IDInput, state *DataFlowState, opts ...ResourceOption) (*DataFlow, error)
    public static DataFlow Get(string name, Input<string> id, DataFlowState? state, CustomResourceOptions? opts = null)
    public static DataFlow get(String name, Output<String> id, DataFlowState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    DataFlowId string
    The ID of the Data flow.
    Description string
    The Description of the data flow. Restrictions:
    DryRun bool
    The dry run.
    FileSystemId string
    The ID of the file system.
    FsetId string
    The ID of the Fileset.
    SourceSecurityType string
    The security protection type of the source storage. If the source storage must be accessed through security protection, specify the security protection type of the source storage. Value:

    • NONE (default): Indicates that the source storage does not need to be accessed through security protection.
    • SSL: Protects access through SSL certificates.
    SourceStorage string
    The access path of the source store. Format: <storage type>://<path>. Among them:

    • storage type: currently only OSS is supported.
    • path: the bucket name of OSS.
    • Only lowercase letters, numbers, and dashes (-) are supported and must start and end with lowercase letters or numbers.
    Status string
    The status of the Data flow. Valid values: Running, Stopped.
    Throughput int
    The maximum transmission bandwidth of data flow, unit: MB/s. Valid values: 1200, 1500, 600. NOTE: The transmission bandwidth of data flow must be less than the IO bandwidth of the file system.
    DataFlowId string
    The ID of the Data flow.
    Description string
    The Description of the data flow. Restrictions:
    DryRun bool
    The dry run.
    FileSystemId string
    The ID of the file system.
    FsetId string
    The ID of the Fileset.
    SourceSecurityType string
    The security protection type of the source storage. If the source storage must be accessed through security protection, specify the security protection type of the source storage. Value:

    • NONE (default): Indicates that the source storage does not need to be accessed through security protection.
    • SSL: Protects access through SSL certificates.
    SourceStorage string
    The access path of the source store. Format: <storage type>://<path>. Among them:

    • storage type: currently only OSS is supported.
    • path: the bucket name of OSS.
    • Only lowercase letters, numbers, and dashes (-) are supported and must start and end with lowercase letters or numbers.
    Status string
    The status of the Data flow. Valid values: Running, Stopped.
    Throughput int
    The maximum transmission bandwidth of data flow, unit: MB/s. Valid values: 1200, 1500, 600. NOTE: The transmission bandwidth of data flow must be less than the IO bandwidth of the file system.
    dataFlowId String
    The ID of the Data flow.
    description String
    The Description of the data flow. Restrictions:
    dryRun Boolean
    The dry run.
    fileSystemId String
    The ID of the file system.
    fsetId String
    The ID of the Fileset.
    sourceSecurityType String
    The security protection type of the source storage. If the source storage must be accessed through security protection, specify the security protection type of the source storage. Value:

    • NONE (default): Indicates that the source storage does not need to be accessed through security protection.
    • SSL: Protects access through SSL certificates.
    sourceStorage String
    The access path of the source store. Format: <storage type>://<path>. Among them:

    • storage type: currently only OSS is supported.
    • path: the bucket name of OSS.
    • Only lowercase letters, numbers, and dashes (-) are supported and must start and end with lowercase letters or numbers.
    status String
    The status of the Data flow. Valid values: Running, Stopped.
    throughput Integer
    The maximum transmission bandwidth of data flow, unit: MB/s. Valid values: 1200, 1500, 600. NOTE: The transmission bandwidth of data flow must be less than the IO bandwidth of the file system.
    dataFlowId string
    The ID of the Data flow.
    description string
    The Description of the data flow. Restrictions:
    dryRun boolean
    The dry run.
    fileSystemId string
    The ID of the file system.
    fsetId string
    The ID of the Fileset.
    sourceSecurityType string
    The security protection type of the source storage. If the source storage must be accessed through security protection, specify the security protection type of the source storage. Value:

    • NONE (default): Indicates that the source storage does not need to be accessed through security protection.
    • SSL: Protects access through SSL certificates.
    sourceStorage string
    The access path of the source store. Format: <storage type>://<path>. Among them:

    • storage type: currently only OSS is supported.
    • path: the bucket name of OSS.
    • Only lowercase letters, numbers, and dashes (-) are supported and must start and end with lowercase letters or numbers.
    status string
    The status of the Data flow. Valid values: Running, Stopped.
    throughput number
    The maximum transmission bandwidth of data flow, unit: MB/s. Valid values: 1200, 1500, 600. NOTE: The transmission bandwidth of data flow must be less than the IO bandwidth of the file system.
    data_flow_id str
    The ID of the Data flow.
    description str
    The Description of the data flow. Restrictions:
    dry_run bool
    The dry run.
    file_system_id str
    The ID of the file system.
    fset_id str
    The ID of the Fileset.
    source_security_type str
    The security protection type of the source storage. If the source storage must be accessed through security protection, specify the security protection type of the source storage. Value:

    • NONE (default): Indicates that the source storage does not need to be accessed through security protection.
    • SSL: Protects access through SSL certificates.
    source_storage str
    The access path of the source store. Format: <storage type>://<path>. Among them:

    • storage type: currently only OSS is supported.
    • path: the bucket name of OSS.
    • Only lowercase letters, numbers, and dashes (-) are supported and must start and end with lowercase letters or numbers.
    status str
    The status of the Data flow. Valid values: Running, Stopped.
    throughput int
    The maximum transmission bandwidth of data flow, unit: MB/s. Valid values: 1200, 1500, 600. NOTE: The transmission bandwidth of data flow must be less than the IO bandwidth of the file system.
    dataFlowId String
    The ID of the Data flow.
    description String
    The Description of the data flow. Restrictions:
    dryRun Boolean
    The dry run.
    fileSystemId String
    The ID of the file system.
    fsetId String
    The ID of the Fileset.
    sourceSecurityType String
    The security protection type of the source storage. If the source storage must be accessed through security protection, specify the security protection type of the source storage. Value:

    • NONE (default): Indicates that the source storage does not need to be accessed through security protection.
    • SSL: Protects access through SSL certificates.
    sourceStorage String
    The access path of the source store. Format: <storage type>://<path>. Among them:

    • storage type: currently only OSS is supported.
    • path: the bucket name of OSS.
    • Only lowercase letters, numbers, and dashes (-) are supported and must start and end with lowercase letters or numbers.
    status String
    The status of the Data flow. Valid values: Running, Stopped.
    throughput Number
    The maximum transmission bandwidth of data flow, unit: MB/s. Valid values: 1200, 1500, 600. NOTE: The transmission bandwidth of data flow must be less than the IO bandwidth of the file system.

    Import

    Network Attached Storage (NAS) Data Flow can be imported using the id, e.g.

    $ pulumi import alicloud:nas/dataFlow:DataFlow example <file_system_id>:<data_flow_id>
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Alibaba Cloud pulumi/pulumi-alicloud
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the alicloud Terraform Provider.
    alicloud logo
    Alibaba Cloud v3.59.0 published on Friday, Jul 12, 2024 by Pulumi