BackendRole

Create a BackendRole Resource

new BackendRole(name: string, args: BackendRoleArgs, opts?: CustomResourceOptions);
@overload
def BackendRole(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                application_object_id: Optional[str] = None,
                azure_groups: Optional[Sequence[BackendRoleAzureGroupArgs]] = None,
                azure_roles: Optional[Sequence[BackendRoleAzureRoleArgs]] = None,
                backend: Optional[str] = None,
                description: Optional[str] = None,
                max_ttl: Optional[str] = None,
                role: Optional[str] = None,
                ttl: Optional[str] = None)
@overload
def BackendRole(resource_name: str,
                args: BackendRoleArgs,
                opts: Optional[ResourceOptions] = None)
func NewBackendRole(ctx *Context, name string, args BackendRoleArgs, opts ...ResourceOption) (*BackendRole, error)
public BackendRole(string name, BackendRoleArgs args, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args BackendRoleArgs
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 BackendRoleArgs
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 BackendRoleArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args BackendRoleArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

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

Role string
Name of the Azure role
ApplicationObjectId string
Application Object ID for an existing service principal that will be used instead of creating dynamic service principals. If present, azure_roles will be ignored.
AzureGroups List<BackendRoleAzureGroupArgs>
List of Azure groups to be assigned to the generated service principal.
AzureRoles List<BackendRoleAzureRoleArgs>
List of Azure roles to be assigned to the generated service principal.
Backend string
Path to the mounted Azure auth backend
Description string
Human-friendly description of the mount for the backend.
MaxTtl string
Specifies the maximum TTL for service principals generated using this role. Accepts time suffixed strings (“1h”) or an integer number of seconds. Defaults to the system/engine max TTL time.
Ttl string
Specifies the default TTL for service principals generated using this role. Accepts time suffixed strings (“1h”) or an integer number of seconds. Defaults to the system/engine default TTL time.
Role string
Name of the Azure role
ApplicationObjectId string
Application Object ID for an existing service principal that will be used instead of creating dynamic service principals. If present, azure_roles will be ignored.
AzureGroups []BackendRoleAzureGroupArgs
List of Azure groups to be assigned to the generated service principal.
AzureRoles []BackendRoleAzureRoleArgs
List of Azure roles to be assigned to the generated service principal.
Backend string
Path to the mounted Azure auth backend
Description string
Human-friendly description of the mount for the backend.
MaxTtl string
Specifies the maximum TTL for service principals generated using this role. Accepts time suffixed strings (“1h”) or an integer number of seconds. Defaults to the system/engine max TTL time.
Ttl string
Specifies the default TTL for service principals generated using this role. Accepts time suffixed strings (“1h”) or an integer number of seconds. Defaults to the system/engine default TTL time.
role string
Name of the Azure role
applicationObjectId string
Application Object ID for an existing service principal that will be used instead of creating dynamic service principals. If present, azure_roles will be ignored.
azureGroups BackendRoleAzureGroupArgs[]
List of Azure groups to be assigned to the generated service principal.
azureRoles BackendRoleAzureRoleArgs[]
List of Azure roles to be assigned to the generated service principal.
backend string
Path to the mounted Azure auth backend
description string
Human-friendly description of the mount for the backend.
maxTtl string
Specifies the maximum TTL for service principals generated using this role. Accepts time suffixed strings (“1h”) or an integer number of seconds. Defaults to the system/engine max TTL time.
ttl string
Specifies the default TTL for service principals generated using this role. Accepts time suffixed strings (“1h”) or an integer number of seconds. Defaults to the system/engine default TTL time.
role str
Name of the Azure role
application_object_id str
Application Object ID for an existing service principal that will be used instead of creating dynamic service principals. If present, azure_roles will be ignored.
azure_groups Sequence[BackendRoleAzureGroupArgs]
List of Azure groups to be assigned to the generated service principal.
azure_roles Sequence[BackendRoleAzureRoleArgs]
List of Azure roles to be assigned to the generated service principal.
backend str
Path to the mounted Azure auth backend
description str
Human-friendly description of the mount for the backend.
max_ttl str
Specifies the maximum TTL for service principals generated using this role. Accepts time suffixed strings (“1h”) or an integer number of seconds. Defaults to the system/engine max TTL time.
ttl str
Specifies the default TTL for service principals generated using this role. Accepts time suffixed strings (“1h”) or an integer number of seconds. Defaults to the system/engine default TTL time.

Outputs

All input properties are implicitly available as output properties. Additionally, the BackendRole resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.

Look up an Existing BackendRole Resource

Get an existing BackendRole 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?: BackendRoleState, opts?: CustomResourceOptions): BackendRole
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        application_object_id: Optional[str] = None,
        azure_groups: Optional[Sequence[BackendRoleAzureGroupArgs]] = None,
        azure_roles: Optional[Sequence[BackendRoleAzureRoleArgs]] = None,
        backend: Optional[str] = None,
        description: Optional[str] = None,
        max_ttl: Optional[str] = None,
        role: Optional[str] = None,
        ttl: Optional[str] = None) -> BackendRole
func GetBackendRole(ctx *Context, name string, id IDInput, state *BackendRoleState, opts ...ResourceOption) (*BackendRole, error)
public static BackendRole Get(string name, Input<string> id, BackendRoleState? state, CustomResourceOptions? opts = null)
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.

The following state arguments are supported:

ApplicationObjectId string
Application Object ID for an existing service principal that will be used instead of creating dynamic service principals. If present, azure_roles will be ignored.
AzureGroups List<BackendRoleAzureGroupArgs>
List of Azure groups to be assigned to the generated service principal.
AzureRoles List<BackendRoleAzureRoleArgs>
List of Azure roles to be assigned to the generated service principal.
Backend string
Path to the mounted Azure auth backend
Description string
Human-friendly description of the mount for the backend.
MaxTtl string
Specifies the maximum TTL for service principals generated using this role. Accepts time suffixed strings (“1h”) or an integer number of seconds. Defaults to the system/engine max TTL time.
Role string
Name of the Azure role
Ttl string
Specifies the default TTL for service principals generated using this role. Accepts time suffixed strings (“1h”) or an integer number of seconds. Defaults to the system/engine default TTL time.
ApplicationObjectId string
Application Object ID for an existing service principal that will be used instead of creating dynamic service principals. If present, azure_roles will be ignored.
AzureGroups []BackendRoleAzureGroupArgs
List of Azure groups to be assigned to the generated service principal.
AzureRoles []BackendRoleAzureRoleArgs
List of Azure roles to be assigned to the generated service principal.
Backend string
Path to the mounted Azure auth backend
Description string
Human-friendly description of the mount for the backend.
MaxTtl string
Specifies the maximum TTL for service principals generated using this role. Accepts time suffixed strings (“1h”) or an integer number of seconds. Defaults to the system/engine max TTL time.
Role string
Name of the Azure role
Ttl string
Specifies the default TTL for service principals generated using this role. Accepts time suffixed strings (“1h”) or an integer number of seconds. Defaults to the system/engine default TTL time.
applicationObjectId string
Application Object ID for an existing service principal that will be used instead of creating dynamic service principals. If present, azure_roles will be ignored.
azureGroups BackendRoleAzureGroupArgs[]
List of Azure groups to be assigned to the generated service principal.
azureRoles BackendRoleAzureRoleArgs[]
List of Azure roles to be assigned to the generated service principal.
backend string
Path to the mounted Azure auth backend
description string
Human-friendly description of the mount for the backend.
maxTtl string
Specifies the maximum TTL for service principals generated using this role. Accepts time suffixed strings (“1h”) or an integer number of seconds. Defaults to the system/engine max TTL time.
role string
Name of the Azure role
ttl string
Specifies the default TTL for service principals generated using this role. Accepts time suffixed strings (“1h”) or an integer number of seconds. Defaults to the system/engine default TTL time.
application_object_id str
Application Object ID for an existing service principal that will be used instead of creating dynamic service principals. If present, azure_roles will be ignored.
azure_groups Sequence[BackendRoleAzureGroupArgs]
List of Azure groups to be assigned to the generated service principal.
azure_roles Sequence[BackendRoleAzureRoleArgs]
List of Azure roles to be assigned to the generated service principal.
backend str
Path to the mounted Azure auth backend
description str
Human-friendly description of the mount for the backend.
max_ttl str
Specifies the maximum TTL for service principals generated using this role. Accepts time suffixed strings (“1h”) or an integer number of seconds. Defaults to the system/engine max TTL time.
role str
Name of the Azure role
ttl str
Specifies the default TTL for service principals generated using this role. Accepts time suffixed strings (“1h”) or an integer number of seconds. Defaults to the system/engine default TTL time.

Supporting Types

BackendRoleAzureGroup

GroupName string
ObjectId string
GroupName string
ObjectId string
groupName string
objectId string
group_name str
object_id str

BackendRoleAzureRole

RoleName string
Scope string
RoleId string
RoleName string
Scope string
RoleId string
roleName string
scope string
roleId string
role_name str
scope str
role_id str

Package Details

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