Class AuthConfigPing

Provides a Rancher v2 Auth Config Ping resource. This can be used to configure and enable Auth Config Ping for Rancher v2 RKE clusters and retrieve their information.

In addition to the built-in local auth, only one external auth config provider can be enabled at a time.

Example Usage

using Pulumi;
using Rancher2 = Pulumi.Rancher2;

class MyStack : Stack
{
public MyStack()
{
    // Create a new rancher2 Auth Config Ping
    var ping = new Rancher2.AuthConfigPing("ping", new Rancher2.AuthConfigPingArgs
    {
        DisplayNameField = "<DISPLAY_NAME_FIELD>",
        GroupsField = "<GROUPS_FIELD>",
        IdpMetadataContent = "<IDP_METADATA_CONTENT>",
        RancherApiHost = "https://<RANCHER_API_HOST>",
        SpCert = "<SP_CERT>",
        SpKey = "<SP_KEY>",
        UidField = "<UID_FIELD>",
        UserNameField = "<USER_NAME_FIELD>",
    });
}

}

Inheritance

System.Object

Resource

CustomResource

AuthConfigPing

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Rancher2

Assembly: Pulumi.Rancher2.dll

Syntax

public class AuthConfigPing : CustomResource

Constructors

AuthConfigPing(String, AuthConfigPingArgs, CustomResourceOptions)

Create a AuthConfigPing resource with the given unique name, arguments, and options.

Declaration

public AuthConfigPing(string name, AuthConfigPingArgs args, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
AuthConfigPingArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

AccessMode

Access mode for auth. required, restricted, unrestricted are supported. Default unrestricted (string)

Declaration

public Output<string> AccessMode { get; }

Property Value

Type	Description
Output<System.String>

AllowedPrincipalIds

Allowed principal ids for auth. Required if access_mode is required or restricted. Ex: ping_user://<USER_ID> ping_group://<GROUP_ID> (list)

Declaration

public Output<ImmutableArray<string>> AllowedPrincipalIds { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>

Annotations

Annotations of the resource (map)

Declaration

public Output<ImmutableDictionary<string, object>> Annotations { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableDictionary<System.String, System.Object>>

DisplayNameField

Ping display name field (string)

Declaration

public Output<string> DisplayNameField { get; }

Property Value

Type	Description
Output<System.String>

Enabled

Enable auth config provider. Default true (bool)

Declaration

public Output<bool?> Enabled { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

GroupsField

Ping group field (string)

Declaration

public Output<string> GroupsField { get; }

Property Value

Type	Description
Output<System.String>

IdpMetadataContent

Ping IDP metadata content (string)

Declaration

public Output<string> IdpMetadataContent { get; }

Property Value

Type	Description
Output<System.String>

Labels

Labels of the resource (map)

Declaration

public Output<ImmutableDictionary<string, object>> Labels { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableDictionary<System.String, System.Object>>

Name

(Computed) The name of the resource (string)

Declaration

public Output<string> Name { get; }

Property Value

Type	Description
Output<System.String>

RancherApiHost

Rancher url. Schema needs to be specified, https://<RANCHER_API_HOST> (string)

Declaration

public Output<string> RancherApiHost { get; }

Property Value

Type	Description
Output<System.String>

SpCert

Ping SP cert (string)

Declaration

public Output<string> SpCert { get; }

Property Value

Type	Description
Output<System.String>

SpKey

Ping SP key (string)

Declaration

public Output<string> SpKey { get; }

Property Value

Type	Description
Output<System.String>

Type

(Computed) The type of the resource (string)

Declaration

public Output<string> Type { get; }

Property Value

Type	Description
Output<System.String>

UidField

Ping UID field (string)

Declaration

public Output<string> UidField { get; }

Property Value

Type	Description
Output<System.String>

UserNameField

Ping user name field (string)

Declaration

public Output<string> UserNameField { get; }

Property Value

Type	Description
Output<System.String>

Methods

Get(String, Input<String>, AuthConfigPingState, CustomResourceOptions)

Get an existing AuthConfigPing resource's state with the given name, ID, and optional extra properties used to qualify the lookup.

Declaration

public static AuthConfigPing Get(string name, Input<string> id, AuthConfigPingState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
AuthConfigPingState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
AuthConfigPing