OidcRole

Import

The key can be imported with the role name, for example

 $ pulumi import vault:identity/oidcRole:OidcRole role role

Create a OidcRole Resource

new OidcRole(name: string, args: OidcRoleArgs, opts?: CustomResourceOptions);
@overload
def OidcRole(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             client_id: Optional[str] = None,
             key: Optional[str] = None,
             name: Optional[str] = None,
             template: Optional[str] = None,
             ttl: Optional[int] = None)
@overload
def OidcRole(resource_name: str,
             args: OidcRoleArgs,
             opts: Optional[ResourceOptions] = None)
func NewOidcRole(ctx *Context, name string, args OidcRoleArgs, opts ...ResourceOption) (*OidcRole, error)
public OidcRole(string name, OidcRoleArgs args, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args OidcRoleArgs
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 OidcRoleArgs
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 OidcRoleArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args OidcRoleArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

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

Key string
A configured named key, the key must already exist before tokens can be issued.
ClientId string
The value that will be included in the aud field of all the OIDC identity tokens issued by this role
Name string
Name of the OIDC Role to create.
Template string
The template string to use for generating tokens. This may be in string-ified JSON or base64 format. See the documentation for the template format.
Ttl int
TTL of the tokens generated against the role in number of seconds.
Key string
A configured named key, the key must already exist before tokens can be issued.
ClientId string
The value that will be included in the aud field of all the OIDC identity tokens issued by this role
Name string
Name of the OIDC Role to create.
Template string
The template string to use for generating tokens. This may be in string-ified JSON or base64 format. See the documentation for the template format.
Ttl int
TTL of the tokens generated against the role in number of seconds.
key string
A configured named key, the key must already exist before tokens can be issued.
clientId string
The value that will be included in the aud field of all the OIDC identity tokens issued by this role
name string
Name of the OIDC Role to create.
template string
The template string to use for generating tokens. This may be in string-ified JSON or base64 format. See the documentation for the template format.
ttl number
TTL of the tokens generated against the role in number of seconds.
key str
A configured named key, the key must already exist before tokens can be issued.
client_id str
The value that will be included in the aud field of all the OIDC identity tokens issued by this role
name str
Name of the OIDC Role to create.
template str
The template string to use for generating tokens. This may be in string-ified JSON or base64 format. See the documentation for the template format.
ttl int
TTL of the tokens generated against the role in number of seconds.

Outputs

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

Get an existing OidcRole 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?: OidcRoleState, opts?: CustomResourceOptions): OidcRole
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        client_id: Optional[str] = None,
        key: Optional[str] = None,
        name: Optional[str] = None,
        template: Optional[str] = None,
        ttl: Optional[int] = None) -> OidcRole
func GetOidcRole(ctx *Context, name string, id IDInput, state *OidcRoleState, opts ...ResourceOption) (*OidcRole, error)
public static OidcRole Get(string name, Input<string> id, OidcRoleState? 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:

ClientId string
The value that will be included in the aud field of all the OIDC identity tokens issued by this role
Key string
A configured named key, the key must already exist before tokens can be issued.
Name string
Name of the OIDC Role to create.
Template string
The template string to use for generating tokens. This may be in string-ified JSON or base64 format. See the documentation for the template format.
Ttl int
TTL of the tokens generated against the role in number of seconds.
ClientId string
The value that will be included in the aud field of all the OIDC identity tokens issued by this role
Key string
A configured named key, the key must already exist before tokens can be issued.
Name string
Name of the OIDC Role to create.
Template string
The template string to use for generating tokens. This may be in string-ified JSON or base64 format. See the documentation for the template format.
Ttl int
TTL of the tokens generated against the role in number of seconds.
clientId string
The value that will be included in the aud field of all the OIDC identity tokens issued by this role
key string
A configured named key, the key must already exist before tokens can be issued.
name string
Name of the OIDC Role to create.
template string
The template string to use for generating tokens. This may be in string-ified JSON or base64 format. See the documentation for the template format.
ttl number
TTL of the tokens generated against the role in number of seconds.
client_id str
The value that will be included in the aud field of all the OIDC identity tokens issued by this role
key str
A configured named key, the key must already exist before tokens can be issued.
name str
Name of the OIDC Role to create.
template str
The template string to use for generating tokens. This may be in string-ified JSON or base64 format. See the documentation for the template format.
ttl int
TTL of the tokens generated against the role in number of seconds.

Package Details

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