Class AuthBackendRole

Provides a resource to create a role in an GCP auth backend within Vault.

Inheritance

System.Object

Resource

CustomResource

AuthBackendRole

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.Gcp

Assembly: Pulumi.Vault.dll

Syntax

public class AuthBackendRole : CustomResource

Constructors

AuthBackendRole(String, AuthBackendRoleArgs, CustomResourceOptions)

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

Declaration

public AuthBackendRole(string name, AuthBackendRoleArgs args, CustomResourceOptions options = null)

Parameters

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

Properties

AddGroupAliases

Declaration

public Output<bool> AddGroupAliases { get; }

Property Value

Type	Description
Output<System.Boolean>

AllowGceInference

A flag to determine if this role should allow GCE instances to authenticate by inferring service accounts from the GCE identity metadata token.

Declaration

public Output<bool> AllowGceInference { get; }

Property Value

Type	Description
Output<System.Boolean>

Backend

Path to the mounted GCP auth backend

Declaration

public Output<string> Backend { get; }

Property Value

Type	Description
Output<System.String>

BoundInstanceGroups

The instance groups that an authorized instance must belong to in order to be authenticated. If specified, either bound_zones or bound_regions must be set too.

Declaration

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

Property Value

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

BoundLabels

A comma-separated list of GCP labels formatted as "key:value" strings that must be set on authorized GCE instances. Because GCP labels are not currently ACL'd, we recommend that this be used in conjunction with other restrictions.

Declaration

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

Property Value

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

BoundProjects

GCP Projects that the role exists within

Declaration

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

Property Value

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

BoundRegions

The list of regions that a GCE instance must belong to in order to be authenticated. If bound_instance_groups is provided, it is assumed to be a regional group and the group must belong to this region. If bound_zones are provided, this attribute is ignored.

Declaration

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

Property Value

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

BoundServiceAccounts

GCP Service Accounts allowed to issue tokens under this role. (Note: Required if role is iam)

Declaration

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

Property Value

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

BoundZones

The list of zones that a GCE instance must belong to in order to be authenticated. If bound_instance_groups is provided, it is assumed to be a zonal group and the group must belong to this zone.

Declaration

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

Property Value

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

MaxJwtExp

The number of seconds past the time of authentication that the login param JWT must expire within. For example, if a user attempts to login with a token that expires within an hour and this is set to 15 minutes, Vault will return an error prompting the user to create a new signed JWT with a shorter exp. The GCE metadata tokens currently do not allow the exp claim to be customized.

Declaration

public Output<string> MaxJwtExp { get; }

Property Value

Type	Description
Output<System.String>

MaxTtl

The maximum allowed lifetime of tokens issued using this role, provided as a number of seconds.

Declaration

public Output<string> MaxTtl { get; }

Property Value

Type	Description
Output<System.String>

Period

If set, indicates that the token generated using this role should never expire. The token should be renewed within the duration specified by this value. At each renewal, the token's TTL will be set to the value of this field. Specified in seconds.

Declaration

public Output<string> Period { get; }

Property Value

Type	Description
Output<System.String>

Policies

An array of strings specifying the policies to be set on tokens issued using this role.

Declaration

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

Property Value

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

Role

Name of the GCP role

Declaration

public Output<string> Role { get; }

Property Value

Type	Description
Output<System.String>

TokenBoundCidrs

List of CIDR blocks; if set, specifies blocks of IP addresses which can authenticate successfully, and ties the resulting token to these blocks as well.

Declaration

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

Property Value

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

TokenExplicitMaxTtl

If set, will encode an explicit max TTL onto the token in number of seconds. This is a hard cap even if token_ttl and token_max_ttl would otherwise allow a renewal.

Declaration

public Output<int?> TokenExplicitMaxTtl { get; }

Property Value

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

TokenMaxTtl

The maximum lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.

Declaration

public Output<int?> TokenMaxTtl { get; }

Property Value

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

TokenNoDefaultPolicy

If set, the default policy will not be set on generated tokens; otherwise it will be added to the policies set in token_policies.

Declaration

public Output<bool?> TokenNoDefaultPolicy { get; }

Property Value

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

TokenNumUses

The period, if any, in number of seconds to set on the token.

Declaration

public Output<int?> TokenNumUses { get; }

Property Value

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

TokenPeriod

If set, indicates that the token generated using this role should never expire. The token should be renewed within the duration specified by this value. At each renewal, the token's TTL will be set to the value of this field. Specified in seconds.

Declaration

public Output<int?> TokenPeriod { get; }

Property Value

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

TokenPolicies

List of policies to encode onto generated tokens. Depending on the auth method, this list may be supplemented by user/group/other values.

Declaration

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

Property Value

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

TokenTtl

The incremental lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.

Declaration

public Output<int?> TokenTtl { get; }

Property Value

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

TokenType

The type of token that should be generated. Can be service, batch, or default to use the mount's tuned default (which unless changed will be service tokens). For token store roles, there are two additional possibilities: default-service and default-batch which specify the type to return unless the client requests a different type at generation time.

Declaration

public Output<string> TokenType { get; }

Property Value

Type	Description
Output<System.String>

Ttl

The TTL period of tokens issued using this role, provided as a number of seconds.

Declaration

public Output<string> Ttl { get; }

Property Value

Type	Description
Output<System.String>

Type

Type of GCP authentication role (either gce or iam)

Declaration

public Output<string> Type { get; }

Property Value

Type	Description
Output<System.String>

Methods

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

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

Declaration

public static AuthBackendRole Get(string name, Input<string> id, AuthBackendRoleState 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.
AuthBackendRoleState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
AuthBackendRole