1. Packages
  2. Packages
  3. Volcenginecc Provider
  4. API Docs
  5. apig
  6. UpstreamSource
Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine
volcenginecc logo
Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine

    The API Gateway supports cluster registration based on container services (VKE) and container service clusters. Import clusters into the API Gateway instance to use them as Upstream sources, allowing the gateway to retrieve the Service list from the cluster

    Example Usage

    Example coming soon!
    
    Example coming soon!
    
    Example coming soon!
    
    Example coming soon!
    
    Example coming soon!
    
    resources:
      upstreamSourceNacosDemo:
        type: volcenginecc:apig:UpstreamSource
        name: UpstreamSourceNacosDemo
        properties:
          gatewayId: gd3s9vbk7npja181xxxxx
          comments: upstreamSourceNacosDemo
          sourceType: Nacos
          sourceSpec:
            nacos_source:
              nacosId: nd3thmnjdl46p917xxxxx
              authConfig:
                basic:
                  username: nacos
                  password: '******'
    

    Create UpstreamSource Resource

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

    Constructor syntax

    new UpstreamSource(name: string, args: UpstreamSourceArgs, opts?: CustomResourceOptions);
    @overload
    def UpstreamSource(resource_name: str,
                       args: UpstreamSourceArgs,
                       opts: Optional[ResourceOptions] = None)
    
    @overload
    def UpstreamSource(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       gateway_id: Optional[str] = None,
                       source_spec: Optional[UpstreamSourceSourceSpecArgs] = None,
                       source_type: Optional[str] = None,
                       comments: Optional[str] = None,
                       ingress_settings: Optional[UpstreamSourceIngressSettingsArgs] = None,
                       watch_namespaces: Optional[Sequence[str]] = None)
    func NewUpstreamSource(ctx *Context, name string, args UpstreamSourceArgs, opts ...ResourceOption) (*UpstreamSource, error)
    public UpstreamSource(string name, UpstreamSourceArgs args, CustomResourceOptions? opts = null)
    public UpstreamSource(String name, UpstreamSourceArgs args)
    public UpstreamSource(String name, UpstreamSourceArgs args, CustomResourceOptions options)
    
    type: volcenginecc:apig:UpstreamSource
    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 UpstreamSourceArgs
    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 UpstreamSourceArgs
    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 UpstreamSourceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args UpstreamSourceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args UpstreamSourceArgs
    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 upstreamSourceResource = new Volcenginecc.Apig.UpstreamSource("upstreamSourceResource", new()
    {
        GatewayId = "string",
        SourceSpec = new Volcenginecc.Apig.Inputs.UpstreamSourceSourceSpecArgs
        {
            K8SSource = new Volcenginecc.Apig.Inputs.UpstreamSourceSourceSpecK8SSourceArgs
            {
                ClusterId = "string",
                ClusterType = "string",
            },
            NacosSource = new Volcenginecc.Apig.Inputs.UpstreamSourceSourceSpecNacosSourceArgs
            {
                AuthConfig = new Volcenginecc.Apig.Inputs.UpstreamSourceSourceSpecNacosSourceAuthConfigArgs
                {
                    Basic = new Volcenginecc.Apig.Inputs.UpstreamSourceSourceSpecNacosSourceAuthConfigBasicArgs
                    {
                        Password = "string",
                        Username = "string",
                    },
                },
                NacosId = "string",
                NacosName = "string",
            },
        },
        SourceType = "string",
        Comments = "string",
        IngressSettings = new Volcenginecc.Apig.Inputs.UpstreamSourceIngressSettingsArgs
        {
            EnableAllIngressClasses = false,
            EnableAllNamespaces = false,
            EnableIngress = false,
            EnableIngressWithoutIngressClass = false,
            IngressClasses = new[]
            {
                "string",
            },
            UpdateStatus = false,
            WatchNamespaces = new[]
            {
                "string",
            },
        },
        WatchNamespaces = new[]
        {
            "string",
        },
    });
    
    example, err := apig.NewUpstreamSource(ctx, "upstreamSourceResource", &apig.UpstreamSourceArgs{
    	GatewayId: pulumi.String("string"),
    	SourceSpec: &apig.UpstreamSourceSourceSpecArgs{
    		K8SSource: &apig.UpstreamSourceSourceSpecK8SSourceArgs{
    			ClusterId:   pulumi.String("string"),
    			ClusterType: pulumi.String("string"),
    		},
    		NacosSource: &apig.UpstreamSourceSourceSpecNacosSourceArgs{
    			AuthConfig: &apig.UpstreamSourceSourceSpecNacosSourceAuthConfigArgs{
    				Basic: &apig.UpstreamSourceSourceSpecNacosSourceAuthConfigBasicArgs{
    					Password: pulumi.String("string"),
    					Username: pulumi.String("string"),
    				},
    			},
    			NacosId:   pulumi.String("string"),
    			NacosName: pulumi.String("string"),
    		},
    	},
    	SourceType: pulumi.String("string"),
    	Comments:   pulumi.String("string"),
    	IngressSettings: &apig.UpstreamSourceIngressSettingsArgs{
    		EnableAllIngressClasses:          pulumi.Bool(false),
    		EnableAllNamespaces:              pulumi.Bool(false),
    		EnableIngress:                    pulumi.Bool(false),
    		EnableIngressWithoutIngressClass: pulumi.Bool(false),
    		IngressClasses: pulumi.StringArray{
    			pulumi.String("string"),
    		},
    		UpdateStatus: pulumi.Bool(false),
    		WatchNamespaces: pulumi.StringArray{
    			pulumi.String("string"),
    		},
    	},
    	WatchNamespaces: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    })
    
    var upstreamSourceResource = new UpstreamSource("upstreamSourceResource", UpstreamSourceArgs.builder()
        .gatewayId("string")
        .sourceSpec(UpstreamSourceSourceSpecArgs.builder()
            .k8SSource(UpstreamSourceSourceSpecK8SSourceArgs.builder()
                .clusterId("string")
                .clusterType("string")
                .build())
            .nacosSource(UpstreamSourceSourceSpecNacosSourceArgs.builder()
                .authConfig(UpstreamSourceSourceSpecNacosSourceAuthConfigArgs.builder()
                    .basic(UpstreamSourceSourceSpecNacosSourceAuthConfigBasicArgs.builder()
                        .password("string")
                        .username("string")
                        .build())
                    .build())
                .nacosId("string")
                .nacosName("string")
                .build())
            .build())
        .sourceType("string")
        .comments("string")
        .ingressSettings(UpstreamSourceIngressSettingsArgs.builder()
            .enableAllIngressClasses(false)
            .enableAllNamespaces(false)
            .enableIngress(false)
            .enableIngressWithoutIngressClass(false)
            .ingressClasses("string")
            .updateStatus(false)
            .watchNamespaces("string")
            .build())
        .watchNamespaces("string")
        .build());
    
    upstream_source_resource = volcenginecc.apig.UpstreamSource("upstreamSourceResource",
        gateway_id="string",
        source_spec={
            "k8_s_source": {
                "cluster_id": "string",
                "cluster_type": "string",
            },
            "nacos_source": {
                "auth_config": {
                    "basic": {
                        "password": "string",
                        "username": "string",
                    },
                },
                "nacos_id": "string",
                "nacos_name": "string",
            },
        },
        source_type="string",
        comments="string",
        ingress_settings={
            "enable_all_ingress_classes": False,
            "enable_all_namespaces": False,
            "enable_ingress": False,
            "enable_ingress_without_ingress_class": False,
            "ingress_classes": ["string"],
            "update_status": False,
            "watch_namespaces": ["string"],
        },
        watch_namespaces=["string"])
    
    const upstreamSourceResource = new volcenginecc.apig.UpstreamSource("upstreamSourceResource", {
        gatewayId: "string",
        sourceSpec: {
            k8SSource: {
                clusterId: "string",
                clusterType: "string",
            },
            nacosSource: {
                authConfig: {
                    basic: {
                        password: "string",
                        username: "string",
                    },
                },
                nacosId: "string",
                nacosName: "string",
            },
        },
        sourceType: "string",
        comments: "string",
        ingressSettings: {
            enableAllIngressClasses: false,
            enableAllNamespaces: false,
            enableIngress: false,
            enableIngressWithoutIngressClass: false,
            ingressClasses: ["string"],
            updateStatus: false,
            watchNamespaces: ["string"],
        },
        watchNamespaces: ["string"],
    });
    
    type: volcenginecc:apig:UpstreamSource
    properties:
        comments: string
        gatewayId: string
        ingressSettings:
            enableAllIngressClasses: false
            enableAllNamespaces: false
            enableIngress: false
            enableIngressWithoutIngressClass: false
            ingressClasses:
                - string
            updateStatus: false
            watchNamespaces:
                - string
        sourceSpec:
            k8SSource:
                clusterId: string
                clusterType: string
            nacosSource:
                authConfig:
                    basic:
                        password: string
                        username: string
                nacosId: string
                nacosName: string
        sourceType: string
        watchNamespaces:
            - string
    

    UpstreamSource Resource Properties

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

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The UpstreamSource resource accepts the following input properties:

    GatewayId string
    Gateway instance ID
    SourceSpec Volcengine.UpstreamSourceSourceSpec
    Upstream source configuration
    SourceType string
    Upstream source type. Options: K8S: Container cluster. Nacos: Registry
    Comments string
    Remarks, length limit: 0–253 characters
    IngressSettings Volcengine.UpstreamSourceIngressSettings
    Route synchronization. When enabled, the API Gateway automatically monitors changes to Ingress resources and converts them into services, domains, Upstream, and other resources, merging them into the current gateway. Resources converted from Ingress cannot be managed in the console. Only supported for container cluster source type
    WatchNamespaces List<string>
    Specify namespace
    GatewayId string
    Gateway instance ID
    SourceSpec UpstreamSourceSourceSpecArgs
    Upstream source configuration
    SourceType string
    Upstream source type. Options: K8S: Container cluster. Nacos: Registry
    Comments string
    Remarks, length limit: 0–253 characters
    IngressSettings UpstreamSourceIngressSettingsArgs
    Route synchronization. When enabled, the API Gateway automatically monitors changes to Ingress resources and converts them into services, domains, Upstream, and other resources, merging them into the current gateway. Resources converted from Ingress cannot be managed in the console. Only supported for container cluster source type
    WatchNamespaces []string
    Specify namespace
    gatewayId String
    Gateway instance ID
    sourceSpec UpstreamSourceSourceSpec
    Upstream source configuration
    sourceType String
    Upstream source type. Options: K8S: Container cluster. Nacos: Registry
    comments String
    Remarks, length limit: 0–253 characters
    ingressSettings UpstreamSourceIngressSettings
    Route synchronization. When enabled, the API Gateway automatically monitors changes to Ingress resources and converts them into services, domains, Upstream, and other resources, merging them into the current gateway. Resources converted from Ingress cannot be managed in the console. Only supported for container cluster source type
    watchNamespaces List<String>
    Specify namespace
    gatewayId string
    Gateway instance ID
    sourceSpec UpstreamSourceSourceSpec
    Upstream source configuration
    sourceType string
    Upstream source type. Options: K8S: Container cluster. Nacos: Registry
    comments string
    Remarks, length limit: 0–253 characters
    ingressSettings UpstreamSourceIngressSettings
    Route synchronization. When enabled, the API Gateway automatically monitors changes to Ingress resources and converts them into services, domains, Upstream, and other resources, merging them into the current gateway. Resources converted from Ingress cannot be managed in the console. Only supported for container cluster source type
    watchNamespaces string[]
    Specify namespace
    gateway_id str
    Gateway instance ID
    source_spec UpstreamSourceSourceSpecArgs
    Upstream source configuration
    source_type str
    Upstream source type. Options: K8S: Container cluster. Nacos: Registry
    comments str
    Remarks, length limit: 0–253 characters
    ingress_settings UpstreamSourceIngressSettingsArgs
    Route synchronization. When enabled, the API Gateway automatically monitors changes to Ingress resources and converts them into services, domains, Upstream, and other resources, merging them into the current gateway. Resources converted from Ingress cannot be managed in the console. Only supported for container cluster source type
    watch_namespaces Sequence[str]
    Specify namespace
    gatewayId String
    Gateway instance ID
    sourceSpec Property Map
    Upstream source configuration
    sourceType String
    Upstream source type. Options: K8S: Container cluster. Nacos: Registry
    comments String
    Remarks, length limit: 0–253 characters
    ingressSettings Property Map
    Route synchronization. When enabled, the API Gateway automatically monitors changes to Ingress resources and converts them into services, domains, Upstream, and other resources, merging them into the current gateway. Resources converted from Ingress cannot be managed in the console. Only supported for container cluster source type
    watchNamespaces List<String>
    Specify namespace

    Outputs

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

    CreatedTime string
    Creation time
    Id string
    The provider-assigned unique ID for this managed resource.
    Status string
    Import status. Options: Syncing: Importing. SyncedSucceed: Import successful. SyncedFailed: Import failed
    StatusMessage string
    Import status information. Options: ConnectionFailed: Unable to connect to Nacos cluster. AuthenticationFailed: Authentication failed. PermissionFailed: Unable to connect to Nacos cluster
    UpdatedTime string
    Update time
    UpstreamSourceId string
    Upstream source ID
    CreatedTime string
    Creation time
    Id string
    The provider-assigned unique ID for this managed resource.
    Status string
    Import status. Options: Syncing: Importing. SyncedSucceed: Import successful. SyncedFailed: Import failed
    StatusMessage string
    Import status information. Options: ConnectionFailed: Unable to connect to Nacos cluster. AuthenticationFailed: Authentication failed. PermissionFailed: Unable to connect to Nacos cluster
    UpdatedTime string
    Update time
    UpstreamSourceId string
    Upstream source ID
    createdTime String
    Creation time
    id String
    The provider-assigned unique ID for this managed resource.
    status String
    Import status. Options: Syncing: Importing. SyncedSucceed: Import successful. SyncedFailed: Import failed
    statusMessage String
    Import status information. Options: ConnectionFailed: Unable to connect to Nacos cluster. AuthenticationFailed: Authentication failed. PermissionFailed: Unable to connect to Nacos cluster
    updatedTime String
    Update time
    upstreamSourceId String
    Upstream source ID
    createdTime string
    Creation time
    id string
    The provider-assigned unique ID for this managed resource.
    status string
    Import status. Options: Syncing: Importing. SyncedSucceed: Import successful. SyncedFailed: Import failed
    statusMessage string
    Import status information. Options: ConnectionFailed: Unable to connect to Nacos cluster. AuthenticationFailed: Authentication failed. PermissionFailed: Unable to connect to Nacos cluster
    updatedTime string
    Update time
    upstreamSourceId string
    Upstream source ID
    created_time str
    Creation time
    id str
    The provider-assigned unique ID for this managed resource.
    status str
    Import status. Options: Syncing: Importing. SyncedSucceed: Import successful. SyncedFailed: Import failed
    status_message str
    Import status information. Options: ConnectionFailed: Unable to connect to Nacos cluster. AuthenticationFailed: Authentication failed. PermissionFailed: Unable to connect to Nacos cluster
    updated_time str
    Update time
    upstream_source_id str
    Upstream source ID
    createdTime String
    Creation time
    id String
    The provider-assigned unique ID for this managed resource.
    status String
    Import status. Options: Syncing: Importing. SyncedSucceed: Import successful. SyncedFailed: Import failed
    statusMessage String
    Import status information. Options: ConnectionFailed: Unable to connect to Nacos cluster. AuthenticationFailed: Authentication failed. PermissionFailed: Unable to connect to Nacos cluster
    updatedTime String
    Update time
    upstreamSourceId String
    Upstream source ID

    Look up Existing UpstreamSource Resource

    Get an existing UpstreamSource 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?: UpstreamSourceState, opts?: CustomResourceOptions): UpstreamSource
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            comments: Optional[str] = None,
            created_time: Optional[str] = None,
            gateway_id: Optional[str] = None,
            ingress_settings: Optional[UpstreamSourceIngressSettingsArgs] = None,
            source_spec: Optional[UpstreamSourceSourceSpecArgs] = None,
            source_type: Optional[str] = None,
            status: Optional[str] = None,
            status_message: Optional[str] = None,
            updated_time: Optional[str] = None,
            upstream_source_id: Optional[str] = None,
            watch_namespaces: Optional[Sequence[str]] = None) -> UpstreamSource
    func GetUpstreamSource(ctx *Context, name string, id IDInput, state *UpstreamSourceState, opts ...ResourceOption) (*UpstreamSource, error)
    public static UpstreamSource Get(string name, Input<string> id, UpstreamSourceState? state, CustomResourceOptions? opts = null)
    public static UpstreamSource get(String name, Output<String> id, UpstreamSourceState state, CustomResourceOptions options)
    resources:  _:    type: volcenginecc:apig:UpstreamSource    get:      id: ${id}
    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:
    Comments string
    Remarks, length limit: 0–253 characters
    CreatedTime string
    Creation time
    GatewayId string
    Gateway instance ID
    IngressSettings Volcengine.UpstreamSourceIngressSettings
    Route synchronization. When enabled, the API Gateway automatically monitors changes to Ingress resources and converts them into services, domains, Upstream, and other resources, merging them into the current gateway. Resources converted from Ingress cannot be managed in the console. Only supported for container cluster source type
    SourceSpec Volcengine.UpstreamSourceSourceSpec
    Upstream source configuration
    SourceType string
    Upstream source type. Options: K8S: Container cluster. Nacos: Registry
    Status string
    Import status. Options: Syncing: Importing. SyncedSucceed: Import successful. SyncedFailed: Import failed
    StatusMessage string
    Import status information. Options: ConnectionFailed: Unable to connect to Nacos cluster. AuthenticationFailed: Authentication failed. PermissionFailed: Unable to connect to Nacos cluster
    UpdatedTime string
    Update time
    UpstreamSourceId string
    Upstream source ID
    WatchNamespaces List<string>
    Specify namespace
    Comments string
    Remarks, length limit: 0–253 characters
    CreatedTime string
    Creation time
    GatewayId string
    Gateway instance ID
    IngressSettings UpstreamSourceIngressSettingsArgs
    Route synchronization. When enabled, the API Gateway automatically monitors changes to Ingress resources and converts them into services, domains, Upstream, and other resources, merging them into the current gateway. Resources converted from Ingress cannot be managed in the console. Only supported for container cluster source type
    SourceSpec UpstreamSourceSourceSpecArgs
    Upstream source configuration
    SourceType string
    Upstream source type. Options: K8S: Container cluster. Nacos: Registry
    Status string
    Import status. Options: Syncing: Importing. SyncedSucceed: Import successful. SyncedFailed: Import failed
    StatusMessage string
    Import status information. Options: ConnectionFailed: Unable to connect to Nacos cluster. AuthenticationFailed: Authentication failed. PermissionFailed: Unable to connect to Nacos cluster
    UpdatedTime string
    Update time
    UpstreamSourceId string
    Upstream source ID
    WatchNamespaces []string
    Specify namespace
    comments String
    Remarks, length limit: 0–253 characters
    createdTime String
    Creation time
    gatewayId String
    Gateway instance ID
    ingressSettings UpstreamSourceIngressSettings
    Route synchronization. When enabled, the API Gateway automatically monitors changes to Ingress resources and converts them into services, domains, Upstream, and other resources, merging them into the current gateway. Resources converted from Ingress cannot be managed in the console. Only supported for container cluster source type
    sourceSpec UpstreamSourceSourceSpec
    Upstream source configuration
    sourceType String
    Upstream source type. Options: K8S: Container cluster. Nacos: Registry
    status String
    Import status. Options: Syncing: Importing. SyncedSucceed: Import successful. SyncedFailed: Import failed
    statusMessage String
    Import status information. Options: ConnectionFailed: Unable to connect to Nacos cluster. AuthenticationFailed: Authentication failed. PermissionFailed: Unable to connect to Nacos cluster
    updatedTime String
    Update time
    upstreamSourceId String
    Upstream source ID
    watchNamespaces List<String>
    Specify namespace
    comments string
    Remarks, length limit: 0–253 characters
    createdTime string
    Creation time
    gatewayId string
    Gateway instance ID
    ingressSettings UpstreamSourceIngressSettings
    Route synchronization. When enabled, the API Gateway automatically monitors changes to Ingress resources and converts them into services, domains, Upstream, and other resources, merging them into the current gateway. Resources converted from Ingress cannot be managed in the console. Only supported for container cluster source type
    sourceSpec UpstreamSourceSourceSpec
    Upstream source configuration
    sourceType string
    Upstream source type. Options: K8S: Container cluster. Nacos: Registry
    status string
    Import status. Options: Syncing: Importing. SyncedSucceed: Import successful. SyncedFailed: Import failed
    statusMessage string
    Import status information. Options: ConnectionFailed: Unable to connect to Nacos cluster. AuthenticationFailed: Authentication failed. PermissionFailed: Unable to connect to Nacos cluster
    updatedTime string
    Update time
    upstreamSourceId string
    Upstream source ID
    watchNamespaces string[]
    Specify namespace
    comments str
    Remarks, length limit: 0–253 characters
    created_time str
    Creation time
    gateway_id str
    Gateway instance ID
    ingress_settings UpstreamSourceIngressSettingsArgs
    Route synchronization. When enabled, the API Gateway automatically monitors changes to Ingress resources and converts them into services, domains, Upstream, and other resources, merging them into the current gateway. Resources converted from Ingress cannot be managed in the console. Only supported for container cluster source type
    source_spec UpstreamSourceSourceSpecArgs
    Upstream source configuration
    source_type str
    Upstream source type. Options: K8S: Container cluster. Nacos: Registry
    status str
    Import status. Options: Syncing: Importing. SyncedSucceed: Import successful. SyncedFailed: Import failed
    status_message str
    Import status information. Options: ConnectionFailed: Unable to connect to Nacos cluster. AuthenticationFailed: Authentication failed. PermissionFailed: Unable to connect to Nacos cluster
    updated_time str
    Update time
    upstream_source_id str
    Upstream source ID
    watch_namespaces Sequence[str]
    Specify namespace
    comments String
    Remarks, length limit: 0–253 characters
    createdTime String
    Creation time
    gatewayId String
    Gateway instance ID
    ingressSettings Property Map
    Route synchronization. When enabled, the API Gateway automatically monitors changes to Ingress resources and converts them into services, domains, Upstream, and other resources, merging them into the current gateway. Resources converted from Ingress cannot be managed in the console. Only supported for container cluster source type
    sourceSpec Property Map
    Upstream source configuration
    sourceType String
    Upstream source type. Options: K8S: Container cluster. Nacos: Registry
    status String
    Import status. Options: Syncing: Importing. SyncedSucceed: Import successful. SyncedFailed: Import failed
    statusMessage String
    Import status information. Options: ConnectionFailed: Unable to connect to Nacos cluster. AuthenticationFailed: Authentication failed. PermissionFailed: Unable to connect to Nacos cluster
    updatedTime String
    Update time
    upstreamSourceId String
    Upstream source ID
    watchNamespaces List<String>
    Specify namespace

    Supporting Types

    UpstreamSourceIngressSettings, UpstreamSourceIngressSettingsArgs

    EnableAllIngressClasses bool
    Whether to enable all Ingress classes
    EnableAllNamespaces bool
    Whether all namespaces
    EnableIngress bool
    Whether enabled
    EnableIngressWithoutIngressClass bool
    Whether to monitor resources with empty IngressClass
    IngressClasses List<string>
    Specify IngressClass
    UpdateStatus bool
    Traffic entry switch. When enabled, the IP address in the Status of the current cluster's Ingress will be updated to the current gateway's IP address
    WatchNamespaces List<string>
    Specify namespace
    EnableAllIngressClasses bool
    Whether to enable all Ingress classes
    EnableAllNamespaces bool
    Whether all namespaces
    EnableIngress bool
    Whether enabled
    EnableIngressWithoutIngressClass bool
    Whether to monitor resources with empty IngressClass
    IngressClasses []string
    Specify IngressClass
    UpdateStatus bool
    Traffic entry switch. When enabled, the IP address in the Status of the current cluster's Ingress will be updated to the current gateway's IP address
    WatchNamespaces []string
    Specify namespace
    enableAllIngressClasses Boolean
    Whether to enable all Ingress classes
    enableAllNamespaces Boolean
    Whether all namespaces
    enableIngress Boolean
    Whether enabled
    enableIngressWithoutIngressClass Boolean
    Whether to monitor resources with empty IngressClass
    ingressClasses List<String>
    Specify IngressClass
    updateStatus Boolean
    Traffic entry switch. When enabled, the IP address in the Status of the current cluster's Ingress will be updated to the current gateway's IP address
    watchNamespaces List<String>
    Specify namespace
    enableAllIngressClasses boolean
    Whether to enable all Ingress classes
    enableAllNamespaces boolean
    Whether all namespaces
    enableIngress boolean
    Whether enabled
    enableIngressWithoutIngressClass boolean
    Whether to monitor resources with empty IngressClass
    ingressClasses string[]
    Specify IngressClass
    updateStatus boolean
    Traffic entry switch. When enabled, the IP address in the Status of the current cluster's Ingress will be updated to the current gateway's IP address
    watchNamespaces string[]
    Specify namespace
    enable_all_ingress_classes bool
    Whether to enable all Ingress classes
    enable_all_namespaces bool
    Whether all namespaces
    enable_ingress bool
    Whether enabled
    enable_ingress_without_ingress_class bool
    Whether to monitor resources with empty IngressClass
    ingress_classes Sequence[str]
    Specify IngressClass
    update_status bool
    Traffic entry switch. When enabled, the IP address in the Status of the current cluster's Ingress will be updated to the current gateway's IP address
    watch_namespaces Sequence[str]
    Specify namespace
    enableAllIngressClasses Boolean
    Whether to enable all Ingress classes
    enableAllNamespaces Boolean
    Whether all namespaces
    enableIngress Boolean
    Whether enabled
    enableIngressWithoutIngressClass Boolean
    Whether to monitor resources with empty IngressClass
    ingressClasses List<String>
    Specify IngressClass
    updateStatus Boolean
    Traffic entry switch. When enabled, the IP address in the Status of the current cluster's Ingress will be updated to the current gateway's IP address
    watchNamespaces List<String>
    Specify namespace

    UpstreamSourceSourceSpec, UpstreamSourceSourceSpecArgs

    k8SSource Property Map
    Container cluster source
    nacosSource Property Map
    Registry source

    UpstreamSourceSourceSpecK8SSource, UpstreamSourceSourceSpecK8SSourceArgs

    ClusterId string
    Cluster ID
    ClusterType string
    Cluster type
    ClusterId string
    Cluster ID
    ClusterType string
    Cluster type
    clusterId String
    Cluster ID
    clusterType String
    Cluster type
    clusterId string
    Cluster ID
    clusterType string
    Cluster type
    cluster_id str
    Cluster ID
    cluster_type str
    Cluster type
    clusterId String
    Cluster ID
    clusterType String
    Cluster type

    UpstreamSourceSourceSpecNacosSource, UpstreamSourceSourceSpecNacosSourceArgs

    AuthConfig Volcengine.UpstreamSourceSourceSpecNacosSourceAuthConfig
    Authentication configuration
    NacosId string
    Nacos ID。
    NacosName string
    Nacos name
    AuthConfig UpstreamSourceSourceSpecNacosSourceAuthConfig
    Authentication configuration
    NacosId string
    Nacos ID。
    NacosName string
    Nacos name
    authConfig UpstreamSourceSourceSpecNacosSourceAuthConfig
    Authentication configuration
    nacosId String
    Nacos ID。
    nacosName String
    Nacos name
    authConfig UpstreamSourceSourceSpecNacosSourceAuthConfig
    Authentication configuration
    nacosId string
    Nacos ID。
    nacosName string
    Nacos name
    auth_config UpstreamSourceSourceSpecNacosSourceAuthConfig
    Authentication configuration
    nacos_id str
    Nacos ID。
    nacos_name str
    Nacos name
    authConfig Property Map
    Authentication configuration
    nacosId String
    Nacos ID。
    nacosName String
    Nacos name

    UpstreamSourceSourceSpecNacosSourceAuthConfig, UpstreamSourceSourceSpecNacosSourceAuthConfigArgs

    basic Property Map
    Basic authentication

    UpstreamSourceSourceSpecNacosSourceAuthConfigBasic, UpstreamSourceSourceSpecNacosSourceAuthConfigBasicArgs

    Password string
    Password
    Username string
    Username
    Password string
    Password
    Username string
    Username
    password String
    Password
    username String
    Username
    password string
    Password
    username string
    Username
    password str
    Password
    username str
    Username
    password String
    Password
    username String
    Username

    Import

    $ pulumi import volcenginecc:apig/upstreamSource:UpstreamSource example "upstream_source_id"
    

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

    Package Details

    Repository
    volcenginecc volcengine/pulumi-volcenginecc
    License
    MPL-2.0
    Notes
    This Pulumi package is based on the volcenginecc Terraform Provider.
    volcenginecc logo
    Viewing docs for volcenginecc v0.0.32
    published on Thursday, Apr 23, 2026 by Volcengine
      Try Pulumi Cloud free. Your team will thank you.