Entity

Create a Entity Resource

new Entity(name: string, args?: EntityArgs, opts?: CustomResourceOptions);

def Entity(resource_name, opts=None, disabled=None, external_policies=None, metadata=None, name=None, policies=None, __props__=None);

func NewEntity(ctx *Context, name string, args *EntityArgs, opts ...ResourceOption) (*Entity, error)

public Entity(string name, EntityArgs? args = null, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args EntityArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args EntityArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args EntityArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

Entity Resource Properties

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

Inputs

The Entity resource accepts the following input properties:

Disabled bool: True/false Is this entity currently disabled. Defaults to false
ExternalPolicies bool: false by default. If set to true, this resource will ignore any policies return from Vault or specified in the resource. You can use vault.identity.EntityPolicies to manage policies for this entity in a decoupled manner.
Metadata Dictionary<string, string>: A Map of additional metadata to associate with the user.
Name string: Name of the identity entity to create.
Policies List<string>: A list of policies to apply to the entity.

Disabled bool: True/false Is this entity currently disabled. Defaults to false
ExternalPolicies bool: false by default. If set to true, this resource will ignore any policies return from Vault or specified in the resource. You can use vault.identity.EntityPolicies to manage policies for this entity in a decoupled manner.
Metadata map[string]string: A Map of additional metadata to associate with the user.
Name string: Name of the identity entity to create.
Policies []string: A list of policies to apply to the entity.

disabled boolean: True/false Is this entity currently disabled. Defaults to false
externalPolicies boolean: false by default. If set to true, this resource will ignore any policies return from Vault or specified in the resource. You can use vault.identity.EntityPolicies to manage policies for this entity in a decoupled manner.
metadata {[key: string]: string}: A Map of additional metadata to associate with the user.
name string: Name of the identity entity to create.
policies string[]: A list of policies to apply to the entity.

disabled bool: True/false Is this entity currently disabled. Defaults to false
external_policies bool: false by default. If set to true, this resource will ignore any policies return from Vault or specified in the resource. You can use vault.identity.EntityPolicies to manage policies for this entity in a decoupled manner.
metadata Dict[str, str]: A Map of additional metadata to associate with the user.
name str: Name of the identity entity to create.
policies List[str]: A list of policies to apply to the entity.

Outputs

All input properties are implicitly available as output properties. Additionally, the Entity 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 str: The provider-assigned unique ID for this managed resource.

Look up an Existing Entity Resource

Get an existing Entity 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?: EntityState, opts?: CustomResourceOptions): Entity

static get(resource_name, id, opts=None, disabled=None, external_policies=None, metadata=None, name=None, policies=None, __props__=None);

func GetEntity(ctx *Context, name string, id IDInput, state *EntityState, opts ...ResourceOption) (*Entity, error)

public static Entity Get(string name, Input<string> id, EntityState? 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:

Disabled bool: True/false Is this entity currently disabled. Defaults to false
ExternalPolicies bool: false by default. If set to true, this resource will ignore any policies return from Vault or specified in the resource. You can use vault.identity.EntityPolicies to manage policies for this entity in a decoupled manner.
Metadata Dictionary<string, string>: A Map of additional metadata to associate with the user.
Name string: Name of the identity entity to create.
Policies List<string>: A list of policies to apply to the entity.

Disabled bool: True/false Is this entity currently disabled. Defaults to false
ExternalPolicies bool: false by default. If set to true, this resource will ignore any policies return from Vault or specified in the resource. You can use vault.identity.EntityPolicies to manage policies for this entity in a decoupled manner.
Metadata map[string]string: A Map of additional metadata to associate with the user.
Name string: Name of the identity entity to create.
Policies []string: A list of policies to apply to the entity.

disabled boolean: True/false Is this entity currently disabled. Defaults to false
externalPolicies boolean: false by default. If set to true, this resource will ignore any policies return from Vault or specified in the resource. You can use vault.identity.EntityPolicies to manage policies for this entity in a decoupled manner.
metadata {[key: string]: string}: A Map of additional metadata to associate with the user.
name string: Name of the identity entity to create.
policies string[]: A list of policies to apply to the entity.

disabled bool: True/false Is this entity currently disabled. Defaults to false
external_policies bool: false by default. If set to true, this resource will ignore any policies return from Vault or specified in the resource. You can use vault.identity.EntityPolicies to manage policies for this entity in a decoupled manner.
metadata Dict[str, str]: A Map of additional metadata to associate with the user.
name str: Name of the identity entity to create.
policies List[str]: A list of policies to apply to the entity.

Package Details

Repository: https://github.com/pulumi/pulumi-vault
License: Apache-2.0
Notes: This Pulumi package is based on the vault Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud