dataworks

package
v3.54.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 24, 2024 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Folder added in v3.6.0 

type Folder struct {
	pulumi.CustomResourceState

	FolderId pulumi.StringOutput `pulumi:"folderId"`
	// Folder Path. The folder path composed with for part: `Business Flow/{Business Flow Name}/[folderDi|folderMaxCompute|folderGeneral|folderJdbc|folderUserDefined]/{Directory Name}`. The first segment of path must be `Business Flow`, and sencond segment of path must be a Business Flow Name within the project. The third part of path must be one of those keywords:`folderDi|folderMaxCompute|folderGeneral|folderJdbc|folderUserDefined`. Then the finial part of folder path can be specified in yourself.
	FolderPath pulumi.StringOutput `pulumi:"folderPath"`
	// The ID of the project.
	ProjectId         pulumi.StringPtrOutput `pulumi:"projectId"`
	ProjectIdentifier pulumi.StringPtrOutput `pulumi:"projectIdentifier"`
}

Provides a Data Works Folder resource.

For information about Data Works Folder and how to use it, see [What is Folder](https://help.aliyun.com/document_detail/173940.html).

> **NOTE:** Available in v1.131.0+.

## Example Usage

Basic Usage

```go package main

import ( 

"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/dataworks"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := dataworks.NewFolder(ctx, "example", &dataworks.FolderArgs{
			ProjectId:  pulumi.String("320687"),
			FolderPath: pulumi.String("Business Flow/tfTestAcc/folderDi/tftest1"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

## Import

Data Works Folder can be imported using the id, e.g.

```sh $ pulumi import alicloud:dataworks/folder:Folder example <folder_id>:<$.ProjectId> ```

func GetFolder added in v3.6.0 

func GetFolder(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *FolderState, opts ...pulumi.ResourceOption) (*Folder, error)

GetFolder gets an existing Folder resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewFolder added in v3.6.0 

func NewFolder(ctx *pulumi.Context,
	name string, args *FolderArgs, opts ...pulumi.ResourceOption) (*Folder, error)

NewFolder registers a new resource with the given unique name, arguments, and options.

func (*Folder) ElementType added in v3.6.0 

func (*Folder) ElementType() reflect.Type

func (*Folder) ToFolderOutput added in v3.6.0 

func (i *Folder) ToFolderOutput() FolderOutput

func (*Folder) ToFolderOutputWithContext added in v3.6.0 

func (i *Folder) ToFolderOutputWithContext(ctx context.Context) FolderOutput

type FolderArgs added in v3.6.0 

type FolderArgs struct {
	// Folder Path. The folder path composed with for part: `Business Flow/{Business Flow Name}/[folderDi|folderMaxCompute|folderGeneral|folderJdbc|folderUserDefined]/{Directory Name}`. The first segment of path must be `Business Flow`, and sencond segment of path must be a Business Flow Name within the project. The third part of path must be one of those keywords:`folderDi|folderMaxCompute|folderGeneral|folderJdbc|folderUserDefined`. Then the finial part of folder path can be specified in yourself.
	FolderPath pulumi.StringInput
	// The ID of the project.
	ProjectId         pulumi.StringPtrInput
	ProjectIdentifier pulumi.StringPtrInput
}

The set of arguments for constructing a Folder resource.

func (FolderArgs) ElementType added in v3.6.0 

func (FolderArgs) ElementType() reflect.Type

type FolderArray added in v3.6.0 

type FolderArray []FolderInput

func (FolderArray) ElementType added in v3.6.0 

func (FolderArray) ElementType() reflect.Type

func (FolderArray) ToFolderArrayOutput added in v3.6.0 

func (i FolderArray) ToFolderArrayOutput() FolderArrayOutput

func (FolderArray) ToFolderArrayOutputWithContext added in v3.6.0 

func (i FolderArray) ToFolderArrayOutputWithContext(ctx context.Context) FolderArrayOutput

type FolderArrayInput added in v3.6.0 

type FolderArrayInput interface {
	pulumi.Input

	ToFolderArrayOutput() FolderArrayOutput
	ToFolderArrayOutputWithContext(context.Context) FolderArrayOutput
}

FolderArrayInput is an input type that accepts FolderArray and FolderArrayOutput values. You can construct a concrete instance of `FolderArrayInput` via: 

FolderArray{ FolderArgs{...} }

type FolderArrayOutput added in v3.6.0 

type FolderArrayOutput struct{ *pulumi.OutputState }

func (FolderArrayOutput) ElementType added in v3.6.0 

func (FolderArrayOutput) ElementType() reflect.Type

func (FolderArrayOutput) Index added in v3.6.0 

func (o FolderArrayOutput) Index(i pulumi.IntInput) FolderOutput

func (FolderArrayOutput) ToFolderArrayOutput added in v3.6.0 

func (o FolderArrayOutput) ToFolderArrayOutput() FolderArrayOutput

func (FolderArrayOutput) ToFolderArrayOutputWithContext added in v3.6.0 

func (o FolderArrayOutput) ToFolderArrayOutputWithContext(ctx context.Context) FolderArrayOutput

type FolderInput added in v3.6.0 

type FolderInput interface {
	pulumi.Input

	ToFolderOutput() FolderOutput
	ToFolderOutputWithContext(ctx context.Context) FolderOutput
}

type FolderMap added in v3.6.0 

type FolderMap map[string]FolderInput

func (FolderMap) ElementType added in v3.6.0 

func (FolderMap) ElementType() reflect.Type

func (FolderMap) ToFolderMapOutput added in v3.6.0 

func (i FolderMap) ToFolderMapOutput() FolderMapOutput

func (FolderMap) ToFolderMapOutputWithContext added in v3.6.0 

func (i FolderMap) ToFolderMapOutputWithContext(ctx context.Context) FolderMapOutput

type FolderMapInput added in v3.6.0 

type FolderMapInput interface {
	pulumi.Input

	ToFolderMapOutput() FolderMapOutput
	ToFolderMapOutputWithContext(context.Context) FolderMapOutput
}

FolderMapInput is an input type that accepts FolderMap and FolderMapOutput values. You can construct a concrete instance of `FolderMapInput` via: 

FolderMap{ "key": FolderArgs{...} }

type FolderMapOutput added in v3.6.0 

type FolderMapOutput struct{ *pulumi.OutputState }

func (FolderMapOutput) ElementType added in v3.6.0 

func (FolderMapOutput) ElementType() reflect.Type

func (FolderMapOutput) MapIndex added in v3.6.0 

func (o FolderMapOutput) MapIndex(k pulumi.StringInput) FolderOutput

func (FolderMapOutput) ToFolderMapOutput added in v3.6.0 

func (o FolderMapOutput) ToFolderMapOutput() FolderMapOutput

func (FolderMapOutput) ToFolderMapOutputWithContext added in v3.6.0 

func (o FolderMapOutput) ToFolderMapOutputWithContext(ctx context.Context) FolderMapOutput

type FolderOutput added in v3.6.0 

type FolderOutput struct{ *pulumi.OutputState }

func (FolderOutput) ElementType added in v3.6.0 

func (FolderOutput) ElementType() reflect.Type

func (FolderOutput) FolderId added in v3.27.0 

func (o FolderOutput) FolderId() pulumi.StringOutput

func (FolderOutput) FolderPath added in v3.27.0 

func (o FolderOutput) FolderPath() pulumi.StringOutput

Folder Path. The folder path composed with for part: `Business Flow/{Business Flow Name}/[folderDi|folderMaxCompute|folderGeneral|folderJdbc|folderUserDefined]/{Directory Name}`. The first segment of path must be `Business Flow`, and sencond segment of path must be a Business Flow Name within the project. The third part of path must be one of those keywords:`folderDi|folderMaxCompute|folderGeneral|folderJdbc|folderUserDefined`. Then the finial part of folder path can be specified in yourself.

func (FolderOutput) ProjectId added in v3.27.0 

func (o FolderOutput) ProjectId() pulumi.StringPtrOutput

The ID of the project.

func (FolderOutput) ProjectIdentifier added in v3.27.0 

func (o FolderOutput) ProjectIdentifier() pulumi.StringPtrOutput

func (FolderOutput) ToFolderOutput added in v3.6.0 

func (o FolderOutput) ToFolderOutput() FolderOutput

func (FolderOutput) ToFolderOutputWithContext added in v3.6.0 

func (o FolderOutput) ToFolderOutputWithContext(ctx context.Context) FolderOutput

type FolderState added in v3.6.0 

type FolderState struct {
	FolderId pulumi.StringPtrInput
	// Folder Path. The folder path composed with for part: `Business Flow/{Business Flow Name}/[folderDi|folderMaxCompute|folderGeneral|folderJdbc|folderUserDefined]/{Directory Name}`. The first segment of path must be `Business Flow`, and sencond segment of path must be a Business Flow Name within the project. The third part of path must be one of those keywords:`folderDi|folderMaxCompute|folderGeneral|folderJdbc|folderUserDefined`. Then the finial part of folder path can be specified in yourself.
	FolderPath pulumi.StringPtrInput
	// The ID of the project.
	ProjectId         pulumi.StringPtrInput
	ProjectIdentifier pulumi.StringPtrInput
}

func (FolderState) ElementType added in v3.6.0 

func (FolderState) ElementType() reflect.Type

type GetFoldersArgs added in v3.6.0 

type GetFoldersArgs struct {
	// A list of Folder IDs.
	Ids []string `pulumi:"ids"`
	// File name where to save data source results (after running `pulumi preview`).
	OutputFile *string `pulumi:"outputFile"`
	// The parent folder path.
	ParentFolderPath string `pulumi:"parentFolderPath"`
	// The ID of the project.
	ProjectId string `pulumi:"projectId"`
}

A collection of arguments for invoking getFolders.

type GetFoldersFolder added in v3.6.0 

type GetFoldersFolder struct {
	FolderId string `pulumi:"folderId"`
	// Folder Path.
	FolderPath string `pulumi:"folderPath"`
	// The Folder ID.
	Id string `pulumi:"id"`
	// The ID of the project.
	ProjectId string `pulumi:"projectId"`
}

type GetFoldersFolderArgs added in v3.6.0 

type GetFoldersFolderArgs struct {
	FolderId pulumi.StringInput `pulumi:"folderId"`
	// Folder Path.
	FolderPath pulumi.StringInput `pulumi:"folderPath"`
	// The Folder ID.
	Id pulumi.StringInput `pulumi:"id"`
	// The ID of the project.
	ProjectId pulumi.StringInput `pulumi:"projectId"`
}

func (GetFoldersFolderArgs) ElementType added in v3.6.0 

func (GetFoldersFolderArgs) ElementType() reflect.Type

func (GetFoldersFolderArgs) ToGetFoldersFolderOutput added in v3.6.0 

func (i GetFoldersFolderArgs) ToGetFoldersFolderOutput() GetFoldersFolderOutput

func (GetFoldersFolderArgs) ToGetFoldersFolderOutputWithContext added in v3.6.0 

func (i GetFoldersFolderArgs) ToGetFoldersFolderOutputWithContext(ctx context.Context) GetFoldersFolderOutput

type GetFoldersFolderArray added in v3.6.0 

type GetFoldersFolderArray []GetFoldersFolderInput

func (GetFoldersFolderArray) ElementType added in v3.6.0 

func (GetFoldersFolderArray) ElementType() reflect.Type

func (GetFoldersFolderArray) ToGetFoldersFolderArrayOutput added in v3.6.0 

func (i GetFoldersFolderArray) ToGetFoldersFolderArrayOutput() GetFoldersFolderArrayOutput

func (GetFoldersFolderArray) ToGetFoldersFolderArrayOutputWithContext added in v3.6.0 

func (i GetFoldersFolderArray) ToGetFoldersFolderArrayOutputWithContext(ctx context.Context) GetFoldersFolderArrayOutput

type GetFoldersFolderArrayInput added in v3.6.0 

type GetFoldersFolderArrayInput interface {
	pulumi.Input

	ToGetFoldersFolderArrayOutput() GetFoldersFolderArrayOutput
	ToGetFoldersFolderArrayOutputWithContext(context.Context) GetFoldersFolderArrayOutput
}

GetFoldersFolderArrayInput is an input type that accepts GetFoldersFolderArray and GetFoldersFolderArrayOutput values. You can construct a concrete instance of `GetFoldersFolderArrayInput` via: 

GetFoldersFolderArray{ GetFoldersFolderArgs{...} }

type GetFoldersFolderArrayOutput added in v3.6.0 

type GetFoldersFolderArrayOutput struct{ *pulumi.OutputState }

func (GetFoldersFolderArrayOutput) ElementType added in v3.6.0 

func (GetFoldersFolderArrayOutput) ElementType() reflect.Type

func (GetFoldersFolderArrayOutput) Index added in v3.6.0 

func (o GetFoldersFolderArrayOutput) Index(i pulumi.IntInput) GetFoldersFolderOutput

func (GetFoldersFolderArrayOutput) ToGetFoldersFolderArrayOutput added in v3.6.0 

func (o GetFoldersFolderArrayOutput) ToGetFoldersFolderArrayOutput() GetFoldersFolderArrayOutput

func (GetFoldersFolderArrayOutput) ToGetFoldersFolderArrayOutputWithContext added in v3.6.0 

func (o GetFoldersFolderArrayOutput) ToGetFoldersFolderArrayOutputWithContext(ctx context.Context) GetFoldersFolderArrayOutput

type GetFoldersFolderInput added in v3.6.0 

type GetFoldersFolderInput interface {
	pulumi.Input

	ToGetFoldersFolderOutput() GetFoldersFolderOutput
	ToGetFoldersFolderOutputWithContext(context.Context) GetFoldersFolderOutput
}

GetFoldersFolderInput is an input type that accepts GetFoldersFolderArgs and GetFoldersFolderOutput values. You can construct a concrete instance of `GetFoldersFolderInput` via: 

GetFoldersFolderArgs{...}

type GetFoldersFolderOutput added in v3.6.0 

type GetFoldersFolderOutput struct{ *pulumi.OutputState }

func (GetFoldersFolderOutput) ElementType added in v3.6.0 

func (GetFoldersFolderOutput) ElementType() reflect.Type

func (GetFoldersFolderOutput) FolderId added in v3.6.0 

func (o GetFoldersFolderOutput) FolderId() pulumi.StringOutput

func (GetFoldersFolderOutput) FolderPath added in v3.6.0 

func (o GetFoldersFolderOutput) FolderPath() pulumi.StringOutput

Folder Path.

func (GetFoldersFolderOutput) Id added in v3.6.0 

func (o GetFoldersFolderOutput) Id() pulumi.StringOutput

The Folder ID.

func (GetFoldersFolderOutput) ProjectId added in v3.6.0 

func (o GetFoldersFolderOutput) ProjectId() pulumi.StringOutput

The ID of the project.

func (GetFoldersFolderOutput) ToGetFoldersFolderOutput added in v3.6.0 

func (o GetFoldersFolderOutput) ToGetFoldersFolderOutput() GetFoldersFolderOutput

func (GetFoldersFolderOutput) ToGetFoldersFolderOutputWithContext added in v3.6.0 

func (o GetFoldersFolderOutput) ToGetFoldersFolderOutputWithContext(ctx context.Context) GetFoldersFolderOutput

type GetFoldersOutputArgs added in v3.9.0 

type GetFoldersOutputArgs struct {
	// A list of Folder IDs.
	Ids pulumi.StringArrayInput `pulumi:"ids"`
	// File name where to save data source results (after running `pulumi preview`).
	OutputFile pulumi.StringPtrInput `pulumi:"outputFile"`
	// The parent folder path.
	ParentFolderPath pulumi.StringInput `pulumi:"parentFolderPath"`
	// The ID of the project.
	ProjectId pulumi.StringInput `pulumi:"projectId"`
}

A collection of arguments for invoking getFolders.

func (GetFoldersOutputArgs) ElementType added in v3.9.0 

func (GetFoldersOutputArgs) ElementType() reflect.Type

type GetFoldersResult added in v3.6.0 

type GetFoldersResult struct {
	Folders []GetFoldersFolder `pulumi:"folders"`
	// The provider-assigned unique ID for this managed resource.
	Id               string   `pulumi:"id"`
	Ids              []string `pulumi:"ids"`
	OutputFile       *string  `pulumi:"outputFile"`
	ParentFolderPath string   `pulumi:"parentFolderPath"`
	ProjectId        string   `pulumi:"projectId"`
}

A collection of values returned by getFolders.

func GetFolders added in v3.6.0 

func GetFolders(ctx *pulumi.Context, args *GetFoldersArgs, opts ...pulumi.InvokeOption) (*GetFoldersResult, error)

This data source provides the Data Works Folders of the current Alibaba Cloud user.

> **NOTE:** Available in v1.131.0+.

## Example Usage

Basic Usage

```go package main

import ( 

"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/dataworks"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := dataworks.NewFolder(ctx, "default", &dataworks.FolderArgs{
			ProjectId:  pulumi.String("xxxx"),
			FolderPath: pulumi.String("Business Flow/tfTestAcc/folderDi"),
		})
		if err != nil {
			return err
		}
		ids := pulumi.All(_default.FolderId, _default.ProjectId).ApplyT(func(_args []interface{}) (dataworks.GetFoldersResult, error) {
			folderId := _args[0].(string)
			projectId := _args[1].(*string)
			return dataworks.GetFoldersOutput(ctx, dataworks.GetFoldersOutputArgs{
				Ids: []string{
					folderId,
				},
				ProjectId:        projectId,
				ParentFolderPath: "Business Flow/tfTestAcc/folderDi",
			}, nil), nil
		}).(dataworks.GetFoldersResultOutput)
		ctx.Export("dataWorksFolderId1", ids.ApplyT(func(ids dataworks.GetFoldersResult) (*string, error) {
			return &ids.Folders[0].Id, nil
		}).(pulumi.StringPtrOutput))
		return nil
	})
}

```

type GetFoldersResultOutput added in v3.9.0 

type GetFoldersResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getFolders.

func GetFoldersOutput added in v3.9.0 

func GetFoldersOutput(ctx *pulumi.Context, args GetFoldersOutputArgs, opts ...pulumi.InvokeOption) GetFoldersResultOutput

func (GetFoldersResultOutput) ElementType added in v3.9.0 

func (GetFoldersResultOutput) ElementType() reflect.Type

func (GetFoldersResultOutput) Folders added in v3.9.0 

func (o GetFoldersResultOutput) Folders() GetFoldersFolderArrayOutput

func (GetFoldersResultOutput) Id added in v3.9.0 

func (o GetFoldersResultOutput) Id() pulumi.StringOutput

The provider-assigned unique ID for this managed resource.

func (GetFoldersResultOutput) Ids added in v3.9.0 

func (o GetFoldersResultOutput) Ids() pulumi.StringArrayOutput

func (GetFoldersResultOutput) OutputFile added in v3.9.0 

func (o GetFoldersResultOutput) OutputFile() pulumi.StringPtrOutput

func (GetFoldersResultOutput) ParentFolderPath added in v3.9.0 

func (o GetFoldersResultOutput) ParentFolderPath() pulumi.StringOutput

func (GetFoldersResultOutput) ProjectId added in v3.9.0 

func (o GetFoldersResultOutput) ProjectId() pulumi.StringOutput

func (GetFoldersResultOutput) ToGetFoldersResultOutput added in v3.9.0 

func (o GetFoldersResultOutput) ToGetFoldersResultOutput() GetFoldersResultOutput

func (GetFoldersResultOutput) ToGetFoldersResultOutputWithContext added in v3.9.0 

func (o GetFoldersResultOutput) ToGetFoldersResultOutputWithContext(ctx context.Context) GetFoldersResultOutput

type GetServiceArgs 

type GetServiceArgs struct {
	// Setting the value to `On` to enable the service. If has been enabled, return the result. Valid values: `On` or `Off`. Default to `Off`.
	//
	// > **NOTE:** Setting `enable = "On"` to open the DataWorks service that means you have read and agreed the [DataWorks Terms of Service](https://help.aliyun.com/document_detail/131538.html). The service can not closed once it is opened.
	Enable *string `pulumi:"enable"`
}

A collection of arguments for invoking getService.

type GetServiceOutputArgs added in v3.9.0 

type GetServiceOutputArgs struct {
	// Setting the value to `On` to enable the service. If has been enabled, return the result. Valid values: `On` or `Off`. Default to `Off`.
	//
	// > **NOTE:** Setting `enable = "On"` to open the DataWorks service that means you have read and agreed the [DataWorks Terms of Service](https://help.aliyun.com/document_detail/131538.html). The service can not closed once it is opened.
	Enable pulumi.StringPtrInput `pulumi:"enable"`
}

A collection of arguments for invoking getService.

func (GetServiceOutputArgs) ElementType added in v3.9.0 

func (GetServiceOutputArgs) ElementType() reflect.Type

type GetServiceResult 

type GetServiceResult struct {
	Enable *string `pulumi:"enable"`
	// The provider-assigned unique ID for this managed resource.
	Id string `pulumi:"id"`
	// The current service enable status.
	Status string `pulumi:"status"`
}

A collection of values returned by getService.

func GetService 

func GetService(ctx *pulumi.Context, args *GetServiceArgs, opts ...pulumi.InvokeOption) (*GetServiceResult, error)

Using this data source can open DataWorks service automatically. If the service has been opened, it will return opened.

For information about DataWorks and how to use it, see [What is DataWorks](https://www.alibabacloud.com/help/en/product/72772.htm).

> **NOTE:** Available in v1.118.0+. After the version 1.141.0, the data source is renamed as `dataworks.getService`.

## Example Usage

```go package main

import ( 

"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/dataworks"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := dataworks.GetService(ctx, &dataworks.GetServiceArgs{
			Enable: pulumi.StringRef("On"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

```

type GetServiceResultOutput added in v3.9.0 

type GetServiceResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getService.

func GetServiceOutput added in v3.9.0 

func GetServiceOutput(ctx *pulumi.Context, args GetServiceOutputArgs, opts ...pulumi.InvokeOption) GetServiceResultOutput

func (GetServiceResultOutput) ElementType added in v3.9.0 

func (GetServiceResultOutput) ElementType() reflect.Type

func (GetServiceResultOutput) Enable added in v3.9.0 

func (o GetServiceResultOutput) Enable() pulumi.StringPtrOutput

func (GetServiceResultOutput) Id added in v3.9.0 

func (o GetServiceResultOutput) Id() pulumi.StringOutput

The provider-assigned unique ID for this managed resource.

func (GetServiceResultOutput) Status added in v3.9.0 

func (o GetServiceResultOutput) Status() pulumi.StringOutput

The current service enable status.

func (GetServiceResultOutput) ToGetServiceResultOutput added in v3.9.0 

func (o GetServiceResultOutput) ToGetServiceResultOutput() GetServiceResultOutput

func (GetServiceResultOutput) ToGetServiceResultOutputWithContext added in v3.9.0 

func (o GetServiceResultOutput) ToGetServiceResultOutputWithContext(ctx context.Context) GetServiceResultOutput

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.