HashiCorp Vault
EntityAlias
Import
Identity entity alias can be imported using the id
, e.g.
$ pulumi import vault:identity/entityAlias:EntityAlias test "3856fb4d-3c91-dcaf-2401-68f446796bfb"
Example Usage
using Pulumi;
using Vault = Pulumi.Vault;
class MyStack : Stack
{
public MyStack()
{
var test = new Vault.Identity.EntityAlias("test", new Vault.Identity.EntityAliasArgs
{
CanonicalId = "49877D63-07AD-4B85-BDA8-B61626C477E8",
MountAccessor = "token_1f2bd5",
});
}
}
package main
import (
"github.com/pulumi/pulumi-vault/sdk/v5/go/vault/identity"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := identity.NewEntityAlias(ctx, "test", &identity.EntityAliasArgs{
CanonicalId: pulumi.String("49877D63-07AD-4B85-BDA8-B61626C477E8"),
MountAccessor: pulumi.String("token_1f2bd5"),
})
if err != nil {
return err
}
return nil
})
}
Coming soon!
import pulumi
import pulumi_vault as vault
test = vault.identity.EntityAlias("test",
canonical_id="49877D63-07AD-4B85-BDA8-B61626C477E8",
mount_accessor="token_1f2bd5")
import * as pulumi from "@pulumi/pulumi";
import * as vault from "@pulumi/vault";
const test = new vault.identity.EntityAlias("test", {
canonicalId: "49877D63-07AD-4B85-BDA8-B61626C477E8",
mountAccessor: "token_1f2bd5",
});
Coming soon!
Create a EntityAlias Resource
new EntityAlias(name: string, args: EntityAliasArgs, opts?: CustomResourceOptions);
@overload
def EntityAlias(resource_name: str,
opts: Optional[ResourceOptions] = None,
canonical_id: Optional[str] = None,
custom_metadata: Optional[Mapping[str, str]] = None,
mount_accessor: Optional[str] = None,
name: Optional[str] = None)
@overload
def EntityAlias(resource_name: str,
args: EntityAliasArgs,
opts: Optional[ResourceOptions] = None)
func NewEntityAlias(ctx *Context, name string, args EntityAliasArgs, opts ...ResourceOption) (*EntityAlias, error)
public EntityAlias(string name, EntityAliasArgs args, CustomResourceOptions? opts = null)
public EntityAlias(String name, EntityAliasArgs args)
public EntityAlias(String name, EntityAliasArgs args, CustomResourceOptions options)
type: vault:identity:EntityAlias
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args EntityAliasArgs
- 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 EntityAliasArgs
- 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 EntityAliasArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args EntityAliasArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args EntityAliasArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
EntityAlias 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 EntityAlias resource accepts the following input properties:
- Canonical
Id string Entity ID to which this alias belongs to.
- Mount
Accessor string Accessor of the mount to which the alias should belong to.
- Custom
Metadata Dictionary<string, string> Custom metadata to be associated with this alias.
- Name string
Name of the alias. Name should be the identifier of the client in the authentication source. For example, if the alias belongs to userpass backend, the name should be a valid username within userpass backend. If alias belongs to GitHub, it should be the GitHub username.
- Canonical
Id string Entity ID to which this alias belongs to.
- Mount
Accessor string Accessor of the mount to which the alias should belong to.
- Custom
Metadata map[string]string Custom metadata to be associated with this alias.
- Name string
Name of the alias. Name should be the identifier of the client in the authentication source. For example, if the alias belongs to userpass backend, the name should be a valid username within userpass backend. If alias belongs to GitHub, it should be the GitHub username.
- canonical
Id String Entity ID to which this alias belongs to.
- mount
Accessor String Accessor of the mount to which the alias should belong to.
- custom
Metadata Map<String,String> Custom metadata to be associated with this alias.
- name String
Name of the alias. Name should be the identifier of the client in the authentication source. For example, if the alias belongs to userpass backend, the name should be a valid username within userpass backend. If alias belongs to GitHub, it should be the GitHub username.
- canonical
Id string Entity ID to which this alias belongs to.
- mount
Accessor string Accessor of the mount to which the alias should belong to.
- custom
Metadata {[key: string]: string} Custom metadata to be associated with this alias.
- name string
Name of the alias. Name should be the identifier of the client in the authentication source. For example, if the alias belongs to userpass backend, the name should be a valid username within userpass backend. If alias belongs to GitHub, it should be the GitHub username.
- canonical_
id str Entity ID to which this alias belongs to.
- mount_
accessor str Accessor of the mount to which the alias should belong to.
- custom_
metadata Mapping[str, str] Custom metadata to be associated with this alias.
- name str
Name of the alias. Name should be the identifier of the client in the authentication source. For example, if the alias belongs to userpass backend, the name should be a valid username within userpass backend. If alias belongs to GitHub, it should be the GitHub username.
- canonical
Id String Entity ID to which this alias belongs to.
- mount
Accessor String Accessor of the mount to which the alias should belong to.
- custom
Metadata Map<String> Custom metadata to be associated with this alias.
- name String
Name of the alias. Name should be the identifier of the client in the authentication source. For example, if the alias belongs to userpass backend, the name should be a valid username within userpass backend. If alias belongs to GitHub, it should be the GitHub username.
Outputs
All input properties are implicitly available as output properties. Additionally, the EntityAlias resource produces the following output properties:
- Id string
The provider-assigned unique ID for this managed resource.
- Id string
The provider-assigned unique ID for this managed resource.
- id String
The provider-assigned unique ID for this managed resource.
- id string
The provider-assigned unique ID for this managed resource.
- id str
The provider-assigned unique ID for this managed resource.
- id String
The provider-assigned unique ID for this managed resource.
Look up an Existing EntityAlias Resource
Get an existing EntityAlias 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?: EntityAliasState, opts?: CustomResourceOptions): EntityAlias
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
canonical_id: Optional[str] = None,
custom_metadata: Optional[Mapping[str, str]] = None,
mount_accessor: Optional[str] = None,
name: Optional[str] = None) -> EntityAlias
func GetEntityAlias(ctx *Context, name string, id IDInput, state *EntityAliasState, opts ...ResourceOption) (*EntityAlias, error)
public static EntityAlias Get(string name, Input<string> id, EntityAliasState? state, CustomResourceOptions? opts = null)
public static EntityAlias get(String name, Output<String> id, EntityAliasState 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.
- Canonical
Id string Entity ID to which this alias belongs to.
- Custom
Metadata Dictionary<string, string> Custom metadata to be associated with this alias.
- Mount
Accessor string Accessor of the mount to which the alias should belong to.
- Name string
Name of the alias. Name should be the identifier of the client in the authentication source. For example, if the alias belongs to userpass backend, the name should be a valid username within userpass backend. If alias belongs to GitHub, it should be the GitHub username.
- Canonical
Id string Entity ID to which this alias belongs to.
- Custom
Metadata map[string]string Custom metadata to be associated with this alias.
- Mount
Accessor string Accessor of the mount to which the alias should belong to.
- Name string
Name of the alias. Name should be the identifier of the client in the authentication source. For example, if the alias belongs to userpass backend, the name should be a valid username within userpass backend. If alias belongs to GitHub, it should be the GitHub username.
- canonical
Id String Entity ID to which this alias belongs to.
- custom
Metadata Map<String,String> Custom metadata to be associated with this alias.
- mount
Accessor String Accessor of the mount to which the alias should belong to.
- name String
Name of the alias. Name should be the identifier of the client in the authentication source. For example, if the alias belongs to userpass backend, the name should be a valid username within userpass backend. If alias belongs to GitHub, it should be the GitHub username.
- canonical
Id string Entity ID to which this alias belongs to.
- custom
Metadata {[key: string]: string} Custom metadata to be associated with this alias.
- mount
Accessor string Accessor of the mount to which the alias should belong to.
- name string
Name of the alias. Name should be the identifier of the client in the authentication source. For example, if the alias belongs to userpass backend, the name should be a valid username within userpass backend. If alias belongs to GitHub, it should be the GitHub username.
- canonical_
id str Entity ID to which this alias belongs to.
- custom_
metadata Mapping[str, str] Custom metadata to be associated with this alias.
- mount_
accessor str Accessor of the mount to which the alias should belong to.
- name str
Name of the alias. Name should be the identifier of the client in the authentication source. For example, if the alias belongs to userpass backend, the name should be a valid username within userpass backend. If alias belongs to GitHub, it should be the GitHub username.
- canonical
Id String Entity ID to which this alias belongs to.
- custom
Metadata Map<String> Custom metadata to be associated with this alias.
- mount
Accessor String Accessor of the mount to which the alias should belong to.
- name String
Name of the alias. Name should be the identifier of the client in the authentication source. For example, if the alias belongs to userpass backend, the name should be a valid username within userpass backend. If alias belongs to GitHub, it should be the GitHub username.
Package Details
- Repository
- https://github.com/pulumi/pulumi-vault
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
vault
Terraform Provider.