AuthBackendRole

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

Example Usage

using Pulumi;
using Vault = Pulumi.Vault;

class MyStack : Stack
{
    public MyStack()
    {
        var alicloudAuthBackend = new Vault.AuthBackend("alicloudAuthBackend", new Vault.AuthBackendArgs
        {
            Type = "alicloud",
            Path = "alicloud",
        });
        var alicloudAuthBackendRole = new Vault.AliCloud.AuthBackendRole("alicloudAuthBackendRole", new Vault.AliCloud.AuthBackendRoleArgs
        {
            Backend = alicloudAuthBackend.Path,
            Role = "example",
            Arn = "acs:ram:123456:tf:role/foobar",
        });
    }

}
package main

import (
	"github.com/pulumi/pulumi-vault/sdk/v4/go/vault"
	"github.com/pulumi/pulumi-vault/sdk/v4/go/vault/alicloud"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		alicloudAuthBackend, err := vault.NewAuthBackend(ctx, "alicloudAuthBackend", &vault.AuthBackendArgs{
			Type: pulumi.String("alicloud"),
			Path: pulumi.String("alicloud"),
		})
		if err != nil {
			return err
		}
		_, err = alicloud.NewAuthBackendRole(ctx, "alicloudAuthBackendRole", &alicloud.AuthBackendRoleArgs{
			Backend: alicloudAuthBackend.Path,
			Role:    pulumi.String("example"),
			Arn:     pulumi.String("acs:ram:123456:tf:role/foobar"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
import pulumi
import pulumi_vault as vault

alicloud_auth_backend = vault.AuthBackend("alicloudAuthBackend",
    type="alicloud",
    path="alicloud")
alicloud_auth_backend_role = vault.alicloud.AuthBackendRole("alicloudAuthBackendRole",
    backend=alicloud_auth_backend.path,
    role="example",
    arn="acs:ram:123456:tf:role/foobar")
import * as pulumi from "@pulumi/pulumi";
import * as vault from "@pulumi/vault";

const alicloudAuthBackend = new vault.AuthBackend("alicloudAuthBackend", {
    type: "alicloud",
    path: "alicloud",
});
const alicloudAuthBackendRole = new vault.alicloud.AuthBackendRole("alicloudAuthBackendRole", {
    backend: alicloudAuthBackend.path,
    role: "example",
    arn: "acs:ram:123456:tf:role/foobar",
});

Create a AuthBackendRole Resource

new AuthBackendRole(name: string, args: AuthBackendRoleArgs, opts?: CustomResourceOptions);
@overload
def AuthBackendRole(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    arn: Optional[str] = None,
                    backend: Optional[str] = None,
                    role: Optional[str] = None,
                    token_bound_cidrs: Optional[Sequence[str]] = None,
                    token_explicit_max_ttl: Optional[int] = None,
                    token_max_ttl: Optional[int] = None,
                    token_no_default_policy: Optional[bool] = None,
                    token_num_uses: Optional[int] = None,
                    token_period: Optional[int] = None,
                    token_policies: Optional[Sequence[str]] = None,
                    token_ttl: Optional[int] = None,
                    token_type: Optional[str] = None)
@overload
def AuthBackendRole(resource_name: str,
                    args: AuthBackendRoleArgs,
                    opts: Optional[ResourceOptions] = None)
func NewAuthBackendRole(ctx *Context, name string, args AuthBackendRoleArgs, opts ...ResourceOption) (*AuthBackendRole, error)
public AuthBackendRole(string name, AuthBackendRoleArgs args, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args AuthBackendRoleArgs
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 AuthBackendRoleArgs
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 AuthBackendRoleArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args AuthBackendRoleArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

AuthBackendRole 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 AuthBackendRole resource accepts the following input properties:

Arn string
The role’s arn.
Role string
Name of the role. Must correspond with the name of the role reflected in the arn.
Backend string
Path to the mounted AliCloud auth backend. Defaults to alicloud
TokenBoundCidrs List<string>
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.
TokenExplicitMaxTtl int
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.
TokenMaxTtl int
The maximum lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.
TokenNoDefaultPolicy bool
If set, the default policy will not be set on generated tokens; otherwise it will be added to the policies set in token_policies.
TokenNumUses int
The period, if any, in number of seconds to set on the token.
TokenPeriod int
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.
TokenPolicies List<string>
List of policies to encode onto generated tokens. Depending on the auth method, this list may be supplemented by user/group/other values.
TokenTtl int
The incremental lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.
TokenType string
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.
Arn string
The role’s arn.
Role string
Name of the role. Must correspond with the name of the role reflected in the arn.
Backend string
Path to the mounted AliCloud auth backend. Defaults to alicloud
TokenBoundCidrs []string
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.
TokenExplicitMaxTtl int
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.
TokenMaxTtl int
The maximum lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.
TokenNoDefaultPolicy bool
If set, the default policy will not be set on generated tokens; otherwise it will be added to the policies set in token_policies.
TokenNumUses int
The period, if any, in number of seconds to set on the token.
TokenPeriod int
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.
TokenPolicies []string
List of policies to encode onto generated tokens. Depending on the auth method, this list may be supplemented by user/group/other values.
TokenTtl int
The incremental lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.
TokenType string
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.
arn string
The role’s arn.
role string
Name of the role. Must correspond with the name of the role reflected in the arn.
backend string
Path to the mounted AliCloud auth backend. Defaults to alicloud
tokenBoundCidrs string[]
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.
tokenExplicitMaxTtl number
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.
tokenMaxTtl number
The maximum lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.
tokenNoDefaultPolicy boolean
If set, the default policy will not be set on generated tokens; otherwise it will be added to the policies set in token_policies.
tokenNumUses number
The period, if any, in number of seconds to set on the token.
tokenPeriod number
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.
tokenPolicies string[]
List of policies to encode onto generated tokens. Depending on the auth method, this list may be supplemented by user/group/other values.
tokenTtl number
The incremental lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.
tokenType string
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.
arn str
The role’s arn.
role str
Name of the role. Must correspond with the name of the role reflected in the arn.
backend str
Path to the mounted AliCloud auth backend. Defaults to alicloud
token_bound_cidrs Sequence[str]
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.
token_explicit_max_ttl int
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.
token_max_ttl int
The maximum lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.
token_no_default_policy bool
If set, the default policy will not be set on generated tokens; otherwise it will be added to the policies set in token_policies.
token_num_uses int
The period, if any, in number of seconds to set on the token.
token_period int
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.
token_policies Sequence[str]
List of policies to encode onto generated tokens. Depending on the auth method, this list may be supplemented by user/group/other values.
token_ttl int
The incremental lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.
token_type str
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.

Outputs

All input properties are implicitly available as output properties. Additionally, the AuthBackendRole 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 AuthBackendRole Resource

Get an existing AuthBackendRole 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?: AuthBackendRoleState, opts?: CustomResourceOptions): AuthBackendRole
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        backend: Optional[str] = None,
        role: Optional[str] = None,
        token_bound_cidrs: Optional[Sequence[str]] = None,
        token_explicit_max_ttl: Optional[int] = None,
        token_max_ttl: Optional[int] = None,
        token_no_default_policy: Optional[bool] = None,
        token_num_uses: Optional[int] = None,
        token_period: Optional[int] = None,
        token_policies: Optional[Sequence[str]] = None,
        token_ttl: Optional[int] = None,
        token_type: Optional[str] = None) -> AuthBackendRole
func GetAuthBackendRole(ctx *Context, name string, id IDInput, state *AuthBackendRoleState, opts ...ResourceOption) (*AuthBackendRole, error)
public static AuthBackendRole Get(string name, Input<string> id, AuthBackendRoleState? 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:

Arn string
The role’s arn.
Backend string
Path to the mounted AliCloud auth backend. Defaults to alicloud
Role string
Name of the role. Must correspond with the name of the role reflected in the arn.
TokenBoundCidrs List<string>
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.
TokenExplicitMaxTtl int
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.
TokenMaxTtl int
The maximum lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.
TokenNoDefaultPolicy bool
If set, the default policy will not be set on generated tokens; otherwise it will be added to the policies set in token_policies.
TokenNumUses int
The period, if any, in number of seconds to set on the token.
TokenPeriod int
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.
TokenPolicies List<string>
List of policies to encode onto generated tokens. Depending on the auth method, this list may be supplemented by user/group/other values.
TokenTtl int
The incremental lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.
TokenType string
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.
Arn string
The role’s arn.
Backend string
Path to the mounted AliCloud auth backend. Defaults to alicloud
Role string
Name of the role. Must correspond with the name of the role reflected in the arn.
TokenBoundCidrs []string
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.
TokenExplicitMaxTtl int
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.
TokenMaxTtl int
The maximum lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.
TokenNoDefaultPolicy bool
If set, the default policy will not be set on generated tokens; otherwise it will be added to the policies set in token_policies.
TokenNumUses int
The period, if any, in number of seconds to set on the token.
TokenPeriod int
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.
TokenPolicies []string
List of policies to encode onto generated tokens. Depending on the auth method, this list may be supplemented by user/group/other values.
TokenTtl int
The incremental lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.
TokenType string
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.
arn string
The role’s arn.
backend string
Path to the mounted AliCloud auth backend. Defaults to alicloud
role string
Name of the role. Must correspond with the name of the role reflected in the arn.
tokenBoundCidrs string[]
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.
tokenExplicitMaxTtl number
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.
tokenMaxTtl number
The maximum lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.
tokenNoDefaultPolicy boolean
If set, the default policy will not be set on generated tokens; otherwise it will be added to the policies set in token_policies.
tokenNumUses number
The period, if any, in number of seconds to set on the token.
tokenPeriod number
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.
tokenPolicies string[]
List of policies to encode onto generated tokens. Depending on the auth method, this list may be supplemented by user/group/other values.
tokenTtl number
The incremental lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.
tokenType string
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.
arn str
The role’s arn.
backend str
Path to the mounted AliCloud auth backend. Defaults to alicloud
role str
Name of the role. Must correspond with the name of the role reflected in the arn.
token_bound_cidrs Sequence[str]
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.
token_explicit_max_ttl int
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.
token_max_ttl int
The maximum lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.
token_no_default_policy bool
If set, the default policy will not be set on generated tokens; otherwise it will be added to the policies set in token_policies.
token_num_uses int
The period, if any, in number of seconds to set on the token.
token_period int
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.
token_policies Sequence[str]
List of policies to encode onto generated tokens. Depending on the auth method, this list may be supplemented by user/group/other values.
token_ttl int
The incremental lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.
token_type str
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.

Import

Alicloud authentication roles can be imported using the path, e.g.

 $ pulumi import vault:alicloud/authBackendRole:AuthBackendRole my_role auth/alicloud/role/my_role

Package Details

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