vault.aws.AuthBackendRole
Explore with Pulumi AI
Manages an AWS auth backend role in a Vault server. Roles constrain the instances or principals that can perform the login operation against the backend. See the Vault documentation for more information.
Example Usage
using System.Collections.Generic;
using Pulumi;
using Vault = Pulumi.Vault;
return await Deployment.RunAsync(() =>
{
var aws = new Vault.AuthBackend("aws", new()
{
Type = "aws",
});
var example = new Vault.Aws.AuthBackendRole("example", new()
{
Backend = aws.Path,
Role = "test-role",
AuthType = "iam",
BoundAmiIds = new[]
{
"ami-8c1be5f6",
},
BoundAccountIds = new[]
{
"123456789012",
},
BoundVpcIds = new[]
{
"vpc-b61106d4",
},
BoundSubnetIds = new[]
{
"vpc-133128f1",
},
BoundIamRoleArns = new[]
{
"arn:aws:iam::123456789012:role/MyRole",
},
BoundIamInstanceProfileArns = new[]
{
"arn:aws:iam::123456789012:instance-profile/MyProfile",
},
InferredEntityType = "ec2_instance",
InferredAwsRegion = "us-east-1",
TokenTtl = 60,
TokenMaxTtl = 120,
TokenPolicies = new[]
{
"default",
"dev",
"prod",
},
});
});
package main
import (
"github.com/pulumi/pulumi-vault/sdk/v5/go/vault"
"github.com/pulumi/pulumi-vault/sdk/v5/go/vault/aws"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
aws, err := vault.NewAuthBackend(ctx, "aws", &vault.AuthBackendArgs{
Type: pulumi.String("aws"),
})
if err != nil {
return err
}
_, err = aws.NewAuthBackendRole(ctx, "example", &aws.AuthBackendRoleArgs{
Backend: aws.Path,
Role: pulumi.String("test-role"),
AuthType: pulumi.String("iam"),
BoundAmiIds: pulumi.StringArray{
pulumi.String("ami-8c1be5f6"),
},
BoundAccountIds: pulumi.StringArray{
pulumi.String("123456789012"),
},
BoundVpcIds: pulumi.StringArray{
pulumi.String("vpc-b61106d4"),
},
BoundSubnetIds: pulumi.StringArray{
pulumi.String("vpc-133128f1"),
},
BoundIamRoleArns: pulumi.StringArray{
pulumi.String("arn:aws:iam::123456789012:role/MyRole"),
},
BoundIamInstanceProfileArns: pulumi.StringArray{
pulumi.String("arn:aws:iam::123456789012:instance-profile/MyProfile"),
},
InferredEntityType: pulumi.String("ec2_instance"),
InferredAwsRegion: pulumi.String("us-east-1"),
TokenTtl: pulumi.Int(60),
TokenMaxTtl: pulumi.Int(120),
TokenPolicies: pulumi.StringArray{
pulumi.String("default"),
pulumi.String("dev"),
pulumi.String("prod"),
},
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.vault.AuthBackend;
import com.pulumi.vault.AuthBackendArgs;
import com.pulumi.vault.aws.AuthBackendRole;
import com.pulumi.vault.aws.AuthBackendRoleArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var aws = new AuthBackend("aws", AuthBackendArgs.builder()
.type("aws")
.build());
var example = new AuthBackendRole("example", AuthBackendRoleArgs.builder()
.backend(aws.path())
.role("test-role")
.authType("iam")
.boundAmiIds("ami-8c1be5f6")
.boundAccountIds("123456789012")
.boundVpcIds("vpc-b61106d4")
.boundSubnetIds("vpc-133128f1")
.boundIamRoleArns("arn:aws:iam::123456789012:role/MyRole")
.boundIamInstanceProfileArns("arn:aws:iam::123456789012:instance-profile/MyProfile")
.inferredEntityType("ec2_instance")
.inferredAwsRegion("us-east-1")
.tokenTtl(60)
.tokenMaxTtl(120)
.tokenPolicies(
"default",
"dev",
"prod")
.build());
}
}
import pulumi
import pulumi_vault as vault
aws = vault.AuthBackend("aws", type="aws")
example = vault.aws.AuthBackendRole("example",
backend=aws.path,
role="test-role",
auth_type="iam",
bound_ami_ids=["ami-8c1be5f6"],
bound_account_ids=["123456789012"],
bound_vpc_ids=["vpc-b61106d4"],
bound_subnet_ids=["vpc-133128f1"],
bound_iam_role_arns=["arn:aws:iam::123456789012:role/MyRole"],
bound_iam_instance_profile_arns=["arn:aws:iam::123456789012:instance-profile/MyProfile"],
inferred_entity_type="ec2_instance",
inferred_aws_region="us-east-1",
token_ttl=60,
token_max_ttl=120,
token_policies=[
"default",
"dev",
"prod",
])
import * as pulumi from "@pulumi/pulumi";
import * as vault from "@pulumi/vault";
const aws = new vault.AuthBackend("aws", {type: "aws"});
const example = new vault.aws.AuthBackendRole("example", {
backend: aws.path,
role: "test-role",
authType: "iam",
boundAmiIds: ["ami-8c1be5f6"],
boundAccountIds: ["123456789012"],
boundVpcIds: ["vpc-b61106d4"],
boundSubnetIds: ["vpc-133128f1"],
boundIamRoleArns: ["arn:aws:iam::123456789012:role/MyRole"],
boundIamInstanceProfileArns: ["arn:aws:iam::123456789012:instance-profile/MyProfile"],
inferredEntityType: "ec2_instance",
inferredAwsRegion: "us-east-1",
tokenTtl: 60,
tokenMaxTtl: 120,
tokenPolicies: [
"default",
"dev",
"prod",
],
});
resources:
aws:
type: vault:AuthBackend
properties:
type: aws
example:
type: vault:aws:AuthBackendRole
properties:
backend: ${aws.path}
role: test-role
authType: iam
boundAmiIds:
- ami-8c1be5f6
boundAccountIds:
- 123456789012
boundVpcIds:
- vpc-b61106d4
boundSubnetIds:
- vpc-133128f1
boundIamRoleArns:
- arn:aws:iam::123456789012:role/MyRole
boundIamInstanceProfileArns:
- arn:aws:iam::123456789012:instance-profile/MyProfile
inferredEntityType: ec2_instance
inferredAwsRegion: us-east-1
tokenTtl: 60
tokenMaxTtl: 120
tokenPolicies:
- default
- dev
- prod
Create AuthBackendRole Resource
new AuthBackendRole(name: string, args: AuthBackendRoleArgs, opts?: CustomResourceOptions);
@overload
def AuthBackendRole(resource_name: str,
opts: Optional[ResourceOptions] = None,
allow_instance_migration: Optional[bool] = None,
auth_type: Optional[str] = None,
backend: Optional[str] = None,
bound_account_ids: Optional[Sequence[str]] = None,
bound_ami_ids: Optional[Sequence[str]] = None,
bound_ec2_instance_ids: Optional[Sequence[str]] = None,
bound_iam_instance_profile_arns: Optional[Sequence[str]] = None,
bound_iam_principal_arns: Optional[Sequence[str]] = None,
bound_iam_role_arns: Optional[Sequence[str]] = None,
bound_regions: Optional[Sequence[str]] = None,
bound_subnet_ids: Optional[Sequence[str]] = None,
bound_vpc_ids: Optional[Sequence[str]] = None,
disallow_reauthentication: Optional[bool] = None,
inferred_aws_region: Optional[str] = None,
inferred_entity_type: Optional[str] = None,
namespace: Optional[str] = None,
resolve_aws_unique_ids: Optional[bool] = None,
role: Optional[str] = None,
role_tag: 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)
public AuthBackendRole(String name, AuthBackendRoleArgs args)
public AuthBackendRole(String name, AuthBackendRoleArgs args, CustomResourceOptions options)
type: vault:aws:AuthBackendRole
properties: # The arguments to resource properties.
options: # 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.
- 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.
- name String
- The unique name of the resource.
- args AuthBackendRoleArgs
- The arguments to resource properties.
- options 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:
- Role string
The name of the role.
- Allow
Instance boolMigration If set to
true
, allows migration of the underlying instance where the client resides.- Auth
Type string The auth type permitted for this role. Valid choices are
ec2
andiam
. Defaults toiam
.- Backend string
Path to the mounted aws auth backend.
- Bound
Account List<string>Ids If set, defines a constraint on the EC2 instances that can perform the login operation that they should be using the account ID specified by this field.
auth_type
must be set toec2
orinferred_entity_type
must be set toec2_instance
to use this constraint.- Bound
Ami List<string>Ids If set, defines a constraint on the EC2 instances that can perform the login operation that they should be using the AMI ID specified by this field.
auth_type
must be set toec2
orinferred_entity_type
must be set toec2_instance
to use this constraint.- Bound
Ec2Instance List<string>Ids Only EC2 instances that match this instance ID will be permitted to log in.
- Bound
Iam List<string>Instance Profile Arns If set, defines a constraint on the EC2 instances that can perform the login operation that they must be associated with an IAM instance profile ARN which has a prefix that matches the value specified by this field. The value is prefix-matched as though it were a glob ending in
*
.auth_type
must be set toec2
orinferred_entity_type
must be set toec2_instance
to use this constraint.- Bound
Iam List<string>Principal Arns If set, defines the IAM principal that must be authenticated when
auth_type
is set toiam
. Wildcards are supported at the end of the ARN.- Bound
Iam List<string>Role Arns If set, defines a constraint on the EC2 instances that can perform the login operation that they must match the IAM role ARN specified by this field.
auth_type
must be set toec2
orinferred_entity_type
must be set toec2_instance
to use this constraint.- Bound
Regions List<string> If set, defines a constraint on the EC2 instances that can perform the login operation that the region in their identity document must match the one specified by this field.
auth_type
must be set toec2
orinferred_entity_type
must be set toec2_instance
to use this constraint.- Bound
Subnet List<string>Ids If set, defines a constraint on the EC2 instances that can perform the login operation that they be associated with the subnet ID that matches the value specified by this field.
auth_type
must be set toec2
orinferred_entity_type
must be set toec2_instance
to use this constraint.- Bound
Vpc List<string>Ids If set, defines a constraint on the EC2 instances that can perform the login operation that they be associated with the VPC ID that matches the value specified by this field.
auth_type
must be set toec2
orinferred_entity_type
must be set toec2_instance
to use this constraint.- Disallow
Reauthentication bool IF set to
true
, only allows a single token to be granted per instance ID. This can only be set whenauth_type
is set toec2
.- Inferred
Aws stringRegion When
inferred_entity_type
is set, this is the region to search for the inferred entities. Required ifinferred_entity_type
is set. This only applies whenauth_type
is set toiam
.- Inferred
Entity stringType If set, instructs Vault to turn on inferencing. The only valid value is
ec2_instance
, which instructs Vault to infer that the role comes from an EC2 instance in an IAM instance profile. This only applies whenauth_type
is set toiam
.- Namespace string
The namespace to provision the resource in. The value should not contain leading or trailing forward slashes. The
namespace
is always relative to the provider's configured namespace. Available only for Vault Enterprise.- Resolve
Aws boolUnique Ids Only valid when
auth_type
isiam
. If set totrue
, thebound_iam_principal_arns
are resolved to AWS Unique IDs for the bound principal ARN. This field is ignored when abound_iam_principal_arn
ends in a wildcard. Resolving to unique IDs more closely mimics the behavior of AWS services in that if an IAM user or role is deleted and a new one is recreated with the same name, those new users or roles won't get access to roles in Vault that were permissioned to the prior principals of the same name. Defaults totrue
. Once set totrue
, this cannot be changed tofalse
without recreating the role.- Role
Tag string If set, enable role tags for this role. The value set for this field should be the key of the tag on the EC2 instance.
auth_type
must be set toec2
orinferred_entity_type
must be set toec2_instance
to use this constraint.- Token
Bound List<string>Cidrs 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 intMax Ttl If set, will encode an explicit max TTL onto the token in number of seconds. This is a hard cap even if
token_ttl
andtoken_max_ttl
would otherwise allow a renewal.- Token
Max intTtl The maximum lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.
- Token
No boolDefault Policy 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 intUses The maximum number of times a generated token may be used (within its lifetime); 0 means unlimited.
- 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 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.
- Token
Ttl int The incremental lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.
- Token
Type string The type of token that should be generated. Can be
service
,batch
, ordefault
to use the mount's tuned default (which unless changed will beservice
tokens). For token store roles, there are two additional possibilities:default-service
anddefault-batch
which specify the type to return unless the client requests a different type at generation time.
- Role string
The name of the role.
- Allow
Instance boolMigration If set to
true
, allows migration of the underlying instance where the client resides.- Auth
Type string The auth type permitted for this role. Valid choices are
ec2
andiam
. Defaults toiam
.- Backend string
Path to the mounted aws auth backend.
- Bound
Account []stringIds If set, defines a constraint on the EC2 instances that can perform the login operation that they should be using the account ID specified by this field.
auth_type
must be set toec2
orinferred_entity_type
must be set toec2_instance
to use this constraint.- Bound
Ami []stringIds If set, defines a constraint on the EC2 instances that can perform the login operation that they should be using the AMI ID specified by this field.
auth_type
must be set toec2
orinferred_entity_type
must be set toec2_instance
to use this constraint.- Bound
Ec2Instance []stringIds Only EC2 instances that match this instance ID will be permitted to log in.
- Bound
Iam []stringInstance Profile Arns If set, defines a constraint on the EC2 instances that can perform the login operation that they must be associated with an IAM instance profile ARN which has a prefix that matches the value specified by this field. The value is prefix-matched as though it were a glob ending in
*
.auth_type
must be set toec2
orinferred_entity_type
must be set toec2_instance
to use this constraint.- Bound
Iam []stringPrincipal Arns If set, defines the IAM principal that must be authenticated when
auth_type
is set toiam
. Wildcards are supported at the end of the ARN.- Bound
Iam []stringRole Arns If set, defines a constraint on the EC2 instances that can perform the login operation that they must match the IAM role ARN specified by this field.
auth_type
must be set toec2
orinferred_entity_type
must be set toec2_instance
to use this constraint.- Bound
Regions []string If set, defines a constraint on the EC2 instances that can perform the login operation that the region in their identity document must match the one specified by this field.
auth_type
must be set toec2
orinferred_entity_type
must be set toec2_instance
to use this constraint.- Bound
Subnet []stringIds If set, defines a constraint on the EC2 instances that can perform the login operation that they be associated with the subnet ID that matches the value specified by this field.
auth_type
must be set toec2
orinferred_entity_type
must be set toec2_instance
to use this constraint.- Bound
Vpc []stringIds If set, defines a constraint on the EC2 instances that can perform the login operation that they be associated with the VPC ID that matches the value specified by this field.
auth_type
must be set toec2
orinferred_entity_type
must be set toec2_instance
to use this constraint.- Disallow
Reauthentication bool IF set to
true
, only allows a single token to be granted per instance ID. This can only be set whenauth_type
is set toec2
.- Inferred
Aws stringRegion When
inferred_entity_type
is set, this is the region to search for the inferred entities. Required ifinferred_entity_type
is set. This only applies whenauth_type
is set toiam
.- Inferred
Entity stringType If set, instructs Vault to turn on inferencing. The only valid value is
ec2_instance
, which instructs Vault to infer that the role comes from an EC2 instance in an IAM instance profile. This only applies whenauth_type
is set toiam
.- Namespace string
The namespace to provision the resource in. The value should not contain leading or trailing forward slashes. The
namespace
is always relative to the provider's configured namespace. Available only for Vault Enterprise.- Resolve
Aws boolUnique Ids Only valid when
auth_type
isiam
. If set totrue
, thebound_iam_principal_arns
are resolved to AWS Unique IDs for the bound principal ARN. This field is ignored when abound_iam_principal_arn
ends in a wildcard. Resolving to unique IDs more closely mimics the behavior of AWS services in that if an IAM user or role is deleted and a new one is recreated with the same name, those new users or roles won't get access to roles in Vault that were permissioned to the prior principals of the same name. Defaults totrue
. Once set totrue
, this cannot be changed tofalse
without recreating the role.- Role
Tag string If set, enable role tags for this role. The value set for this field should be the key of the tag on the EC2 instance.
auth_type
must be set toec2
orinferred_entity_type
must be set toec2_instance
to use this constraint.- Token
Bound []stringCidrs 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 intMax Ttl If set, will encode an explicit max TTL onto the token in number of seconds. This is a hard cap even if
token_ttl
andtoken_max_ttl
would otherwise allow a renewal.- Token
Max intTtl The maximum lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.
- Token
No boolDefault Policy 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 intUses The maximum number of times a generated token may be used (within its lifetime); 0 means unlimited.
- 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 []string 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 string The type of token that should be generated. Can be
service
,batch
, ordefault
to use the mount's tuned default (which unless changed will beservice
tokens). For token store roles, there are two additional possibilities:default-service
anddefault-batch
which specify the type to return unless the client requests a different type at generation time.
- role String
The name of the role.
- allow
Instance BooleanMigration If set to
true
, allows migration of the underlying instance where the client resides.- auth
Type String The auth type permitted for this role. Valid choices are
ec2
andiam
. Defaults toiam
.- backend String
Path to the mounted aws auth backend.
- bound
Account List<String>Ids If set, defines a constraint on the EC2 instances that can perform the login operation that they should be using the account ID specified by this field.
auth_type
must be set toec2
orinferred_entity_type
must be set toec2_instance
to use this constraint.- bound
Ami List<String>Ids If set, defines a constraint on the EC2 instances that can perform the login operation that they should be using the AMI ID specified by this field.
auth_type
must be set toec2
orinferred_entity_type
must be set toec2_instance
to use this constraint.- bound
Ec2Instance List<String>Ids Only EC2 instances that match this instance ID will be permitted to log in.
- bound
Iam List<String>Instance Profile Arns If set, defines a constraint on the EC2 instances that can perform the login operation that they must be associated with an IAM instance profile ARN which has a prefix that matches the value specified by this field. The value is prefix-matched as though it were a glob ending in
*
.auth_type
must be set toec2
orinferred_entity_type
must be set toec2_instance
to use this constraint.- bound
Iam List<String>Principal Arns If set, defines the IAM principal that must be authenticated when
auth_type
is set toiam
. Wildcards are supported at the end of the ARN.- bound
Iam List<String>Role Arns If set, defines a constraint on the EC2 instances that can perform the login operation that they must match the IAM role ARN specified by this field.
auth_type
must be set toec2
orinferred_entity_type
must be set toec2_instance
to use this constraint.- bound
Regions List<String> If set, defines a constraint on the EC2 instances that can perform the login operation that the region in their identity document must match the one specified by this field.
auth_type
must be set toec2
orinferred_entity_type
must be set toec2_instance
to use this constraint.- bound
Subnet List<String>Ids If set, defines a constraint on the EC2 instances that can perform the login operation that they be associated with the subnet ID that matches the value specified by this field.
auth_type
must be set toec2
orinferred_entity_type
must be set toec2_instance
to use this constraint.- bound
Vpc List<String>Ids If set, defines a constraint on the EC2 instances that can perform the login operation that they be associated with the VPC ID that matches the value specified by this field.
auth_type
must be set toec2
orinferred_entity_type
must be set toec2_instance
to use this constraint.- disallow
Reauthentication Boolean IF set to
true
, only allows a single token to be granted per instance ID. This can only be set whenauth_type
is set toec2
.- inferred
Aws StringRegion When
inferred_entity_type
is set, this is the region to search for the inferred entities. Required ifinferred_entity_type
is set. This only applies whenauth_type
is set toiam
.- inferred
Entity StringType If set, instructs Vault to turn on inferencing. The only valid value is
ec2_instance
, which instructs Vault to infer that the role comes from an EC2 instance in an IAM instance profile. This only applies whenauth_type
is set toiam
.- namespace String
The namespace to provision the resource in. The value should not contain leading or trailing forward slashes. The
namespace
is always relative to the provider's configured namespace. Available only for Vault Enterprise.- resolve
Aws BooleanUnique Ids Only valid when
auth_type
isiam
. If set totrue
, thebound_iam_principal_arns
are resolved to AWS Unique IDs for the bound principal ARN. This field is ignored when abound_iam_principal_arn
ends in a wildcard. Resolving to unique IDs more closely mimics the behavior of AWS services in that if an IAM user or role is deleted and a new one is recreated with the same name, those new users or roles won't get access to roles in Vault that were permissioned to the prior principals of the same name. Defaults totrue
. Once set totrue
, this cannot be changed tofalse
without recreating the role.- role
Tag String If set, enable role tags for this role. The value set for this field should be the key of the tag on the EC2 instance.
auth_type
must be set toec2
orinferred_entity_type
must be set toec2_instance
to use this constraint.- token
Bound List<String>Cidrs 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 IntegerMax Ttl If set, will encode an explicit max TTL onto the token in number of seconds. This is a hard cap even if
token_ttl
andtoken_max_ttl
would otherwise allow a renewal.- token
Max IntegerTtl The maximum lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.
- token
No BooleanDefault Policy 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 IntegerUses The maximum number of times a generated token may be used (within its lifetime); 0 means unlimited.
- token
Period Integer 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 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.
- token
Ttl Integer The incremental lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.
- token
Type String The type of token that should be generated. Can be
service
,batch
, ordefault
to use the mount's tuned default (which unless changed will beservice
tokens). For token store roles, there are two additional possibilities:default-service
anddefault-batch
which specify the type to return unless the client requests a different type at generation time.
- role string
The name of the role.
- allow
Instance booleanMigration If set to
true
, allows migration of the underlying instance where the client resides.- auth
Type string The auth type permitted for this role. Valid choices are
ec2
andiam
. Defaults toiam
.- backend string
Path to the mounted aws auth backend.
- bound
Account string[]Ids If set, defines a constraint on the EC2 instances that can perform the login operation that they should be using the account ID specified by this field.
auth_type
must be set toec2
orinferred_entity_type
must be set toec2_instance
to use this constraint.- bound
Ami string[]Ids If set, defines a constraint on the EC2 instances that can perform the login operation that they should be using the AMI ID specified by this field.
auth_type
must be set toec2
orinferred_entity_type
must be set toec2_instance
to use this constraint.- bound
Ec2Instance string[]Ids Only EC2 instances that match this instance ID will be permitted to log in.
- bound
Iam string[]Instance Profile Arns If set, defines a constraint on the EC2 instances that can perform the login operation that they must be associated with an IAM instance profile ARN which has a prefix that matches the value specified by this field. The value is prefix-matched as though it were a glob ending in
*
.auth_type
must be set toec2
orinferred_entity_type
must be set toec2_instance
to use this constraint.- bound
Iam string[]Principal Arns If set, defines the IAM principal that must be authenticated when
auth_type
is set toiam
. Wildcards are supported at the end of the ARN.- bound
Iam string[]Role Arns If set, defines a constraint on the EC2 instances that can perform the login operation that they must match the IAM role ARN specified by this field.
auth_type
must be set toec2
orinferred_entity_type
must be set toec2_instance
to use this constraint.- bound
Regions string[] If set, defines a constraint on the EC2 instances that can perform the login operation that the region in their identity document must match the one specified by this field.
auth_type
must be set toec2
orinferred_entity_type
must be set toec2_instance
to use this constraint.- bound
Subnet string[]Ids If set, defines a constraint on the EC2 instances that can perform the login operation that they be associated with the subnet ID that matches the value specified by this field.
auth_type
must be set toec2
orinferred_entity_type
must be set toec2_instance
to use this constraint.- bound
Vpc string[]Ids If set, defines a constraint on the EC2 instances that can perform the login operation that they be associated with the VPC ID that matches the value specified by this field.
auth_type
must be set toec2
orinferred_entity_type
must be set toec2_instance
to use this constraint.- disallow
Reauthentication boolean IF set to
true
, only allows a single token to be granted per instance ID. This can only be set whenauth_type
is set toec2
.- inferred
Aws stringRegion When
inferred_entity_type
is set, this is the region to search for the inferred entities. Required ifinferred_entity_type
is set. This only applies whenauth_type
is set toiam
.- inferred
Entity stringType If set, instructs Vault to turn on inferencing. The only valid value is
ec2_instance
, which instructs Vault to infer that the role comes from an EC2 instance in an IAM instance profile. This only applies whenauth_type
is set toiam
.- namespace string
The namespace to provision the resource in. The value should not contain leading or trailing forward slashes. The
namespace
is always relative to the provider's configured namespace. Available only for Vault Enterprise.- resolve
Aws booleanUnique Ids Only valid when
auth_type
isiam
. If set totrue
, thebound_iam_principal_arns
are resolved to AWS Unique IDs for the bound principal ARN. This field is ignored when abound_iam_principal_arn
ends in a wildcard. Resolving to unique IDs more closely mimics the behavior of AWS services in that if an IAM user or role is deleted and a new one is recreated with the same name, those new users or roles won't get access to roles in Vault that were permissioned to the prior principals of the same name. Defaults totrue
. Once set totrue
, this cannot be changed tofalse
without recreating the role.- role
Tag string If set, enable role tags for this role. The value set for this field should be the key of the tag on the EC2 instance.
auth_type
must be set toec2
orinferred_entity_type
must be set toec2_instance
to use this constraint.- token
Bound string[]Cidrs 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 numberMax Ttl If set, will encode an explicit max TTL onto the token in number of seconds. This is a hard cap even if
token_ttl
andtoken_max_ttl
would otherwise allow a renewal.- token
Max numberTtl The maximum lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.
- token
No booleanDefault Policy 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 numberUses The maximum number of times a generated token may be used (within its lifetime); 0 means unlimited.
- token
Period 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.
- token
Policies string[] 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 number The incremental lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.
- token
Type string The type of token that should be generated. Can be
service
,batch
, ordefault
to use the mount's tuned default (which unless changed will beservice
tokens). For token store roles, there are two additional possibilities:default-service
anddefault-batch
which specify the type to return unless the client requests a different type at generation time.
- role str
The name of the role.
- allow_
instance_ boolmigration If set to
true
, allows migration of the underlying instance where the client resides.- auth_
type str The auth type permitted for this role. Valid choices are
ec2
andiam
. Defaults toiam
.- backend str
Path to the mounted aws auth backend.
- bound_
account_ Sequence[str]ids If set, defines a constraint on the EC2 instances that can perform the login operation that they should be using the account ID specified by this field.
auth_type
must be set toec2
orinferred_entity_type
must be set toec2_instance
to use this constraint.- bound_
ami_ Sequence[str]ids If set, defines a constraint on the EC2 instances that can perform the login operation that they should be using the AMI ID specified by this field.
auth_type
must be set toec2
orinferred_entity_type
must be set toec2_instance
to use this constraint.- bound_
ec2_ Sequence[str]instance_ ids Only EC2 instances that match this instance ID will be permitted to log in.
- bound_
iam_ Sequence[str]instance_ profile_ arns If set, defines a constraint on the EC2 instances that can perform the login operation that they must be associated with an IAM instance profile ARN which has a prefix that matches the value specified by this field. The value is prefix-matched as though it were a glob ending in
*
.auth_type
must be set toec2
orinferred_entity_type
must be set toec2_instance
to use this constraint.- bound_
iam_ Sequence[str]principal_ arns If set, defines the IAM principal that must be authenticated when
auth_type
is set toiam
. Wildcards are supported at the end of the ARN.- bound_
iam_ Sequence[str]role_ arns If set, defines a constraint on the EC2 instances that can perform the login operation that they must match the IAM role ARN specified by this field.
auth_type
must be set toec2
orinferred_entity_type
must be set toec2_instance
to use this constraint.- bound_
regions Sequence[str] If set, defines a constraint on the EC2 instances that can perform the login operation that the region in their identity document must match the one specified by this field.
auth_type
must be set toec2
orinferred_entity_type
must be set toec2_instance
to use this constraint.- bound_
subnet_ Sequence[str]ids If set, defines a constraint on the EC2 instances that can perform the login operation that they be associated with the subnet ID that matches the value specified by this field.
auth_type
must be set toec2
orinferred_entity_type
must be set toec2_instance
to use this constraint.- bound_
vpc_ Sequence[str]ids If set, defines a constraint on the EC2 instances that can perform the login operation that they be associated with the VPC ID that matches the value specified by this field.
auth_type
must be set toec2
orinferred_entity_type
must be set toec2_instance
to use this constraint.- disallow_
reauthentication bool IF set to
true
, only allows a single token to be granted per instance ID. This can only be set whenauth_type
is set toec2
.- inferred_
aws_ strregion When
inferred_entity_type
is set, this is the region to search for the inferred entities. Required ifinferred_entity_type
is set. This only applies whenauth_type
is set toiam
.- inferred_
entity_ strtype If set, instructs Vault to turn on inferencing. The only valid value is
ec2_instance
, which instructs Vault to infer that the role comes from an EC2 instance in an IAM instance profile. This only applies whenauth_type
is set toiam
.- namespace str
The namespace to provision the resource in. The value should not contain leading or trailing forward slashes. The
namespace
is always relative to the provider's configured namespace. Available only for Vault Enterprise.- resolve_
aws_ boolunique_ ids Only valid when
auth_type
isiam
. If set totrue
, thebound_iam_principal_arns
are resolved to AWS Unique IDs for the bound principal ARN. This field is ignored when abound_iam_principal_arn
ends in a wildcard. Resolving to unique IDs more closely mimics the behavior of AWS services in that if an IAM user or role is deleted and a new one is recreated with the same name, those new users or roles won't get access to roles in Vault that were permissioned to the prior principals of the same name. Defaults totrue
. Once set totrue
, this cannot be changed tofalse
without recreating the role.- role_
tag str If set, enable role tags for this role. The value set for this field should be the key of the tag on the EC2 instance.
auth_type
must be set toec2
orinferred_entity_type
must be set toec2_instance
to use this constraint.- token_
bound_ Sequence[str]cidrs 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_ intmax_ ttl If set, will encode an explicit max TTL onto the token in number of seconds. This is a hard cap even if
token_ttl
andtoken_max_ttl
would otherwise allow a renewal.- token_
max_ intttl The maximum lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.
- token_
no_ booldefault_ policy 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_ intuses The maximum number of times a generated token may be used (within its lifetime); 0 means unlimited.
- 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
, ordefault
to use the mount's tuned default (which unless changed will beservice
tokens). For token store roles, there are two additional possibilities:default-service
anddefault-batch
which specify the type to return unless the client requests a different type at generation time.
- role String
The name of the role.
- allow
Instance BooleanMigration If set to
true
, allows migration of the underlying instance where the client resides.- auth
Type String The auth type permitted for this role. Valid choices are
ec2
andiam
. Defaults toiam
.- backend String
Path to the mounted aws auth backend.
- bound
Account List<String>Ids If set, defines a constraint on the EC2 instances that can perform the login operation that they should be using the account ID specified by this field.
auth_type
must be set toec2
orinferred_entity_type
must be set toec2_instance
to use this constraint.- bound
Ami List<String>Ids If set, defines a constraint on the EC2 instances that can perform the login operation that they should be using the AMI ID specified by this field.
auth_type
must be set toec2
orinferred_entity_type
must be set toec2_instance
to use this constraint.- bound
Ec2Instance List<String>Ids Only EC2 instances that match this instance ID will be permitted to log in.
- bound
Iam List<String>Instance Profile Arns If set, defines a constraint on the EC2 instances that can perform the login operation that they must be associated with an IAM instance profile ARN which has a prefix that matches the value specified by this field. The value is prefix-matched as though it were a glob ending in
*
.auth_type
must be set toec2
orinferred_entity_type
must be set toec2_instance
to use this constraint.- bound
Iam List<String>Principal Arns If set, defines the IAM principal that must be authenticated when
auth_type
is set toiam
. Wildcards are supported at the end of the ARN.- bound
Iam List<String>Role Arns If set, defines a constraint on the EC2 instances that can perform the login operation that they must match the IAM role ARN specified by this field.
auth_type
must be set toec2
orinferred_entity_type
must be set toec2_instance
to use this constraint.- bound
Regions List<String> If set, defines a constraint on the EC2 instances that can perform the login operation that the region in their identity document must match the one specified by this field.
auth_type
must be set toec2
orinferred_entity_type
must be set toec2_instance
to use this constraint.- bound
Subnet List<String>Ids If set, defines a constraint on the EC2 instances that can perform the login operation that they be associated with the subnet ID that matches the value specified by this field.
auth_type
must be set toec2
orinferred_entity_type
must be set toec2_instance
to use this constraint.- bound
Vpc List<String>Ids If set, defines a constraint on the EC2 instances that can perform the login operation that they be associated with the VPC ID that matches the value specified by this field.
auth_type
must be set toec2
orinferred_entity_type
must be set toec2_instance
to use this constraint.- disallow
Reauthentication Boolean IF set to
true
, only allows a single token to be granted per instance ID. This can only be set whenauth_type
is set toec2
.- inferred
Aws StringRegion When
inferred_entity_type
is set, this is the region to search for the inferred entities. Required ifinferred_entity_type
is set. This only applies whenauth_type
is set toiam
.- inferred
Entity StringType If set, instructs Vault to turn on inferencing. The only valid value is
ec2_instance
, which instructs Vault to infer that the role comes from an EC2 instance in an IAM instance profile. This only applies whenauth_type
is set toiam
.- namespace String
The namespace to provision the resource in. The value should not contain leading or trailing forward slashes. The
namespace
is always relative to the provider's configured namespace. Available only for Vault Enterprise.- resolve
Aws BooleanUnique Ids Only valid when
auth_type
isiam
. If set totrue
, thebound_iam_principal_arns
are resolved to AWS Unique IDs for the bound principal ARN. This field is ignored when abound_iam_principal_arn
ends in a wildcard. Resolving to unique IDs more closely mimics the behavior of AWS services in that if an IAM user or role is deleted and a new one is recreated with the same name, those new users or roles won't get access to roles in Vault that were permissioned to the prior principals of the same name. Defaults totrue
. Once set totrue
, this cannot be changed tofalse
without recreating the role.- role
Tag String If set, enable role tags for this role. The value set for this field should be the key of the tag on the EC2 instance.
auth_type
must be set toec2
orinferred_entity_type
must be set toec2_instance
to use this constraint.- token
Bound List<String>Cidrs 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 NumberMax Ttl If set, will encode an explicit max TTL onto the token in number of seconds. This is a hard cap even if
token_ttl
andtoken_max_ttl
would otherwise allow a renewal.- token
Max NumberTtl The maximum lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.
- token
No BooleanDefault Policy 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 NumberUses The maximum number of times a generated token may be used (within its lifetime); 0 means unlimited.
- token
Period 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.
- token
Policies 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.
- token
Ttl Number The incremental lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.
- token
Type String The type of token that should be generated. Can be
service
,batch
, ordefault
to use the mount's tuned default (which unless changed will beservice
tokens). For token store roles, there are two additional possibilities:default-service
anddefault-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:
Look up 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,
allow_instance_migration: Optional[bool] = None,
auth_type: Optional[str] = None,
backend: Optional[str] = None,
bound_account_ids: Optional[Sequence[str]] = None,
bound_ami_ids: Optional[Sequence[str]] = None,
bound_ec2_instance_ids: Optional[Sequence[str]] = None,
bound_iam_instance_profile_arns: Optional[Sequence[str]] = None,
bound_iam_principal_arns: Optional[Sequence[str]] = None,
bound_iam_role_arns: Optional[Sequence[str]] = None,
bound_regions: Optional[Sequence[str]] = None,
bound_subnet_ids: Optional[Sequence[str]] = None,
bound_vpc_ids: Optional[Sequence[str]] = None,
disallow_reauthentication: Optional[bool] = None,
inferred_aws_region: Optional[str] = None,
inferred_entity_type: Optional[str] = None,
namespace: Optional[str] = None,
resolve_aws_unique_ids: Optional[bool] = None,
role: Optional[str] = None,
role_id: Optional[str] = None,
role_tag: 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)
public static AuthBackendRole get(String name, Output<String> id, AuthBackendRoleState 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.
- Allow
Instance boolMigration If set to
true
, allows migration of the underlying instance where the client resides.- Auth
Type string The auth type permitted for this role. Valid choices are
ec2
andiam
. Defaults toiam
.- Backend string
Path to the mounted aws auth backend.
- Bound
Account List<string>Ids If set, defines a constraint on the EC2 instances that can perform the login operation that they should be using the account ID specified by this field.
auth_type
must be set toec2
orinferred_entity_type
must be set toec2_instance
to use this constraint.- Bound
Ami List<string>Ids If set, defines a constraint on the EC2 instances that can perform the login operation that they should be using the AMI ID specified by this field.
auth_type
must be set toec2
orinferred_entity_type
must be set toec2_instance
to use this constraint.- Bound
Ec2Instance List<string>Ids Only EC2 instances that match this instance ID will be permitted to log in.
- Bound
Iam List<string>Instance Profile Arns If set, defines a constraint on the EC2 instances that can perform the login operation that they must be associated with an IAM instance profile ARN which has a prefix that matches the value specified by this field. The value is prefix-matched as though it were a glob ending in
*
.auth_type
must be set toec2
orinferred_entity_type
must be set toec2_instance
to use this constraint.- Bound
Iam List<string>Principal Arns If set, defines the IAM principal that must be authenticated when
auth_type
is set toiam
. Wildcards are supported at the end of the ARN.- Bound
Iam List<string>Role Arns If set, defines a constraint on the EC2 instances that can perform the login operation that they must match the IAM role ARN specified by this field.
auth_type
must be set toec2
orinferred_entity_type
must be set toec2_instance
to use this constraint.- Bound
Regions List<string> If set, defines a constraint on the EC2 instances that can perform the login operation that the region in their identity document must match the one specified by this field.
auth_type
must be set toec2
orinferred_entity_type
must be set toec2_instance
to use this constraint.- Bound
Subnet List<string>Ids If set, defines a constraint on the EC2 instances that can perform the login operation that they be associated with the subnet ID that matches the value specified by this field.
auth_type
must be set toec2
orinferred_entity_type
must be set toec2_instance
to use this constraint.- Bound
Vpc List<string>Ids If set, defines a constraint on the EC2 instances that can perform the login operation that they be associated with the VPC ID that matches the value specified by this field.
auth_type
must be set toec2
orinferred_entity_type
must be set toec2_instance
to use this constraint.- Disallow
Reauthentication bool IF set to
true
, only allows a single token to be granted per instance ID. This can only be set whenauth_type
is set toec2
.- Inferred
Aws stringRegion When
inferred_entity_type
is set, this is the region to search for the inferred entities. Required ifinferred_entity_type
is set. This only applies whenauth_type
is set toiam
.- Inferred
Entity stringType If set, instructs Vault to turn on inferencing. The only valid value is
ec2_instance
, which instructs Vault to infer that the role comes from an EC2 instance in an IAM instance profile. This only applies whenauth_type
is set toiam
.- Namespace string
The namespace to provision the resource in. The value should not contain leading or trailing forward slashes. The
namespace
is always relative to the provider's configured namespace. Available only for Vault Enterprise.- Resolve
Aws boolUnique Ids Only valid when
auth_type
isiam
. If set totrue
, thebound_iam_principal_arns
are resolved to AWS Unique IDs for the bound principal ARN. This field is ignored when abound_iam_principal_arn
ends in a wildcard. Resolving to unique IDs more closely mimics the behavior of AWS services in that if an IAM user or role is deleted and a new one is recreated with the same name, those new users or roles won't get access to roles in Vault that were permissioned to the prior principals of the same name. Defaults totrue
. Once set totrue
, this cannot be changed tofalse
without recreating the role.- Role string
The name of the role.
- Role
Id string The Vault generated role ID.
- Role
Tag string If set, enable role tags for this role. The value set for this field should be the key of the tag on the EC2 instance.
auth_type
must be set toec2
orinferred_entity_type
must be set toec2_instance
to use this constraint.- Token
Bound List<string>Cidrs 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 intMax Ttl If set, will encode an explicit max TTL onto the token in number of seconds. This is a hard cap even if
token_ttl
andtoken_max_ttl
would otherwise allow a renewal.- Token
Max intTtl The maximum lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.
- Token
No boolDefault Policy 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 intUses The maximum number of times a generated token may be used (within its lifetime); 0 means unlimited.
- 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 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.
- Token
Ttl int The incremental lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.
- Token
Type string The type of token that should be generated. Can be
service
,batch
, ordefault
to use the mount's tuned default (which unless changed will beservice
tokens). For token store roles, there are two additional possibilities:default-service
anddefault-batch
which specify the type to return unless the client requests a different type at generation time.
- Allow
Instance boolMigration If set to
true
, allows migration of the underlying instance where the client resides.- Auth
Type string The auth type permitted for this role. Valid choices are
ec2
andiam
. Defaults toiam
.- Backend string
Path to the mounted aws auth backend.
- Bound
Account []stringIds If set, defines a constraint on the EC2 instances that can perform the login operation that they should be using the account ID specified by this field.
auth_type
must be set toec2
orinferred_entity_type
must be set toec2_instance
to use this constraint.- Bound
Ami []stringIds If set, defines a constraint on the EC2 instances that can perform the login operation that they should be using the AMI ID specified by this field.
auth_type
must be set toec2
orinferred_entity_type
must be set toec2_instance
to use this constraint.- Bound
Ec2Instance []stringIds Only EC2 instances that match this instance ID will be permitted to log in.
- Bound
Iam []stringInstance Profile Arns If set, defines a constraint on the EC2 instances that can perform the login operation that they must be associated with an IAM instance profile ARN which has a prefix that matches the value specified by this field. The value is prefix-matched as though it were a glob ending in
*
.auth_type
must be set toec2
orinferred_entity_type
must be set toec2_instance
to use this constraint.- Bound
Iam []stringPrincipal Arns If set, defines the IAM principal that must be authenticated when
auth_type
is set toiam
. Wildcards are supported at the end of the ARN.- Bound
Iam []stringRole Arns If set, defines a constraint on the EC2 instances that can perform the login operation that they must match the IAM role ARN specified by this field.
auth_type
must be set toec2
orinferred_entity_type
must be set toec2_instance
to use this constraint.- Bound
Regions []string If set, defines a constraint on the EC2 instances that can perform the login operation that the region in their identity document must match the one specified by this field.
auth_type
must be set toec2
orinferred_entity_type
must be set toec2_instance
to use this constraint.- Bound
Subnet []stringIds If set, defines a constraint on the EC2 instances that can perform the login operation that they be associated with the subnet ID that matches the value specified by this field.
auth_type
must be set toec2
orinferred_entity_type
must be set toec2_instance
to use this constraint.- Bound
Vpc []stringIds If set, defines a constraint on the EC2 instances that can perform the login operation that they be associated with the VPC ID that matches the value specified by this field.
auth_type
must be set toec2
orinferred_entity_type
must be set toec2_instance
to use this constraint.- Disallow
Reauthentication bool IF set to
true
, only allows a single token to be granted per instance ID. This can only be set whenauth_type
is set toec2
.- Inferred
Aws stringRegion When
inferred_entity_type
is set, this is the region to search for the inferred entities. Required ifinferred_entity_type
is set. This only applies whenauth_type
is set toiam
.- Inferred
Entity stringType If set, instructs Vault to turn on inferencing. The only valid value is
ec2_instance
, which instructs Vault to infer that the role comes from an EC2 instance in an IAM instance profile. This only applies whenauth_type
is set toiam
.- Namespace string
The namespace to provision the resource in. The value should not contain leading or trailing forward slashes. The
namespace
is always relative to the provider's configured namespace. Available only for Vault Enterprise.- Resolve
Aws boolUnique Ids Only valid when
auth_type
isiam
. If set totrue
, thebound_iam_principal_arns
are resolved to AWS Unique IDs for the bound principal ARN. This field is ignored when abound_iam_principal_arn
ends in a wildcard. Resolving to unique IDs more closely mimics the behavior of AWS services in that if an IAM user or role is deleted and a new one is recreated with the same name, those new users or roles won't get access to roles in Vault that were permissioned to the prior principals of the same name. Defaults totrue
. Once set totrue
, this cannot be changed tofalse
without recreating the role.- Role string
The name of the role.
- Role
Id string The Vault generated role ID.
- Role
Tag string If set, enable role tags for this role. The value set for this field should be the key of the tag on the EC2 instance.
auth_type
must be set toec2
orinferred_entity_type
must be set toec2_instance
to use this constraint.- Token
Bound []stringCidrs 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 intMax Ttl If set, will encode an explicit max TTL onto the token in number of seconds. This is a hard cap even if
token_ttl
andtoken_max_ttl
would otherwise allow a renewal.- Token
Max intTtl The maximum lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.
- Token
No boolDefault Policy 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 intUses The maximum number of times a generated token may be used (within its lifetime); 0 means unlimited.
- 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 []string 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 string The type of token that should be generated. Can be
service
,batch
, ordefault
to use the mount's tuned default (which unless changed will beservice
tokens). For token store roles, there are two additional possibilities:default-service
anddefault-batch
which specify the type to return unless the client requests a different type at generation time.
- allow
Instance BooleanMigration If set to
true
, allows migration of the underlying instance where the client resides.- auth
Type String The auth type permitted for this role. Valid choices are
ec2
andiam
. Defaults toiam
.- backend String
Path to the mounted aws auth backend.
- bound
Account List<String>Ids If set, defines a constraint on the EC2 instances that can perform the login operation that they should be using the account ID specified by this field.
auth_type
must be set toec2
orinferred_entity_type
must be set toec2_instance
to use this constraint.- bound
Ami List<String>Ids If set, defines a constraint on the EC2 instances that can perform the login operation that they should be using the AMI ID specified by this field.
auth_type
must be set toec2
orinferred_entity_type
must be set toec2_instance
to use this constraint.- bound
Ec2Instance List<String>Ids Only EC2 instances that match this instance ID will be permitted to log in.
- bound
Iam List<String>Instance Profile Arns If set, defines a constraint on the EC2 instances that can perform the login operation that they must be associated with an IAM instance profile ARN which has a prefix that matches the value specified by this field. The value is prefix-matched as though it were a glob ending in
*
.auth_type
must be set toec2
orinferred_entity_type
must be set toec2_instance
to use this constraint.- bound
Iam List<String>Principal Arns If set, defines the IAM principal that must be authenticated when
auth_type
is set toiam
. Wildcards are supported at the end of the ARN.- bound
Iam List<String>Role Arns If set, defines a constraint on the EC2 instances that can perform the login operation that they must match the IAM role ARN specified by this field.
auth_type
must be set toec2
orinferred_entity_type
must be set toec2_instance
to use this constraint.- bound
Regions List<String> If set, defines a constraint on the EC2 instances that can perform the login operation that the region in their identity document must match the one specified by this field.
auth_type
must be set toec2
orinferred_entity_type
must be set toec2_instance
to use this constraint.- bound
Subnet List<String>Ids If set, defines a constraint on the EC2 instances that can perform the login operation that they be associated with the subnet ID that matches the value specified by this field.
auth_type
must be set toec2
orinferred_entity_type
must be set toec2_instance
to use this constraint.- bound
Vpc List<String>Ids If set, defines a constraint on the EC2 instances that can perform the login operation that they be associated with the VPC ID that matches the value specified by this field.
auth_type
must be set toec2
orinferred_entity_type
must be set toec2_instance
to use this constraint.- disallow
Reauthentication Boolean IF set to
true
, only allows a single token to be granted per instance ID. This can only be set whenauth_type
is set toec2
.- inferred
Aws StringRegion When
inferred_entity_type
is set, this is the region to search for the inferred entities. Required ifinferred_entity_type
is set. This only applies whenauth_type
is set toiam
.- inferred
Entity StringType If set, instructs Vault to turn on inferencing. The only valid value is
ec2_instance
, which instructs Vault to infer that the role comes from an EC2 instance in an IAM instance profile. This only applies whenauth_type
is set toiam
.- namespace String
The namespace to provision the resource in. The value should not contain leading or trailing forward slashes. The
namespace
is always relative to the provider's configured namespace. Available only for Vault Enterprise.- resolve
Aws BooleanUnique Ids Only valid when
auth_type
isiam
. If set totrue
, thebound_iam_principal_arns
are resolved to AWS Unique IDs for the bound principal ARN. This field is ignored when abound_iam_principal_arn
ends in a wildcard. Resolving to unique IDs more closely mimics the behavior of AWS services in that if an IAM user or role is deleted and a new one is recreated with the same name, those new users or roles won't get access to roles in Vault that were permissioned to the prior principals of the same name. Defaults totrue
. Once set totrue
, this cannot be changed tofalse
without recreating the role.- role String
The name of the role.
- role
Id String The Vault generated role ID.
- role
Tag String If set, enable role tags for this role. The value set for this field should be the key of the tag on the EC2 instance.
auth_type
must be set toec2
orinferred_entity_type
must be set toec2_instance
to use this constraint.- token
Bound List<String>Cidrs 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 IntegerMax Ttl If set, will encode an explicit max TTL onto the token in number of seconds. This is a hard cap even if
token_ttl
andtoken_max_ttl
would otherwise allow a renewal.- token
Max IntegerTtl The maximum lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.
- token
No BooleanDefault Policy 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 IntegerUses The maximum number of times a generated token may be used (within its lifetime); 0 means unlimited.
- token
Period Integer 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 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.
- token
Ttl Integer The incremental lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.
- token
Type String The type of token that should be generated. Can be
service
,batch
, ordefault
to use the mount's tuned default (which unless changed will beservice
tokens). For token store roles, there are two additional possibilities:default-service
anddefault-batch
which specify the type to return unless the client requests a different type at generation time.
- allow
Instance booleanMigration If set to
true
, allows migration of the underlying instance where the client resides.- auth
Type string The auth type permitted for this role. Valid choices are
ec2
andiam
. Defaults toiam
.- backend string
Path to the mounted aws auth backend.
- bound
Account string[]Ids If set, defines a constraint on the EC2 instances that can perform the login operation that they should be using the account ID specified by this field.
auth_type
must be set toec2
orinferred_entity_type
must be set toec2_instance
to use this constraint.- bound
Ami string[]Ids If set, defines a constraint on the EC2 instances that can perform the login operation that they should be using the AMI ID specified by this field.
auth_type
must be set toec2
orinferred_entity_type
must be set toec2_instance
to use this constraint.- bound
Ec2Instance string[]Ids Only EC2 instances that match this instance ID will be permitted to log in.
- bound
Iam string[]Instance Profile Arns If set, defines a constraint on the EC2 instances that can perform the login operation that they must be associated with an IAM instance profile ARN which has a prefix that matches the value specified by this field. The value is prefix-matched as though it were a glob ending in
*
.auth_type
must be set toec2
orinferred_entity_type
must be set toec2_instance
to use this constraint.- bound
Iam string[]Principal Arns If set, defines the IAM principal that must be authenticated when
auth_type
is set toiam
. Wildcards are supported at the end of the ARN.- bound
Iam string[]Role Arns If set, defines a constraint on the EC2 instances that can perform the login operation that they must match the IAM role ARN specified by this field.
auth_type
must be set toec2
orinferred_entity_type
must be set toec2_instance
to use this constraint.- bound
Regions string[] If set, defines a constraint on the EC2 instances that can perform the login operation that the region in their identity document must match the one specified by this field.
auth_type
must be set toec2
orinferred_entity_type
must be set toec2_instance
to use this constraint.- bound
Subnet string[]Ids If set, defines a constraint on the EC2 instances that can perform the login operation that they be associated with the subnet ID that matches the value specified by this field.
auth_type
must be set toec2
orinferred_entity_type
must be set toec2_instance
to use this constraint.- bound
Vpc string[]Ids If set, defines a constraint on the EC2 instances that can perform the login operation that they be associated with the VPC ID that matches the value specified by this field.
auth_type
must be set toec2
orinferred_entity_type
must be set toec2_instance
to use this constraint.- disallow
Reauthentication boolean IF set to
true
, only allows a single token to be granted per instance ID. This can only be set whenauth_type
is set toec2
.- inferred
Aws stringRegion When
inferred_entity_type
is set, this is the region to search for the inferred entities. Required ifinferred_entity_type
is set. This only applies whenauth_type
is set toiam
.- inferred
Entity stringType If set, instructs Vault to turn on inferencing. The only valid value is
ec2_instance
, which instructs Vault to infer that the role comes from an EC2 instance in an IAM instance profile. This only applies whenauth_type
is set toiam
.- namespace string
The namespace to provision the resource in. The value should not contain leading or trailing forward slashes. The
namespace
is always relative to the provider's configured namespace. Available only for Vault Enterprise.- resolve
Aws booleanUnique Ids Only valid when
auth_type
isiam
. If set totrue
, thebound_iam_principal_arns
are resolved to AWS Unique IDs for the bound principal ARN. This field is ignored when abound_iam_principal_arn
ends in a wildcard. Resolving to unique IDs more closely mimics the behavior of AWS services in that if an IAM user or role is deleted and a new one is recreated with the same name, those new users or roles won't get access to roles in Vault that were permissioned to the prior principals of the same name. Defaults totrue
. Once set totrue
, this cannot be changed tofalse
without recreating the role.- role string
The name of the role.
- role
Id string The Vault generated role ID.
- role
Tag string If set, enable role tags for this role. The value set for this field should be the key of the tag on the EC2 instance.
auth_type
must be set toec2
orinferred_entity_type
must be set toec2_instance
to use this constraint.- token
Bound string[]Cidrs 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 numberMax Ttl If set, will encode an explicit max TTL onto the token in number of seconds. This is a hard cap even if
token_ttl
andtoken_max_ttl
would otherwise allow a renewal.- token
Max numberTtl The maximum lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.
- token
No booleanDefault Policy 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 numberUses The maximum number of times a generated token may be used (within its lifetime); 0 means unlimited.
- token
Period 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.
- token
Policies string[] 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 number The incremental lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.
- token
Type string The type of token that should be generated. Can be
service
,batch
, ordefault
to use the mount's tuned default (which unless changed will beservice
tokens). For token store roles, there are two additional possibilities:default-service
anddefault-batch
which specify the type to return unless the client requests a different type at generation time.
- allow_
instance_ boolmigration If set to
true
, allows migration of the underlying instance where the client resides.- auth_
type str The auth type permitted for this role. Valid choices are
ec2
andiam
. Defaults toiam
.- backend str
Path to the mounted aws auth backend.
- bound_
account_ Sequence[str]ids If set, defines a constraint on the EC2 instances that can perform the login operation that they should be using the account ID specified by this field.
auth_type
must be set toec2
orinferred_entity_type
must be set toec2_instance
to use this constraint.- bound_
ami_ Sequence[str]ids If set, defines a constraint on the EC2 instances that can perform the login operation that they should be using the AMI ID specified by this field.
auth_type
must be set toec2
orinferred_entity_type
must be set toec2_instance
to use this constraint.- bound_
ec2_ Sequence[str]instance_ ids Only EC2 instances that match this instance ID will be permitted to log in.
- bound_
iam_ Sequence[str]instance_ profile_ arns If set, defines a constraint on the EC2 instances that can perform the login operation that they must be associated with an IAM instance profile ARN which has a prefix that matches the value specified by this field. The value is prefix-matched as though it were a glob ending in
*
.auth_type
must be set toec2
orinferred_entity_type
must be set toec2_instance
to use this constraint.- bound_
iam_ Sequence[str]principal_ arns If set, defines the IAM principal that must be authenticated when
auth_type
is set toiam
. Wildcards are supported at the end of the ARN.- bound_
iam_ Sequence[str]role_ arns If set, defines a constraint on the EC2 instances that can perform the login operation that they must match the IAM role ARN specified by this field.
auth_type
must be set toec2
orinferred_entity_type
must be set toec2_instance
to use this constraint.- bound_
regions Sequence[str] If set, defines a constraint on the EC2 instances that can perform the login operation that the region in their identity document must match the one specified by this field.
auth_type
must be set toec2
orinferred_entity_type
must be set toec2_instance
to use this constraint.- bound_
subnet_ Sequence[str]ids If set, defines a constraint on the EC2 instances that can perform the login operation that they be associated with the subnet ID that matches the value specified by this field.
auth_type
must be set toec2
orinferred_entity_type
must be set toec2_instance
to use this constraint.- bound_
vpc_ Sequence[str]ids If set, defines a constraint on the EC2 instances that can perform the login operation that they be associated with the VPC ID that matches the value specified by this field.
auth_type
must be set toec2
orinferred_entity_type
must be set toec2_instance
to use this constraint.- disallow_
reauthentication bool IF set to
true
, only allows a single token to be granted per instance ID. This can only be set whenauth_type
is set toec2
.- inferred_
aws_ strregion When
inferred_entity_type
is set, this is the region to search for the inferred entities. Required ifinferred_entity_type
is set. This only applies whenauth_type
is set toiam
.- inferred_
entity_ strtype If set, instructs Vault to turn on inferencing. The only valid value is
ec2_instance
, which instructs Vault to infer that the role comes from an EC2 instance in an IAM instance profile. This only applies whenauth_type
is set toiam
.- namespace str
The namespace to provision the resource in. The value should not contain leading or trailing forward slashes. The
namespace
is always relative to the provider's configured namespace. Available only for Vault Enterprise.- resolve_
aws_ boolunique_ ids Only valid when
auth_type
isiam
. If set totrue
, thebound_iam_principal_arns
are resolved to AWS Unique IDs for the bound principal ARN. This field is ignored when abound_iam_principal_arn
ends in a wildcard. Resolving to unique IDs more closely mimics the behavior of AWS services in that if an IAM user or role is deleted and a new one is recreated with the same name, those new users or roles won't get access to roles in Vault that were permissioned to the prior principals of the same name. Defaults totrue
. Once set totrue
, this cannot be changed tofalse
without recreating the role.- role str
The name of the role.
- role_
id str The Vault generated role ID.
- role_
tag str If set, enable role tags for this role. The value set for this field should be the key of the tag on the EC2 instance.
auth_type
must be set toec2
orinferred_entity_type
must be set toec2_instance
to use this constraint.- token_
bound_ Sequence[str]cidrs 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_ intmax_ ttl If set, will encode an explicit max TTL onto the token in number of seconds. This is a hard cap even if
token_ttl
andtoken_max_ttl
would otherwise allow a renewal.- token_
max_ intttl The maximum lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.
- token_
no_ booldefault_ policy 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_ intuses The maximum number of times a generated token may be used (within its lifetime); 0 means unlimited.
- 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
, ordefault
to use the mount's tuned default (which unless changed will beservice
tokens). For token store roles, there are two additional possibilities:default-service
anddefault-batch
which specify the type to return unless the client requests a different type at generation time.
- allow
Instance BooleanMigration If set to
true
, allows migration of the underlying instance where the client resides.- auth
Type String The auth type permitted for this role. Valid choices are
ec2
andiam
. Defaults toiam
.- backend String
Path to the mounted aws auth backend.
- bound
Account List<String>Ids If set, defines a constraint on the EC2 instances that can perform the login operation that they should be using the account ID specified by this field.
auth_type
must be set toec2
orinferred_entity_type
must be set toec2_instance
to use this constraint.- bound
Ami List<String>Ids If set, defines a constraint on the EC2 instances that can perform the login operation that they should be using the AMI ID specified by this field.
auth_type
must be set toec2
orinferred_entity_type
must be set toec2_instance
to use this constraint.- bound
Ec2Instance List<String>Ids Only EC2 instances that match this instance ID will be permitted to log in.
- bound
Iam List<String>Instance Profile Arns If set, defines a constraint on the EC2 instances that can perform the login operation that they must be associated with an IAM instance profile ARN which has a prefix that matches the value specified by this field. The value is prefix-matched as though it were a glob ending in
*
.auth_type
must be set toec2
orinferred_entity_type
must be set toec2_instance
to use this constraint.- bound
Iam List<String>Principal Arns If set, defines the IAM principal that must be authenticated when
auth_type
is set toiam
. Wildcards are supported at the end of the ARN.- bound
Iam List<String>Role Arns If set, defines a constraint on the EC2 instances that can perform the login operation that they must match the IAM role ARN specified by this field.
auth_type
must be set toec2
orinferred_entity_type
must be set toec2_instance
to use this constraint.- bound
Regions List<String> If set, defines a constraint on the EC2 instances that can perform the login operation that the region in their identity document must match the one specified by this field.
auth_type
must be set toec2
orinferred_entity_type
must be set toec2_instance
to use this constraint.- bound
Subnet List<String>Ids If set, defines a constraint on the EC2 instances that can perform the login operation that they be associated with the subnet ID that matches the value specified by this field.
auth_type
must be set toec2
orinferred_entity_type
must be set toec2_instance
to use this constraint.- bound
Vpc List<String>Ids If set, defines a constraint on the EC2 instances that can perform the login operation that they be associated with the VPC ID that matches the value specified by this field.
auth_type
must be set toec2
orinferred_entity_type
must be set toec2_instance
to use this constraint.- disallow
Reauthentication Boolean IF set to
true
, only allows a single token to be granted per instance ID. This can only be set whenauth_type
is set toec2
.- inferred
Aws StringRegion When
inferred_entity_type
is set, this is the region to search for the inferred entities. Required ifinferred_entity_type
is set. This only applies whenauth_type
is set toiam
.- inferred
Entity StringType If set, instructs Vault to turn on inferencing. The only valid value is
ec2_instance
, which instructs Vault to infer that the role comes from an EC2 instance in an IAM instance profile. This only applies whenauth_type
is set toiam
.- namespace String
The namespace to provision the resource in. The value should not contain leading or trailing forward slashes. The
namespace
is always relative to the provider's configured namespace. Available only for Vault Enterprise.- resolve
Aws BooleanUnique Ids Only valid when
auth_type
isiam
. If set totrue
, thebound_iam_principal_arns
are resolved to AWS Unique IDs for the bound principal ARN. This field is ignored when abound_iam_principal_arn
ends in a wildcard. Resolving to unique IDs more closely mimics the behavior of AWS services in that if an IAM user or role is deleted and a new one is recreated with the same name, those new users or roles won't get access to roles in Vault that were permissioned to the prior principals of the same name. Defaults totrue
. Once set totrue
, this cannot be changed tofalse
without recreating the role.- role String
The name of the role.
- role
Id String The Vault generated role ID.
- role
Tag String If set, enable role tags for this role. The value set for this field should be the key of the tag on the EC2 instance.
auth_type
must be set toec2
orinferred_entity_type
must be set toec2_instance
to use this constraint.- token
Bound List<String>Cidrs 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 NumberMax Ttl If set, will encode an explicit max TTL onto the token in number of seconds. This is a hard cap even if
token_ttl
andtoken_max_ttl
would otherwise allow a renewal.- token
Max NumberTtl The maximum lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.
- token
No BooleanDefault Policy 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 NumberUses The maximum number of times a generated token may be used (within its lifetime); 0 means unlimited.
- token
Period 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.
- token
Policies 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.
- token
Ttl Number The incremental lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.
- token
Type String The type of token that should be generated. Can be
service
,batch
, ordefault
to use the mount's tuned default (which unless changed will beservice
tokens). For token store roles, there are two additional possibilities:default-service
anddefault-batch
which specify the type to return unless the client requests a different type at generation time.
Import
AWS auth backend roles can be imported using auth/
, the backend
path, /role/
, and the role
name e.g.
$ pulumi import vault:aws/authBackendRole:AuthBackendRole example auth/aws/role/test-role
Package Details
- Repository
- Vault pulumi/pulumi-vault
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
vault
Terraform Provider.