1. Packages
  2. Rancher2 Provider
  3. API Docs
  4. GlobalDnsProvider
Rancher 2 v7.1.1 published on Monday, Oct 7, 2024 by Pulumi

rancher2.GlobalDnsProvider

Explore with Pulumi AI

rancher2 logo
Rancher 2 v7.1.1 published on Monday, Oct 7, 2024 by Pulumi

    Provides a Rancher V2 Global DNS Provider resource. This can be used to create Global DNS Providers for Rancher V2. Supported Global DNS Providers: alidns, cloudflare, route53

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as rancher2 from "@pulumi/rancher2";
    
    // Create a new rancher2 Global DNS Provider - alidns
    const foo = new rancher2.GlobalDnsProvider("foo", {
        name: "foo",
        rootDomain: "example.com",
        alidnsConfig: {
            accessKey: "YYYYYYYYYYYYYYYYYYYY",
            secretKey: "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
        },
    });
    
    import pulumi
    import pulumi_rancher2 as rancher2
    
    # Create a new rancher2 Global DNS Provider - alidns
    foo = rancher2.GlobalDnsProvider("foo",
        name="foo",
        root_domain="example.com",
        alidns_config={
            "access_key": "YYYYYYYYYYYYYYYYYYYY",
            "secret_key": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
        })
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-rancher2/sdk/v7/go/rancher2"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		// Create a new rancher2 Global DNS Provider - alidns
    		_, err := rancher2.NewGlobalDnsProvider(ctx, "foo", &rancher2.GlobalDnsProviderArgs{
    			Name:       pulumi.String("foo"),
    			RootDomain: pulumi.String("example.com"),
    			AlidnsConfig: &rancher2.GlobalDnsProviderAlidnsConfigArgs{
    				AccessKey: pulumi.String("YYYYYYYYYYYYYYYYYYYY"),
    				SecretKey: pulumi.String("XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Rancher2 = Pulumi.Rancher2;
    
    return await Deployment.RunAsync(() => 
    {
        // Create a new rancher2 Global DNS Provider - alidns
        var foo = new Rancher2.GlobalDnsProvider("foo", new()
        {
            Name = "foo",
            RootDomain = "example.com",
            AlidnsConfig = new Rancher2.Inputs.GlobalDnsProviderAlidnsConfigArgs
            {
                AccessKey = "YYYYYYYYYYYYYYYYYYYY",
                SecretKey = "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.rancher2.GlobalDnsProvider;
    import com.pulumi.rancher2.GlobalDnsProviderArgs;
    import com.pulumi.rancher2.inputs.GlobalDnsProviderAlidnsConfigArgs;
    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) {
            // Create a new rancher2 Global DNS Provider - alidns
            var foo = new GlobalDnsProvider("foo", GlobalDnsProviderArgs.builder()
                .name("foo")
                .rootDomain("example.com")
                .alidnsConfig(GlobalDnsProviderAlidnsConfigArgs.builder()
                    .accessKey("YYYYYYYYYYYYYYYYYYYY")
                    .secretKey("XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX")
                    .build())
                .build());
    
        }
    }
    
    resources:
      # Create a new rancher2 Global DNS Provider - alidns
      foo:
        type: rancher2:GlobalDnsProvider
        properties:
          name: foo
          rootDomain: example.com
          alidnsConfig:
            accessKey: YYYYYYYYYYYYYYYYYYYY
            secretKey: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
    
    import * as pulumi from "@pulumi/pulumi";
    import * as rancher2 from "@pulumi/rancher2";
    
    // Create a new rancher2 Global DNS Provider - cloudflare
    const foo = new rancher2.GlobalDnsProvider("foo", {
        name: "foo",
        rootDomain: "example.com",
        cloudflareConfig: {
            apiEmail: "test@test.local",
            apiKey: "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
            proxySetting: true,
        },
    });
    
    import pulumi
    import pulumi_rancher2 as rancher2
    
    # Create a new rancher2 Global DNS Provider - cloudflare
    foo = rancher2.GlobalDnsProvider("foo",
        name="foo",
        root_domain="example.com",
        cloudflare_config={
            "api_email": "test@test.local",
            "api_key": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
            "proxy_setting": True,
        })
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-rancher2/sdk/v7/go/rancher2"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		// Create a new rancher2 Global DNS Provider - cloudflare
    		_, err := rancher2.NewGlobalDnsProvider(ctx, "foo", &rancher2.GlobalDnsProviderArgs{
    			Name:       pulumi.String("foo"),
    			RootDomain: pulumi.String("example.com"),
    			CloudflareConfig: &rancher2.GlobalDnsProviderCloudflareConfigArgs{
    				ApiEmail:     pulumi.String("test@test.local"),
    				ApiKey:       pulumi.String("XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"),
    				ProxySetting: pulumi.Bool(true),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Rancher2 = Pulumi.Rancher2;
    
    return await Deployment.RunAsync(() => 
    {
        // Create a new rancher2 Global DNS Provider - cloudflare
        var foo = new Rancher2.GlobalDnsProvider("foo", new()
        {
            Name = "foo",
            RootDomain = "example.com",
            CloudflareConfig = new Rancher2.Inputs.GlobalDnsProviderCloudflareConfigArgs
            {
                ApiEmail = "test@test.local",
                ApiKey = "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
                ProxySetting = true,
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.rancher2.GlobalDnsProvider;
    import com.pulumi.rancher2.GlobalDnsProviderArgs;
    import com.pulumi.rancher2.inputs.GlobalDnsProviderCloudflareConfigArgs;
    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) {
            // Create a new rancher2 Global DNS Provider - cloudflare
            var foo = new GlobalDnsProvider("foo", GlobalDnsProviderArgs.builder()
                .name("foo")
                .rootDomain("example.com")
                .cloudflareConfig(GlobalDnsProviderCloudflareConfigArgs.builder()
                    .apiEmail("test@test.local")
                    .apiKey("XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX")
                    .proxySetting(true)
                    .build())
                .build());
    
        }
    }
    
    resources:
      # Create a new rancher2 Global DNS Provider - cloudflare
      foo:
        type: rancher2:GlobalDnsProvider
        properties:
          name: foo
          rootDomain: example.com
          cloudflareConfig:
            apiEmail: test@test.local
            apiKey: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
            proxySetting: true
    
    import * as pulumi from "@pulumi/pulumi";
    import * as rancher2 from "@pulumi/rancher2";
    
    // Create a new rancher2 Global DNS Provider - route53
    const foo = new rancher2.GlobalDnsProvider("foo", {
        name: "foo",
        rootDomain: "example.com",
        route53Config: {
            accessKey: "YYYYYYYYYYYYYYYYYYYY",
            secretKey: "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
            zoneType: "private",
            region: "us-east-1",
        },
    });
    
    import pulumi
    import pulumi_rancher2 as rancher2
    
    # Create a new rancher2 Global DNS Provider - route53
    foo = rancher2.GlobalDnsProvider("foo",
        name="foo",
        root_domain="example.com",
        route53_config={
            "access_key": "YYYYYYYYYYYYYYYYYYYY",
            "secret_key": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
            "zone_type": "private",
            "region": "us-east-1",
        })
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-rancher2/sdk/v7/go/rancher2"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		// Create a new rancher2 Global DNS Provider - route53
    		_, err := rancher2.NewGlobalDnsProvider(ctx, "foo", &rancher2.GlobalDnsProviderArgs{
    			Name:       pulumi.String("foo"),
    			RootDomain: pulumi.String("example.com"),
    			Route53Config: &rancher2.GlobalDnsProviderRoute53ConfigArgs{
    				AccessKey: pulumi.String("YYYYYYYYYYYYYYYYYYYY"),
    				SecretKey: pulumi.String("XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"),
    				ZoneType:  pulumi.String("private"),
    				Region:    pulumi.String("us-east-1"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Rancher2 = Pulumi.Rancher2;
    
    return await Deployment.RunAsync(() => 
    {
        // Create a new rancher2 Global DNS Provider - route53
        var foo = new Rancher2.GlobalDnsProvider("foo", new()
        {
            Name = "foo",
            RootDomain = "example.com",
            Route53Config = new Rancher2.Inputs.GlobalDnsProviderRoute53ConfigArgs
            {
                AccessKey = "YYYYYYYYYYYYYYYYYYYY",
                SecretKey = "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
                ZoneType = "private",
                Region = "us-east-1",
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.rancher2.GlobalDnsProvider;
    import com.pulumi.rancher2.GlobalDnsProviderArgs;
    import com.pulumi.rancher2.inputs.GlobalDnsProviderRoute53ConfigArgs;
    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) {
            // Create a new rancher2 Global DNS Provider - route53
            var foo = new GlobalDnsProvider("foo", GlobalDnsProviderArgs.builder()
                .name("foo")
                .rootDomain("example.com")
                .route53Config(GlobalDnsProviderRoute53ConfigArgs.builder()
                    .accessKey("YYYYYYYYYYYYYYYYYYYY")
                    .secretKey("XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX")
                    .zoneType("private")
                    .region("us-east-1")
                    .build())
                .build());
    
        }
    }
    
    resources:
      # Create a new rancher2 Global DNS Provider - route53
      foo:
        type: rancher2:GlobalDnsProvider
        properties:
          name: foo
          rootDomain: example.com
          route53Config:
            accessKey: YYYYYYYYYYYYYYYYYYYY
            secretKey: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
            zoneType: private
            region: us-east-1
    

    Create GlobalDnsProvider Resource

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

    Constructor syntax

    new GlobalDnsProvider(name: string, args: GlobalDnsProviderArgs, opts?: CustomResourceOptions);
    @overload
    def GlobalDnsProvider(resource_name: str,
                          args: GlobalDnsProviderArgs,
                          opts: Optional[ResourceOptions] = None)
    
    @overload
    def GlobalDnsProvider(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          root_domain: Optional[str] = None,
                          alidns_config: Optional[GlobalDnsProviderAlidnsConfigArgs] = None,
                          annotations: Optional[Mapping[str, str]] = None,
                          cloudflare_config: Optional[GlobalDnsProviderCloudflareConfigArgs] = None,
                          labels: Optional[Mapping[str, str]] = None,
                          name: Optional[str] = None,
                          route53_config: Optional[GlobalDnsProviderRoute53ConfigArgs] = None)
    func NewGlobalDnsProvider(ctx *Context, name string, args GlobalDnsProviderArgs, opts ...ResourceOption) (*GlobalDnsProvider, error)
    public GlobalDnsProvider(string name, GlobalDnsProviderArgs args, CustomResourceOptions? opts = null)
    public GlobalDnsProvider(String name, GlobalDnsProviderArgs args)
    public GlobalDnsProvider(String name, GlobalDnsProviderArgs args, CustomResourceOptions options)
    
    type: rancher2:GlobalDnsProvider
    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 GlobalDnsProviderArgs
    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 GlobalDnsProviderArgs
    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 GlobalDnsProviderArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args GlobalDnsProviderArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args GlobalDnsProviderArgs
    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 globalDnsProviderResource = new Rancher2.GlobalDnsProvider("globalDnsProviderResource", new()
    {
        RootDomain = "string",
        AlidnsConfig = new Rancher2.Inputs.GlobalDnsProviderAlidnsConfigArgs
        {
            AccessKey = "string",
            SecretKey = "string",
        },
        Annotations = 
        {
            { "string", "string" },
        },
        CloudflareConfig = new Rancher2.Inputs.GlobalDnsProviderCloudflareConfigArgs
        {
            ApiEmail = "string",
            ApiKey = "string",
            ProxySetting = false,
        },
        Labels = 
        {
            { "string", "string" },
        },
        Name = "string",
        Route53Config = new Rancher2.Inputs.GlobalDnsProviderRoute53ConfigArgs
        {
            AccessKey = "string",
            SecretKey = "string",
            CredentialsPath = "string",
            Region = "string",
            RoleArn = "string",
            ZoneType = "string",
        },
    });
    
    example, err := rancher2.NewGlobalDnsProvider(ctx, "globalDnsProviderResource", &rancher2.GlobalDnsProviderArgs{
    	RootDomain: pulumi.String("string"),
    	AlidnsConfig: &rancher2.GlobalDnsProviderAlidnsConfigArgs{
    		AccessKey: pulumi.String("string"),
    		SecretKey: pulumi.String("string"),
    	},
    	Annotations: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	CloudflareConfig: &rancher2.GlobalDnsProviderCloudflareConfigArgs{
    		ApiEmail:     pulumi.String("string"),
    		ApiKey:       pulumi.String("string"),
    		ProxySetting: pulumi.Bool(false),
    	},
    	Labels: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	Name: pulumi.String("string"),
    	Route53Config: &rancher2.GlobalDnsProviderRoute53ConfigArgs{
    		AccessKey:       pulumi.String("string"),
    		SecretKey:       pulumi.String("string"),
    		CredentialsPath: pulumi.String("string"),
    		Region:          pulumi.String("string"),
    		RoleArn:         pulumi.String("string"),
    		ZoneType:        pulumi.String("string"),
    	},
    })
    
    var globalDnsProviderResource = new GlobalDnsProvider("globalDnsProviderResource", GlobalDnsProviderArgs.builder()
        .rootDomain("string")
        .alidnsConfig(GlobalDnsProviderAlidnsConfigArgs.builder()
            .accessKey("string")
            .secretKey("string")
            .build())
        .annotations(Map.of("string", "string"))
        .cloudflareConfig(GlobalDnsProviderCloudflareConfigArgs.builder()
            .apiEmail("string")
            .apiKey("string")
            .proxySetting(false)
            .build())
        .labels(Map.of("string", "string"))
        .name("string")
        .route53Config(GlobalDnsProviderRoute53ConfigArgs.builder()
            .accessKey("string")
            .secretKey("string")
            .credentialsPath("string")
            .region("string")
            .roleArn("string")
            .zoneType("string")
            .build())
        .build());
    
    global_dns_provider_resource = rancher2.GlobalDnsProvider("globalDnsProviderResource",
        root_domain="string",
        alidns_config={
            "access_key": "string",
            "secret_key": "string",
        },
        annotations={
            "string": "string",
        },
        cloudflare_config={
            "api_email": "string",
            "api_key": "string",
            "proxy_setting": False,
        },
        labels={
            "string": "string",
        },
        name="string",
        route53_config={
            "access_key": "string",
            "secret_key": "string",
            "credentials_path": "string",
            "region": "string",
            "role_arn": "string",
            "zone_type": "string",
        })
    
    const globalDnsProviderResource = new rancher2.GlobalDnsProvider("globalDnsProviderResource", {
        rootDomain: "string",
        alidnsConfig: {
            accessKey: "string",
            secretKey: "string",
        },
        annotations: {
            string: "string",
        },
        cloudflareConfig: {
            apiEmail: "string",
            apiKey: "string",
            proxySetting: false,
        },
        labels: {
            string: "string",
        },
        name: "string",
        route53Config: {
            accessKey: "string",
            secretKey: "string",
            credentialsPath: "string",
            region: "string",
            roleArn: "string",
            zoneType: "string",
        },
    });
    
    type: rancher2:GlobalDnsProvider
    properties:
        alidnsConfig:
            accessKey: string
            secretKey: string
        annotations:
            string: string
        cloudflareConfig:
            apiEmail: string
            apiKey: string
            proxySetting: false
        labels:
            string: string
        name: string
        rootDomain: string
        route53Config:
            accessKey: string
            credentialsPath: string
            region: string
            roleArn: string
            secretKey: string
            zoneType: string
    

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

    RootDomain string
    The user ID to assign Global DNS Provider (string)
    AlidnsConfig GlobalDnsProviderAlidnsConfig
    Annotations Dictionary<string, string>
    Annotations for Global DNS Provider (map)
    CloudflareConfig GlobalDnsProviderCloudflareConfig
    Labels Dictionary<string, string>
    Labels for Global DNS Provider (map)
    Name string
    The name of the Global DNS Provider (string)
    Route53Config GlobalDnsProviderRoute53Config
    RootDomain string
    The user ID to assign Global DNS Provider (string)
    AlidnsConfig GlobalDnsProviderAlidnsConfigArgs
    Annotations map[string]string
    Annotations for Global DNS Provider (map)
    CloudflareConfig GlobalDnsProviderCloudflareConfigArgs
    Labels map[string]string
    Labels for Global DNS Provider (map)
    Name string
    The name of the Global DNS Provider (string)
    Route53Config GlobalDnsProviderRoute53ConfigArgs
    rootDomain String
    The user ID to assign Global DNS Provider (string)
    alidnsConfig GlobalDnsProviderAlidnsConfig
    annotations Map<String,String>
    Annotations for Global DNS Provider (map)
    cloudflareConfig GlobalDnsProviderCloudflareConfig
    labels Map<String,String>
    Labels for Global DNS Provider (map)
    name String
    The name of the Global DNS Provider (string)
    route53Config GlobalDnsProviderRoute53Config
    rootDomain string
    The user ID to assign Global DNS Provider (string)
    alidnsConfig GlobalDnsProviderAlidnsConfig
    annotations {[key: string]: string}
    Annotations for Global DNS Provider (map)
    cloudflareConfig GlobalDnsProviderCloudflareConfig
    labels {[key: string]: string}
    Labels for Global DNS Provider (map)
    name string
    The name of the Global DNS Provider (string)
    route53Config GlobalDnsProviderRoute53Config
    root_domain str
    The user ID to assign Global DNS Provider (string)
    alidns_config GlobalDnsProviderAlidnsConfigArgs
    annotations Mapping[str, str]
    Annotations for Global DNS Provider (map)
    cloudflare_config GlobalDnsProviderCloudflareConfigArgs
    labels Mapping[str, str]
    Labels for Global DNS Provider (map)
    name str
    The name of the Global DNS Provider (string)
    route53_config GlobalDnsProviderRoute53ConfigArgs
    rootDomain String
    The user ID to assign Global DNS Provider (string)
    alidnsConfig Property Map
    annotations Map<String>
    Annotations for Global DNS Provider (map)
    cloudflareConfig Property Map
    labels Map<String>
    Labels for Global DNS Provider (map)
    name String
    The name of the Global DNS Provider (string)
    route53Config Property Map

    Outputs

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

    DnsProvider string
    (Computed) The Global DNS Provider alidns, cloudflare, route53 (string)
    Id string
    The provider-assigned unique ID for this managed resource.
    DnsProvider string
    (Computed) The Global DNS Provider alidns, cloudflare, route53 (string)
    Id string
    The provider-assigned unique ID for this managed resource.
    dnsProvider String
    (Computed) The Global DNS Provider alidns, cloudflare, route53 (string)
    id String
    The provider-assigned unique ID for this managed resource.
    dnsProvider string
    (Computed) The Global DNS Provider alidns, cloudflare, route53 (string)
    id string
    The provider-assigned unique ID for this managed resource.
    dns_provider str
    (Computed) The Global DNS Provider alidns, cloudflare, route53 (string)
    id str
    The provider-assigned unique ID for this managed resource.
    dnsProvider String
    (Computed) The Global DNS Provider alidns, cloudflare, route53 (string)
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing GlobalDnsProvider Resource

    Get an existing GlobalDnsProvider 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?: GlobalDnsProviderState, opts?: CustomResourceOptions): GlobalDnsProvider
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            alidns_config: Optional[GlobalDnsProviderAlidnsConfigArgs] = None,
            annotations: Optional[Mapping[str, str]] = None,
            cloudflare_config: Optional[GlobalDnsProviderCloudflareConfigArgs] = None,
            dns_provider: Optional[str] = None,
            labels: Optional[Mapping[str, str]] = None,
            name: Optional[str] = None,
            root_domain: Optional[str] = None,
            route53_config: Optional[GlobalDnsProviderRoute53ConfigArgs] = None) -> GlobalDnsProvider
    func GetGlobalDnsProvider(ctx *Context, name string, id IDInput, state *GlobalDnsProviderState, opts ...ResourceOption) (*GlobalDnsProvider, error)
    public static GlobalDnsProvider Get(string name, Input<string> id, GlobalDnsProviderState? state, CustomResourceOptions? opts = null)
    public static GlobalDnsProvider get(String name, Output<String> id, GlobalDnsProviderState 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:
    AlidnsConfig GlobalDnsProviderAlidnsConfig
    Annotations Dictionary<string, string>
    Annotations for Global DNS Provider (map)
    CloudflareConfig GlobalDnsProviderCloudflareConfig
    DnsProvider string
    (Computed) The Global DNS Provider alidns, cloudflare, route53 (string)
    Labels Dictionary<string, string>
    Labels for Global DNS Provider (map)
    Name string
    The name of the Global DNS Provider (string)
    RootDomain string
    The user ID to assign Global DNS Provider (string)
    Route53Config GlobalDnsProviderRoute53Config
    AlidnsConfig GlobalDnsProviderAlidnsConfigArgs
    Annotations map[string]string
    Annotations for Global DNS Provider (map)
    CloudflareConfig GlobalDnsProviderCloudflareConfigArgs
    DnsProvider string
    (Computed) The Global DNS Provider alidns, cloudflare, route53 (string)
    Labels map[string]string
    Labels for Global DNS Provider (map)
    Name string
    The name of the Global DNS Provider (string)
    RootDomain string
    The user ID to assign Global DNS Provider (string)
    Route53Config GlobalDnsProviderRoute53ConfigArgs
    alidnsConfig GlobalDnsProviderAlidnsConfig
    annotations Map<String,String>
    Annotations for Global DNS Provider (map)
    cloudflareConfig GlobalDnsProviderCloudflareConfig
    dnsProvider String
    (Computed) The Global DNS Provider alidns, cloudflare, route53 (string)
    labels Map<String,String>
    Labels for Global DNS Provider (map)
    name String
    The name of the Global DNS Provider (string)
    rootDomain String
    The user ID to assign Global DNS Provider (string)
    route53Config GlobalDnsProviderRoute53Config
    alidnsConfig GlobalDnsProviderAlidnsConfig
    annotations {[key: string]: string}
    Annotations for Global DNS Provider (map)
    cloudflareConfig GlobalDnsProviderCloudflareConfig
    dnsProvider string
    (Computed) The Global DNS Provider alidns, cloudflare, route53 (string)
    labels {[key: string]: string}
    Labels for Global DNS Provider (map)
    name string
    The name of the Global DNS Provider (string)
    rootDomain string
    The user ID to assign Global DNS Provider (string)
    route53Config GlobalDnsProviderRoute53Config
    alidns_config GlobalDnsProviderAlidnsConfigArgs
    annotations Mapping[str, str]
    Annotations for Global DNS Provider (map)
    cloudflare_config GlobalDnsProviderCloudflareConfigArgs
    dns_provider str
    (Computed) The Global DNS Provider alidns, cloudflare, route53 (string)
    labels Mapping[str, str]
    Labels for Global DNS Provider (map)
    name str
    The name of the Global DNS Provider (string)
    root_domain str
    The user ID to assign Global DNS Provider (string)
    route53_config GlobalDnsProviderRoute53ConfigArgs
    alidnsConfig Property Map
    annotations Map<String>
    Annotations for Global DNS Provider (map)
    cloudflareConfig Property Map
    dnsProvider String
    (Computed) The Global DNS Provider alidns, cloudflare, route53 (string)
    labels Map<String>
    Labels for Global DNS Provider (map)
    name String
    The name of the Global DNS Provider (string)
    rootDomain String
    The user ID to assign Global DNS Provider (string)
    route53Config Property Map

    Supporting Types

    GlobalDnsProviderAlidnsConfig, GlobalDnsProviderAlidnsConfigArgs

    AccessKey string
    The AWS Access key (string)
    SecretKey string
    The AWS Secret key (string)
    AccessKey string
    The AWS Access key (string)
    SecretKey string
    The AWS Secret key (string)
    accessKey String
    The AWS Access key (string)
    secretKey String
    The AWS Secret key (string)
    accessKey string
    The AWS Access key (string)
    secretKey string
    The AWS Secret key (string)
    access_key str
    The AWS Access key (string)
    secret_key str
    The AWS Secret key (string)
    accessKey String
    The AWS Access key (string)
    secretKey String
    The AWS Secret key (string)

    GlobalDnsProviderCloudflareConfig, GlobalDnsProviderCloudflareConfigArgs

    ApiEmail string
    The CloudFlare API Email (string)
    ApiKey string
    The CloudFlare API Key (string)
    ProxySetting bool
    CloudFlare Proxy Setting. Default: false (bool)
    ApiEmail string
    The CloudFlare API Email (string)
    ApiKey string
    The CloudFlare API Key (string)
    ProxySetting bool
    CloudFlare Proxy Setting. Default: false (bool)
    apiEmail String
    The CloudFlare API Email (string)
    apiKey String
    The CloudFlare API Key (string)
    proxySetting Boolean
    CloudFlare Proxy Setting. Default: false (bool)
    apiEmail string
    The CloudFlare API Email (string)
    apiKey string
    The CloudFlare API Key (string)
    proxySetting boolean
    CloudFlare Proxy Setting. Default: false (bool)
    api_email str
    The CloudFlare API Email (string)
    api_key str
    The CloudFlare API Key (string)
    proxy_setting bool
    CloudFlare Proxy Setting. Default: false (bool)
    apiEmail String
    The CloudFlare API Email (string)
    apiKey String
    The CloudFlare API Key (string)
    proxySetting Boolean
    CloudFlare Proxy Setting. Default: false (bool)

    GlobalDnsProviderRoute53Config, GlobalDnsProviderRoute53ConfigArgs

    AccessKey string
    The AWS Access key (string)
    SecretKey string
    The AWS Secret key (string)
    CredentialsPath string
    The AWS credentials path. Default: "/.aws" (string)
    Region string
    The AWS Region. Default: "us-west-2" (string)
    RoleArn string
    The AWS Role ARN (string)
    ZoneType string
    The Route53 zone type public, private. Default: "public" (string)
    AccessKey string
    The AWS Access key (string)
    SecretKey string
    The AWS Secret key (string)
    CredentialsPath string
    The AWS credentials path. Default: "/.aws" (string)
    Region string
    The AWS Region. Default: "us-west-2" (string)
    RoleArn string
    The AWS Role ARN (string)
    ZoneType string
    The Route53 zone type public, private. Default: "public" (string)
    accessKey String
    The AWS Access key (string)
    secretKey String
    The AWS Secret key (string)
    credentialsPath String
    The AWS credentials path. Default: "/.aws" (string)
    region String
    The AWS Region. Default: "us-west-2" (string)
    roleArn String
    The AWS Role ARN (string)
    zoneType String
    The Route53 zone type public, private. Default: "public" (string)
    accessKey string
    The AWS Access key (string)
    secretKey string
    The AWS Secret key (string)
    credentialsPath string
    The AWS credentials path. Default: "/.aws" (string)
    region string
    The AWS Region. Default: "us-west-2" (string)
    roleArn string
    The AWS Role ARN (string)
    zoneType string
    The Route53 zone type public, private. Default: "public" (string)
    access_key str
    The AWS Access key (string)
    secret_key str
    The AWS Secret key (string)
    credentials_path str
    The AWS credentials path. Default: "/.aws" (string)
    region str
    The AWS Region. Default: "us-west-2" (string)
    role_arn str
    The AWS Role ARN (string)
    zone_type str
    The Route53 zone type public, private. Default: "public" (string)
    accessKey String
    The AWS Access key (string)
    secretKey String
    The AWS Secret key (string)
    credentialsPath String
    The AWS credentials path. Default: "/.aws" (string)
    region String
    The AWS Region. Default: "us-west-2" (string)
    roleArn String
    The AWS Role ARN (string)
    zoneType String
    The Route53 zone type public, private. Default: "public" (string)

    Import

    Global DNS Providers can be imported using the Rancher Global DNS Provider ID

    $ pulumi import rancher2:index/globalDnsProvider:GlobalDnsProvider foo <global_dns_provider_id>
    

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

    Package Details

    Repository
    Rancher2 pulumi/pulumi-rancher2
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the rancher2 Terraform Provider.
    rancher2 logo
    Rancher 2 v7.1.1 published on Monday, Oct 7, 2024 by Pulumi