1. Packages
  2. Alibaba Cloud
  3. API Docs
  4. imp
  5. AppTemplate
Alibaba Cloud v3.57.0 published on Saturday, Jun 15, 2024 by Pulumi

alicloud.imp.AppTemplate

Explore with Pulumi AI

alicloud logo
Alibaba Cloud v3.57.0 published on Saturday, Jun 15, 2024 by Pulumi

    Provides a Apsara Agile Live (IMP) App Template resource.

    For information about Apsara Agile Live (IMP) App Template and how to use it, see What is App Template.

    NOTE: Available in v1.137.0+.

    Example Usage

    Basic Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as alicloud from "@pulumi/alicloud";
    
    const example = new alicloud.imp.AppTemplate("example", {
        appTemplateName: "example_value",
        componentLists: [
            "component.live",
            "component.liveRecord",
        ],
        integrationMode: "paasSDK",
        scene: "business",
    });
    
    import pulumi
    import pulumi_alicloud as alicloud
    
    example = alicloud.imp.AppTemplate("example",
        app_template_name="example_value",
        component_lists=[
            "component.live",
            "component.liveRecord",
        ],
        integration_mode="paasSDK",
        scene="business")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/imp"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := imp.NewAppTemplate(ctx, "example", &imp.AppTemplateArgs{
    			AppTemplateName: pulumi.String("example_value"),
    			ComponentLists: pulumi.StringArray{
    				pulumi.String("component.live"),
    				pulumi.String("component.liveRecord"),
    			},
    			IntegrationMode: pulumi.String("paasSDK"),
    			Scene:           pulumi.String("business"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AliCloud = Pulumi.AliCloud;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new AliCloud.Imp.AppTemplate("example", new()
        {
            AppTemplateName = "example_value",
            ComponentLists = new[]
            {
                "component.live",
                "component.liveRecord",
            },
            IntegrationMode = "paasSDK",
            Scene = "business",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.alicloud.imp.AppTemplate;
    import com.pulumi.alicloud.imp.AppTemplateArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var example = new AppTemplate("example", AppTemplateArgs.builder()
                .appTemplateName("example_value")
                .componentLists(            
                    "component.live",
                    "component.liveRecord")
                .integrationMode("paasSDK")
                .scene("business")
                .build());
    
        }
    }
    
    resources:
      example:
        type: alicloud:imp:AppTemplate
        properties:
          appTemplateName: example_value
          componentLists:
            - component.live
            - component.liveRecord
          integrationMode: paasSDK
          scene: business
    

    Create AppTemplate Resource

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

    Constructor syntax

    new AppTemplate(name: string, args: AppTemplateArgs, opts?: CustomResourceOptions);
    @overload
    def AppTemplate(resource_name: str,
                    args: AppTemplateArgs,
                    opts: Optional[ResourceOptions] = None)
    
    @overload
    def AppTemplate(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    app_template_name: Optional[str] = None,
                    component_lists: Optional[Sequence[str]] = None,
                    config_lists: Optional[Sequence[AppTemplateConfigListArgs]] = None,
                    integration_mode: Optional[str] = None,
                    scene: Optional[str] = None)
    func NewAppTemplate(ctx *Context, name string, args AppTemplateArgs, opts ...ResourceOption) (*AppTemplate, error)
    public AppTemplate(string name, AppTemplateArgs args, CustomResourceOptions? opts = null)
    public AppTemplate(String name, AppTemplateArgs args)
    public AppTemplate(String name, AppTemplateArgs args, CustomResourceOptions options)
    
    type: alicloud:imp:AppTemplate
    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 AppTemplateArgs
    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 AppTemplateArgs
    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 AppTemplateArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AppTemplateArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AppTemplateArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

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

    var appTemplateResource = new AliCloud.Imp.AppTemplate("appTemplateResource", new()
    {
        AppTemplateName = "string",
        ComponentLists = new[]
        {
            "string",
        },
        ConfigLists = new[]
        {
            new AliCloud.Imp.Inputs.AppTemplateConfigListArgs
            {
                Key = "string",
                Value = "string",
            },
        },
        IntegrationMode = "string",
        Scene = "string",
    });
    
    example, err := imp.NewAppTemplate(ctx, "appTemplateResource", &imp.AppTemplateArgs{
    	AppTemplateName: pulumi.String("string"),
    	ComponentLists: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	ConfigLists: imp.AppTemplateConfigListArray{
    		&imp.AppTemplateConfigListArgs{
    			Key:   pulumi.String("string"),
    			Value: pulumi.String("string"),
    		},
    	},
    	IntegrationMode: pulumi.String("string"),
    	Scene:           pulumi.String("string"),
    })
    
    var appTemplateResource = new AppTemplate("appTemplateResource", AppTemplateArgs.builder()
        .appTemplateName("string")
        .componentLists("string")
        .configLists(AppTemplateConfigListArgs.builder()
            .key("string")
            .value("string")
            .build())
        .integrationMode("string")
        .scene("string")
        .build());
    
    app_template_resource = alicloud.imp.AppTemplate("appTemplateResource",
        app_template_name="string",
        component_lists=["string"],
        config_lists=[alicloud.imp.AppTemplateConfigListArgs(
            key="string",
            value="string",
        )],
        integration_mode="string",
        scene="string")
    
    const appTemplateResource = new alicloud.imp.AppTemplate("appTemplateResource", {
        appTemplateName: "string",
        componentLists: ["string"],
        configLists: [{
            key: "string",
            value: "string",
        }],
        integrationMode: "string",
        scene: "string",
    });
    
    type: alicloud:imp:AppTemplate
    properties:
        appTemplateName: string
        componentLists:
            - string
        configLists:
            - key: string
              value: string
        integrationMode: string
        scene: string
    

    AppTemplate 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 AppTemplate resource accepts the following input properties:

    AppTemplateName string
    The name of the resource.
    ComponentLists List<string>
    List of components. Its element valid values: ["component.live","component.liveRecord","component.liveBeauty","component.rtc","component.rtcRecord","component.im","component.whiteboard","component.liveSecurity","component.chatSecurity"].
    ConfigLists List<Pulumi.AliCloud.Imp.Inputs.AppTemplateConfigList>
    Configuration list. It have several default configs after the resource is created. See the following Block config_list.
    IntegrationMode string
    Integration mode. Valid values:

    • paasSDK: Integrated SDK.
    • standardRoom: Model Room.
    Scene string
    Application Template scenario. Valid values: ["business", "classroom"].
    AppTemplateName string
    The name of the resource.
    ComponentLists []string
    List of components. Its element valid values: ["component.live","component.liveRecord","component.liveBeauty","component.rtc","component.rtcRecord","component.im","component.whiteboard","component.liveSecurity","component.chatSecurity"].
    ConfigLists []AppTemplateConfigListArgs
    Configuration list. It have several default configs after the resource is created. See the following Block config_list.
    IntegrationMode string
    Integration mode. Valid values:

    • paasSDK: Integrated SDK.
    • standardRoom: Model Room.
    Scene string
    Application Template scenario. Valid values: ["business", "classroom"].
    appTemplateName String
    The name of the resource.
    componentLists List<String>
    List of components. Its element valid values: ["component.live","component.liveRecord","component.liveBeauty","component.rtc","component.rtcRecord","component.im","component.whiteboard","component.liveSecurity","component.chatSecurity"].
    configLists List<AppTemplateConfigList>
    Configuration list. It have several default configs after the resource is created. See the following Block config_list.
    integrationMode String
    Integration mode. Valid values:

    • paasSDK: Integrated SDK.
    • standardRoom: Model Room.
    scene String
    Application Template scenario. Valid values: ["business", "classroom"].
    appTemplateName string
    The name of the resource.
    componentLists string[]
    List of components. Its element valid values: ["component.live","component.liveRecord","component.liveBeauty","component.rtc","component.rtcRecord","component.im","component.whiteboard","component.liveSecurity","component.chatSecurity"].
    configLists AppTemplateConfigList[]
    Configuration list. It have several default configs after the resource is created. See the following Block config_list.
    integrationMode string
    Integration mode. Valid values:

    • paasSDK: Integrated SDK.
    • standardRoom: Model Room.
    scene string
    Application Template scenario. Valid values: ["business", "classroom"].
    app_template_name str
    The name of the resource.
    component_lists Sequence[str]
    List of components. Its element valid values: ["component.live","component.liveRecord","component.liveBeauty","component.rtc","component.rtcRecord","component.im","component.whiteboard","component.liveSecurity","component.chatSecurity"].
    config_lists Sequence[AppTemplateConfigListArgs]
    Configuration list. It have several default configs after the resource is created. See the following Block config_list.
    integration_mode str
    Integration mode. Valid values:

    • paasSDK: Integrated SDK.
    • standardRoom: Model Room.
    scene str
    Application Template scenario. Valid values: ["business", "classroom"].
    appTemplateName String
    The name of the resource.
    componentLists List<String>
    List of components. Its element valid values: ["component.live","component.liveRecord","component.liveBeauty","component.rtc","component.rtcRecord","component.im","component.whiteboard","component.liveSecurity","component.chatSecurity"].
    configLists List<Property Map>
    Configuration list. It have several default configs after the resource is created. See the following Block config_list.
    integrationMode String
    Integration mode. Valid values:

    • paasSDK: Integrated SDK.
    • standardRoom: Model Room.
    scene String
    Application Template scenario. Valid values: ["business", "classroom"].

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Status string
    Application template usage status.
    Id string
    The provider-assigned unique ID for this managed resource.
    Status string
    Application template usage status.
    id String
    The provider-assigned unique ID for this managed resource.
    status String
    Application template usage status.
    id string
    The provider-assigned unique ID for this managed resource.
    status string
    Application template usage status.
    id str
    The provider-assigned unique ID for this managed resource.
    status str
    Application template usage status.
    id String
    The provider-assigned unique ID for this managed resource.
    status String
    Application template usage status.

    Look up Existing AppTemplate Resource

    Get an existing AppTemplate 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?: AppTemplateState, opts?: CustomResourceOptions): AppTemplate
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            app_template_name: Optional[str] = None,
            component_lists: Optional[Sequence[str]] = None,
            config_lists: Optional[Sequence[AppTemplateConfigListArgs]] = None,
            integration_mode: Optional[str] = None,
            scene: Optional[str] = None,
            status: Optional[str] = None) -> AppTemplate
    func GetAppTemplate(ctx *Context, name string, id IDInput, state *AppTemplateState, opts ...ResourceOption) (*AppTemplate, error)
    public static AppTemplate Get(string name, Input<string> id, AppTemplateState? state, CustomResourceOptions? opts = null)
    public static AppTemplate get(String name, Output<String> id, AppTemplateState 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:
    AppTemplateName string
    The name of the resource.
    ComponentLists List<string>
    List of components. Its element valid values: ["component.live","component.liveRecord","component.liveBeauty","component.rtc","component.rtcRecord","component.im","component.whiteboard","component.liveSecurity","component.chatSecurity"].
    ConfigLists List<Pulumi.AliCloud.Imp.Inputs.AppTemplateConfigList>
    Configuration list. It have several default configs after the resource is created. See the following Block config_list.
    IntegrationMode string
    Integration mode. Valid values:

    • paasSDK: Integrated SDK.
    • standardRoom: Model Room.
    Scene string
    Application Template scenario. Valid values: ["business", "classroom"].
    Status string
    Application template usage status.
    AppTemplateName string
    The name of the resource.
    ComponentLists []string
    List of components. Its element valid values: ["component.live","component.liveRecord","component.liveBeauty","component.rtc","component.rtcRecord","component.im","component.whiteboard","component.liveSecurity","component.chatSecurity"].
    ConfigLists []AppTemplateConfigListArgs
    Configuration list. It have several default configs after the resource is created. See the following Block config_list.
    IntegrationMode string
    Integration mode. Valid values:

    • paasSDK: Integrated SDK.
    • standardRoom: Model Room.
    Scene string
    Application Template scenario. Valid values: ["business", "classroom"].
    Status string
    Application template usage status.
    appTemplateName String
    The name of the resource.
    componentLists List<String>
    List of components. Its element valid values: ["component.live","component.liveRecord","component.liveBeauty","component.rtc","component.rtcRecord","component.im","component.whiteboard","component.liveSecurity","component.chatSecurity"].
    configLists List<AppTemplateConfigList>
    Configuration list. It have several default configs after the resource is created. See the following Block config_list.
    integrationMode String
    Integration mode. Valid values:

    • paasSDK: Integrated SDK.
    • standardRoom: Model Room.
    scene String
    Application Template scenario. Valid values: ["business", "classroom"].
    status String
    Application template usage status.
    appTemplateName string
    The name of the resource.
    componentLists string[]
    List of components. Its element valid values: ["component.live","component.liveRecord","component.liveBeauty","component.rtc","component.rtcRecord","component.im","component.whiteboard","component.liveSecurity","component.chatSecurity"].
    configLists AppTemplateConfigList[]
    Configuration list. It have several default configs after the resource is created. See the following Block config_list.
    integrationMode string
    Integration mode. Valid values:

    • paasSDK: Integrated SDK.
    • standardRoom: Model Room.
    scene string
    Application Template scenario. Valid values: ["business", "classroom"].
    status string
    Application template usage status.
    app_template_name str
    The name of the resource.
    component_lists Sequence[str]
    List of components. Its element valid values: ["component.live","component.liveRecord","component.liveBeauty","component.rtc","component.rtcRecord","component.im","component.whiteboard","component.liveSecurity","component.chatSecurity"].
    config_lists Sequence[AppTemplateConfigListArgs]
    Configuration list. It have several default configs after the resource is created. See the following Block config_list.
    integration_mode str
    Integration mode. Valid values:

    • paasSDK: Integrated SDK.
    • standardRoom: Model Room.
    scene str
    Application Template scenario. Valid values: ["business", "classroom"].
    status str
    Application template usage status.
    appTemplateName String
    The name of the resource.
    componentLists List<String>
    List of components. Its element valid values: ["component.live","component.liveRecord","component.liveBeauty","component.rtc","component.rtcRecord","component.im","component.whiteboard","component.liveSecurity","component.chatSecurity"].
    configLists List<Property Map>
    Configuration list. It have several default configs after the resource is created. See the following Block config_list.
    integrationMode String
    Integration mode. Valid values:

    • paasSDK: Integrated SDK.
    • standardRoom: Model Room.
    scene String
    Application Template scenario. Valid values: ["business", "classroom"].
    status String
    Application template usage status.

    Supporting Types

    AppTemplateConfigList, AppTemplateConfigListArgs

    Key string
    Value string
    Key string
    Value string
    key String
    value String
    key string
    value string
    key str
    value str
    key String
    value String

    Import

    Apsara Agile Live (IMP) App Template can be imported using the id, e.g.

    $ pulumi import alicloud:imp/appTemplate:AppTemplate example <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.57.0 published on Saturday, Jun 15, 2024 by Pulumi