1. Docs
  2. Reference
  3. API
  4. Rancher 2
  5. CloudCredential

CloudCredential

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, linode, openstack and vsphere credentials config are supported for Cloud Credential.

Example Usage

using Pulumi;
using Rancher2 = Pulumi.Rancher2;

class MyStack : Stack
{
    public MyStack()
    {
        // Create a new rancher2 Cloud Credential
        var foo = new Rancher2.CloudCredential("foo", new Rancher2.CloudCredentialArgs
        {
            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/v3/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
	})
}

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",
});

Create a 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,
                    labels: Optional[Mapping[str, Any]] = None,
                    linode_credential_config: Optional[CloudCredentialLinodeCredentialConfigArgs] = None,
                    name: Optional[str] = None,
                    openstack_credential_config: Optional[CloudCredentialOpenstackCredentialConfigArgs] = 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)
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.

CloudCredential Resource Properties

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

Inputs

The CloudCredential resource accepts the following input properties:

Amazonec2CredentialConfig CloudCredentialAmazonec2CredentialConfigArgs
AWS config for the Cloud Credential (list maxitems:1)
Annotations Dictionary<string, object>
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)
Labels Dictionary<string, object>
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)
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]interface{}
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)
Labels map[string]interface{}
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)
VsphereCredentialConfig CloudCredentialVsphereCredentialConfig
vSphere config for the Cloud Credential (list maxitems:1)
amazonec2CredentialConfig CloudCredentialAmazonec2CredentialConfigArgs
AWS config for the Cloud Credential (list maxitems:1)
annotations {[key: string]: any}
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)
labels {[key: string]: any}
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)
vsphereCredentialConfig CloudCredentialVsphereCredentialConfigArgs
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)
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)
vsphere_credential_config CloudCredentialVsphereCredentialConfigArgs
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 str
(Computed) The driver of the Cloud Credential (string)
id str
The provider-assigned unique ID for this managed resource.

Look up an 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,
        labels: Optional[Mapping[str, Any]] = None,
        linode_credential_config: Optional[CloudCredentialLinodeCredentialConfigArgs] = None,
        name: Optional[str] = None,
        openstack_credential_config: Optional[CloudCredentialOpenstackCredentialConfigArgs] = 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)
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.

The following state arguments are supported:

Amazonec2CredentialConfig CloudCredentialAmazonec2CredentialConfigArgs
AWS config for the Cloud Credential (list maxitems:1)
Annotations Dictionary<string, object>
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)
Labels Dictionary<string, object>
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)
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]interface{}
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)
Labels map[string]interface{}
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)
VsphereCredentialConfig CloudCredentialVsphereCredentialConfig
vSphere config for the Cloud Credential (list maxitems:1)
amazonec2CredentialConfig CloudCredentialAmazonec2CredentialConfigArgs
AWS config for the Cloud Credential (list maxitems:1)
annotations {[key: string]: any}
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)
labels {[key: string]: any}
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)
vsphereCredentialConfig CloudCredentialVsphereCredentialConfigArgs
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)
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)
vsphere_credential_config CloudCredentialVsphereCredentialConfigArgs
vSphere config for the Cloud Credential (list maxitems:1)

Supporting Types

CloudCredentialAmazonec2CredentialConfig

AccessKey string
AWS access key (string)
SecretKey string
AWS secret key (string)
AccessKey string
AWS access key (string)
SecretKey string
AWS secret key (string)
accessKey string
AWS access key (string)
secretKey string
AWS secret key (string)
access_key str
AWS access key (string)
secret_key str
AWS secret key (string)

CloudCredentialAzureCredentialConfig

ClientId string
Azure Service Principal Account ID (string)
ClientSecret string
Azure Service Principal Account password (string)
SubscriptionId string
Azure Subscription ID (string)
ClientId string
Azure Service Principal Account ID (string)
ClientSecret string
Azure Service Principal Account password (string)
SubscriptionId string
Azure Subscription ID (string)
clientId string
Azure Service Principal Account ID (string)
clientSecret string
Azure Service Principal Account password (string)
subscriptionId string
Azure Subscription 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)

CloudCredentialDigitaloceanCredentialConfig

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)

CloudCredentialLinodeCredentialConfig

Token string
Linode API token (string)
Token string
Linode API token (string)
token string
Linode API token (string)
token str
Linode API token (string)

CloudCredentialOpenstackCredentialConfig

Password string
vSphere password (string)
Password string
vSphere password (string)
password string
vSphere password (string)
password str
vSphere password (string)

CloudCredentialVsphereCredentialConfig

Password string
vSphere 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
vSphere 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
vSphere 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
vSphere 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)

Package Details

Repository
https://github.com/pulumi/pulumi-rancher2
License
Apache-2.0
Notes
This Pulumi package is based on the rancher2 Terraform Provider.
Register Now For PulumiUP