1. Packages
  2. Rancher2
  3. API Docs
  4. CloudCredential
Rancher 2 v5.1.1 published on Thursday, Aug 3, 2023 by Pulumi

rancher2.CloudCredential

Explore with Pulumi AI

rancher2 logo
Rancher 2 v5.1.1 published on Thursday, Aug 3, 2023 by Pulumi

    Provides a Rancher v2 Cloud Credential resource. This can be used to create Cloud Credential for Rancher v2.2.x and retrieve their information.

    amazonec2, azure, digitalocean, harvester, linode, openstack and vsphere credentials config are supported for Cloud Credential.

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Rancher2 = Pulumi.Rancher2;
    
    return await Deployment.RunAsync(() => 
    {
        // Create a new rancher2 Cloud Credential
        var foo = new Rancher2.CloudCredential("foo", new()
        {
            Amazonec2CredentialConfig = new Rancher2.Inputs.CloudCredentialAmazonec2CredentialConfigArgs
            {
                AccessKey = "<AWS_ACCESS_KEY>",
                SecretKey = "<AWS_SECRET_KEY>",
            },
            Description = "foo test",
        });
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-rancher2/sdk/v5/go/rancher2"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := rancher2.NewCloudCredential(ctx, "foo", &rancher2.CloudCredentialArgs{
    			Amazonec2CredentialConfig: &rancher2.CloudCredentialAmazonec2CredentialConfigArgs{
    				AccessKey: pulumi.String("<AWS_ACCESS_KEY>"),
    				SecretKey: pulumi.String("<AWS_SECRET_KEY>"),
    			},
    			Description: pulumi.String("foo test"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.rancher2.CloudCredential;
    import com.pulumi.rancher2.CloudCredentialArgs;
    import com.pulumi.rancher2.inputs.CloudCredentialAmazonec2CredentialConfigArgs;
    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 foo = new CloudCredential("foo", CloudCredentialArgs.builder()        
                .amazonec2CredentialConfig(CloudCredentialAmazonec2CredentialConfigArgs.builder()
                    .accessKey("<AWS_ACCESS_KEY>")
                    .secretKey("<AWS_SECRET_KEY>")
                    .build())
                .description("foo test")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_rancher2 as rancher2
    
    # Create a new rancher2 Cloud Credential
    foo = rancher2.CloudCredential("foo",
        amazonec2_credential_config=rancher2.CloudCredentialAmazonec2CredentialConfigArgs(
            access_key="<AWS_ACCESS_KEY>",
            secret_key="<AWS_SECRET_KEY>",
        ),
        description="foo test")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as rancher2 from "@pulumi/rancher2";
    
    // Create a new rancher2 Cloud Credential
    const foo = new rancher2.CloudCredential("foo", {
        amazonec2CredentialConfig: {
            accessKey: "<AWS_ACCESS_KEY>",
            secretKey: "<AWS_SECRET_KEY>",
        },
        description: "foo test",
    });
    
    resources:
      # Create a new rancher2 Cloud Credential
      foo:
        type: rancher2:CloudCredential
        properties:
          amazonec2CredentialConfig:
            accessKey: <AWS_ACCESS_KEY>
            secretKey: <AWS_SECRET_KEY>
          description: foo test
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Rancher2 = Pulumi.Rancher2;
    
    return await Deployment.RunAsync(() => 
    {
        var foo_harvesterClusterV2 = Rancher2.GetClusterV2.Invoke(new()
        {
            Name = "foo-harvester",
        });
    
        // Create a new Cloud Credential for an imported Harvester cluster
        var foo_harvesterCloudCredential = new Rancher2.CloudCredential("foo-harvesterCloudCredential", new()
        {
            HarvesterCredentialConfig = new Rancher2.Inputs.CloudCredentialHarvesterCredentialConfigArgs
            {
                ClusterId = foo_harvesterClusterV2.Apply(foo_harvesterClusterV2 => foo_harvesterClusterV2.Apply(getClusterV2Result => getClusterV2Result.ClusterV1Id)),
                ClusterType = "imported",
                KubeconfigContent = foo_harvesterClusterV2.Apply(foo_harvesterClusterV2 => foo_harvesterClusterV2.Apply(getClusterV2Result => getClusterV2Result.KubeConfig)),
            },
        });
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-rancher2/sdk/v5/go/rancher2"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		foo_harvesterClusterV2, err := rancher2.LookupClusterV2(ctx, &rancher2.LookupClusterV2Args{
    			Name: "foo-harvester",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		_, err = rancher2.NewCloudCredential(ctx, "foo-harvesterCloudCredential", &rancher2.CloudCredentialArgs{
    			HarvesterCredentialConfig: &rancher2.CloudCredentialHarvesterCredentialConfigArgs{
    				ClusterId:         *pulumi.String(foo_harvesterClusterV2.ClusterV1Id),
    				ClusterType:       pulumi.String("imported"),
    				KubeconfigContent: *pulumi.String(foo_harvesterClusterV2.KubeConfig),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.rancher2.Rancher2Functions;
    import com.pulumi.rancher2.inputs.GetClusterV2Args;
    import com.pulumi.rancher2.CloudCredential;
    import com.pulumi.rancher2.CloudCredentialArgs;
    import com.pulumi.rancher2.inputs.CloudCredentialHarvesterCredentialConfigArgs;
    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 foo-harvesterClusterV2 = Rancher2Functions.getClusterV2(GetClusterV2Args.builder()
                .name("foo-harvester")
                .build());
    
            var foo_harvesterCloudCredential = new CloudCredential("foo-harvesterCloudCredential", CloudCredentialArgs.builder()        
                .harvesterCredentialConfig(CloudCredentialHarvesterCredentialConfigArgs.builder()
                    .clusterId(foo_harvesterClusterV2.clusterV1Id())
                    .clusterType("imported")
                    .kubeconfigContent(foo_harvesterClusterV2.kubeConfig())
                    .build())
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_rancher2 as rancher2
    
    foo_harvester_cluster_v2 = rancher2.get_cluster_v2(name="foo-harvester")
    # Create a new Cloud Credential for an imported Harvester cluster
    foo_harvester_cloud_credential = rancher2.CloudCredential("foo-harvesterCloudCredential", harvester_credential_config=rancher2.CloudCredentialHarvesterCredentialConfigArgs(
        cluster_id=foo_harvester_cluster_v2.cluster_v1_id,
        cluster_type="imported",
        kubeconfig_content=foo_harvester_cluster_v2.kube_config,
    ))
    
    import * as pulumi from "@pulumi/pulumi";
    import * as rancher2 from "@pulumi/rancher2";
    
    const foo-harvesterClusterV2 = rancher2.getClusterV2({
        name: "foo-harvester",
    });
    // Create a new Cloud Credential for an imported Harvester cluster
    const foo_harvesterCloudCredential = new rancher2.CloudCredential("foo-harvesterCloudCredential", {harvesterCredentialConfig: {
        clusterId: foo_harvesterClusterV2.then(foo_harvesterClusterV2 => foo_harvesterClusterV2.clusterV1Id),
        clusterType: "imported",
        kubeconfigContent: foo_harvesterClusterV2.then(foo_harvesterClusterV2 => foo_harvesterClusterV2.kubeConfig),
    }});
    
    resources:
      # Create a new Cloud Credential for an imported Harvester cluster
      foo-harvesterCloudCredential:
        type: rancher2:CloudCredential
        properties:
          harvesterCredentialConfig:
            clusterId: ${["foo-harvesterClusterV2"].clusterV1Id}
            clusterType: imported
            kubeconfigContent: ${["foo-harvesterClusterV2"].kubeConfig}
    variables:
      foo-harvesterClusterV2:
        fn::invoke:
          Function: rancher2:getClusterV2
          Arguments:
            name: foo-harvester
    

    Create CloudCredential Resource

    new CloudCredential(name: string, args?: CloudCredentialArgs, opts?: CustomResourceOptions);
    @overload
    def CloudCredential(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        amazonec2_credential_config: Optional[CloudCredentialAmazonec2CredentialConfigArgs] = None,
                        annotations: Optional[Mapping[str, Any]] = None,
                        azure_credential_config: Optional[CloudCredentialAzureCredentialConfigArgs] = None,
                        description: Optional[str] = None,
                        digitalocean_credential_config: Optional[CloudCredentialDigitaloceanCredentialConfigArgs] = None,
                        google_credential_config: Optional[CloudCredentialGoogleCredentialConfigArgs] = None,
                        harvester_credential_config: Optional[CloudCredentialHarvesterCredentialConfigArgs] = None,
                        labels: Optional[Mapping[str, Any]] = None,
                        linode_credential_config: Optional[CloudCredentialLinodeCredentialConfigArgs] = None,
                        name: Optional[str] = None,
                        openstack_credential_config: Optional[CloudCredentialOpenstackCredentialConfigArgs] = None,
                        s3_credential_config: Optional[CloudCredentialS3CredentialConfigArgs] = None,
                        vsphere_credential_config: Optional[CloudCredentialVsphereCredentialConfigArgs] = None)
    @overload
    def CloudCredential(resource_name: str,
                        args: Optional[CloudCredentialArgs] = None,
                        opts: Optional[ResourceOptions] = None)
    func NewCloudCredential(ctx *Context, name string, args *CloudCredentialArgs, opts ...ResourceOption) (*CloudCredential, error)
    public CloudCredential(string name, CloudCredentialArgs? args = null, CustomResourceOptions? opts = null)
    public CloudCredential(String name, CloudCredentialArgs args)
    public CloudCredential(String name, CloudCredentialArgs args, CustomResourceOptions options)
    
    type: rancher2:CloudCredential
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    name string
    The unique name of the resource.
    args CloudCredentialArgs
    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 CloudCredentialArgs
    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 CloudCredentialArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CloudCredentialArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CloudCredentialArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

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

    Amazonec2CredentialConfig CloudCredentialAmazonec2CredentialConfig

    AWS config for the Cloud Credential (list maxitems:1)

    Annotations Dictionary<string, object>

    Annotations for Cloud Credential object (map)

    AzureCredentialConfig CloudCredentialAzureCredentialConfig

    Azure config for the Cloud Credential (list maxitems:1)

    Description string

    Description for the Cloud Credential (string)

    DigitaloceanCredentialConfig CloudCredentialDigitaloceanCredentialConfig

    DigitalOcean config for the Cloud Credential (list maxitems:1)

    GoogleCredentialConfig CloudCredentialGoogleCredentialConfig

    Google config for the Cloud Credential (list maxitems:1)

    HarvesterCredentialConfig CloudCredentialHarvesterCredentialConfig

    Harvester config for the Cloud Credential (list maxitems:1)

    Labels Dictionary<string, object>

    Labels for Cloud Credential object (map)

    LinodeCredentialConfig CloudCredentialLinodeCredentialConfig

    Linode config for the Cloud Credential (list maxitems:1)

    Name string

    The name of the Cloud Credential (string)

    OpenstackCredentialConfig CloudCredentialOpenstackCredentialConfig

    OpenStack config for the Cloud Credential (list maxitems:1)

    S3CredentialConfig CloudCredentialS3CredentialConfig

    S3 config for the Cloud Credential. For Rancher 2.6.0 and above (list maxitems:1)

    VsphereCredentialConfig CloudCredentialVsphereCredentialConfig

    vSphere config for the Cloud Credential (list maxitems:1)

    Amazonec2CredentialConfig CloudCredentialAmazonec2CredentialConfigArgs

    AWS config for the Cloud Credential (list maxitems:1)

    Annotations map[string]interface{}

    Annotations for Cloud Credential object (map)

    AzureCredentialConfig CloudCredentialAzureCredentialConfigArgs

    Azure config for the Cloud Credential (list maxitems:1)

    Description string

    Description for the Cloud Credential (string)

    DigitaloceanCredentialConfig CloudCredentialDigitaloceanCredentialConfigArgs

    DigitalOcean config for the Cloud Credential (list maxitems:1)

    GoogleCredentialConfig CloudCredentialGoogleCredentialConfigArgs

    Google config for the Cloud Credential (list maxitems:1)

    HarvesterCredentialConfig CloudCredentialHarvesterCredentialConfigArgs

    Harvester config for the Cloud Credential (list maxitems:1)

    Labels map[string]interface{}

    Labels for Cloud Credential object (map)

    LinodeCredentialConfig CloudCredentialLinodeCredentialConfigArgs

    Linode config for the Cloud Credential (list maxitems:1)

    Name string

    The name of the Cloud Credential (string)

    OpenstackCredentialConfig CloudCredentialOpenstackCredentialConfigArgs

    OpenStack config for the Cloud Credential (list maxitems:1)

    S3CredentialConfig CloudCredentialS3CredentialConfigArgs

    S3 config for the Cloud Credential. For Rancher 2.6.0 and above (list maxitems:1)

    VsphereCredentialConfig CloudCredentialVsphereCredentialConfigArgs

    vSphere config for the Cloud Credential (list maxitems:1)

    amazonec2CredentialConfig CloudCredentialAmazonec2CredentialConfig

    AWS config for the Cloud Credential (list maxitems:1)

    annotations Map<String,Object>

    Annotations for Cloud Credential object (map)

    azureCredentialConfig CloudCredentialAzureCredentialConfig

    Azure config for the Cloud Credential (list maxitems:1)

    description String

    Description for the Cloud Credential (string)

    digitaloceanCredentialConfig CloudCredentialDigitaloceanCredentialConfig

    DigitalOcean config for the Cloud Credential (list maxitems:1)

    googleCredentialConfig CloudCredentialGoogleCredentialConfig

    Google config for the Cloud Credential (list maxitems:1)

    harvesterCredentialConfig CloudCredentialHarvesterCredentialConfig

    Harvester config for the Cloud Credential (list maxitems:1)

    labels Map<String,Object>

    Labels for Cloud Credential object (map)

    linodeCredentialConfig CloudCredentialLinodeCredentialConfig

    Linode config for the Cloud Credential (list maxitems:1)

    name String

    The name of the Cloud Credential (string)

    openstackCredentialConfig CloudCredentialOpenstackCredentialConfig

    OpenStack config for the Cloud Credential (list maxitems:1)

    s3CredentialConfig CloudCredentialS3CredentialConfig

    S3 config for the Cloud Credential. For Rancher 2.6.0 and above (list maxitems:1)

    vsphereCredentialConfig CloudCredentialVsphereCredentialConfig

    vSphere config for the Cloud Credential (list maxitems:1)

    amazonec2CredentialConfig CloudCredentialAmazonec2CredentialConfig

    AWS config for the Cloud Credential (list maxitems:1)

    annotations {[key: string]: any}

    Annotations for Cloud Credential object (map)

    azureCredentialConfig CloudCredentialAzureCredentialConfig

    Azure config for the Cloud Credential (list maxitems:1)

    description string

    Description for the Cloud Credential (string)

    digitaloceanCredentialConfig CloudCredentialDigitaloceanCredentialConfig

    DigitalOcean config for the Cloud Credential (list maxitems:1)

    googleCredentialConfig CloudCredentialGoogleCredentialConfig

    Google config for the Cloud Credential (list maxitems:1)

    harvesterCredentialConfig CloudCredentialHarvesterCredentialConfig

    Harvester config for the Cloud Credential (list maxitems:1)

    labels {[key: string]: any}

    Labels for Cloud Credential object (map)

    linodeCredentialConfig CloudCredentialLinodeCredentialConfig

    Linode config for the Cloud Credential (list maxitems:1)

    name string

    The name of the Cloud Credential (string)

    openstackCredentialConfig CloudCredentialOpenstackCredentialConfig

    OpenStack config for the Cloud Credential (list maxitems:1)

    s3CredentialConfig CloudCredentialS3CredentialConfig

    S3 config for the Cloud Credential. For Rancher 2.6.0 and above (list maxitems:1)

    vsphereCredentialConfig CloudCredentialVsphereCredentialConfig

    vSphere config for the Cloud Credential (list maxitems:1)

    amazonec2_credential_config CloudCredentialAmazonec2CredentialConfigArgs

    AWS config for the Cloud Credential (list maxitems:1)

    annotations Mapping[str, Any]

    Annotations for Cloud Credential object (map)

    azure_credential_config CloudCredentialAzureCredentialConfigArgs

    Azure config for the Cloud Credential (list maxitems:1)

    description str

    Description for the Cloud Credential (string)

    digitalocean_credential_config CloudCredentialDigitaloceanCredentialConfigArgs

    DigitalOcean config for the Cloud Credential (list maxitems:1)

    google_credential_config CloudCredentialGoogleCredentialConfigArgs

    Google config for the Cloud Credential (list maxitems:1)

    harvester_credential_config CloudCredentialHarvesterCredentialConfigArgs

    Harvester config for the Cloud Credential (list maxitems:1)

    labels Mapping[str, Any]

    Labels for Cloud Credential object (map)

    linode_credential_config CloudCredentialLinodeCredentialConfigArgs

    Linode config for the Cloud Credential (list maxitems:1)

    name str

    The name of the Cloud Credential (string)

    openstack_credential_config CloudCredentialOpenstackCredentialConfigArgs

    OpenStack config for the Cloud Credential (list maxitems:1)

    s3_credential_config CloudCredentialS3CredentialConfigArgs

    S3 config for the Cloud Credential. For Rancher 2.6.0 and above (list maxitems:1)

    vsphere_credential_config CloudCredentialVsphereCredentialConfigArgs

    vSphere config for the Cloud Credential (list maxitems:1)

    amazonec2CredentialConfig Property Map

    AWS config for the Cloud Credential (list maxitems:1)

    annotations Map<Any>

    Annotations for Cloud Credential object (map)

    azureCredentialConfig Property Map

    Azure config for the Cloud Credential (list maxitems:1)

    description String

    Description for the Cloud Credential (string)

    digitaloceanCredentialConfig Property Map

    DigitalOcean config for the Cloud Credential (list maxitems:1)

    googleCredentialConfig Property Map

    Google config for the Cloud Credential (list maxitems:1)

    harvesterCredentialConfig Property Map

    Harvester config for the Cloud Credential (list maxitems:1)

    labels Map<Any>

    Labels for Cloud Credential object (map)

    linodeCredentialConfig Property Map

    Linode config for the Cloud Credential (list maxitems:1)

    name String

    The name of the Cloud Credential (string)

    openstackCredentialConfig Property Map

    OpenStack config for the Cloud Credential (list maxitems:1)

    s3CredentialConfig Property Map

    S3 config for the Cloud Credential. For Rancher 2.6.0 and above (list maxitems:1)

    vsphereCredentialConfig Property Map

    vSphere config for the Cloud Credential (list maxitems:1)

    Outputs

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

    Driver string

    (Computed) The driver of the Cloud Credential (string)

    Id string

    The provider-assigned unique ID for this managed resource.

    Driver string

    (Computed) The driver of the Cloud Credential (string)

    Id string

    The provider-assigned unique ID for this managed resource.

    driver String

    (Computed) The driver of the Cloud Credential (string)

    id String

    The provider-assigned unique ID for this managed resource.

    driver string

    (Computed) The driver of the Cloud Credential (string)

    id string

    The provider-assigned unique ID for this managed resource.

    driver str

    (Computed) The driver of the Cloud Credential (string)

    id str

    The provider-assigned unique ID for this managed resource.

    driver String

    (Computed) The driver of the Cloud Credential (string)

    id String

    The provider-assigned unique ID for this managed resource.

    Look up Existing CloudCredential Resource

    Get an existing CloudCredential 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?: CloudCredentialState, opts?: CustomResourceOptions): CloudCredential
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            amazonec2_credential_config: Optional[CloudCredentialAmazonec2CredentialConfigArgs] = None,
            annotations: Optional[Mapping[str, Any]] = None,
            azure_credential_config: Optional[CloudCredentialAzureCredentialConfigArgs] = None,
            description: Optional[str] = None,
            digitalocean_credential_config: Optional[CloudCredentialDigitaloceanCredentialConfigArgs] = None,
            driver: Optional[str] = None,
            google_credential_config: Optional[CloudCredentialGoogleCredentialConfigArgs] = None,
            harvester_credential_config: Optional[CloudCredentialHarvesterCredentialConfigArgs] = None,
            labels: Optional[Mapping[str, Any]] = None,
            linode_credential_config: Optional[CloudCredentialLinodeCredentialConfigArgs] = None,
            name: Optional[str] = None,
            openstack_credential_config: Optional[CloudCredentialOpenstackCredentialConfigArgs] = None,
            s3_credential_config: Optional[CloudCredentialS3CredentialConfigArgs] = None,
            vsphere_credential_config: Optional[CloudCredentialVsphereCredentialConfigArgs] = None) -> CloudCredential
    func GetCloudCredential(ctx *Context, name string, id IDInput, state *CloudCredentialState, opts ...ResourceOption) (*CloudCredential, error)
    public static CloudCredential Get(string name, Input<string> id, CloudCredentialState? state, CustomResourceOptions? opts = null)
    public static CloudCredential get(String name, Output<String> id, CloudCredentialState 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:
    Amazonec2CredentialConfig CloudCredentialAmazonec2CredentialConfig

    AWS config for the Cloud Credential (list maxitems:1)

    Annotations Dictionary<string, object>

    Annotations for Cloud Credential object (map)

    AzureCredentialConfig CloudCredentialAzureCredentialConfig

    Azure config for the Cloud Credential (list maxitems:1)

    Description string

    Description for the Cloud Credential (string)

    DigitaloceanCredentialConfig CloudCredentialDigitaloceanCredentialConfig

    DigitalOcean config for the Cloud Credential (list maxitems:1)

    Driver string

    (Computed) The driver of the Cloud Credential (string)

    GoogleCredentialConfig CloudCredentialGoogleCredentialConfig

    Google config for the Cloud Credential (list maxitems:1)

    HarvesterCredentialConfig CloudCredentialHarvesterCredentialConfig

    Harvester config for the Cloud Credential (list maxitems:1)

    Labels Dictionary<string, object>

    Labels for Cloud Credential object (map)

    LinodeCredentialConfig CloudCredentialLinodeCredentialConfig

    Linode config for the Cloud Credential (list maxitems:1)

    Name string

    The name of the Cloud Credential (string)

    OpenstackCredentialConfig CloudCredentialOpenstackCredentialConfig

    OpenStack config for the Cloud Credential (list maxitems:1)

    S3CredentialConfig CloudCredentialS3CredentialConfig

    S3 config for the Cloud Credential. For Rancher 2.6.0 and above (list maxitems:1)

    VsphereCredentialConfig CloudCredentialVsphereCredentialConfig

    vSphere config for the Cloud Credential (list maxitems:1)

    Amazonec2CredentialConfig CloudCredentialAmazonec2CredentialConfigArgs

    AWS config for the Cloud Credential (list maxitems:1)

    Annotations map[string]interface{}

    Annotations for Cloud Credential object (map)

    AzureCredentialConfig CloudCredentialAzureCredentialConfigArgs

    Azure config for the Cloud Credential (list maxitems:1)

    Description string

    Description for the Cloud Credential (string)

    DigitaloceanCredentialConfig CloudCredentialDigitaloceanCredentialConfigArgs

    DigitalOcean config for the Cloud Credential (list maxitems:1)

    Driver string

    (Computed) The driver of the Cloud Credential (string)

    GoogleCredentialConfig CloudCredentialGoogleCredentialConfigArgs

    Google config for the Cloud Credential (list maxitems:1)

    HarvesterCredentialConfig CloudCredentialHarvesterCredentialConfigArgs

    Harvester config for the Cloud Credential (list maxitems:1)

    Labels map[string]interface{}

    Labels for Cloud Credential object (map)

    LinodeCredentialConfig CloudCredentialLinodeCredentialConfigArgs

    Linode config for the Cloud Credential (list maxitems:1)

    Name string

    The name of the Cloud Credential (string)

    OpenstackCredentialConfig CloudCredentialOpenstackCredentialConfigArgs

    OpenStack config for the Cloud Credential (list maxitems:1)

    S3CredentialConfig CloudCredentialS3CredentialConfigArgs

    S3 config for the Cloud Credential. For Rancher 2.6.0 and above (list maxitems:1)

    VsphereCredentialConfig CloudCredentialVsphereCredentialConfigArgs

    vSphere config for the Cloud Credential (list maxitems:1)

    amazonec2CredentialConfig CloudCredentialAmazonec2CredentialConfig

    AWS config for the Cloud Credential (list maxitems:1)

    annotations Map<String,Object>

    Annotations for Cloud Credential object (map)

    azureCredentialConfig CloudCredentialAzureCredentialConfig

    Azure config for the Cloud Credential (list maxitems:1)

    description String

    Description for the Cloud Credential (string)

    digitaloceanCredentialConfig CloudCredentialDigitaloceanCredentialConfig

    DigitalOcean config for the Cloud Credential (list maxitems:1)

    driver String

    (Computed) The driver of the Cloud Credential (string)

    googleCredentialConfig CloudCredentialGoogleCredentialConfig

    Google config for the Cloud Credential (list maxitems:1)

    harvesterCredentialConfig CloudCredentialHarvesterCredentialConfig

    Harvester config for the Cloud Credential (list maxitems:1)

    labels Map<String,Object>

    Labels for Cloud Credential object (map)

    linodeCredentialConfig CloudCredentialLinodeCredentialConfig

    Linode config for the Cloud Credential (list maxitems:1)

    name String

    The name of the Cloud Credential (string)

    openstackCredentialConfig CloudCredentialOpenstackCredentialConfig

    OpenStack config for the Cloud Credential (list maxitems:1)

    s3CredentialConfig CloudCredentialS3CredentialConfig

    S3 config for the Cloud Credential. For Rancher 2.6.0 and above (list maxitems:1)

    vsphereCredentialConfig CloudCredentialVsphereCredentialConfig

    vSphere config for the Cloud Credential (list maxitems:1)

    amazonec2CredentialConfig CloudCredentialAmazonec2CredentialConfig

    AWS config for the Cloud Credential (list maxitems:1)

    annotations {[key: string]: any}

    Annotations for Cloud Credential object (map)

    azureCredentialConfig CloudCredentialAzureCredentialConfig

    Azure config for the Cloud Credential (list maxitems:1)

    description string

    Description for the Cloud Credential (string)

    digitaloceanCredentialConfig CloudCredentialDigitaloceanCredentialConfig

    DigitalOcean config for the Cloud Credential (list maxitems:1)

    driver string

    (Computed) The driver of the Cloud Credential (string)

    googleCredentialConfig CloudCredentialGoogleCredentialConfig

    Google config for the Cloud Credential (list maxitems:1)

    harvesterCredentialConfig CloudCredentialHarvesterCredentialConfig

    Harvester config for the Cloud Credential (list maxitems:1)

    labels {[key: string]: any}

    Labels for Cloud Credential object (map)

    linodeCredentialConfig CloudCredentialLinodeCredentialConfig

    Linode config for the Cloud Credential (list maxitems:1)

    name string

    The name of the Cloud Credential (string)

    openstackCredentialConfig CloudCredentialOpenstackCredentialConfig

    OpenStack config for the Cloud Credential (list maxitems:1)

    s3CredentialConfig CloudCredentialS3CredentialConfig

    S3 config for the Cloud Credential. For Rancher 2.6.0 and above (list maxitems:1)

    vsphereCredentialConfig CloudCredentialVsphereCredentialConfig

    vSphere config for the Cloud Credential (list maxitems:1)

    amazonec2_credential_config CloudCredentialAmazonec2CredentialConfigArgs

    AWS config for the Cloud Credential (list maxitems:1)

    annotations Mapping[str, Any]

    Annotations for Cloud Credential object (map)

    azure_credential_config CloudCredentialAzureCredentialConfigArgs

    Azure config for the Cloud Credential (list maxitems:1)

    description str

    Description for the Cloud Credential (string)

    digitalocean_credential_config CloudCredentialDigitaloceanCredentialConfigArgs

    DigitalOcean config for the Cloud Credential (list maxitems:1)

    driver str

    (Computed) The driver of the Cloud Credential (string)

    google_credential_config CloudCredentialGoogleCredentialConfigArgs

    Google config for the Cloud Credential (list maxitems:1)

    harvester_credential_config CloudCredentialHarvesterCredentialConfigArgs

    Harvester config for the Cloud Credential (list maxitems:1)

    labels Mapping[str, Any]

    Labels for Cloud Credential object (map)

    linode_credential_config CloudCredentialLinodeCredentialConfigArgs

    Linode config for the Cloud Credential (list maxitems:1)

    name str

    The name of the Cloud Credential (string)

    openstack_credential_config CloudCredentialOpenstackCredentialConfigArgs

    OpenStack config for the Cloud Credential (list maxitems:1)

    s3_credential_config CloudCredentialS3CredentialConfigArgs

    S3 config for the Cloud Credential. For Rancher 2.6.0 and above (list maxitems:1)

    vsphere_credential_config CloudCredentialVsphereCredentialConfigArgs

    vSphere config for the Cloud Credential (list maxitems:1)

    amazonec2CredentialConfig Property Map

    AWS config for the Cloud Credential (list maxitems:1)

    annotations Map<Any>

    Annotations for Cloud Credential object (map)

    azureCredentialConfig Property Map

    Azure config for the Cloud Credential (list maxitems:1)

    description String

    Description for the Cloud Credential (string)

    digitaloceanCredentialConfig Property Map

    DigitalOcean config for the Cloud Credential (list maxitems:1)

    driver String

    (Computed) The driver of the Cloud Credential (string)

    googleCredentialConfig Property Map

    Google config for the Cloud Credential (list maxitems:1)

    harvesterCredentialConfig Property Map

    Harvester config for the Cloud Credential (list maxitems:1)

    labels Map<Any>

    Labels for Cloud Credential object (map)

    linodeCredentialConfig Property Map

    Linode config for the Cloud Credential (list maxitems:1)

    name String

    The name of the Cloud Credential (string)

    openstackCredentialConfig Property Map

    OpenStack config for the Cloud Credential (list maxitems:1)

    s3CredentialConfig Property Map

    S3 config for the Cloud Credential. For Rancher 2.6.0 and above (list maxitems:1)

    vsphereCredentialConfig Property Map

    vSphere config for the Cloud Credential (list maxitems:1)

    Supporting Types

    CloudCredentialAmazonec2CredentialConfig, CloudCredentialAmazonec2CredentialConfigArgs

    AccessKey string

    AWS access key (string)

    SecretKey string

    AWS secret key (string)

    DefaultRegion string

    AWS default region (string)

    AccessKey string

    AWS access key (string)

    SecretKey string

    AWS secret key (string)

    DefaultRegion string

    AWS default region (string)

    accessKey String

    AWS access key (string)

    secretKey String

    AWS secret key (string)

    defaultRegion String

    AWS default region (string)

    accessKey string

    AWS access key (string)

    secretKey string

    AWS secret key (string)

    defaultRegion string

    AWS default region (string)

    access_key str

    AWS access key (string)

    secret_key str

    AWS secret key (string)

    default_region str

    AWS default region (string)

    accessKey String

    AWS access key (string)

    secretKey String

    AWS secret key (string)

    defaultRegion String

    AWS default region (string)

    CloudCredentialAzureCredentialConfig, CloudCredentialAzureCredentialConfigArgs

    ClientId string

    Azure Service Principal Account ID (string)

    ClientSecret string

    Azure Service Principal Account password (string)

    SubscriptionId string

    Azure Subscription ID (string)

    Environment string

    Azure environment (e.g. AzurePublicCloud, AzureChinaCloud) (string)

    TenantId string

    Azure Tenant ID (string)

    ClientId string

    Azure Service Principal Account ID (string)

    ClientSecret string

    Azure Service Principal Account password (string)

    SubscriptionId string

    Azure Subscription ID (string)

    Environment string

    Azure environment (e.g. AzurePublicCloud, AzureChinaCloud) (string)

    TenantId string

    Azure Tenant ID (string)

    clientId String

    Azure Service Principal Account ID (string)

    clientSecret String

    Azure Service Principal Account password (string)

    subscriptionId String

    Azure Subscription ID (string)

    environment String

    Azure environment (e.g. AzurePublicCloud, AzureChinaCloud) (string)

    tenantId String

    Azure Tenant ID (string)

    clientId string

    Azure Service Principal Account ID (string)

    clientSecret string

    Azure Service Principal Account password (string)

    subscriptionId string

    Azure Subscription ID (string)

    environment string

    Azure environment (e.g. AzurePublicCloud, AzureChinaCloud) (string)

    tenantId string

    Azure Tenant ID (string)

    client_id str

    Azure Service Principal Account ID (string)

    client_secret str

    Azure Service Principal Account password (string)

    subscription_id str

    Azure Subscription ID (string)

    environment str

    Azure environment (e.g. AzurePublicCloud, AzureChinaCloud) (string)

    tenant_id str

    Azure Tenant ID (string)

    clientId String

    Azure Service Principal Account ID (string)

    clientSecret String

    Azure Service Principal Account password (string)

    subscriptionId String

    Azure Subscription ID (string)

    environment String

    Azure environment (e.g. AzurePublicCloud, AzureChinaCloud) (string)

    tenantId String

    Azure Tenant ID (string)

    CloudCredentialDigitaloceanCredentialConfig, CloudCredentialDigitaloceanCredentialConfigArgs

    AccessToken string

    DigitalOcean access token (string)

    AccessToken string

    DigitalOcean access token (string)

    accessToken String

    DigitalOcean access token (string)

    accessToken string

    DigitalOcean access token (string)

    access_token str

    DigitalOcean access token (string)

    accessToken String

    DigitalOcean access token (string)

    CloudCredentialGoogleCredentialConfig, CloudCredentialGoogleCredentialConfigArgs

    AuthEncodedJson string

    Google auth encoded json (string)

    AuthEncodedJson string

    Google auth encoded json (string)

    authEncodedJson String

    Google auth encoded json (string)

    authEncodedJson string

    Google auth encoded json (string)

    auth_encoded_json str

    Google auth encoded json (string)

    authEncodedJson String

    Google auth encoded json (string)

    CloudCredentialHarvesterCredentialConfig, CloudCredentialHarvesterCredentialConfigArgs

    ClusterType string

    Harvester Cluster Type. Supported values : "imported" | "external" (string)

    KubeconfigContent string

    Harvester Cluster KubeConfig Content (string)

    ClusterId string

    Imported Harvester Cluster ID (string)

    ClusterType string

    Harvester Cluster Type. Supported values : "imported" | "external" (string)

    KubeconfigContent string

    Harvester Cluster KubeConfig Content (string)

    ClusterId string

    Imported Harvester Cluster ID (string)

    clusterType String

    Harvester Cluster Type. Supported values : "imported" | "external" (string)

    kubeconfigContent String

    Harvester Cluster KubeConfig Content (string)

    clusterId String

    Imported Harvester Cluster ID (string)

    clusterType string

    Harvester Cluster Type. Supported values : "imported" | "external" (string)

    kubeconfigContent string

    Harvester Cluster KubeConfig Content (string)

    clusterId string

    Imported Harvester Cluster ID (string)

    cluster_type str

    Harvester Cluster Type. Supported values : "imported" | "external" (string)

    kubeconfig_content str

    Harvester Cluster KubeConfig Content (string)

    cluster_id str

    Imported Harvester Cluster ID (string)

    clusterType String

    Harvester Cluster Type. Supported values : "imported" | "external" (string)

    kubeconfigContent String

    Harvester Cluster KubeConfig Content (string)

    clusterId String

    Imported Harvester Cluster ID (string)

    CloudCredentialLinodeCredentialConfig, CloudCredentialLinodeCredentialConfigArgs

    Token string

    Linode API token (string)

    Token string

    Linode API token (string)

    token String

    Linode API token (string)

    token string

    Linode API token (string)

    token str

    Linode API token (string)

    token String

    Linode API token (string)

    CloudCredentialOpenstackCredentialConfig, CloudCredentialOpenstackCredentialConfigArgs

    Password string

    OpenStack password (string)

    Password string

    OpenStack password (string)

    password String

    OpenStack password (string)

    password string

    OpenStack password (string)

    password str

    OpenStack password (string)

    password String

    OpenStack password (string)

    CloudCredentialS3CredentialConfig, CloudCredentialS3CredentialConfigArgs

    AccessKey string

    AWS access key (string)

    SecretKey string

    AWS secret key (string)

    DefaultBucket string

    AWS default bucket (string)

    DefaultEndpoint string

    AWS default endpoint (string)

    DefaultEndpointCa string

    AWS default endpoint CA (string)

    DefaultFolder string

    AWS default folder (string)

    DefaultRegion string

    AWS default region (string)

    DefaultSkipSslVerify bool

    AWS default skip ssl verify. Default: false (bool)

    AccessKey string

    AWS access key (string)

    SecretKey string

    AWS secret key (string)

    DefaultBucket string

    AWS default bucket (string)

    DefaultEndpoint string

    AWS default endpoint (string)

    DefaultEndpointCa string

    AWS default endpoint CA (string)

    DefaultFolder string

    AWS default folder (string)

    DefaultRegion string

    AWS default region (string)

    DefaultSkipSslVerify bool

    AWS default skip ssl verify. Default: false (bool)

    accessKey String

    AWS access key (string)

    secretKey String

    AWS secret key (string)

    defaultBucket String

    AWS default bucket (string)

    defaultEndpoint String

    AWS default endpoint (string)

    defaultEndpointCa String

    AWS default endpoint CA (string)

    defaultFolder String

    AWS default folder (string)

    defaultRegion String

    AWS default region (string)

    defaultSkipSslVerify Boolean

    AWS default skip ssl verify. Default: false (bool)

    accessKey string

    AWS access key (string)

    secretKey string

    AWS secret key (string)

    defaultBucket string

    AWS default bucket (string)

    defaultEndpoint string

    AWS default endpoint (string)

    defaultEndpointCa string

    AWS default endpoint CA (string)

    defaultFolder string

    AWS default folder (string)

    defaultRegion string

    AWS default region (string)

    defaultSkipSslVerify boolean

    AWS default skip ssl verify. Default: false (bool)

    access_key str

    AWS access key (string)

    secret_key str

    AWS secret key (string)

    default_bucket str

    AWS default bucket (string)

    default_endpoint str

    AWS default endpoint (string)

    default_endpoint_ca str

    AWS default endpoint CA (string)

    default_folder str

    AWS default folder (string)

    default_region str

    AWS default region (string)

    default_skip_ssl_verify bool

    AWS default skip ssl verify. Default: false (bool)

    accessKey String

    AWS access key (string)

    secretKey String

    AWS secret key (string)

    defaultBucket String

    AWS default bucket (string)

    defaultEndpoint String

    AWS default endpoint (string)

    defaultEndpointCa String

    AWS default endpoint CA (string)

    defaultFolder String

    AWS default folder (string)

    defaultRegion String

    AWS default region (string)

    defaultSkipSslVerify Boolean

    AWS default skip ssl verify. Default: false (bool)

    CloudCredentialVsphereCredentialConfig, CloudCredentialVsphereCredentialConfigArgs

    Password string

    OpenStack password (string)

    Username string

    vSphere username (string)

    Vcenter string

    vSphere IP/hostname for vCenter (string)

    VcenterPort string

    vSphere Port for vCenter. Default 443 (string)

    Password string

    OpenStack password (string)

    Username string

    vSphere username (string)

    Vcenter string

    vSphere IP/hostname for vCenter (string)

    VcenterPort string

    vSphere Port for vCenter. Default 443 (string)

    password String

    OpenStack password (string)

    username String

    vSphere username (string)

    vcenter String

    vSphere IP/hostname for vCenter (string)

    vcenterPort String

    vSphere Port for vCenter. Default 443 (string)

    password string

    OpenStack password (string)

    username string

    vSphere username (string)

    vcenter string

    vSphere IP/hostname for vCenter (string)

    vcenterPort string

    vSphere Port for vCenter. Default 443 (string)

    password str

    OpenStack password (string)

    username str

    vSphere username (string)

    vcenter str

    vSphere IP/hostname for vCenter (string)

    vcenter_port str

    vSphere Port for vCenter. Default 443 (string)

    password String

    OpenStack password (string)

    username String

    vSphere username (string)

    vcenter String

    vSphere IP/hostname for vCenter (string)

    vcenterPort String

    vSphere Port for vCenter. Default 443 (string)

    Import

    Cloud Credential can be imported using the Cloud Credential ID and the Driver name. bash

     $ pulumi import rancher2:index/cloudCredential:CloudCredential foo &lt;CLOUD_CREDENTIAL_ID&gt;.&lt;DRIVER&gt;
    

    The following drivers are supported* amazonec2 * azure * digitalocean * googlekubernetesengine * linode * openstack * s3 * vmwarevsphere

    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 v5.1.1 published on Thursday, Aug 3, 2023 by Pulumi