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
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",
    ],
});
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",
    ])
package main
import (
	"github.com/pulumi/pulumi-vault/sdk/v6/go/vault"
	"github.com/pulumi/pulumi-vault/sdk/v6/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
	})
}
using System.Collections.Generic;
using System.Linq;
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 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());
    }
}
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
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new AuthBackendRole(name: string, args: AuthBackendRoleArgs, opts?: CustomResourceOptions);@overload
def AuthBackendRole(resource_name: str,
                    args: AuthBackendRoleArgs,
                    opts: Optional[ResourceOptions] = None)
@overload
def AuthBackendRole(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    role: Optional[str] = None,
                    inferred_entity_type: Optional[str] = None,
                    token_policies: Optional[Sequence[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,
                    namespace: Optional[str] = None,
                    backend: Optional[str] = None,
                    inferred_aws_region: Optional[str] = None,
                    disallow_reauthentication: Optional[bool] = None,
                    resolve_aws_unique_ids: Optional[bool] = None,
                    auth_type: 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,
                    allow_instance_migration: Optional[bool] = None,
                    token_ttl: Optional[int] = None,
                    token_type: Optional[str] = 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.
Parameters
- 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.
Constructor example
The following reference example uses placeholder values for all input properties.
var exampleauthBackendRoleResourceResourceFromAwsauthBackendRole = new Vault.Aws.AuthBackendRole("exampleauthBackendRoleResourceResourceFromAwsauthBackendRole", new()
{
    Role = "string",
    InferredEntityType = "string",
    TokenPolicies = new[]
    {
        "string",
    },
    BoundAccountIds = new[]
    {
        "string",
    },
    BoundAmiIds = new[]
    {
        "string",
    },
    BoundEc2InstanceIds = new[]
    {
        "string",
    },
    BoundIamInstanceProfileArns = new[]
    {
        "string",
    },
    BoundIamPrincipalArns = new[]
    {
        "string",
    },
    BoundIamRoleArns = new[]
    {
        "string",
    },
    BoundRegions = new[]
    {
        "string",
    },
    BoundSubnetIds = new[]
    {
        "string",
    },
    BoundVpcIds = new[]
    {
        "string",
    },
    Namespace = "string",
    Backend = "string",
    InferredAwsRegion = "string",
    DisallowReauthentication = false,
    ResolveAwsUniqueIds = false,
    AuthType = "string",
    RoleTag = "string",
    TokenBoundCidrs = new[]
    {
        "string",
    },
    TokenExplicitMaxTtl = 0,
    TokenMaxTtl = 0,
    TokenNoDefaultPolicy = false,
    TokenNumUses = 0,
    TokenPeriod = 0,
    AllowInstanceMigration = false,
    TokenTtl = 0,
    TokenType = "string",
});
example, err := aws.NewAuthBackendRole(ctx, "exampleauthBackendRoleResourceResourceFromAwsauthBackendRole", &aws.AuthBackendRoleArgs{
	Role:               pulumi.String("string"),
	InferredEntityType: pulumi.String("string"),
	TokenPolicies: pulumi.StringArray{
		pulumi.String("string"),
	},
	BoundAccountIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	BoundAmiIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	BoundEc2InstanceIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	BoundIamInstanceProfileArns: pulumi.StringArray{
		pulumi.String("string"),
	},
	BoundIamPrincipalArns: pulumi.StringArray{
		pulumi.String("string"),
	},
	BoundIamRoleArns: pulumi.StringArray{
		pulumi.String("string"),
	},
	BoundRegions: pulumi.StringArray{
		pulumi.String("string"),
	},
	BoundSubnetIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	BoundVpcIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	Namespace:                pulumi.String("string"),
	Backend:                  pulumi.String("string"),
	InferredAwsRegion:        pulumi.String("string"),
	DisallowReauthentication: pulumi.Bool(false),
	ResolveAwsUniqueIds:      pulumi.Bool(false),
	AuthType:                 pulumi.String("string"),
	RoleTag:                  pulumi.String("string"),
	TokenBoundCidrs: pulumi.StringArray{
		pulumi.String("string"),
	},
	TokenExplicitMaxTtl:    pulumi.Int(0),
	TokenMaxTtl:            pulumi.Int(0),
	TokenNoDefaultPolicy:   pulumi.Bool(false),
	TokenNumUses:           pulumi.Int(0),
	TokenPeriod:            pulumi.Int(0),
	AllowInstanceMigration: pulumi.Bool(false),
	TokenTtl:               pulumi.Int(0),
	TokenType:              pulumi.String("string"),
})
var exampleauthBackendRoleResourceResourceFromAwsauthBackendRole = new com.pulumi.vault.aws.AuthBackendRole("exampleauthBackendRoleResourceResourceFromAwsauthBackendRole", com.pulumi.vault.aws.AuthBackendRoleArgs.builder()
    .role("string")
    .inferredEntityType("string")
    .tokenPolicies("string")
    .boundAccountIds("string")
    .boundAmiIds("string")
    .boundEc2InstanceIds("string")
    .boundIamInstanceProfileArns("string")
    .boundIamPrincipalArns("string")
    .boundIamRoleArns("string")
    .boundRegions("string")
    .boundSubnetIds("string")
    .boundVpcIds("string")
    .namespace("string")
    .backend("string")
    .inferredAwsRegion("string")
    .disallowReauthentication(false)
    .resolveAwsUniqueIds(false)
    .authType("string")
    .roleTag("string")
    .tokenBoundCidrs("string")
    .tokenExplicitMaxTtl(0)
    .tokenMaxTtl(0)
    .tokenNoDefaultPolicy(false)
    .tokenNumUses(0)
    .tokenPeriod(0)
    .allowInstanceMigration(false)
    .tokenTtl(0)
    .tokenType("string")
    .build());
exampleauth_backend_role_resource_resource_from_awsauth_backend_role = vault.aws.AuthBackendRole("exampleauthBackendRoleResourceResourceFromAwsauthBackendRole",
    role="string",
    inferred_entity_type="string",
    token_policies=["string"],
    bound_account_ids=["string"],
    bound_ami_ids=["string"],
    bound_ec2_instance_ids=["string"],
    bound_iam_instance_profile_arns=["string"],
    bound_iam_principal_arns=["string"],
    bound_iam_role_arns=["string"],
    bound_regions=["string"],
    bound_subnet_ids=["string"],
    bound_vpc_ids=["string"],
    namespace="string",
    backend="string",
    inferred_aws_region="string",
    disallow_reauthentication=False,
    resolve_aws_unique_ids=False,
    auth_type="string",
    role_tag="string",
    token_bound_cidrs=["string"],
    token_explicit_max_ttl=0,
    token_max_ttl=0,
    token_no_default_policy=False,
    token_num_uses=0,
    token_period=0,
    allow_instance_migration=False,
    token_ttl=0,
    token_type="string")
const exampleauthBackendRoleResourceResourceFromAwsauthBackendRole = new vault.aws.AuthBackendRole("exampleauthBackendRoleResourceResourceFromAwsauthBackendRole", {
    role: "string",
    inferredEntityType: "string",
    tokenPolicies: ["string"],
    boundAccountIds: ["string"],
    boundAmiIds: ["string"],
    boundEc2InstanceIds: ["string"],
    boundIamInstanceProfileArns: ["string"],
    boundIamPrincipalArns: ["string"],
    boundIamRoleArns: ["string"],
    boundRegions: ["string"],
    boundSubnetIds: ["string"],
    boundVpcIds: ["string"],
    namespace: "string",
    backend: "string",
    inferredAwsRegion: "string",
    disallowReauthentication: false,
    resolveAwsUniqueIds: false,
    authType: "string",
    roleTag: "string",
    tokenBoundCidrs: ["string"],
    tokenExplicitMaxTtl: 0,
    tokenMaxTtl: 0,
    tokenNoDefaultPolicy: false,
    tokenNumUses: 0,
    tokenPeriod: 0,
    allowInstanceMigration: false,
    tokenTtl: 0,
    tokenType: "string",
});
type: vault:aws:AuthBackendRole
properties:
    allowInstanceMigration: false
    authType: string
    backend: string
    boundAccountIds:
        - string
    boundAmiIds:
        - string
    boundEc2InstanceIds:
        - string
    boundIamInstanceProfileArns:
        - string
    boundIamPrincipalArns:
        - string
    boundIamRoleArns:
        - string
    boundRegions:
        - string
    boundSubnetIds:
        - string
    boundVpcIds:
        - string
    disallowReauthentication: false
    inferredAwsRegion: string
    inferredEntityType: string
    namespace: string
    resolveAwsUniqueIds: false
    role: string
    roleTag: string
    tokenBoundCidrs:
        - string
    tokenExplicitMaxTtl: 0
    tokenMaxTtl: 0
    tokenNoDefaultPolicy: false
    tokenNumUses: 0
    tokenPeriod: 0
    tokenPolicies:
        - string
    tokenTtl: 0
    tokenType: string
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
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The AuthBackendRole resource accepts the following input properties:
- Role string
- The name of the role.
- AllowInstance boolMigration 
- If set to true, allows migration of the underlying instance where the client resides.
- AuthType string
- The auth type permitted for this role. Valid choices
are ec2andiam. Defaults toiam.
- Backend string
- Path to the mounted aws auth backend.
- BoundAccount 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_typemust be set toec2orinferred_entity_typemust be set toec2_instanceto use this constraint.
- BoundAmi 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_typemust be set toec2orinferred_entity_typemust be set toec2_instanceto use this constraint.
- BoundEc2Instance List<string>Ids 
- Only EC2 instances that match this instance ID will be permitted to log in.
- BoundIam 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_typemust be set toec2orinferred_entity_typemust be set toec2_instanceto use this constraint.
- BoundIam List<string>Principal Arns 
- If set, defines the IAM principal that
must be authenticated when auth_typeis set toiam. Wildcards are supported at the end of the ARN.
- BoundIam 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_typemust be set toec2orinferred_entity_typemust be set toec2_instanceto use this constraint.
- BoundRegions 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_typemust be set toec2orinferred_entity_typemust be set toec2_instanceto use this constraint.
- BoundSubnet 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_typemust be set toec2orinferred_entity_typemust be set toec2_instanceto use this constraint.
- BoundVpc 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_typemust be set toec2orinferred_entity_typemust be set toec2_instanceto use this constraint.
- DisallowReauthentication bool
- IF set to true, only allows a single token to be granted per instance ID. This can only be set whenauth_typeis set toec2.
- InferredAws stringRegion 
- When inferred_entity_typeis set, this is the region to search for the inferred entities. Required ifinferred_entity_typeis set. This only applies whenauth_typeis set toiam.
- InferredEntity 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_typeis set toiam.
- Namespace string
- The namespace to provision the resource in.
The value should not contain leading or trailing forward slashes.
The namespaceis always relative to the provider's configured namespace. Available only for Vault Enterprise.
- ResolveAws boolUnique Ids 
- Only valid when
auth_typeisiam. If set totrue, thebound_iam_principal_arnsare resolved to AWS Unique IDs for the bound principal ARN. This field is ignored when abound_iam_principal_arnends 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 tofalsewithout recreating the role.
- RoleTag 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_typemust be set toec2orinferred_entity_typemust be set toec2_instanceto use this constraint.
- TokenBound List<string>Cidrs 
- Specifies the blocks of IP addresses which are allowed to use the generated token
- TokenExplicit intMax Ttl 
- Generated Token's Explicit Maximum TTL in seconds
- TokenMax intTtl 
- The maximum lifetime of the generated token
- TokenNo boolDefault Policy 
- If true, the 'default' policy will not automatically be added to generated tokens
- TokenNum intUses 
- The maximum number of times a token may be used, a value of zero means unlimited
- TokenPeriod int
- Generated Token's Period
- TokenPolicies List<string>
- Generated Token's Policies
- TokenTtl int
- The initial ttl of the token to generate in seconds
- TokenType string
- The type of token to generate, service or batch
- Role string
- The name of the role.
- AllowInstance boolMigration 
- If set to true, allows migration of the underlying instance where the client resides.
- AuthType string
- The auth type permitted for this role. Valid choices
are ec2andiam. Defaults toiam.
- Backend string
- Path to the mounted aws auth backend.
- BoundAccount []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_typemust be set toec2orinferred_entity_typemust be set toec2_instanceto use this constraint.
- BoundAmi []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_typemust be set toec2orinferred_entity_typemust be set toec2_instanceto use this constraint.
- BoundEc2Instance []stringIds 
- Only EC2 instances that match this instance ID will be permitted to log in.
- BoundIam []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_typemust be set toec2orinferred_entity_typemust be set toec2_instanceto use this constraint.
- BoundIam []stringPrincipal Arns 
- If set, defines the IAM principal that
must be authenticated when auth_typeis set toiam. Wildcards are supported at the end of the ARN.
- BoundIam []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_typemust be set toec2orinferred_entity_typemust be set toec2_instanceto use this constraint.
- BoundRegions []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_typemust be set toec2orinferred_entity_typemust be set toec2_instanceto use this constraint.
- BoundSubnet []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_typemust be set toec2orinferred_entity_typemust be set toec2_instanceto use this constraint.
- BoundVpc []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_typemust be set toec2orinferred_entity_typemust be set toec2_instanceto use this constraint.
- DisallowReauthentication bool
- IF set to true, only allows a single token to be granted per instance ID. This can only be set whenauth_typeis set toec2.
- InferredAws stringRegion 
- When inferred_entity_typeis set, this is the region to search for the inferred entities. Required ifinferred_entity_typeis set. This only applies whenauth_typeis set toiam.
- InferredEntity 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_typeis set toiam.
- Namespace string
- The namespace to provision the resource in.
The value should not contain leading or trailing forward slashes.
The namespaceis always relative to the provider's configured namespace. Available only for Vault Enterprise.
- ResolveAws boolUnique Ids 
- Only valid when
auth_typeisiam. If set totrue, thebound_iam_principal_arnsare resolved to AWS Unique IDs for the bound principal ARN. This field is ignored when abound_iam_principal_arnends 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 tofalsewithout recreating the role.
- RoleTag 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_typemust be set toec2orinferred_entity_typemust be set toec2_instanceto use this constraint.
- TokenBound []stringCidrs 
- Specifies the blocks of IP addresses which are allowed to use the generated token
- TokenExplicit intMax Ttl 
- Generated Token's Explicit Maximum TTL in seconds
- TokenMax intTtl 
- The maximum lifetime of the generated token
- TokenNo boolDefault Policy 
- If true, the 'default' policy will not automatically be added to generated tokens
- TokenNum intUses 
- The maximum number of times a token may be used, a value of zero means unlimited
- TokenPeriod int
- Generated Token's Period
- TokenPolicies []string
- Generated Token's Policies
- TokenTtl int
- The initial ttl of the token to generate in seconds
- TokenType string
- The type of token to generate, service or batch
- role String
- The name of the role.
- allowInstance BooleanMigration 
- If set to true, allows migration of the underlying instance where the client resides.
- authType String
- The auth type permitted for this role. Valid choices
are ec2andiam. Defaults toiam.
- backend String
- Path to the mounted aws auth backend.
- boundAccount 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_typemust be set toec2orinferred_entity_typemust be set toec2_instanceto use this constraint.
- boundAmi 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_typemust be set toec2orinferred_entity_typemust be set toec2_instanceto use this constraint.
- boundEc2Instance List<String>Ids 
- Only EC2 instances that match this instance ID will be permitted to log in.
- boundIam 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_typemust be set toec2orinferred_entity_typemust be set toec2_instanceto use this constraint.
- boundIam List<String>Principal Arns 
- If set, defines the IAM principal that
must be authenticated when auth_typeis set toiam. Wildcards are supported at the end of the ARN.
- boundIam 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_typemust be set toec2orinferred_entity_typemust be set toec2_instanceto use this constraint.
- boundRegions 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_typemust be set toec2orinferred_entity_typemust be set toec2_instanceto use this constraint.
- boundSubnet 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_typemust be set toec2orinferred_entity_typemust be set toec2_instanceto use this constraint.
- boundVpc 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_typemust be set toec2orinferred_entity_typemust be set toec2_instanceto use this constraint.
- disallowReauthentication Boolean
- IF set to true, only allows a single token to be granted per instance ID. This can only be set whenauth_typeis set toec2.
- inferredAws StringRegion 
- When inferred_entity_typeis set, this is the region to search for the inferred entities. Required ifinferred_entity_typeis set. This only applies whenauth_typeis set toiam.
- inferredEntity 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_typeis set toiam.
- namespace String
- The namespace to provision the resource in.
The value should not contain leading or trailing forward slashes.
The namespaceis always relative to the provider's configured namespace. Available only for Vault Enterprise.
- resolveAws BooleanUnique Ids 
- Only valid when
auth_typeisiam. If set totrue, thebound_iam_principal_arnsare resolved to AWS Unique IDs for the bound principal ARN. This field is ignored when abound_iam_principal_arnends 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 tofalsewithout recreating the role.
- roleTag 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_typemust be set toec2orinferred_entity_typemust be set toec2_instanceto use this constraint.
- tokenBound List<String>Cidrs 
- Specifies the blocks of IP addresses which are allowed to use the generated token
- tokenExplicit IntegerMax Ttl 
- Generated Token's Explicit Maximum TTL in seconds
- tokenMax IntegerTtl 
- The maximum lifetime of the generated token
- tokenNo BooleanDefault Policy 
- If true, the 'default' policy will not automatically be added to generated tokens
- tokenNum IntegerUses 
- The maximum number of times a token may be used, a value of zero means unlimited
- tokenPeriod Integer
- Generated Token's Period
- tokenPolicies List<String>
- Generated Token's Policies
- tokenTtl Integer
- The initial ttl of the token to generate in seconds
- tokenType String
- The type of token to generate, service or batch
- role string
- The name of the role.
- allowInstance booleanMigration 
- If set to true, allows migration of the underlying instance where the client resides.
- authType string
- The auth type permitted for this role. Valid choices
are ec2andiam. Defaults toiam.
- backend string
- Path to the mounted aws auth backend.
- boundAccount 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_typemust be set toec2orinferred_entity_typemust be set toec2_instanceto use this constraint.
- boundAmi 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_typemust be set toec2orinferred_entity_typemust be set toec2_instanceto use this constraint.
- boundEc2Instance string[]Ids 
- Only EC2 instances that match this instance ID will be permitted to log in.
- boundIam 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_typemust be set toec2orinferred_entity_typemust be set toec2_instanceto use this constraint.
- boundIam string[]Principal Arns 
- If set, defines the IAM principal that
must be authenticated when auth_typeis set toiam. Wildcards are supported at the end of the ARN.
- boundIam 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_typemust be set toec2orinferred_entity_typemust be set toec2_instanceto use this constraint.
- boundRegions 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_typemust be set toec2orinferred_entity_typemust be set toec2_instanceto use this constraint.
- boundSubnet 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_typemust be set toec2orinferred_entity_typemust be set toec2_instanceto use this constraint.
- boundVpc 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_typemust be set toec2orinferred_entity_typemust be set toec2_instanceto use this constraint.
- disallowReauthentication boolean
- IF set to true, only allows a single token to be granted per instance ID. This can only be set whenauth_typeis set toec2.
- inferredAws stringRegion 
- When inferred_entity_typeis set, this is the region to search for the inferred entities. Required ifinferred_entity_typeis set. This only applies whenauth_typeis set toiam.
- inferredEntity 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_typeis set toiam.
- namespace string
- The namespace to provision the resource in.
The value should not contain leading or trailing forward slashes.
The namespaceis always relative to the provider's configured namespace. Available only for Vault Enterprise.
- resolveAws booleanUnique Ids 
- Only valid when
auth_typeisiam. If set totrue, thebound_iam_principal_arnsare resolved to AWS Unique IDs for the bound principal ARN. This field is ignored when abound_iam_principal_arnends 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 tofalsewithout recreating the role.
- roleTag 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_typemust be set toec2orinferred_entity_typemust be set toec2_instanceto use this constraint.
- tokenBound string[]Cidrs 
- Specifies the blocks of IP addresses which are allowed to use the generated token
- tokenExplicit numberMax Ttl 
- Generated Token's Explicit Maximum TTL in seconds
- tokenMax numberTtl 
- The maximum lifetime of the generated token
- tokenNo booleanDefault Policy 
- If true, the 'default' policy will not automatically be added to generated tokens
- tokenNum numberUses 
- The maximum number of times a token may be used, a value of zero means unlimited
- tokenPeriod number
- Generated Token's Period
- tokenPolicies string[]
- Generated Token's Policies
- tokenTtl number
- The initial ttl of the token to generate in seconds
- tokenType string
- The type of token to generate, service or batch
- 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 ec2andiam. 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_typemust be set toec2orinferred_entity_typemust be set toec2_instanceto 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_typemust be set toec2orinferred_entity_typemust be set toec2_instanceto 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_typemust be set toec2orinferred_entity_typemust be set toec2_instanceto use this constraint.
- bound_iam_ Sequence[str]principal_ arns 
- If set, defines the IAM principal that
must be authenticated when auth_typeis 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_typemust be set toec2orinferred_entity_typemust be set toec2_instanceto 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_typemust be set toec2orinferred_entity_typemust be set toec2_instanceto 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_typemust be set toec2orinferred_entity_typemust be set toec2_instanceto 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_typemust be set toec2orinferred_entity_typemust be set toec2_instanceto 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_typeis set toec2.
- inferred_aws_ strregion 
- When inferred_entity_typeis set, this is the region to search for the inferred entities. Required ifinferred_entity_typeis set. This only applies whenauth_typeis 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_typeis set toiam.
- namespace str
- The namespace to provision the resource in.
The value should not contain leading or trailing forward slashes.
The namespaceis always relative to the provider's configured namespace. Available only for Vault Enterprise.
- resolve_aws_ boolunique_ ids 
- Only valid when
auth_typeisiam. If set totrue, thebound_iam_principal_arnsare resolved to AWS Unique IDs for the bound principal ARN. This field is ignored when abound_iam_principal_arnends 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 tofalsewithout 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_typemust be set toec2orinferred_entity_typemust be set toec2_instanceto use this constraint.
- token_bound_ Sequence[str]cidrs 
- Specifies the blocks of IP addresses which are allowed to use the generated token
- token_explicit_ intmax_ ttl 
- Generated Token's Explicit Maximum TTL in seconds
- token_max_ intttl 
- The maximum lifetime of the generated token
- token_no_ booldefault_ policy 
- If true, the 'default' policy will not automatically be added to generated tokens
- token_num_ intuses 
- The maximum number of times a token may be used, a value of zero means unlimited
- token_period int
- Generated Token's Period
- token_policies Sequence[str]
- Generated Token's Policies
- token_ttl int
- The initial ttl of the token to generate in seconds
- token_type str
- The type of token to generate, service or batch
- role String
- The name of the role.
- allowInstance BooleanMigration 
- If set to true, allows migration of the underlying instance where the client resides.
- authType String
- The auth type permitted for this role. Valid choices
are ec2andiam. Defaults toiam.
- backend String
- Path to the mounted aws auth backend.
- boundAccount 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_typemust be set toec2orinferred_entity_typemust be set toec2_instanceto use this constraint.
- boundAmi 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_typemust be set toec2orinferred_entity_typemust be set toec2_instanceto use this constraint.
- boundEc2Instance List<String>Ids 
- Only EC2 instances that match this instance ID will be permitted to log in.
- boundIam 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_typemust be set toec2orinferred_entity_typemust be set toec2_instanceto use this constraint.
- boundIam List<String>Principal Arns 
- If set, defines the IAM principal that
must be authenticated when auth_typeis set toiam. Wildcards are supported at the end of the ARN.
- boundIam 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_typemust be set toec2orinferred_entity_typemust be set toec2_instanceto use this constraint.
- boundRegions 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_typemust be set toec2orinferred_entity_typemust be set toec2_instanceto use this constraint.
- boundSubnet 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_typemust be set toec2orinferred_entity_typemust be set toec2_instanceto use this constraint.
- boundVpc 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_typemust be set toec2orinferred_entity_typemust be set toec2_instanceto use this constraint.
- disallowReauthentication Boolean
- IF set to true, only allows a single token to be granted per instance ID. This can only be set whenauth_typeis set toec2.
- inferredAws StringRegion 
- When inferred_entity_typeis set, this is the region to search for the inferred entities. Required ifinferred_entity_typeis set. This only applies whenauth_typeis set toiam.
- inferredEntity 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_typeis set toiam.
- namespace String
- The namespace to provision the resource in.
The value should not contain leading or trailing forward slashes.
The namespaceis always relative to the provider's configured namespace. Available only for Vault Enterprise.
- resolveAws BooleanUnique Ids 
- Only valid when
auth_typeisiam. If set totrue, thebound_iam_principal_arnsare resolved to AWS Unique IDs for the bound principal ARN. This field is ignored when abound_iam_principal_arnends 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 tofalsewithout recreating the role.
- roleTag 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_typemust be set toec2orinferred_entity_typemust be set toec2_instanceto use this constraint.
- tokenBound List<String>Cidrs 
- Specifies the blocks of IP addresses which are allowed to use the generated token
- tokenExplicit NumberMax Ttl 
- Generated Token's Explicit Maximum TTL in seconds
- tokenMax NumberTtl 
- The maximum lifetime of the generated token
- tokenNo BooleanDefault Policy 
- If true, the 'default' policy will not automatically be added to generated tokens
- tokenNum NumberUses 
- The maximum number of times a token may be used, a value of zero means unlimited
- tokenPeriod Number
- Generated Token's Period
- tokenPolicies List<String>
- Generated Token's Policies
- tokenTtl Number
- The initial ttl of the token to generate in seconds
- tokenType String
- The type of token to generate, service or batch
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) -> AuthBackendRolefunc 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)resources:  _:    type: vault:aws:AuthBackendRole    get:      id: ${id}- 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.
- AllowInstance boolMigration 
- If set to true, allows migration of the underlying instance where the client resides.
- AuthType string
- The auth type permitted for this role. Valid choices
are ec2andiam. Defaults toiam.
- Backend string
- Path to the mounted aws auth backend.
- BoundAccount 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_typemust be set toec2orinferred_entity_typemust be set toec2_instanceto use this constraint.
- BoundAmi 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_typemust be set toec2orinferred_entity_typemust be set toec2_instanceto use this constraint.
- BoundEc2Instance List<string>Ids 
- Only EC2 instances that match this instance ID will be permitted to log in.
- BoundIam 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_typemust be set toec2orinferred_entity_typemust be set toec2_instanceto use this constraint.
- BoundIam List<string>Principal Arns 
- If set, defines the IAM principal that
must be authenticated when auth_typeis set toiam. Wildcards are supported at the end of the ARN.
- BoundIam 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_typemust be set toec2orinferred_entity_typemust be set toec2_instanceto use this constraint.
- BoundRegions 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_typemust be set toec2orinferred_entity_typemust be set toec2_instanceto use this constraint.
- BoundSubnet 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_typemust be set toec2orinferred_entity_typemust be set toec2_instanceto use this constraint.
- BoundVpc 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_typemust be set toec2orinferred_entity_typemust be set toec2_instanceto use this constraint.
- DisallowReauthentication bool
- IF set to true, only allows a single token to be granted per instance ID. This can only be set whenauth_typeis set toec2.
- InferredAws stringRegion 
- When inferred_entity_typeis set, this is the region to search for the inferred entities. Required ifinferred_entity_typeis set. This only applies whenauth_typeis set toiam.
- InferredEntity 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_typeis set toiam.
- Namespace string
- The namespace to provision the resource in.
The value should not contain leading or trailing forward slashes.
The namespaceis always relative to the provider's configured namespace. Available only for Vault Enterprise.
- ResolveAws boolUnique Ids 
- Only valid when
auth_typeisiam. If set totrue, thebound_iam_principal_arnsare resolved to AWS Unique IDs for the bound principal ARN. This field is ignored when abound_iam_principal_arnends 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 tofalsewithout recreating the role.
- Role string
- The name of the role.
- RoleId string
- The Vault generated role ID.
- RoleTag 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_typemust be set toec2orinferred_entity_typemust be set toec2_instanceto use this constraint.
- TokenBound List<string>Cidrs 
- Specifies the blocks of IP addresses which are allowed to use the generated token
- TokenExplicit intMax Ttl 
- Generated Token's Explicit Maximum TTL in seconds
- TokenMax intTtl 
- The maximum lifetime of the generated token
- TokenNo boolDefault Policy 
- If true, the 'default' policy will not automatically be added to generated tokens
- TokenNum intUses 
- The maximum number of times a token may be used, a value of zero means unlimited
- TokenPeriod int
- Generated Token's Period
- TokenPolicies List<string>
- Generated Token's Policies
- TokenTtl int
- The initial ttl of the token to generate in seconds
- TokenType string
- The type of token to generate, service or batch
- AllowInstance boolMigration 
- If set to true, allows migration of the underlying instance where the client resides.
- AuthType string
- The auth type permitted for this role. Valid choices
are ec2andiam. Defaults toiam.
- Backend string
- Path to the mounted aws auth backend.
- BoundAccount []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_typemust be set toec2orinferred_entity_typemust be set toec2_instanceto use this constraint.
- BoundAmi []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_typemust be set toec2orinferred_entity_typemust be set toec2_instanceto use this constraint.
- BoundEc2Instance []stringIds 
- Only EC2 instances that match this instance ID will be permitted to log in.
- BoundIam []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_typemust be set toec2orinferred_entity_typemust be set toec2_instanceto use this constraint.
- BoundIam []stringPrincipal Arns 
- If set, defines the IAM principal that
must be authenticated when auth_typeis set toiam. Wildcards are supported at the end of the ARN.
- BoundIam []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_typemust be set toec2orinferred_entity_typemust be set toec2_instanceto use this constraint.
- BoundRegions []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_typemust be set toec2orinferred_entity_typemust be set toec2_instanceto use this constraint.
- BoundSubnet []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_typemust be set toec2orinferred_entity_typemust be set toec2_instanceto use this constraint.
- BoundVpc []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_typemust be set toec2orinferred_entity_typemust be set toec2_instanceto use this constraint.
- DisallowReauthentication bool
- IF set to true, only allows a single token to be granted per instance ID. This can only be set whenauth_typeis set toec2.
- InferredAws stringRegion 
- When inferred_entity_typeis set, this is the region to search for the inferred entities. Required ifinferred_entity_typeis set. This only applies whenauth_typeis set toiam.
- InferredEntity 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_typeis set toiam.
- Namespace string
- The namespace to provision the resource in.
The value should not contain leading or trailing forward slashes.
The namespaceis always relative to the provider's configured namespace. Available only for Vault Enterprise.
- ResolveAws boolUnique Ids 
- Only valid when
auth_typeisiam. If set totrue, thebound_iam_principal_arnsare resolved to AWS Unique IDs for the bound principal ARN. This field is ignored when abound_iam_principal_arnends 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 tofalsewithout recreating the role.
- Role string
- The name of the role.
- RoleId string
- The Vault generated role ID.
- RoleTag 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_typemust be set toec2orinferred_entity_typemust be set toec2_instanceto use this constraint.
- TokenBound []stringCidrs 
- Specifies the blocks of IP addresses which are allowed to use the generated token
- TokenExplicit intMax Ttl 
- Generated Token's Explicit Maximum TTL in seconds
- TokenMax intTtl 
- The maximum lifetime of the generated token
- TokenNo boolDefault Policy 
- If true, the 'default' policy will not automatically be added to generated tokens
- TokenNum intUses 
- The maximum number of times a token may be used, a value of zero means unlimited
- TokenPeriod int
- Generated Token's Period
- TokenPolicies []string
- Generated Token's Policies
- TokenTtl int
- The initial ttl of the token to generate in seconds
- TokenType string
- The type of token to generate, service or batch
- allowInstance BooleanMigration 
- If set to true, allows migration of the underlying instance where the client resides.
- authType String
- The auth type permitted for this role. Valid choices
are ec2andiam. Defaults toiam.
- backend String
- Path to the mounted aws auth backend.
- boundAccount 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_typemust be set toec2orinferred_entity_typemust be set toec2_instanceto use this constraint.
- boundAmi 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_typemust be set toec2orinferred_entity_typemust be set toec2_instanceto use this constraint.
- boundEc2Instance List<String>Ids 
- Only EC2 instances that match this instance ID will be permitted to log in.
- boundIam 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_typemust be set toec2orinferred_entity_typemust be set toec2_instanceto use this constraint.
- boundIam List<String>Principal Arns 
- If set, defines the IAM principal that
must be authenticated when auth_typeis set toiam. Wildcards are supported at the end of the ARN.
- boundIam 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_typemust be set toec2orinferred_entity_typemust be set toec2_instanceto use this constraint.
- boundRegions 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_typemust be set toec2orinferred_entity_typemust be set toec2_instanceto use this constraint.
- boundSubnet 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_typemust be set toec2orinferred_entity_typemust be set toec2_instanceto use this constraint.
- boundVpc 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_typemust be set toec2orinferred_entity_typemust be set toec2_instanceto use this constraint.
- disallowReauthentication Boolean
- IF set to true, only allows a single token to be granted per instance ID. This can only be set whenauth_typeis set toec2.
- inferredAws StringRegion 
- When inferred_entity_typeis set, this is the region to search for the inferred entities. Required ifinferred_entity_typeis set. This only applies whenauth_typeis set toiam.
- inferredEntity 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_typeis set toiam.
- namespace String
- The namespace to provision the resource in.
The value should not contain leading or trailing forward slashes.
The namespaceis always relative to the provider's configured namespace. Available only for Vault Enterprise.
- resolveAws BooleanUnique Ids 
- Only valid when
auth_typeisiam. If set totrue, thebound_iam_principal_arnsare resolved to AWS Unique IDs for the bound principal ARN. This field is ignored when abound_iam_principal_arnends 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 tofalsewithout recreating the role.
- role String
- The name of the role.
- roleId String
- The Vault generated role ID.
- roleTag 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_typemust be set toec2orinferred_entity_typemust be set toec2_instanceto use this constraint.
- tokenBound List<String>Cidrs 
- Specifies the blocks of IP addresses which are allowed to use the generated token
- tokenExplicit IntegerMax Ttl 
- Generated Token's Explicit Maximum TTL in seconds
- tokenMax IntegerTtl 
- The maximum lifetime of the generated token
- tokenNo BooleanDefault Policy 
- If true, the 'default' policy will not automatically be added to generated tokens
- tokenNum IntegerUses 
- The maximum number of times a token may be used, a value of zero means unlimited
- tokenPeriod Integer
- Generated Token's Period
- tokenPolicies List<String>
- Generated Token's Policies
- tokenTtl Integer
- The initial ttl of the token to generate in seconds
- tokenType String
- The type of token to generate, service or batch
- allowInstance booleanMigration 
- If set to true, allows migration of the underlying instance where the client resides.
- authType string
- The auth type permitted for this role. Valid choices
are ec2andiam. Defaults toiam.
- backend string
- Path to the mounted aws auth backend.
- boundAccount 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_typemust be set toec2orinferred_entity_typemust be set toec2_instanceto use this constraint.
- boundAmi 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_typemust be set toec2orinferred_entity_typemust be set toec2_instanceto use this constraint.
- boundEc2Instance string[]Ids 
- Only EC2 instances that match this instance ID will be permitted to log in.
- boundIam 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_typemust be set toec2orinferred_entity_typemust be set toec2_instanceto use this constraint.
- boundIam string[]Principal Arns 
- If set, defines the IAM principal that
must be authenticated when auth_typeis set toiam. Wildcards are supported at the end of the ARN.
- boundIam 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_typemust be set toec2orinferred_entity_typemust be set toec2_instanceto use this constraint.
- boundRegions 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_typemust be set toec2orinferred_entity_typemust be set toec2_instanceto use this constraint.
- boundSubnet 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_typemust be set toec2orinferred_entity_typemust be set toec2_instanceto use this constraint.
- boundVpc 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_typemust be set toec2orinferred_entity_typemust be set toec2_instanceto use this constraint.
- disallowReauthentication boolean
- IF set to true, only allows a single token to be granted per instance ID. This can only be set whenauth_typeis set toec2.
- inferredAws stringRegion 
- When inferred_entity_typeis set, this is the region to search for the inferred entities. Required ifinferred_entity_typeis set. This only applies whenauth_typeis set toiam.
- inferredEntity 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_typeis set toiam.
- namespace string
- The namespace to provision the resource in.
The value should not contain leading or trailing forward slashes.
The namespaceis always relative to the provider's configured namespace. Available only for Vault Enterprise.
- resolveAws booleanUnique Ids 
- Only valid when
auth_typeisiam. If set totrue, thebound_iam_principal_arnsare resolved to AWS Unique IDs for the bound principal ARN. This field is ignored when abound_iam_principal_arnends 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 tofalsewithout recreating the role.
- role string
- The name of the role.
- roleId string
- The Vault generated role ID.
- roleTag 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_typemust be set toec2orinferred_entity_typemust be set toec2_instanceto use this constraint.
- tokenBound string[]Cidrs 
- Specifies the blocks of IP addresses which are allowed to use the generated token
- tokenExplicit numberMax Ttl 
- Generated Token's Explicit Maximum TTL in seconds
- tokenMax numberTtl 
- The maximum lifetime of the generated token
- tokenNo booleanDefault Policy 
- If true, the 'default' policy will not automatically be added to generated tokens
- tokenNum numberUses 
- The maximum number of times a token may be used, a value of zero means unlimited
- tokenPeriod number
- Generated Token's Period
- tokenPolicies string[]
- Generated Token's Policies
- tokenTtl number
- The initial ttl of the token to generate in seconds
- tokenType string
- The type of token to generate, service or batch
- 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 ec2andiam. 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_typemust be set toec2orinferred_entity_typemust be set toec2_instanceto 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_typemust be set toec2orinferred_entity_typemust be set toec2_instanceto 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_typemust be set toec2orinferred_entity_typemust be set toec2_instanceto use this constraint.
- bound_iam_ Sequence[str]principal_ arns 
- If set, defines the IAM principal that
must be authenticated when auth_typeis 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_typemust be set toec2orinferred_entity_typemust be set toec2_instanceto 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_typemust be set toec2orinferred_entity_typemust be set toec2_instanceto 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_typemust be set toec2orinferred_entity_typemust be set toec2_instanceto 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_typemust be set toec2orinferred_entity_typemust be set toec2_instanceto 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_typeis set toec2.
- inferred_aws_ strregion 
- When inferred_entity_typeis set, this is the region to search for the inferred entities. Required ifinferred_entity_typeis set. This only applies whenauth_typeis 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_typeis set toiam.
- namespace str
- The namespace to provision the resource in.
The value should not contain leading or trailing forward slashes.
The namespaceis always relative to the provider's configured namespace. Available only for Vault Enterprise.
- resolve_aws_ boolunique_ ids 
- Only valid when
auth_typeisiam. If set totrue, thebound_iam_principal_arnsare resolved to AWS Unique IDs for the bound principal ARN. This field is ignored when abound_iam_principal_arnends 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 tofalsewithout 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_typemust be set toec2orinferred_entity_typemust be set toec2_instanceto use this constraint.
- token_bound_ Sequence[str]cidrs 
- Specifies the blocks of IP addresses which are allowed to use the generated token
- token_explicit_ intmax_ ttl 
- Generated Token's Explicit Maximum TTL in seconds
- token_max_ intttl 
- The maximum lifetime of the generated token
- token_no_ booldefault_ policy 
- If true, the 'default' policy will not automatically be added to generated tokens
- token_num_ intuses 
- The maximum number of times a token may be used, a value of zero means unlimited
- token_period int
- Generated Token's Period
- token_policies Sequence[str]
- Generated Token's Policies
- token_ttl int
- The initial ttl of the token to generate in seconds
- token_type str
- The type of token to generate, service or batch
- allowInstance BooleanMigration 
- If set to true, allows migration of the underlying instance where the client resides.
- authType String
- The auth type permitted for this role. Valid choices
are ec2andiam. Defaults toiam.
- backend String
- Path to the mounted aws auth backend.
- boundAccount 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_typemust be set toec2orinferred_entity_typemust be set toec2_instanceto use this constraint.
- boundAmi 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_typemust be set toec2orinferred_entity_typemust be set toec2_instanceto use this constraint.
- boundEc2Instance List<String>Ids 
- Only EC2 instances that match this instance ID will be permitted to log in.
- boundIam 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_typemust be set toec2orinferred_entity_typemust be set toec2_instanceto use this constraint.
- boundIam List<String>Principal Arns 
- If set, defines the IAM principal that
must be authenticated when auth_typeis set toiam. Wildcards are supported at the end of the ARN.
- boundIam 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_typemust be set toec2orinferred_entity_typemust be set toec2_instanceto use this constraint.
- boundRegions 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_typemust be set toec2orinferred_entity_typemust be set toec2_instanceto use this constraint.
- boundSubnet 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_typemust be set toec2orinferred_entity_typemust be set toec2_instanceto use this constraint.
- boundVpc 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_typemust be set toec2orinferred_entity_typemust be set toec2_instanceto use this constraint.
- disallowReauthentication Boolean
- IF set to true, only allows a single token to be granted per instance ID. This can only be set whenauth_typeis set toec2.
- inferredAws StringRegion 
- When inferred_entity_typeis set, this is the region to search for the inferred entities. Required ifinferred_entity_typeis set. This only applies whenauth_typeis set toiam.
- inferredEntity 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_typeis set toiam.
- namespace String
- The namespace to provision the resource in.
The value should not contain leading or trailing forward slashes.
The namespaceis always relative to the provider's configured namespace. Available only for Vault Enterprise.
- resolveAws BooleanUnique Ids 
- Only valid when
auth_typeisiam. If set totrue, thebound_iam_principal_arnsare resolved to AWS Unique IDs for the bound principal ARN. This field is ignored when abound_iam_principal_arnends 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 tofalsewithout recreating the role.
- role String
- The name of the role.
- roleId String
- The Vault generated role ID.
- roleTag 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_typemust be set toec2orinferred_entity_typemust be set toec2_instanceto use this constraint.
- tokenBound List<String>Cidrs 
- Specifies the blocks of IP addresses which are allowed to use the generated token
- tokenExplicit NumberMax Ttl 
- Generated Token's Explicit Maximum TTL in seconds
- tokenMax NumberTtl 
- The maximum lifetime of the generated token
- tokenNo BooleanDefault Policy 
- If true, the 'default' policy will not automatically be added to generated tokens
- tokenNum NumberUses 
- The maximum number of times a token may be used, a value of zero means unlimited
- tokenPeriod Number
- Generated Token's Period
- tokenPolicies List<String>
- Generated Token's Policies
- tokenTtl Number
- The initial ttl of the token to generate in seconds
- tokenType String
- The type of token to generate, service or batch
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
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Vault pulumi/pulumi-vault
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the vaultTerraform Provider.