Show / Hide Table of Contents

Class AuthBackendRoleSecretID

Manages an AppRole auth backend SecretID in a Vault server. See the Vault documentation for more information.

Example Usage

using Pulumi;
using Vault = Pulumi.Vault;

class MyStack : Stack
{
public MyStack()
{
    var approle = new Vault.AuthBackend("approle", new Vault.AuthBackendArgs
    {
        Type = "approle",
    });
    var example = new Vault.AppRole.AuthBackendRole("example", new Vault.AppRole.AuthBackendRoleArgs
    {
        Backend = approle.Path,
        Policies = 
        {
            "default",
            "dev",
            "prod",
        },
        RoleName = "test-role",
    });
    var id = new Vault.AppRole.AuthBackendRoleSecretID("id", new Vault.AppRole.AuthBackendRoleSecretIDArgs
    {
        Backend = approle.Path,
        Metadata = @"{
""hello"": ""world""
}

",
        RoleName = example.RoleName,
    });
}

}
Inheritance
System.Object
Resource
CustomResource
AuthBackendRoleSecretID
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.Vault.AppRole
Assembly: Pulumi.Vault.dll
Syntax
public class AuthBackendRoleSecretID : CustomResource

Constructors

View Source

AuthBackendRoleSecretID(String, AuthBackendRoleSecretIDArgs, CustomResourceOptions)

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

Declaration
public AuthBackendRoleSecretID(string name, AuthBackendRoleSecretIDArgs args, CustomResourceOptions options = null)
Parameters
Type Name Description
System.String name

The unique name of the resource

AuthBackendRoleSecretIDArgs args

The arguments used to populate this resource's properties

CustomResourceOptions options

A bag of options that control this resource's behavior

Properties

View Source

Accessor

The unique ID for this SecretID that can be safely logged.

Declaration
public Output<string> Accessor { get; }
Property Value
Type Description
Output<System.String>
View Source

Backend

Unique name of the auth backend to configure.

Declaration
public Output<string> Backend { get; }
Property Value
Type Description
Output<System.String>
View Source

CidrLists

If set, specifies blocks of IP addresses which can perform the login operation using this SecretID.

Declaration
public Output<ImmutableArray<string>> CidrLists { get; }
Property Value
Type Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>
View Source

Metadata

A JSON-encoded string containing metadata in key-value pairs to be set on tokens issued with this SecretID.

Declaration
public Output<string> Metadata { get; }
Property Value
Type Description
Output<System.String>
View Source

RoleName

The name of the role to create the SecretID for.

Declaration
public Output<string> RoleName { get; }
Property Value
Type Description
Output<System.String>
View Source

SecretId

The SecretID to be created. If set, uses "Push" mode. Defaults to Vault auto-generating SecretIDs.

Declaration
public Output<string> SecretId { get; }
Property Value
Type Description
Output<System.String>
View Source

WrappingAccessor

The unique ID for the response-wrapped SecretID that can be safely logged.

Declaration
public Output<string> WrappingAccessor { get; }
Property Value
Type Description
Output<System.String>
View Source

WrappingToken

The token used to retrieve a response-wrapped SecretID.

Declaration
public Output<string> WrappingToken { get; }
Property Value
Type Description
Output<System.String>
View Source

WrappingTtl

If set, the SecretID response will be response-wrapped and available for the duration specified. Only a single unwrapping of the token is allowed.

Declaration
public Output<string> WrappingTtl { get; }
Property Value
Type Description
Output<System.String>

Methods

View Source

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

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

Declaration
public static AuthBackendRoleSecretID Get(string name, Input<string> id, AuthBackendRoleSecretIDState 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.

AuthBackendRoleSecretIDState state

Any extra arguments used during the lookup.

CustomResourceOptions options

A bag of options that control this resource's behavior

Returns
Type Description
AuthBackendRoleSecretID
  • View Source
Back to top Copyright 2016-2020, Pulumi Corporation.