vault.transform.Template
Create Template Resource
new Template(name: string, args: TemplateArgs, opts?: CustomResourceOptions);
@overload
def Template(resource_name: str,
opts: Optional[ResourceOptions] = None,
alphabet: Optional[str] = None,
decode_formats: Optional[Mapping[str, Any]] = None,
encode_format: Optional[str] = None,
name: Optional[str] = None,
path: Optional[str] = None,
pattern: Optional[str] = None,
type: Optional[str] = None)
@overload
def Template(resource_name: str,
args: TemplateArgs,
opts: Optional[ResourceOptions] = None)
func NewTemplate(ctx *Context, name string, args TemplateArgs, opts ...ResourceOption) (*Template, error)
public Template(string name, TemplateArgs args, CustomResourceOptions? opts = null)
public Template(String name, TemplateArgs args)
public Template(String name, TemplateArgs args, CustomResourceOptions options)
type: vault:transform:Template
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args TemplateArgs
- 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 TemplateArgs
- 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 TemplateArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args TemplateArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args TemplateArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Template 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 Template resource accepts the following input properties:
- Path string
Path to where the back-end is mounted within Vault.
- Alphabet string
The alphabet to use for this template. This is only used during FPE transformations.
- Decode
Formats Dictionary<string, object> - Optional mapping of name to regular expression template, used to customize the decoded output. (requires Vault Enterprise 1.9+)
- Encode
Format string - The regular expression template used to format encoded values. (requires Vault Enterprise 1.9+)
- Name string
The name of the template.
- Pattern string
The pattern used for matching. Currently, only regular expression pattern is supported.
- Type string
The pattern type to use for match detection. Currently, only regex is supported.
- Path string
Path to where the back-end is mounted within Vault.
- Alphabet string
The alphabet to use for this template. This is only used during FPE transformations.
- Decode
Formats map[string]interface{} - Optional mapping of name to regular expression template, used to customize the decoded output. (requires Vault Enterprise 1.9+)
- Encode
Format string - The regular expression template used to format encoded values. (requires Vault Enterprise 1.9+)
- Name string
The name of the template.
- Pattern string
The pattern used for matching. Currently, only regular expression pattern is supported.
- Type string
The pattern type to use for match detection. Currently, only regex is supported.
- path String
Path to where the back-end is mounted within Vault.
- alphabet String
The alphabet to use for this template. This is only used during FPE transformations.
- decode
Formats Map<String,Object> - Optional mapping of name to regular expression template, used to customize the decoded output. (requires Vault Enterprise 1.9+)
- encode
Format String - The regular expression template used to format encoded values. (requires Vault Enterprise 1.9+)
- name String
The name of the template.
- pattern String
The pattern used for matching. Currently, only regular expression pattern is supported.
- type String
The pattern type to use for match detection. Currently, only regex is supported.
- path string
Path to where the back-end is mounted within Vault.
- alphabet string
The alphabet to use for this template. This is only used during FPE transformations.
- decode
Formats {[key: string]: any} - Optional mapping of name to regular expression template, used to customize the decoded output. (requires Vault Enterprise 1.9+)
- encode
Format string - The regular expression template used to format encoded values. (requires Vault Enterprise 1.9+)
- name string
The name of the template.
- pattern string
The pattern used for matching. Currently, only regular expression pattern is supported.
- type string
The pattern type to use for match detection. Currently, only regex is supported.
- path str
Path to where the back-end is mounted within Vault.
- alphabet str
The alphabet to use for this template. This is only used during FPE transformations.
- decode_
formats Mapping[str, Any] - Optional mapping of name to regular expression template, used to customize the decoded output. (requires Vault Enterprise 1.9+)
- encode_
format str - The regular expression template used to format encoded values. (requires Vault Enterprise 1.9+)
- name str
The name of the template.
- pattern str
The pattern used for matching. Currently, only regular expression pattern is supported.
- type str
The pattern type to use for match detection. Currently, only regex is supported.
- path String
Path to where the back-end is mounted within Vault.
- alphabet String
The alphabet to use for this template. This is only used during FPE transformations.
- decode
Formats Map<Any> - Optional mapping of name to regular expression template, used to customize the decoded output. (requires Vault Enterprise 1.9+)
- encode
Format String - The regular expression template used to format encoded values. (requires Vault Enterprise 1.9+)
- name String
The name of the template.
- pattern String
The pattern used for matching. Currently, only regular expression pattern is supported.
- type String
The pattern type to use for match detection. Currently, only regex is supported.
Outputs
All input properties are implicitly available as output properties. Additionally, the Template 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 string
The provider-assigned unique ID for this managed resource.
- id str
The provider-assigned unique ID for this managed resource.
- id String
The provider-assigned unique ID for this managed resource.
Look up Existing Template Resource
Get an existing Template 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?: TemplateState, opts?: CustomResourceOptions): Template
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
alphabet: Optional[str] = None,
decode_formats: Optional[Mapping[str, Any]] = None,
encode_format: Optional[str] = None,
name: Optional[str] = None,
path: Optional[str] = None,
pattern: Optional[str] = None,
type: Optional[str] = None) -> Template
func GetTemplate(ctx *Context, name string, id IDInput, state *TemplateState, opts ...ResourceOption) (*Template, error)
public static Template Get(string name, Input<string> id, TemplateState? state, CustomResourceOptions? opts = null)
public static Template get(String name, Output<String> id, TemplateState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Alphabet string
The alphabet to use for this template. This is only used during FPE transformations.
- Decode
Formats Dictionary<string, object> - Optional mapping of name to regular expression template, used to customize the decoded output. (requires Vault Enterprise 1.9+)
- Encode
Format string - The regular expression template used to format encoded values. (requires Vault Enterprise 1.9+)
- Name string
The name of the template.
- Path string
Path to where the back-end is mounted within Vault.
- Pattern string
The pattern used for matching. Currently, only regular expression pattern is supported.
- Type string
The pattern type to use for match detection. Currently, only regex is supported.
- Alphabet string
The alphabet to use for this template. This is only used during FPE transformations.
- Decode
Formats map[string]interface{} - Optional mapping of name to regular expression template, used to customize the decoded output. (requires Vault Enterprise 1.9+)
- Encode
Format string - The regular expression template used to format encoded values. (requires Vault Enterprise 1.9+)
- Name string
The name of the template.
- Path string
Path to where the back-end is mounted within Vault.
- Pattern string
The pattern used for matching. Currently, only regular expression pattern is supported.
- Type string
The pattern type to use for match detection. Currently, only regex is supported.
- alphabet String
The alphabet to use for this template. This is only used during FPE transformations.
- decode
Formats Map<String,Object> - Optional mapping of name to regular expression template, used to customize the decoded output. (requires Vault Enterprise 1.9+)
- encode
Format String - The regular expression template used to format encoded values. (requires Vault Enterprise 1.9+)
- name String
The name of the template.
- path String
Path to where the back-end is mounted within Vault.
- pattern String
The pattern used for matching. Currently, only regular expression pattern is supported.
- type String
The pattern type to use for match detection. Currently, only regex is supported.
- alphabet string
The alphabet to use for this template. This is only used during FPE transformations.
- decode
Formats {[key: string]: any} - Optional mapping of name to regular expression template, used to customize the decoded output. (requires Vault Enterprise 1.9+)
- encode
Format string - The regular expression template used to format encoded values. (requires Vault Enterprise 1.9+)
- name string
The name of the template.
- path string
Path to where the back-end is mounted within Vault.
- pattern string
The pattern used for matching. Currently, only regular expression pattern is supported.
- type string
The pattern type to use for match detection. Currently, only regex is supported.
- alphabet str
The alphabet to use for this template. This is only used during FPE transformations.
- decode_
formats Mapping[str, Any] - Optional mapping of name to regular expression template, used to customize the decoded output. (requires Vault Enterprise 1.9+)
- encode_
format str - The regular expression template used to format encoded values. (requires Vault Enterprise 1.9+)
- name str
The name of the template.
- path str
Path to where the back-end is mounted within Vault.
- pattern str
The pattern used for matching. Currently, only regular expression pattern is supported.
- type str
The pattern type to use for match detection. Currently, only regex is supported.
- alphabet String
The alphabet to use for this template. This is only used during FPE transformations.
- decode
Formats Map<Any> - Optional mapping of name to regular expression template, used to customize the decoded output. (requires Vault Enterprise 1.9+)
- encode
Format String - The regular expression template used to format encoded values. (requires Vault Enterprise 1.9+)
- name String
The name of the template.
- path String
Path to where the back-end is mounted within Vault.
- pattern String
The pattern used for matching. Currently, only regular expression pattern is supported.
- type String
The pattern type to use for match detection. Currently, only regex is supported.
Package Details
- Repository
- Vault pulumi/pulumi-vault
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
vault
Terraform Provider.