1. Packages
  2. Gcore Provider
  3. API Docs
  4. getCdnOriginGroup
Viewing docs for gcore 2.0.0-alpha.2
published on Tuesday, Mar 24, 2026 by g-core
gcore logo
Viewing docs for gcore 2.0.0-alpha.2
published on Tuesday, Mar 24, 2026 by g-core

    CDN origin groups aggregate one or more origin servers with failover and load balancing for content delivery.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as gcore from "@pulumi/gcore";
    
    const exampleCdnOriginGroup = gcore.getCdnOriginGroup({
        originGroupId: 0,
    });
    
    import pulumi
    import pulumi_gcore as gcore
    
    example_cdn_origin_group = gcore.get_cdn_origin_group(origin_group_id=0)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/gcore/v2/gcore"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := gcore.LookupCdnOriginGroup(ctx, &gcore.LookupCdnOriginGroupArgs{
    			OriginGroupId: 0,
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Gcore = Pulumi.Gcore;
    
    return await Deployment.RunAsync(() => 
    {
        var exampleCdnOriginGroup = Gcore.GetCdnOriginGroup.Invoke(new()
        {
            OriginGroupId = 0,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.gcore.GcoreFunctions;
    import com.pulumi.gcore.inputs.GetCdnOriginGroupArgs;
    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) {
            final var exampleCdnOriginGroup = GcoreFunctions.getCdnOriginGroup(GetCdnOriginGroupArgs.builder()
                .originGroupId(0)
                .build());
    
        }
    }
    
    variables:
      exampleCdnOriginGroup:
        fn::invoke:
          function: gcore:getCdnOriginGroup
          arguments:
            originGroupId: 0
    

    Using getCdnOriginGroup

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getCdnOriginGroup(args: GetCdnOriginGroupArgs, opts?: InvokeOptions): Promise<GetCdnOriginGroupResult>
    function getCdnOriginGroupOutput(args: GetCdnOriginGroupOutputArgs, opts?: InvokeOptions): Output<GetCdnOriginGroupResult>
    def get_cdn_origin_group(origin_group_id: Optional[float] = None,
                             opts: Optional[InvokeOptions] = None) -> GetCdnOriginGroupResult
    def get_cdn_origin_group_output(origin_group_id: Optional[pulumi.Input[float]] = None,
                             opts: Optional[InvokeOptions] = None) -> Output[GetCdnOriginGroupResult]
    func LookupCdnOriginGroup(ctx *Context, args *LookupCdnOriginGroupArgs, opts ...InvokeOption) (*LookupCdnOriginGroupResult, error)
    func LookupCdnOriginGroupOutput(ctx *Context, args *LookupCdnOriginGroupOutputArgs, opts ...InvokeOption) LookupCdnOriginGroupResultOutput

    > Note: This function is named LookupCdnOriginGroup in the Go SDK.

    public static class GetCdnOriginGroup 
    {
        public static Task<GetCdnOriginGroupResult> InvokeAsync(GetCdnOriginGroupArgs args, InvokeOptions? opts = null)
        public static Output<GetCdnOriginGroupResult> Invoke(GetCdnOriginGroupInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetCdnOriginGroupResult> getCdnOriginGroup(GetCdnOriginGroupArgs args, InvokeOptions options)
    public static Output<GetCdnOriginGroupResult> getCdnOriginGroup(GetCdnOriginGroupArgs args, InvokeOptions options)
    
    fn::invoke:
      function: gcore:index/getCdnOriginGroup:getCdnOriginGroup
      arguments:
        # arguments dictionary

    The following arguments are supported:

    getCdnOriginGroup Result

    The following output properties are available:

    Auth GetCdnOriginGroupAuth
    Credentials to access the private bucket.
    AuthType string
    Origin authentication type.
    HasRelatedResources bool
    Id double
    Name string
    OriginGroupId double
    Path string
    ProxyNextUpstreams List<string>
    Sources List<GetCdnOriginGroupSource>
    UseNext bool
    Auth GetCdnOriginGroupAuth
    Credentials to access the private bucket.
    AuthType string
    Origin authentication type.
    HasRelatedResources bool
    Id float64
    Name string
    OriginGroupId float64
    Path string
    ProxyNextUpstreams []string
    Sources []GetCdnOriginGroupSource
    UseNext bool
    auth GetCdnOriginGroupAuth
    Credentials to access the private bucket.
    authType String
    Origin authentication type.
    hasRelatedResources Boolean
    id Double
    name String
    originGroupId Double
    path String
    proxyNextUpstreams List<String>
    sources List<GetCdnOriginGroupSource>
    useNext Boolean
    auth GetCdnOriginGroupAuth
    Credentials to access the private bucket.
    authType string
    Origin authentication type.
    hasRelatedResources boolean
    id number
    name string
    originGroupId number
    path string
    proxyNextUpstreams string[]
    sources GetCdnOriginGroupSource[]
    useNext boolean
    auth GetCdnOriginGroupAuth
    Credentials to access the private bucket.
    auth_type str
    Origin authentication type.
    has_related_resources bool
    id float
    name str
    origin_group_id float
    path str
    proxy_next_upstreams Sequence[str]
    sources Sequence[GetCdnOriginGroupSource]
    use_next bool
    auth Property Map
    Credentials to access the private bucket.
    authType String
    Origin authentication type.
    hasRelatedResources Boolean
    id Number
    name String
    originGroupId Number
    path String
    proxyNextUpstreams List<String>
    sources List<Property Map>
    useNext Boolean

    Supporting Types

    GetCdnOriginGroupAuth

    S3AccessKeyId string
    Access key ID for the S3 account.
    S3BucketName string

    S3 bucket name.

    Restrictions:

    • Maximum 128 characters.
    S3Region string

    S3 storage region.

    The parameter is required, if <span pulumi-lang-nodejs=""s3Type"" pulumi-lang-dotnet=""S3Type"" pulumi-lang-go=""s3Type"" pulumi-lang-python=""s3_type"" pulumi-lang-yaml=""s3Type"" pulumi-lang-java=""s3Type"">"s3_type": amazon.

    S3SecretAccessKey string

    Secret access key for the S3 account.

    Restrictions:

    • Latin letters (A-Z, a-z), numbers (0-9), pluses, slashes, dashes, colons and underscores.
    • If <span pulumi-lang-nodejs=""s3Type"" pulumi-lang-dotnet=""S3Type"" pulumi-lang-go=""s3Type"" pulumi-lang-python=""s3_type"" pulumi-lang-yaml=""s3Type"" pulumi-lang-java=""s3Type"">"s3_type": amazon, length should be 40 characters.
    • If <span pulumi-lang-nodejs=""s3Type"" pulumi-lang-dotnet=""S3Type"" pulumi-lang-go=""s3Type"" pulumi-lang-python=""s3_type"" pulumi-lang-yaml=""s3Type"" pulumi-lang-java=""s3Type"">"s3_type": other, length should be from 16 to 255 characters.
    S3StorageHostname string

    S3 storage hostname.

    The parameter is required, if <span pulumi-lang-nodejs=""s3Type"" pulumi-lang-dotnet=""S3Type"" pulumi-lang-go=""s3Type"" pulumi-lang-python=""s3_type"" pulumi-lang-yaml=""s3Type"" pulumi-lang-java=""s3Type"">"s3_type": other.

    S3Type string

    Storage type compatible with S3.

    Possible values:

    • amazon – AWS S3 storage.
    • other – Other (not AWS) S3 compatible storage.
    S3AccessKeyId string
    Access key ID for the S3 account.
    S3BucketName string

    S3 bucket name.

    Restrictions:

    • Maximum 128 characters.
    S3Region string

    S3 storage region.

    The parameter is required, if <span pulumi-lang-nodejs=""s3Type"" pulumi-lang-dotnet=""S3Type"" pulumi-lang-go=""s3Type"" pulumi-lang-python=""s3_type"" pulumi-lang-yaml=""s3Type"" pulumi-lang-java=""s3Type"">"s3_type": amazon.

    S3SecretAccessKey string

    Secret access key for the S3 account.

    Restrictions:

    • Latin letters (A-Z, a-z), numbers (0-9), pluses, slashes, dashes, colons and underscores.
    • If <span pulumi-lang-nodejs=""s3Type"" pulumi-lang-dotnet=""S3Type"" pulumi-lang-go=""s3Type"" pulumi-lang-python=""s3_type"" pulumi-lang-yaml=""s3Type"" pulumi-lang-java=""s3Type"">"s3_type": amazon, length should be 40 characters.
    • If <span pulumi-lang-nodejs=""s3Type"" pulumi-lang-dotnet=""S3Type"" pulumi-lang-go=""s3Type"" pulumi-lang-python=""s3_type"" pulumi-lang-yaml=""s3Type"" pulumi-lang-java=""s3Type"">"s3_type": other, length should be from 16 to 255 characters.
    S3StorageHostname string

    S3 storage hostname.

    The parameter is required, if <span pulumi-lang-nodejs=""s3Type"" pulumi-lang-dotnet=""S3Type"" pulumi-lang-go=""s3Type"" pulumi-lang-python=""s3_type"" pulumi-lang-yaml=""s3Type"" pulumi-lang-java=""s3Type"">"s3_type": other.

    S3Type string

    Storage type compatible with S3.

    Possible values:

    • amazon – AWS S3 storage.
    • other – Other (not AWS) S3 compatible storage.
    s3AccessKeyId String
    Access key ID for the S3 account.
    s3BucketName String

    S3 bucket name.

    Restrictions:

    • Maximum 128 characters.
    s3Region String

    S3 storage region.

    The parameter is required, if <span pulumi-lang-nodejs=""s3Type"" pulumi-lang-dotnet=""S3Type"" pulumi-lang-go=""s3Type"" pulumi-lang-python=""s3_type"" pulumi-lang-yaml=""s3Type"" pulumi-lang-java=""s3Type"">"s3_type": amazon.

    s3SecretAccessKey String

    Secret access key for the S3 account.

    Restrictions:

    • Latin letters (A-Z, a-z), numbers (0-9), pluses, slashes, dashes, colons and underscores.
    • If <span pulumi-lang-nodejs=""s3Type"" pulumi-lang-dotnet=""S3Type"" pulumi-lang-go=""s3Type"" pulumi-lang-python=""s3_type"" pulumi-lang-yaml=""s3Type"" pulumi-lang-java=""s3Type"">"s3_type": amazon, length should be 40 characters.
    • If <span pulumi-lang-nodejs=""s3Type"" pulumi-lang-dotnet=""S3Type"" pulumi-lang-go=""s3Type"" pulumi-lang-python=""s3_type"" pulumi-lang-yaml=""s3Type"" pulumi-lang-java=""s3Type"">"s3_type": other, length should be from 16 to 255 characters.
    s3StorageHostname String

    S3 storage hostname.

    The parameter is required, if <span pulumi-lang-nodejs=""s3Type"" pulumi-lang-dotnet=""S3Type"" pulumi-lang-go=""s3Type"" pulumi-lang-python=""s3_type"" pulumi-lang-yaml=""s3Type"" pulumi-lang-java=""s3Type"">"s3_type": other.

    s3Type String

    Storage type compatible with S3.

    Possible values:

    • amazon – AWS S3 storage.
    • other – Other (not AWS) S3 compatible storage.
    s3AccessKeyId string
    Access key ID for the S3 account.
    s3BucketName string

    S3 bucket name.

    Restrictions:

    • Maximum 128 characters.
    s3Region string

    S3 storage region.

    The parameter is required, if <span pulumi-lang-nodejs=""s3Type"" pulumi-lang-dotnet=""S3Type"" pulumi-lang-go=""s3Type"" pulumi-lang-python=""s3_type"" pulumi-lang-yaml=""s3Type"" pulumi-lang-java=""s3Type"">"s3_type": amazon.

    s3SecretAccessKey string

    Secret access key for the S3 account.

    Restrictions:

    • Latin letters (A-Z, a-z), numbers (0-9), pluses, slashes, dashes, colons and underscores.
    • If <span pulumi-lang-nodejs=""s3Type"" pulumi-lang-dotnet=""S3Type"" pulumi-lang-go=""s3Type"" pulumi-lang-python=""s3_type"" pulumi-lang-yaml=""s3Type"" pulumi-lang-java=""s3Type"">"s3_type": amazon, length should be 40 characters.
    • If <span pulumi-lang-nodejs=""s3Type"" pulumi-lang-dotnet=""S3Type"" pulumi-lang-go=""s3Type"" pulumi-lang-python=""s3_type"" pulumi-lang-yaml=""s3Type"" pulumi-lang-java=""s3Type"">"s3_type": other, length should be from 16 to 255 characters.
    s3StorageHostname string

    S3 storage hostname.

    The parameter is required, if <span pulumi-lang-nodejs=""s3Type"" pulumi-lang-dotnet=""S3Type"" pulumi-lang-go=""s3Type"" pulumi-lang-python=""s3_type"" pulumi-lang-yaml=""s3Type"" pulumi-lang-java=""s3Type"">"s3_type": other.

    s3Type string

    Storage type compatible with S3.

    Possible values:

    • amazon – AWS S3 storage.
    • other – Other (not AWS) S3 compatible storage.
    s3_access_key_id str
    Access key ID for the S3 account.
    s3_bucket_name str

    S3 bucket name.

    Restrictions:

    • Maximum 128 characters.
    s3_region str

    S3 storage region.

    The parameter is required, if <span pulumi-lang-nodejs=""s3Type"" pulumi-lang-dotnet=""S3Type"" pulumi-lang-go=""s3Type"" pulumi-lang-python=""s3_type"" pulumi-lang-yaml=""s3Type"" pulumi-lang-java=""s3Type"">"s3_type": amazon.

    s3_secret_access_key str

    Secret access key for the S3 account.

    Restrictions:

    • Latin letters (A-Z, a-z), numbers (0-9), pluses, slashes, dashes, colons and underscores.
    • If <span pulumi-lang-nodejs=""s3Type"" pulumi-lang-dotnet=""S3Type"" pulumi-lang-go=""s3Type"" pulumi-lang-python=""s3_type"" pulumi-lang-yaml=""s3Type"" pulumi-lang-java=""s3Type"">"s3_type": amazon, length should be 40 characters.
    • If <span pulumi-lang-nodejs=""s3Type"" pulumi-lang-dotnet=""S3Type"" pulumi-lang-go=""s3Type"" pulumi-lang-python=""s3_type"" pulumi-lang-yaml=""s3Type"" pulumi-lang-java=""s3Type"">"s3_type": other, length should be from 16 to 255 characters.
    s3_storage_hostname str

    S3 storage hostname.

    The parameter is required, if <span pulumi-lang-nodejs=""s3Type"" pulumi-lang-dotnet=""S3Type"" pulumi-lang-go=""s3Type"" pulumi-lang-python=""s3_type"" pulumi-lang-yaml=""s3Type"" pulumi-lang-java=""s3Type"">"s3_type": other.

    s3_type str

    Storage type compatible with S3.

    Possible values:

    • amazon – AWS S3 storage.
    • other – Other (not AWS) S3 compatible storage.
    s3AccessKeyId String
    Access key ID for the S3 account.
    s3BucketName String

    S3 bucket name.

    Restrictions:

    • Maximum 128 characters.
    s3Region String

    S3 storage region.

    The parameter is required, if <span pulumi-lang-nodejs=""s3Type"" pulumi-lang-dotnet=""S3Type"" pulumi-lang-go=""s3Type"" pulumi-lang-python=""s3_type"" pulumi-lang-yaml=""s3Type"" pulumi-lang-java=""s3Type"">"s3_type": amazon.

    s3SecretAccessKey String

    Secret access key for the S3 account.

    Restrictions:

    • Latin letters (A-Z, a-z), numbers (0-9), pluses, slashes, dashes, colons and underscores.
    • If <span pulumi-lang-nodejs=""s3Type"" pulumi-lang-dotnet=""S3Type"" pulumi-lang-go=""s3Type"" pulumi-lang-python=""s3_type"" pulumi-lang-yaml=""s3Type"" pulumi-lang-java=""s3Type"">"s3_type": amazon, length should be 40 characters.
    • If <span pulumi-lang-nodejs=""s3Type"" pulumi-lang-dotnet=""S3Type"" pulumi-lang-go=""s3Type"" pulumi-lang-python=""s3_type"" pulumi-lang-yaml=""s3Type"" pulumi-lang-java=""s3Type"">"s3_type": other, length should be from 16 to 255 characters.
    s3StorageHostname String

    S3 storage hostname.

    The parameter is required, if <span pulumi-lang-nodejs=""s3Type"" pulumi-lang-dotnet=""S3Type"" pulumi-lang-go=""s3Type"" pulumi-lang-python=""s3_type"" pulumi-lang-yaml=""s3Type"" pulumi-lang-java=""s3Type"">"s3_type": other.

    s3Type String

    Storage type compatible with S3.

    Possible values:

    • amazon – AWS S3 storage.
    • other – Other (not AWS) S3 compatible storage.

    GetCdnOriginGroupSource

    Backup bool
    Defines whether the origin is a backup, meaning that it will not be used until one of active origins become unavailable.
    Enabled bool

    Enables or disables an origin source in the origin group.

    Possible values:

    • true - Origin is enabled and the CDN uses it to pull content.
    • false - Origin is disabled and the CDN does not use it to pull content.

    Origin group must contain at least one enabled origin.

    Source string
    IP address or domain name of the origin and the port, if custom port is used.
    Backup bool
    Defines whether the origin is a backup, meaning that it will not be used until one of active origins become unavailable.
    Enabled bool

    Enables or disables an origin source in the origin group.

    Possible values:

    • true - Origin is enabled and the CDN uses it to pull content.
    • false - Origin is disabled and the CDN does not use it to pull content.

    Origin group must contain at least one enabled origin.

    Source string
    IP address or domain name of the origin and the port, if custom port is used.
    backup Boolean
    Defines whether the origin is a backup, meaning that it will not be used until one of active origins become unavailable.
    enabled Boolean

    Enables or disables an origin source in the origin group.

    Possible values:

    • true - Origin is enabled and the CDN uses it to pull content.
    • false - Origin is disabled and the CDN does not use it to pull content.

    Origin group must contain at least one enabled origin.

    source String
    IP address or domain name of the origin and the port, if custom port is used.
    backup boolean
    Defines whether the origin is a backup, meaning that it will not be used until one of active origins become unavailable.
    enabled boolean

    Enables or disables an origin source in the origin group.

    Possible values:

    • true - Origin is enabled and the CDN uses it to pull content.
    • false - Origin is disabled and the CDN does not use it to pull content.

    Origin group must contain at least one enabled origin.

    source string
    IP address or domain name of the origin and the port, if custom port is used.
    backup bool
    Defines whether the origin is a backup, meaning that it will not be used until one of active origins become unavailable.
    enabled bool

    Enables or disables an origin source in the origin group.

    Possible values:

    • true - Origin is enabled and the CDN uses it to pull content.
    • false - Origin is disabled and the CDN does not use it to pull content.

    Origin group must contain at least one enabled origin.

    source str
    IP address or domain name of the origin and the port, if custom port is used.
    backup Boolean
    Defines whether the origin is a backup, meaning that it will not be used until one of active origins become unavailable.
    enabled Boolean

    Enables or disables an origin source in the origin group.

    Possible values:

    • true - Origin is enabled and the CDN uses it to pull content.
    • false - Origin is disabled and the CDN does not use it to pull content.

    Origin group must contain at least one enabled origin.

    source String
    IP address or domain name of the origin and the port, if custom port is used.

    Package Details

    Repository
    gcore g-core/terraform-provider-gcore
    License
    Notes
    This Pulumi package is based on the gcore Terraform Provider.
    gcore logo
    Viewing docs for gcore 2.0.0-alpha.2
    published on Tuesday, Mar 24, 2026 by g-core
      Try Pulumi Cloud free. Your team will thank you.