1. Docs
2. Reference
3. API
4. @pulumi/alicloud
5. datahub

Module datahub

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-alicloud repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-alicloud repo.

Resources

• Project
• Subscription
• Topic

Others

• ProjectArgs
• ProjectState
• SubscriptionArgs
• SubscriptionState
• TopicArgs
• TopicState

Resources

Resource Project

class Project extends CustomResource

constructor

new Project(name: string, args?: ProjectArgs, opts?: pulumi.CustomResourceOptions)

Create a Project resource with the given unique name, arguments, and options.

• name The unique name of the resource.
• args The arguments to use to populate this resource's properties.
• opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ProjectState, opts?: pulumi.CustomResourceOptions): Project

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Project

Returns true if the given object is an instance of Project. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property comment

public comment: pulumi.Output<string | undefined>;

Comment of the datahub project. It cannot be longer than 255 characters.

property createTime

public createTime: pulumi.Output<string>;

Create time of the datahub project. It is a human-readable string rather than 64-bits UTC.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property lastModifyTime

public lastModifyTime: pulumi.Output<string>;

Last modify time of the datahub project. It is the same as create_time at the beginning. It is also a human-readable string rather than 64-bits UTC.

property name

public name: pulumi.Output<string>;

The name of the datahub project. Its length is limited to 3-32 and only characters such as letters, digits and ‘_’ are allowed. It is case-insensitive.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource Subscription

class Subscription extends CustomResource

constructor

new Subscription(name: string, args: SubscriptionArgs, opts?: pulumi.CustomResourceOptions)

Create a Subscription resource with the given unique name, arguments, and options.

• name The unique name of the resource.
• args The arguments to use to populate this resource's properties.
• opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: SubscriptionState, opts?: pulumi.CustomResourceOptions): Subscription

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Subscription

Returns true if the given object is an instance of Subscription. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property comment

public comment: pulumi.Output<string | undefined>;

Comment of the datahub subscription. It cannot be longer than 255 characters.

property createTime

public createTime: pulumi.Output<string>;

Create time of the datahub subscription. It is a human-readable string rather than 64-bits UTC.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property lastModifyTime

public lastModifyTime: pulumi.Output<string>;

Last modify time of the datahub subscription. It is the same as create_time at the beginning. It is also a human-readable string rather than 64-bits UTC.

property projectName

public projectName: pulumi.Output<string>;

The name of the datahub project that the subscription belongs to. Its length is limited to 3-32 and only characters such as letters, digits and ‘_’ are allowed. It is case-insensitive.

property subId

public subId: pulumi.Output<string>;

The identidy of the subscritpion, generate from server side.

property topicName

public topicName: pulumi.Output<string>;

The name of the datahub topic that the subscription belongs to. Its length is limited to 1-128 and only characters such as letters, digits and ‘_’ are allowed. It is case-insensitive.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource Topic

class Topic extends CustomResource

constructor

new Topic(name: string, args: TopicArgs, opts?: pulumi.CustomResourceOptions)

Create a Topic resource with the given unique name, arguments, and options.

• name The unique name of the resource.
• args The arguments to use to populate this resource's properties.
• opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: TopicState, opts?: pulumi.CustomResourceOptions): Topic

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Topic

Returns true if the given object is an instance of Topic. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property comment

public comment: pulumi.Output<string | undefined>;

Comment of the datahub topic. It cannot be longer than 255 characters.

property createTime

public createTime: pulumi.Output<string>;

Create time of the datahub topic. It is a human-readable string rather than 64-bits UTC.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property lastModifyTime

public lastModifyTime: pulumi.Output<string>;

Last modify time of the datahub topic. It is the same as create_time at the beginning. It is also a human-readable string rather than 64-bits UTC.

property lifeCycle

public lifeCycle: pulumi.Output<number | undefined>;

How many days this topic lives. The permitted range of values is [1, 7]. The default value is 3.

property name

public name: pulumi.Output<string>;

The name of the datahub topic. Its length is limited to 1-128 and only characters such as letters, digits and ‘_’ are allowed. It is case-insensitive.

property projectName

public projectName: pulumi.Output<string>;

The name of the datahub project that this topic belongs to. It is case-insensitive.

property recordSchema

public recordSchema: pulumi.Output<{[key: string]: any} | undefined>;

Schema of this topic, required only for TUPLE topic. Supported data types (case-insensitive) are: - BIGINT - STRING - BOOLEAN - DOUBLE - TIMESTAMP

property recordType

public recordType: pulumi.Output<string | undefined>;

The type of this topic. Its value must be one of {BLOB, TUPLE}. For BLOB topic, data will be organized as binary and encoded by BASE64. For TUPLE topic, data has fixed schema. The default value is “TUPLE” with a schema {STRING}.

property shardCount

public shardCount: pulumi.Output<number | undefined>;

The number of shards this topic contains. The permitted range of values is [1, 10]. The default value is 1.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Others

interface ProjectArgs

interface ProjectArgs

The set of arguments for constructing a Project resource.

property comment

comment?: pulumi.Input<string>;

Comment of the datahub project. It cannot be longer than 255 characters.

property name

name?: pulumi.Input<string>;

The name of the datahub project. Its length is limited to 3-32 and only characters such as letters, digits and ‘_’ are allowed. It is case-insensitive.

interface ProjectState

interface ProjectState

Input properties used for looking up and filtering Project resources.

property comment

comment?: pulumi.Input<string>;

Comment of the datahub project. It cannot be longer than 255 characters.

property createTime

createTime?: pulumi.Input<string>;

Create time of the datahub project. It is a human-readable string rather than 64-bits UTC.

property lastModifyTime

lastModifyTime?: pulumi.Input<string>;

Last modify time of the datahub project. It is the same as create_time at the beginning. It is also a human-readable string rather than 64-bits UTC.

property name

name?: pulumi.Input<string>;

The name of the datahub project. Its length is limited to 3-32 and only characters such as letters, digits and ‘_’ are allowed. It is case-insensitive.

interface SubscriptionArgs

interface SubscriptionArgs

The set of arguments for constructing a Subscription resource.

property comment

comment?: pulumi.Input<string>;

Comment of the datahub subscription. It cannot be longer than 255 characters.

property projectName

projectName: pulumi.Input<string>;

The name of the datahub project that the subscription belongs to. Its length is limited to 3-32 and only characters such as letters, digits and ‘_’ are allowed. It is case-insensitive.

property topicName

topicName: pulumi.Input<string>;

The name of the datahub topic that the subscription belongs to. Its length is limited to 1-128 and only characters such as letters, digits and ‘_’ are allowed. It is case-insensitive.

interface SubscriptionState

interface SubscriptionState

Input properties used for looking up and filtering Subscription resources.

property comment

comment?: pulumi.Input<string>;

Comment of the datahub subscription. It cannot be longer than 255 characters.

property createTime

createTime?: pulumi.Input<string>;

Create time of the datahub subscription. It is a human-readable string rather than 64-bits UTC.

property lastModifyTime

lastModifyTime?: pulumi.Input<string>;

Last modify time of the datahub subscription. It is the same as create_time at the beginning. It is also a human-readable string rather than 64-bits UTC.

property projectName

projectName?: pulumi.Input<string>;

The name of the datahub project that the subscription belongs to. Its length is limited to 3-32 and only characters such as letters, digits and ‘_’ are allowed. It is case-insensitive.

property subId

subId?: pulumi.Input<string>;

The identidy of the subscritpion, generate from server side.

property topicName

topicName?: pulumi.Input<string>;

The name of the datahub topic that the subscription belongs to. Its length is limited to 1-128 and only characters such as letters, digits and ‘_’ are allowed. It is case-insensitive.

interface TopicArgs

interface TopicArgs

The set of arguments for constructing a Topic resource.

property comment

comment?: pulumi.Input<string>;

Comment of the datahub topic. It cannot be longer than 255 characters.

property lifeCycle

lifeCycle?: pulumi.Input<number>;

How many days this topic lives. The permitted range of values is [1, 7]. The default value is 3.

property name

name?: pulumi.Input<string>;

The name of the datahub topic. Its length is limited to 1-128 and only characters such as letters, digits and ‘_’ are allowed. It is case-insensitive.

property projectName

projectName: pulumi.Input<string>;

The name of the datahub project that this topic belongs to. It is case-insensitive.

property recordSchema

recordSchema?: pulumi.Input<{[key: string]: any}>;

Schema of this topic, required only for TUPLE topic. Supported data types (case-insensitive) are: - BIGINT - STRING - BOOLEAN - DOUBLE - TIMESTAMP

property recordType

recordType?: pulumi.Input<string>;

The type of this topic. Its value must be one of {BLOB, TUPLE}. For BLOB topic, data will be organized as binary and encoded by BASE64. For TUPLE topic, data has fixed schema. The default value is “TUPLE” with a schema {STRING}.

property shardCount

shardCount?: pulumi.Input<number>;

The number of shards this topic contains. The permitted range of values is [1, 10]. The default value is 1.

interface TopicState

interface TopicState

Input properties used for looking up and filtering Topic resources.

property comment

comment?: pulumi.Input<string>;

Comment of the datahub topic. It cannot be longer than 255 characters.

property createTime

createTime?: pulumi.Input<string>;

Create time of the datahub topic. It is a human-readable string rather than 64-bits UTC.

property lastModifyTime

lastModifyTime?: pulumi.Input<string>;

Last modify time of the datahub topic. It is the same as create_time at the beginning. It is also a human-readable string rather than 64-bits UTC.

property lifeCycle

lifeCycle?: pulumi.Input<number>;

How many days this topic lives. The permitted range of values is [1, 7]. The default value is 3.

property name

name?: pulumi.Input<string>;

The name of the datahub topic. Its length is limited to 1-128 and only characters such as letters, digits and ‘_’ are allowed. It is case-insensitive.

property projectName

projectName?: pulumi.Input<string>;

The name of the datahub project that this topic belongs to. It is case-insensitive.

property recordSchema

recordSchema?: pulumi.Input<{[key: string]: any}>;

Schema of this topic, required only for TUPLE topic. Supported data types (case-insensitive) are: - BIGINT - STRING - BOOLEAN - DOUBLE - TIMESTAMP

property recordType

recordType?: pulumi.Input<string>;

The type of this topic. Its value must be one of {BLOB, TUPLE}. For BLOB topic, data will be organized as binary and encoded by BASE64. For TUPLE topic, data has fixed schema. The default value is “TUPLE” with a schema {STRING}.

property shardCount

shardCount?: pulumi.Input<number>;

The number of shards this topic contains. The permitted range of values is [1, 10]. The default value is 1.