Documentation ¶
Overview ¶
A Pulumi package for creating and managing onepassword resources.
Index ¶
- func PkgVersion() (semver.Version, error)
- type GetItemSection
- type GetItemSectionArgs
- type GetItemSectionArray
- type GetItemSectionArrayInput
- type GetItemSectionArrayOutput
- func (GetItemSectionArrayOutput) ElementType() reflect.Type
- func (o GetItemSectionArrayOutput) Index(i pulumi.IntInput) GetItemSectionOutput
- func (o GetItemSectionArrayOutput) ToGetItemSectionArrayOutput() GetItemSectionArrayOutput
- func (o GetItemSectionArrayOutput) ToGetItemSectionArrayOutputWithContext(ctx context.Context) GetItemSectionArrayOutput
- type GetItemSectionField
- type GetItemSectionFieldArgs
- type GetItemSectionFieldArray
- type GetItemSectionFieldArrayInput
- type GetItemSectionFieldArrayOutput
- func (GetItemSectionFieldArrayOutput) ElementType() reflect.Type
- func (o GetItemSectionFieldArrayOutput) Index(i pulumi.IntInput) GetItemSectionFieldOutput
- func (o GetItemSectionFieldArrayOutput) ToGetItemSectionFieldArrayOutput() GetItemSectionFieldArrayOutput
- func (o GetItemSectionFieldArrayOutput) ToGetItemSectionFieldArrayOutputWithContext(ctx context.Context) GetItemSectionFieldArrayOutput
- type GetItemSectionFieldInput
- type GetItemSectionFieldOutput
- func (GetItemSectionFieldOutput) ElementType() reflect.Type
- func (o GetItemSectionFieldOutput) Id() pulumi.StringOutput
- func (o GetItemSectionFieldOutput) Label() pulumi.StringOutput
- func (o GetItemSectionFieldOutput) Purpose() pulumi.StringOutput
- func (o GetItemSectionFieldOutput) ToGetItemSectionFieldOutput() GetItemSectionFieldOutput
- func (o GetItemSectionFieldOutput) ToGetItemSectionFieldOutputWithContext(ctx context.Context) GetItemSectionFieldOutput
- func (o GetItemSectionFieldOutput) Type() pulumi.StringOutput
- func (o GetItemSectionFieldOutput) Value() pulumi.StringOutput
- type GetItemSectionInput
- type GetItemSectionOutput
- func (GetItemSectionOutput) ElementType() reflect.Type
- func (o GetItemSectionOutput) Fields() GetItemSectionFieldArrayOutput
- func (o GetItemSectionOutput) Id() pulumi.StringOutput
- func (o GetItemSectionOutput) Label() pulumi.StringOutput
- func (o GetItemSectionOutput) ToGetItemSectionOutput() GetItemSectionOutput
- func (o GetItemSectionOutput) ToGetItemSectionOutputWithContext(ctx context.Context) GetItemSectionOutput
- type GetVaultArgs
- type GetVaultOutputArgs
- type GetVaultResult
- type GetVaultResultOutput
- func (o GetVaultResultOutput) Description() pulumi.StringOutput
- func (GetVaultResultOutput) ElementType() reflect.Type
- func (o GetVaultResultOutput) Id() pulumi.StringOutput
- func (o GetVaultResultOutput) Name() pulumi.StringOutput
- func (o GetVaultResultOutput) ToGetVaultResultOutput() GetVaultResultOutput
- func (o GetVaultResultOutput) ToGetVaultResultOutputWithContext(ctx context.Context) GetVaultResultOutput
- func (o GetVaultResultOutput) Uuid() pulumi.StringOutput
- type Item
- type ItemArgs
- type ItemArray
- type ItemArrayInput
- type ItemArrayOutput
- type ItemInput
- type ItemMap
- type ItemMapInput
- type ItemMapOutput
- type ItemOutput
- func (o ItemOutput) Category() pulumi.StringPtrOutput
- func (o ItemOutput) Database() pulumi.StringPtrOutput
- func (ItemOutput) ElementType() reflect.Type
- func (o ItemOutput) Hostname() pulumi.StringPtrOutput
- func (o ItemOutput) Password() pulumi.StringOutput
- func (o ItemOutput) PasswordRecipe() ItemPasswordRecipePtrOutput
- func (o ItemOutput) Port() pulumi.StringPtrOutput
- func (o ItemOutput) Sections() ItemSectionArrayOutput
- func (o ItemOutput) Tags() pulumi.StringArrayOutput
- func (o ItemOutput) Title() pulumi.StringPtrOutput
- func (o ItemOutput) ToItemOutput() ItemOutput
- func (o ItemOutput) ToItemOutputWithContext(ctx context.Context) ItemOutput
- func (o ItemOutput) Type() pulumi.StringPtrOutput
- func (o ItemOutput) Url() pulumi.StringPtrOutput
- func (o ItemOutput) Username() pulumi.StringPtrOutput
- func (o ItemOutput) Uuid() pulumi.StringOutput
- func (o ItemOutput) Vault() pulumi.StringOutput
- type ItemPasswordRecipe
- type ItemPasswordRecipeArgs
- func (ItemPasswordRecipeArgs) ElementType() reflect.Type
- func (i ItemPasswordRecipeArgs) ToItemPasswordRecipeOutput() ItemPasswordRecipeOutput
- func (i ItemPasswordRecipeArgs) ToItemPasswordRecipeOutputWithContext(ctx context.Context) ItemPasswordRecipeOutput
- func (i ItemPasswordRecipeArgs) ToItemPasswordRecipePtrOutput() ItemPasswordRecipePtrOutput
- func (i ItemPasswordRecipeArgs) ToItemPasswordRecipePtrOutputWithContext(ctx context.Context) ItemPasswordRecipePtrOutput
- type ItemPasswordRecipeInput
- type ItemPasswordRecipeOutput
- func (o ItemPasswordRecipeOutput) Digits() pulumi.BoolPtrOutput
- func (ItemPasswordRecipeOutput) ElementType() reflect.Type
- func (o ItemPasswordRecipeOutput) Length() pulumi.IntPtrOutput
- func (o ItemPasswordRecipeOutput) Letters() pulumi.BoolPtrOutput
- func (o ItemPasswordRecipeOutput) Symbols() pulumi.BoolPtrOutput
- func (o ItemPasswordRecipeOutput) ToItemPasswordRecipeOutput() ItemPasswordRecipeOutput
- func (o ItemPasswordRecipeOutput) ToItemPasswordRecipeOutputWithContext(ctx context.Context) ItemPasswordRecipeOutput
- func (o ItemPasswordRecipeOutput) ToItemPasswordRecipePtrOutput() ItemPasswordRecipePtrOutput
- func (o ItemPasswordRecipeOutput) ToItemPasswordRecipePtrOutputWithContext(ctx context.Context) ItemPasswordRecipePtrOutput
- type ItemPasswordRecipePtrInput
- type ItemPasswordRecipePtrOutput
- func (o ItemPasswordRecipePtrOutput) Digits() pulumi.BoolPtrOutput
- func (o ItemPasswordRecipePtrOutput) Elem() ItemPasswordRecipeOutput
- func (ItemPasswordRecipePtrOutput) ElementType() reflect.Type
- func (o ItemPasswordRecipePtrOutput) Length() pulumi.IntPtrOutput
- func (o ItemPasswordRecipePtrOutput) Letters() pulumi.BoolPtrOutput
- func (o ItemPasswordRecipePtrOutput) Symbols() pulumi.BoolPtrOutput
- func (o ItemPasswordRecipePtrOutput) ToItemPasswordRecipePtrOutput() ItemPasswordRecipePtrOutput
- func (o ItemPasswordRecipePtrOutput) ToItemPasswordRecipePtrOutputWithContext(ctx context.Context) ItemPasswordRecipePtrOutput
- type ItemSection
- type ItemSectionArgs
- type ItemSectionArray
- type ItemSectionArrayInput
- type ItemSectionArrayOutput
- func (ItemSectionArrayOutput) ElementType() reflect.Type
- func (o ItemSectionArrayOutput) Index(i pulumi.IntInput) ItemSectionOutput
- func (o ItemSectionArrayOutput) ToItemSectionArrayOutput() ItemSectionArrayOutput
- func (o ItemSectionArrayOutput) ToItemSectionArrayOutputWithContext(ctx context.Context) ItemSectionArrayOutput
- type ItemSectionField
- type ItemSectionFieldArgs
- type ItemSectionFieldArray
- type ItemSectionFieldArrayInput
- type ItemSectionFieldArrayOutput
- func (ItemSectionFieldArrayOutput) ElementType() reflect.Type
- func (o ItemSectionFieldArrayOutput) Index(i pulumi.IntInput) ItemSectionFieldOutput
- func (o ItemSectionFieldArrayOutput) ToItemSectionFieldArrayOutput() ItemSectionFieldArrayOutput
- func (o ItemSectionFieldArrayOutput) ToItemSectionFieldArrayOutputWithContext(ctx context.Context) ItemSectionFieldArrayOutput
- type ItemSectionFieldInput
- type ItemSectionFieldOutput
- func (ItemSectionFieldOutput) ElementType() reflect.Type
- func (o ItemSectionFieldOutput) Id() pulumi.StringPtrOutput
- func (o ItemSectionFieldOutput) Label() pulumi.StringOutput
- func (o ItemSectionFieldOutput) PasswordRecipe() ItemSectionFieldPasswordRecipePtrOutput
- func (o ItemSectionFieldOutput) Purpose() pulumi.StringPtrOutput
- func (o ItemSectionFieldOutput) ToItemSectionFieldOutput() ItemSectionFieldOutput
- func (o ItemSectionFieldOutput) ToItemSectionFieldOutputWithContext(ctx context.Context) ItemSectionFieldOutput
- func (o ItemSectionFieldOutput) Type() pulumi.StringPtrOutput
- func (o ItemSectionFieldOutput) Value() pulumi.StringPtrOutput
- type ItemSectionFieldPasswordRecipe
- type ItemSectionFieldPasswordRecipeArgs
- func (ItemSectionFieldPasswordRecipeArgs) ElementType() reflect.Type
- func (i ItemSectionFieldPasswordRecipeArgs) ToItemSectionFieldPasswordRecipeOutput() ItemSectionFieldPasswordRecipeOutput
- func (i ItemSectionFieldPasswordRecipeArgs) ToItemSectionFieldPasswordRecipeOutputWithContext(ctx context.Context) ItemSectionFieldPasswordRecipeOutput
- func (i ItemSectionFieldPasswordRecipeArgs) ToItemSectionFieldPasswordRecipePtrOutput() ItemSectionFieldPasswordRecipePtrOutput
- func (i ItemSectionFieldPasswordRecipeArgs) ToItemSectionFieldPasswordRecipePtrOutputWithContext(ctx context.Context) ItemSectionFieldPasswordRecipePtrOutput
- type ItemSectionFieldPasswordRecipeInput
- type ItemSectionFieldPasswordRecipeOutput
- func (o ItemSectionFieldPasswordRecipeOutput) Digits() pulumi.BoolPtrOutput
- func (ItemSectionFieldPasswordRecipeOutput) ElementType() reflect.Type
- func (o ItemSectionFieldPasswordRecipeOutput) Length() pulumi.IntPtrOutput
- func (o ItemSectionFieldPasswordRecipeOutput) Letters() pulumi.BoolPtrOutput
- func (o ItemSectionFieldPasswordRecipeOutput) Symbols() pulumi.BoolPtrOutput
- func (o ItemSectionFieldPasswordRecipeOutput) ToItemSectionFieldPasswordRecipeOutput() ItemSectionFieldPasswordRecipeOutput
- func (o ItemSectionFieldPasswordRecipeOutput) ToItemSectionFieldPasswordRecipeOutputWithContext(ctx context.Context) ItemSectionFieldPasswordRecipeOutput
- func (o ItemSectionFieldPasswordRecipeOutput) ToItemSectionFieldPasswordRecipePtrOutput() ItemSectionFieldPasswordRecipePtrOutput
- func (o ItemSectionFieldPasswordRecipeOutput) ToItemSectionFieldPasswordRecipePtrOutputWithContext(ctx context.Context) ItemSectionFieldPasswordRecipePtrOutput
- type ItemSectionFieldPasswordRecipePtrInput
- type ItemSectionFieldPasswordRecipePtrOutput
- func (o ItemSectionFieldPasswordRecipePtrOutput) Digits() pulumi.BoolPtrOutput
- func (o ItemSectionFieldPasswordRecipePtrOutput) Elem() ItemSectionFieldPasswordRecipeOutput
- func (ItemSectionFieldPasswordRecipePtrOutput) ElementType() reflect.Type
- func (o ItemSectionFieldPasswordRecipePtrOutput) Length() pulumi.IntPtrOutput
- func (o ItemSectionFieldPasswordRecipePtrOutput) Letters() pulumi.BoolPtrOutput
- func (o ItemSectionFieldPasswordRecipePtrOutput) Symbols() pulumi.BoolPtrOutput
- func (o ItemSectionFieldPasswordRecipePtrOutput) ToItemSectionFieldPasswordRecipePtrOutput() ItemSectionFieldPasswordRecipePtrOutput
- func (o ItemSectionFieldPasswordRecipePtrOutput) ToItemSectionFieldPasswordRecipePtrOutputWithContext(ctx context.Context) ItemSectionFieldPasswordRecipePtrOutput
- type ItemSectionInput
- type ItemSectionOutput
- func (ItemSectionOutput) ElementType() reflect.Type
- func (o ItemSectionOutput) Fields() ItemSectionFieldArrayOutput
- func (o ItemSectionOutput) Id() pulumi.StringPtrOutput
- func (o ItemSectionOutput) Label() pulumi.StringOutput
- func (o ItemSectionOutput) ToItemSectionOutput() ItemSectionOutput
- func (o ItemSectionOutput) ToItemSectionOutputWithContext(ctx context.Context) ItemSectionOutput
- type ItemState
- type LookupItemArgs
- type LookupItemOutputArgs
- type LookupItemResult
- type LookupItemResultOutput
- func (o LookupItemResultOutput) Category() pulumi.StringOutput
- func (o LookupItemResultOutput) Database() pulumi.StringOutput
- func (LookupItemResultOutput) ElementType() reflect.Type
- func (o LookupItemResultOutput) Hostname() pulumi.StringOutput
- func (o LookupItemResultOutput) Id() pulumi.StringOutput
- func (o LookupItemResultOutput) Password() pulumi.StringOutput
- func (o LookupItemResultOutput) Port() pulumi.StringOutput
- func (o LookupItemResultOutput) Sections() GetItemSectionArrayOutput
- func (o LookupItemResultOutput) Tags() pulumi.StringArrayOutput
- func (o LookupItemResultOutput) Title() pulumi.StringOutput
- func (o LookupItemResultOutput) ToLookupItemResultOutput() LookupItemResultOutput
- func (o LookupItemResultOutput) ToLookupItemResultOutputWithContext(ctx context.Context) LookupItemResultOutput
- func (o LookupItemResultOutput) Type() pulumi.StringOutput
- func (o LookupItemResultOutput) Url() pulumi.StringOutput
- func (o LookupItemResultOutput) Username() pulumi.StringOutput
- func (o LookupItemResultOutput) Uuid() pulumi.StringOutput
- func (o LookupItemResultOutput) Vault() pulumi.StringOutput
- type Provider
- type ProviderArgs
- type ProviderInput
- type ProviderOutput
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func PkgVersion ¶
PkgVersion uses reflection to determine the version of the current package. If a version cannot be determined, v1 will be assumed. The second return value is always nil.
Types ¶
type GetItemSection ¶
type GetItemSection struct { Fields []GetItemSectionField `pulumi:"fields"` Id string `pulumi:"id"` Label string `pulumi:"label"` }
type GetItemSectionArgs ¶
type GetItemSectionArgs struct { Fields GetItemSectionFieldArrayInput `pulumi:"fields"` Id pulumi.StringInput `pulumi:"id"` Label pulumi.StringInput `pulumi:"label"` }
func (GetItemSectionArgs) ElementType ¶
func (GetItemSectionArgs) ElementType() reflect.Type
func (GetItemSectionArgs) ToGetItemSectionOutput ¶
func (i GetItemSectionArgs) ToGetItemSectionOutput() GetItemSectionOutput
func (GetItemSectionArgs) ToGetItemSectionOutputWithContext ¶
func (i GetItemSectionArgs) ToGetItemSectionOutputWithContext(ctx context.Context) GetItemSectionOutput
type GetItemSectionArray ¶
type GetItemSectionArray []GetItemSectionInput
func (GetItemSectionArray) ElementType ¶
func (GetItemSectionArray) ElementType() reflect.Type
func (GetItemSectionArray) ToGetItemSectionArrayOutput ¶
func (i GetItemSectionArray) ToGetItemSectionArrayOutput() GetItemSectionArrayOutput
func (GetItemSectionArray) ToGetItemSectionArrayOutputWithContext ¶
func (i GetItemSectionArray) ToGetItemSectionArrayOutputWithContext(ctx context.Context) GetItemSectionArrayOutput
type GetItemSectionArrayInput ¶
type GetItemSectionArrayInput interface { pulumi.Input ToGetItemSectionArrayOutput() GetItemSectionArrayOutput ToGetItemSectionArrayOutputWithContext(context.Context) GetItemSectionArrayOutput }
GetItemSectionArrayInput is an input type that accepts GetItemSectionArray and GetItemSectionArrayOutput values. You can construct a concrete instance of `GetItemSectionArrayInput` via:
GetItemSectionArray{ GetItemSectionArgs{...} }
type GetItemSectionArrayOutput ¶
type GetItemSectionArrayOutput struct{ *pulumi.OutputState }
func (GetItemSectionArrayOutput) ElementType ¶
func (GetItemSectionArrayOutput) ElementType() reflect.Type
func (GetItemSectionArrayOutput) Index ¶
func (o GetItemSectionArrayOutput) Index(i pulumi.IntInput) GetItemSectionOutput
func (GetItemSectionArrayOutput) ToGetItemSectionArrayOutput ¶
func (o GetItemSectionArrayOutput) ToGetItemSectionArrayOutput() GetItemSectionArrayOutput
func (GetItemSectionArrayOutput) ToGetItemSectionArrayOutputWithContext ¶
func (o GetItemSectionArrayOutput) ToGetItemSectionArrayOutputWithContext(ctx context.Context) GetItemSectionArrayOutput
type GetItemSectionField ¶
type GetItemSectionField struct { Id string `pulumi:"id"` Label string `pulumi:"label"` Purpose string `pulumi:"purpose"` // (Only applies to the database category) The type of database. One of ["db2" "filemaker" "msaccess" "mssql" "mysql" "oracle" "postgresql" "sqlite" "other"] Type string `pulumi:"type"` Value string `pulumi:"value"` }
type GetItemSectionFieldArgs ¶
type GetItemSectionFieldArgs struct { Id pulumi.StringInput `pulumi:"id"` Label pulumi.StringInput `pulumi:"label"` Purpose pulumi.StringInput `pulumi:"purpose"` // (Only applies to the database category) The type of database. One of ["db2" "filemaker" "msaccess" "mssql" "mysql" "oracle" "postgresql" "sqlite" "other"] Type pulumi.StringInput `pulumi:"type"` Value pulumi.StringInput `pulumi:"value"` }
func (GetItemSectionFieldArgs) ElementType ¶
func (GetItemSectionFieldArgs) ElementType() reflect.Type
func (GetItemSectionFieldArgs) ToGetItemSectionFieldOutput ¶
func (i GetItemSectionFieldArgs) ToGetItemSectionFieldOutput() GetItemSectionFieldOutput
func (GetItemSectionFieldArgs) ToGetItemSectionFieldOutputWithContext ¶
func (i GetItemSectionFieldArgs) ToGetItemSectionFieldOutputWithContext(ctx context.Context) GetItemSectionFieldOutput
type GetItemSectionFieldArray ¶
type GetItemSectionFieldArray []GetItemSectionFieldInput
func (GetItemSectionFieldArray) ElementType ¶
func (GetItemSectionFieldArray) ElementType() reflect.Type
func (GetItemSectionFieldArray) ToGetItemSectionFieldArrayOutput ¶
func (i GetItemSectionFieldArray) ToGetItemSectionFieldArrayOutput() GetItemSectionFieldArrayOutput
func (GetItemSectionFieldArray) ToGetItemSectionFieldArrayOutputWithContext ¶
func (i GetItemSectionFieldArray) ToGetItemSectionFieldArrayOutputWithContext(ctx context.Context) GetItemSectionFieldArrayOutput
type GetItemSectionFieldArrayInput ¶
type GetItemSectionFieldArrayInput interface { pulumi.Input ToGetItemSectionFieldArrayOutput() GetItemSectionFieldArrayOutput ToGetItemSectionFieldArrayOutputWithContext(context.Context) GetItemSectionFieldArrayOutput }
GetItemSectionFieldArrayInput is an input type that accepts GetItemSectionFieldArray and GetItemSectionFieldArrayOutput values. You can construct a concrete instance of `GetItemSectionFieldArrayInput` via:
GetItemSectionFieldArray{ GetItemSectionFieldArgs{...} }
type GetItemSectionFieldArrayOutput ¶
type GetItemSectionFieldArrayOutput struct{ *pulumi.OutputState }
func (GetItemSectionFieldArrayOutput) ElementType ¶
func (GetItemSectionFieldArrayOutput) ElementType() reflect.Type
func (GetItemSectionFieldArrayOutput) Index ¶
func (o GetItemSectionFieldArrayOutput) Index(i pulumi.IntInput) GetItemSectionFieldOutput
func (GetItemSectionFieldArrayOutput) ToGetItemSectionFieldArrayOutput ¶
func (o GetItemSectionFieldArrayOutput) ToGetItemSectionFieldArrayOutput() GetItemSectionFieldArrayOutput
func (GetItemSectionFieldArrayOutput) ToGetItemSectionFieldArrayOutputWithContext ¶
func (o GetItemSectionFieldArrayOutput) ToGetItemSectionFieldArrayOutputWithContext(ctx context.Context) GetItemSectionFieldArrayOutput
type GetItemSectionFieldInput ¶
type GetItemSectionFieldInput interface { pulumi.Input ToGetItemSectionFieldOutput() GetItemSectionFieldOutput ToGetItemSectionFieldOutputWithContext(context.Context) GetItemSectionFieldOutput }
GetItemSectionFieldInput is an input type that accepts GetItemSectionFieldArgs and GetItemSectionFieldOutput values. You can construct a concrete instance of `GetItemSectionFieldInput` via:
GetItemSectionFieldArgs{...}
type GetItemSectionFieldOutput ¶
type GetItemSectionFieldOutput struct{ *pulumi.OutputState }
func (GetItemSectionFieldOutput) ElementType ¶
func (GetItemSectionFieldOutput) ElementType() reflect.Type
func (GetItemSectionFieldOutput) Id ¶
func (o GetItemSectionFieldOutput) Id() pulumi.StringOutput
func (GetItemSectionFieldOutput) Label ¶
func (o GetItemSectionFieldOutput) Label() pulumi.StringOutput
func (GetItemSectionFieldOutput) Purpose ¶
func (o GetItemSectionFieldOutput) Purpose() pulumi.StringOutput
func (GetItemSectionFieldOutput) ToGetItemSectionFieldOutput ¶
func (o GetItemSectionFieldOutput) ToGetItemSectionFieldOutput() GetItemSectionFieldOutput
func (GetItemSectionFieldOutput) ToGetItemSectionFieldOutputWithContext ¶
func (o GetItemSectionFieldOutput) ToGetItemSectionFieldOutputWithContext(ctx context.Context) GetItemSectionFieldOutput
func (GetItemSectionFieldOutput) Type ¶
func (o GetItemSectionFieldOutput) Type() pulumi.StringOutput
(Only applies to the database category) The type of database. One of ["db2" "filemaker" "msaccess" "mssql" "mysql" "oracle" "postgresql" "sqlite" "other"]
func (GetItemSectionFieldOutput) Value ¶
func (o GetItemSectionFieldOutput) Value() pulumi.StringOutput
type GetItemSectionInput ¶
type GetItemSectionInput interface { pulumi.Input ToGetItemSectionOutput() GetItemSectionOutput ToGetItemSectionOutputWithContext(context.Context) GetItemSectionOutput }
GetItemSectionInput is an input type that accepts GetItemSectionArgs and GetItemSectionOutput values. You can construct a concrete instance of `GetItemSectionInput` via:
GetItemSectionArgs{...}
type GetItemSectionOutput ¶
type GetItemSectionOutput struct{ *pulumi.OutputState }
func (GetItemSectionOutput) ElementType ¶
func (GetItemSectionOutput) ElementType() reflect.Type
func (GetItemSectionOutput) Fields ¶
func (o GetItemSectionOutput) Fields() GetItemSectionFieldArrayOutput
func (GetItemSectionOutput) Id ¶
func (o GetItemSectionOutput) Id() pulumi.StringOutput
func (GetItemSectionOutput) Label ¶
func (o GetItemSectionOutput) Label() pulumi.StringOutput
func (GetItemSectionOutput) ToGetItemSectionOutput ¶
func (o GetItemSectionOutput) ToGetItemSectionOutput() GetItemSectionOutput
func (GetItemSectionOutput) ToGetItemSectionOutputWithContext ¶
func (o GetItemSectionOutput) ToGetItemSectionOutputWithContext(ctx context.Context) GetItemSectionOutput
type GetVaultArgs ¶
type GetVaultArgs struct { // The name of the vault to retrieve. This field will be populated with the name of the vault if the vault it looked up by its UUID. Name *string `pulumi:"name"` // The UUID of the vault to retrieve. This field will be populated with the UUID of the vault if the vault it looked up by its name. Uuid *string `pulumi:"uuid"` }
A collection of arguments for invoking GetVault.
type GetVaultOutputArgs ¶
type GetVaultOutputArgs struct { // The name of the vault to retrieve. This field will be populated with the name of the vault if the vault it looked up by its UUID. Name pulumi.StringPtrInput `pulumi:"name"` // The UUID of the vault to retrieve. This field will be populated with the UUID of the vault if the vault it looked up by its name. Uuid pulumi.StringPtrInput `pulumi:"uuid"` }
A collection of arguments for invoking GetVault.
func (GetVaultOutputArgs) ElementType ¶
func (GetVaultOutputArgs) ElementType() reflect.Type
type GetVaultResult ¶
type GetVaultResult struct { // The description of the vault. Description string `pulumi:"description"` Id string `pulumi:"id"` // The name of the vault to retrieve. This field will be populated with the name of the vault if the vault it looked up by its UUID. Name string `pulumi:"name"` // The UUID of the vault to retrieve. This field will be populated with the UUID of the vault if the vault it looked up by its name. Uuid string `pulumi:"uuid"` }
A collection of values returned by GetVault.
func GetVault ¶
func GetVault(ctx *pulumi.Context, args *GetVaultArgs, opts ...pulumi.InvokeOption) (*GetVaultResult, error)
Use this data source to get details of a vault by either its name or uuid.
type GetVaultResultOutput ¶
type GetVaultResultOutput struct{ *pulumi.OutputState }
A collection of values returned by GetVault.
func GetVaultOutput ¶
func GetVaultOutput(ctx *pulumi.Context, args GetVaultOutputArgs, opts ...pulumi.InvokeOption) GetVaultResultOutput
func (GetVaultResultOutput) Description ¶
func (o GetVaultResultOutput) Description() pulumi.StringOutput
The description of the vault.
func (GetVaultResultOutput) ElementType ¶
func (GetVaultResultOutput) ElementType() reflect.Type
func (GetVaultResultOutput) Id ¶
func (o GetVaultResultOutput) Id() pulumi.StringOutput
func (GetVaultResultOutput) Name ¶
func (o GetVaultResultOutput) Name() pulumi.StringOutput
The name of the vault to retrieve. This field will be populated with the name of the vault if the vault it looked up by its UUID.
func (GetVaultResultOutput) ToGetVaultResultOutput ¶
func (o GetVaultResultOutput) ToGetVaultResultOutput() GetVaultResultOutput
func (GetVaultResultOutput) ToGetVaultResultOutputWithContext ¶
func (o GetVaultResultOutput) ToGetVaultResultOutputWithContext(ctx context.Context) GetVaultResultOutput
func (GetVaultResultOutput) Uuid ¶
func (o GetVaultResultOutput) Uuid() pulumi.StringOutput
The UUID of the vault to retrieve. This field will be populated with the UUID of the vault if the vault it looked up by its name.
type Item ¶
type Item struct { pulumi.CustomResourceState // The category of the item. One of ["login" "password" "database"] Category pulumi.StringPtrOutput `pulumi:"category"` // (Only applies to the database category) The name of the database. Database pulumi.StringPtrOutput `pulumi:"database"` // (Only applies to the database category) The address where the database can be found Hostname pulumi.StringPtrOutput `pulumi:"hostname"` // Password for this item. Password pulumi.StringOutput `pulumi:"password"` // Password for this item. PasswordRecipe ItemPasswordRecipePtrOutput `pulumi:"passwordRecipe"` // (Only applies to the database category) The port the database is listening on. Port pulumi.StringPtrOutput `pulumi:"port"` // A list of custom sections in an item Sections ItemSectionArrayOutput `pulumi:"sections"` // An array of strings of the tags assigned to the item. Tags pulumi.StringArrayOutput `pulumi:"tags"` // The title of the item. Title pulumi.StringPtrOutput `pulumi:"title"` // (Only applies to the database category) The type of database. One of ["db2" "filemaker" "msaccess" "mssql" "mysql" "oracle" "postgresql" "sqlite" "other"] Type pulumi.StringPtrOutput `pulumi:"type"` // The primary URL for the item. Url pulumi.StringPtrOutput `pulumi:"url"` // Username for this item. Username pulumi.StringPtrOutput `pulumi:"username"` // The UUID of the item. Item identifiers are unique within a specific vault. Uuid pulumi.StringOutput `pulumi:"uuid"` // The UUID of the vault the item is in. Vault pulumi.StringOutput `pulumi:"vault"` }
A 1Password item.
## Example Usage
```go package main
import (
"github.com/SimCubeLtd/pulumi-onepassword/sdk/go/onepassword" "github.com/pulumi/pulumi-onepassword/sdk/go/onepassword" "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() { pulumi.Run(func(ctx *pulumi.Context) error { _, err := onepassword.NewItem(ctx, "demoPassword", &onepassword.ItemArgs{ Vault: pulumi.Any(_var.Demo_vault), Title: pulumi.String("Demo Password Recipe"), Category: pulumi.String("password"), PasswordRecipe: &ItemPasswordRecipeArgs{ Length: pulumi.Int(40), Symbols: pulumi.Bool(false), }, }) if err != nil { return err } _, err = onepassword.NewItem(ctx, "demoLogin", &onepassword.ItemArgs{ Vault: pulumi.Any(_var.Demo_vault), Title: pulumi.String("Demo Terraform Login"), Category: pulumi.String("login"), Username: pulumi.String("test@example.com"), }) if err != nil { return err } _, err = onepassword.NewItem(ctx, "demoDb", &onepassword.ItemArgs{ Vault: pulumi.Any(_var.Demo_vault), Category: pulumi.String("database"), Type: pulumi.String("mysql"), Title: pulumi.String("Demo TF Database"), Username: pulumi.String("root"), Database: pulumi.String("Example MySQL Instance"), Hostname: pulumi.String("localhost"), Port: pulumi.String("3306"), }) if err != nil { return err } return nil }) }
```
## Import
import an existing 1Password item ¶
```sh
$ pulumi import onepassword:index/item:Item myitem vaults/<vault uuid>/items/<item uuid>
```
func GetItem ¶
func GetItem(ctx *pulumi.Context, name string, id pulumi.IDInput, state *ItemState, opts ...pulumi.ResourceOption) (*Item, error)
GetItem gets an existing Item resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
func NewItem ¶
func NewItem(ctx *pulumi.Context, name string, args *ItemArgs, opts ...pulumi.ResourceOption) (*Item, error)
NewItem registers a new resource with the given unique name, arguments, and options.
func (*Item) ElementType ¶
func (*Item) ToItemOutput ¶
func (i *Item) ToItemOutput() ItemOutput
func (*Item) ToItemOutputWithContext ¶
func (i *Item) ToItemOutputWithContext(ctx context.Context) ItemOutput
type ItemArgs ¶
type ItemArgs struct { // The category of the item. One of ["login" "password" "database"] Category pulumi.StringPtrInput // (Only applies to the database category) The name of the database. Database pulumi.StringPtrInput // (Only applies to the database category) The address where the database can be found Hostname pulumi.StringPtrInput // Password for this item. Password pulumi.StringPtrInput // Password for this item. PasswordRecipe ItemPasswordRecipePtrInput // (Only applies to the database category) The port the database is listening on. Port pulumi.StringPtrInput // A list of custom sections in an item Sections ItemSectionArrayInput // An array of strings of the tags assigned to the item. Tags pulumi.StringArrayInput // The title of the item. Title pulumi.StringPtrInput // (Only applies to the database category) The type of database. One of ["db2" "filemaker" "msaccess" "mssql" "mysql" "oracle" "postgresql" "sqlite" "other"] Type pulumi.StringPtrInput // The primary URL for the item. Url pulumi.StringPtrInput // Username for this item. Username pulumi.StringPtrInput // The UUID of the vault the item is in. Vault pulumi.StringInput }
The set of arguments for constructing a Item resource.
func (ItemArgs) ElementType ¶
type ItemArray ¶
type ItemArray []ItemInput
func (ItemArray) ElementType ¶
func (ItemArray) ToItemArrayOutput ¶
func (i ItemArray) ToItemArrayOutput() ItemArrayOutput
func (ItemArray) ToItemArrayOutputWithContext ¶
func (i ItemArray) ToItemArrayOutputWithContext(ctx context.Context) ItemArrayOutput
type ItemArrayInput ¶
type ItemArrayInput interface { pulumi.Input ToItemArrayOutput() ItemArrayOutput ToItemArrayOutputWithContext(context.Context) ItemArrayOutput }
ItemArrayInput is an input type that accepts ItemArray and ItemArrayOutput values. You can construct a concrete instance of `ItemArrayInput` via:
ItemArray{ ItemArgs{...} }
type ItemArrayOutput ¶
type ItemArrayOutput struct{ *pulumi.OutputState }
func (ItemArrayOutput) ElementType ¶
func (ItemArrayOutput) ElementType() reflect.Type
func (ItemArrayOutput) Index ¶
func (o ItemArrayOutput) Index(i pulumi.IntInput) ItemOutput
func (ItemArrayOutput) ToItemArrayOutput ¶
func (o ItemArrayOutput) ToItemArrayOutput() ItemArrayOutput
func (ItemArrayOutput) ToItemArrayOutputWithContext ¶
func (o ItemArrayOutput) ToItemArrayOutputWithContext(ctx context.Context) ItemArrayOutput
type ItemInput ¶
type ItemInput interface { pulumi.Input ToItemOutput() ItemOutput ToItemOutputWithContext(ctx context.Context) ItemOutput }
type ItemMap ¶
func (ItemMap) ElementType ¶
func (ItemMap) ToItemMapOutput ¶
func (i ItemMap) ToItemMapOutput() ItemMapOutput
func (ItemMap) ToItemMapOutputWithContext ¶
func (i ItemMap) ToItemMapOutputWithContext(ctx context.Context) ItemMapOutput
type ItemMapInput ¶
type ItemMapInput interface { pulumi.Input ToItemMapOutput() ItemMapOutput ToItemMapOutputWithContext(context.Context) ItemMapOutput }
ItemMapInput is an input type that accepts ItemMap and ItemMapOutput values. You can construct a concrete instance of `ItemMapInput` via:
ItemMap{ "key": ItemArgs{...} }
type ItemMapOutput ¶
type ItemMapOutput struct{ *pulumi.OutputState }
func (ItemMapOutput) ElementType ¶
func (ItemMapOutput) ElementType() reflect.Type
func (ItemMapOutput) MapIndex ¶
func (o ItemMapOutput) MapIndex(k pulumi.StringInput) ItemOutput
func (ItemMapOutput) ToItemMapOutput ¶
func (o ItemMapOutput) ToItemMapOutput() ItemMapOutput
func (ItemMapOutput) ToItemMapOutputWithContext ¶
func (o ItemMapOutput) ToItemMapOutputWithContext(ctx context.Context) ItemMapOutput
type ItemOutput ¶
type ItemOutput struct{ *pulumi.OutputState }
func (ItemOutput) Category ¶
func (o ItemOutput) Category() pulumi.StringPtrOutput
The category of the item. One of ["login" "password" "database"]
func (ItemOutput) Database ¶
func (o ItemOutput) Database() pulumi.StringPtrOutput
(Only applies to the database category) The name of the database.
func (ItemOutput) ElementType ¶
func (ItemOutput) ElementType() reflect.Type
func (ItemOutput) Hostname ¶
func (o ItemOutput) Hostname() pulumi.StringPtrOutput
(Only applies to the database category) The address where the database can be found
func (ItemOutput) Password ¶
func (o ItemOutput) Password() pulumi.StringOutput
Password for this item.
func (ItemOutput) PasswordRecipe ¶
func (o ItemOutput) PasswordRecipe() ItemPasswordRecipePtrOutput
Password for this item.
func (ItemOutput) Port ¶
func (o ItemOutput) Port() pulumi.StringPtrOutput
(Only applies to the database category) The port the database is listening on.
func (ItemOutput) Sections ¶
func (o ItemOutput) Sections() ItemSectionArrayOutput
A list of custom sections in an item
func (ItemOutput) Tags ¶
func (o ItemOutput) Tags() pulumi.StringArrayOutput
An array of strings of the tags assigned to the item.
func (ItemOutput) ToItemOutput ¶
func (o ItemOutput) ToItemOutput() ItemOutput
func (ItemOutput) ToItemOutputWithContext ¶
func (o ItemOutput) ToItemOutputWithContext(ctx context.Context) ItemOutput
func (ItemOutput) Type ¶
func (o ItemOutput) Type() pulumi.StringPtrOutput
(Only applies to the database category) The type of database. One of ["db2" "filemaker" "msaccess" "mssql" "mysql" "oracle" "postgresql" "sqlite" "other"]
func (ItemOutput) Url ¶
func (o ItemOutput) Url() pulumi.StringPtrOutput
The primary URL for the item.
func (ItemOutput) Username ¶
func (o ItemOutput) Username() pulumi.StringPtrOutput
Username for this item.
func (ItemOutput) Uuid ¶
func (o ItemOutput) Uuid() pulumi.StringOutput
The UUID of the item. Item identifiers are unique within a specific vault.
func (ItemOutput) Vault ¶
func (o ItemOutput) Vault() pulumi.StringOutput
The UUID of the vault the item is in.
type ItemPasswordRecipe ¶
type ItemPasswordRecipe struct { // Use digits [0-9] when generating the password. Digits *bool `pulumi:"digits"` // The length of the password to be generated. Length *int `pulumi:"length"` // Use letters [a-zA-Z] when generating the password. Letters *bool `pulumi:"letters"` // Use symbols [!@.-_*] when generating the password. Symbols *bool `pulumi:"symbols"` }
type ItemPasswordRecipeArgs ¶
type ItemPasswordRecipeArgs struct { // Use digits [0-9] when generating the password. Digits pulumi.BoolPtrInput `pulumi:"digits"` // The length of the password to be generated. Length pulumi.IntPtrInput `pulumi:"length"` // Use letters [a-zA-Z] when generating the password. Letters pulumi.BoolPtrInput `pulumi:"letters"` // Use symbols [!@.-_*] when generating the password. Symbols pulumi.BoolPtrInput `pulumi:"symbols"` }
func (ItemPasswordRecipeArgs) ElementType ¶
func (ItemPasswordRecipeArgs) ElementType() reflect.Type
func (ItemPasswordRecipeArgs) ToItemPasswordRecipeOutput ¶
func (i ItemPasswordRecipeArgs) ToItemPasswordRecipeOutput() ItemPasswordRecipeOutput
func (ItemPasswordRecipeArgs) ToItemPasswordRecipeOutputWithContext ¶
func (i ItemPasswordRecipeArgs) ToItemPasswordRecipeOutputWithContext(ctx context.Context) ItemPasswordRecipeOutput
func (ItemPasswordRecipeArgs) ToItemPasswordRecipePtrOutput ¶
func (i ItemPasswordRecipeArgs) ToItemPasswordRecipePtrOutput() ItemPasswordRecipePtrOutput
func (ItemPasswordRecipeArgs) ToItemPasswordRecipePtrOutputWithContext ¶
func (i ItemPasswordRecipeArgs) ToItemPasswordRecipePtrOutputWithContext(ctx context.Context) ItemPasswordRecipePtrOutput
type ItemPasswordRecipeInput ¶
type ItemPasswordRecipeInput interface { pulumi.Input ToItemPasswordRecipeOutput() ItemPasswordRecipeOutput ToItemPasswordRecipeOutputWithContext(context.Context) ItemPasswordRecipeOutput }
ItemPasswordRecipeInput is an input type that accepts ItemPasswordRecipeArgs and ItemPasswordRecipeOutput values. You can construct a concrete instance of `ItemPasswordRecipeInput` via:
ItemPasswordRecipeArgs{...}
type ItemPasswordRecipeOutput ¶
type ItemPasswordRecipeOutput struct{ *pulumi.OutputState }
func (ItemPasswordRecipeOutput) Digits ¶
func (o ItemPasswordRecipeOutput) Digits() pulumi.BoolPtrOutput
Use digits [0-9] when generating the password.
func (ItemPasswordRecipeOutput) ElementType ¶
func (ItemPasswordRecipeOutput) ElementType() reflect.Type
func (ItemPasswordRecipeOutput) Length ¶
func (o ItemPasswordRecipeOutput) Length() pulumi.IntPtrOutput
The length of the password to be generated.
func (ItemPasswordRecipeOutput) Letters ¶
func (o ItemPasswordRecipeOutput) Letters() pulumi.BoolPtrOutput
Use letters [a-zA-Z] when generating the password.
func (ItemPasswordRecipeOutput) Symbols ¶
func (o ItemPasswordRecipeOutput) Symbols() pulumi.BoolPtrOutput
Use symbols [!@.-_*] when generating the password.
func (ItemPasswordRecipeOutput) ToItemPasswordRecipeOutput ¶
func (o ItemPasswordRecipeOutput) ToItemPasswordRecipeOutput() ItemPasswordRecipeOutput
func (ItemPasswordRecipeOutput) ToItemPasswordRecipeOutputWithContext ¶
func (o ItemPasswordRecipeOutput) ToItemPasswordRecipeOutputWithContext(ctx context.Context) ItemPasswordRecipeOutput
func (ItemPasswordRecipeOutput) ToItemPasswordRecipePtrOutput ¶
func (o ItemPasswordRecipeOutput) ToItemPasswordRecipePtrOutput() ItemPasswordRecipePtrOutput
func (ItemPasswordRecipeOutput) ToItemPasswordRecipePtrOutputWithContext ¶
func (o ItemPasswordRecipeOutput) ToItemPasswordRecipePtrOutputWithContext(ctx context.Context) ItemPasswordRecipePtrOutput
type ItemPasswordRecipePtrInput ¶
type ItemPasswordRecipePtrInput interface { pulumi.Input ToItemPasswordRecipePtrOutput() ItemPasswordRecipePtrOutput ToItemPasswordRecipePtrOutputWithContext(context.Context) ItemPasswordRecipePtrOutput }
ItemPasswordRecipePtrInput is an input type that accepts ItemPasswordRecipeArgs, ItemPasswordRecipePtr and ItemPasswordRecipePtrOutput values. You can construct a concrete instance of `ItemPasswordRecipePtrInput` via:
ItemPasswordRecipeArgs{...} or: nil
func ItemPasswordRecipePtr ¶
func ItemPasswordRecipePtr(v *ItemPasswordRecipeArgs) ItemPasswordRecipePtrInput
type ItemPasswordRecipePtrOutput ¶
type ItemPasswordRecipePtrOutput struct{ *pulumi.OutputState }
func (ItemPasswordRecipePtrOutput) Digits ¶
func (o ItemPasswordRecipePtrOutput) Digits() pulumi.BoolPtrOutput
Use digits [0-9] when generating the password.
func (ItemPasswordRecipePtrOutput) Elem ¶
func (o ItemPasswordRecipePtrOutput) Elem() ItemPasswordRecipeOutput
func (ItemPasswordRecipePtrOutput) ElementType ¶
func (ItemPasswordRecipePtrOutput) ElementType() reflect.Type
func (ItemPasswordRecipePtrOutput) Length ¶
func (o ItemPasswordRecipePtrOutput) Length() pulumi.IntPtrOutput
The length of the password to be generated.
func (ItemPasswordRecipePtrOutput) Letters ¶
func (o ItemPasswordRecipePtrOutput) Letters() pulumi.BoolPtrOutput
Use letters [a-zA-Z] when generating the password.
func (ItemPasswordRecipePtrOutput) Symbols ¶
func (o ItemPasswordRecipePtrOutput) Symbols() pulumi.BoolPtrOutput
Use symbols [!@.-_*] when generating the password.
func (ItemPasswordRecipePtrOutput) ToItemPasswordRecipePtrOutput ¶
func (o ItemPasswordRecipePtrOutput) ToItemPasswordRecipePtrOutput() ItemPasswordRecipePtrOutput
func (ItemPasswordRecipePtrOutput) ToItemPasswordRecipePtrOutputWithContext ¶
func (o ItemPasswordRecipePtrOutput) ToItemPasswordRecipePtrOutputWithContext(ctx context.Context) ItemPasswordRecipePtrOutput
type ItemSection ¶
type ItemSection struct { // A list of custom fields in the section. Fields []ItemSectionField `pulumi:"fields"` // A unique identifier for the section. Id *string `pulumi:"id"` // The label for the section. Label string `pulumi:"label"` }
type ItemSectionArgs ¶
type ItemSectionArgs struct { // A list of custom fields in the section. Fields ItemSectionFieldArrayInput `pulumi:"fields"` // A unique identifier for the section. Id pulumi.StringPtrInput `pulumi:"id"` // The label for the section. Label pulumi.StringInput `pulumi:"label"` }
func (ItemSectionArgs) ElementType ¶
func (ItemSectionArgs) ElementType() reflect.Type
func (ItemSectionArgs) ToItemSectionOutput ¶
func (i ItemSectionArgs) ToItemSectionOutput() ItemSectionOutput
func (ItemSectionArgs) ToItemSectionOutputWithContext ¶
func (i ItemSectionArgs) ToItemSectionOutputWithContext(ctx context.Context) ItemSectionOutput
type ItemSectionArray ¶
type ItemSectionArray []ItemSectionInput
func (ItemSectionArray) ElementType ¶
func (ItemSectionArray) ElementType() reflect.Type
func (ItemSectionArray) ToItemSectionArrayOutput ¶
func (i ItemSectionArray) ToItemSectionArrayOutput() ItemSectionArrayOutput
func (ItemSectionArray) ToItemSectionArrayOutputWithContext ¶
func (i ItemSectionArray) ToItemSectionArrayOutputWithContext(ctx context.Context) ItemSectionArrayOutput
type ItemSectionArrayInput ¶
type ItemSectionArrayInput interface { pulumi.Input ToItemSectionArrayOutput() ItemSectionArrayOutput ToItemSectionArrayOutputWithContext(context.Context) ItemSectionArrayOutput }
ItemSectionArrayInput is an input type that accepts ItemSectionArray and ItemSectionArrayOutput values. You can construct a concrete instance of `ItemSectionArrayInput` via:
ItemSectionArray{ ItemSectionArgs{...} }
type ItemSectionArrayOutput ¶
type ItemSectionArrayOutput struct{ *pulumi.OutputState }
func (ItemSectionArrayOutput) ElementType ¶
func (ItemSectionArrayOutput) ElementType() reflect.Type
func (ItemSectionArrayOutput) Index ¶
func (o ItemSectionArrayOutput) Index(i pulumi.IntInput) ItemSectionOutput
func (ItemSectionArrayOutput) ToItemSectionArrayOutput ¶
func (o ItemSectionArrayOutput) ToItemSectionArrayOutput() ItemSectionArrayOutput
func (ItemSectionArrayOutput) ToItemSectionArrayOutputWithContext ¶
func (o ItemSectionArrayOutput) ToItemSectionArrayOutputWithContext(ctx context.Context) ItemSectionArrayOutput
type ItemSectionField ¶
type ItemSectionField struct { Id *string `pulumi:"id"` Label string `pulumi:"label"` // Password for this item. PasswordRecipe *ItemSectionFieldPasswordRecipe `pulumi:"passwordRecipe"` Purpose *string `pulumi:"purpose"` // (Only applies to the database category) The type of database. One of ["db2" "filemaker" "msaccess" "mssql" "mysql" "oracle" "postgresql" "sqlite" "other"] Type *string `pulumi:"type"` Value *string `pulumi:"value"` }
type ItemSectionFieldArgs ¶
type ItemSectionFieldArgs struct { Id pulumi.StringPtrInput `pulumi:"id"` Label pulumi.StringInput `pulumi:"label"` // Password for this item. PasswordRecipe ItemSectionFieldPasswordRecipePtrInput `pulumi:"passwordRecipe"` Purpose pulumi.StringPtrInput `pulumi:"purpose"` // (Only applies to the database category) The type of database. One of ["db2" "filemaker" "msaccess" "mssql" "mysql" "oracle" "postgresql" "sqlite" "other"] Type pulumi.StringPtrInput `pulumi:"type"` Value pulumi.StringPtrInput `pulumi:"value"` }
func (ItemSectionFieldArgs) ElementType ¶
func (ItemSectionFieldArgs) ElementType() reflect.Type
func (ItemSectionFieldArgs) ToItemSectionFieldOutput ¶
func (i ItemSectionFieldArgs) ToItemSectionFieldOutput() ItemSectionFieldOutput
func (ItemSectionFieldArgs) ToItemSectionFieldOutputWithContext ¶
func (i ItemSectionFieldArgs) ToItemSectionFieldOutputWithContext(ctx context.Context) ItemSectionFieldOutput
type ItemSectionFieldArray ¶
type ItemSectionFieldArray []ItemSectionFieldInput
func (ItemSectionFieldArray) ElementType ¶
func (ItemSectionFieldArray) ElementType() reflect.Type
func (ItemSectionFieldArray) ToItemSectionFieldArrayOutput ¶
func (i ItemSectionFieldArray) ToItemSectionFieldArrayOutput() ItemSectionFieldArrayOutput
func (ItemSectionFieldArray) ToItemSectionFieldArrayOutputWithContext ¶
func (i ItemSectionFieldArray) ToItemSectionFieldArrayOutputWithContext(ctx context.Context) ItemSectionFieldArrayOutput
type ItemSectionFieldArrayInput ¶
type ItemSectionFieldArrayInput interface { pulumi.Input ToItemSectionFieldArrayOutput() ItemSectionFieldArrayOutput ToItemSectionFieldArrayOutputWithContext(context.Context) ItemSectionFieldArrayOutput }
ItemSectionFieldArrayInput is an input type that accepts ItemSectionFieldArray and ItemSectionFieldArrayOutput values. You can construct a concrete instance of `ItemSectionFieldArrayInput` via:
ItemSectionFieldArray{ ItemSectionFieldArgs{...} }
type ItemSectionFieldArrayOutput ¶
type ItemSectionFieldArrayOutput struct{ *pulumi.OutputState }
func (ItemSectionFieldArrayOutput) ElementType ¶
func (ItemSectionFieldArrayOutput) ElementType() reflect.Type
func (ItemSectionFieldArrayOutput) Index ¶
func (o ItemSectionFieldArrayOutput) Index(i pulumi.IntInput) ItemSectionFieldOutput
func (ItemSectionFieldArrayOutput) ToItemSectionFieldArrayOutput ¶
func (o ItemSectionFieldArrayOutput) ToItemSectionFieldArrayOutput() ItemSectionFieldArrayOutput
func (ItemSectionFieldArrayOutput) ToItemSectionFieldArrayOutputWithContext ¶
func (o ItemSectionFieldArrayOutput) ToItemSectionFieldArrayOutputWithContext(ctx context.Context) ItemSectionFieldArrayOutput
type ItemSectionFieldInput ¶
type ItemSectionFieldInput interface { pulumi.Input ToItemSectionFieldOutput() ItemSectionFieldOutput ToItemSectionFieldOutputWithContext(context.Context) ItemSectionFieldOutput }
ItemSectionFieldInput is an input type that accepts ItemSectionFieldArgs and ItemSectionFieldOutput values. You can construct a concrete instance of `ItemSectionFieldInput` via:
ItemSectionFieldArgs{...}
type ItemSectionFieldOutput ¶
type ItemSectionFieldOutput struct{ *pulumi.OutputState }
func (ItemSectionFieldOutput) ElementType ¶
func (ItemSectionFieldOutput) ElementType() reflect.Type
func (ItemSectionFieldOutput) Id ¶
func (o ItemSectionFieldOutput) Id() pulumi.StringPtrOutput
func (ItemSectionFieldOutput) Label ¶
func (o ItemSectionFieldOutput) Label() pulumi.StringOutput
func (ItemSectionFieldOutput) PasswordRecipe ¶
func (o ItemSectionFieldOutput) PasswordRecipe() ItemSectionFieldPasswordRecipePtrOutput
Password for this item.
func (ItemSectionFieldOutput) Purpose ¶
func (o ItemSectionFieldOutput) Purpose() pulumi.StringPtrOutput
func (ItemSectionFieldOutput) ToItemSectionFieldOutput ¶
func (o ItemSectionFieldOutput) ToItemSectionFieldOutput() ItemSectionFieldOutput
func (ItemSectionFieldOutput) ToItemSectionFieldOutputWithContext ¶
func (o ItemSectionFieldOutput) ToItemSectionFieldOutputWithContext(ctx context.Context) ItemSectionFieldOutput
func (ItemSectionFieldOutput) Type ¶
func (o ItemSectionFieldOutput) Type() pulumi.StringPtrOutput
(Only applies to the database category) The type of database. One of ["db2" "filemaker" "msaccess" "mssql" "mysql" "oracle" "postgresql" "sqlite" "other"]
func (ItemSectionFieldOutput) Value ¶
func (o ItemSectionFieldOutput) Value() pulumi.StringPtrOutput
type ItemSectionFieldPasswordRecipe ¶
type ItemSectionFieldPasswordRecipe struct { // Use digits [0-9] when generating the password. Digits *bool `pulumi:"digits"` // The length of the password to be generated. Length *int `pulumi:"length"` // Use letters [a-zA-Z] when generating the password. Letters *bool `pulumi:"letters"` // Use symbols [!@.-_*] when generating the password. Symbols *bool `pulumi:"symbols"` }
type ItemSectionFieldPasswordRecipeArgs ¶
type ItemSectionFieldPasswordRecipeArgs struct { // Use digits [0-9] when generating the password. Digits pulumi.BoolPtrInput `pulumi:"digits"` // The length of the password to be generated. Length pulumi.IntPtrInput `pulumi:"length"` // Use letters [a-zA-Z] when generating the password. Letters pulumi.BoolPtrInput `pulumi:"letters"` // Use symbols [!@.-_*] when generating the password. Symbols pulumi.BoolPtrInput `pulumi:"symbols"` }
func (ItemSectionFieldPasswordRecipeArgs) ElementType ¶
func (ItemSectionFieldPasswordRecipeArgs) ElementType() reflect.Type
func (ItemSectionFieldPasswordRecipeArgs) ToItemSectionFieldPasswordRecipeOutput ¶
func (i ItemSectionFieldPasswordRecipeArgs) ToItemSectionFieldPasswordRecipeOutput() ItemSectionFieldPasswordRecipeOutput
func (ItemSectionFieldPasswordRecipeArgs) ToItemSectionFieldPasswordRecipeOutputWithContext ¶
func (i ItemSectionFieldPasswordRecipeArgs) ToItemSectionFieldPasswordRecipeOutputWithContext(ctx context.Context) ItemSectionFieldPasswordRecipeOutput
func (ItemSectionFieldPasswordRecipeArgs) ToItemSectionFieldPasswordRecipePtrOutput ¶
func (i ItemSectionFieldPasswordRecipeArgs) ToItemSectionFieldPasswordRecipePtrOutput() ItemSectionFieldPasswordRecipePtrOutput
func (ItemSectionFieldPasswordRecipeArgs) ToItemSectionFieldPasswordRecipePtrOutputWithContext ¶
func (i ItemSectionFieldPasswordRecipeArgs) ToItemSectionFieldPasswordRecipePtrOutputWithContext(ctx context.Context) ItemSectionFieldPasswordRecipePtrOutput
type ItemSectionFieldPasswordRecipeInput ¶
type ItemSectionFieldPasswordRecipeInput interface { pulumi.Input ToItemSectionFieldPasswordRecipeOutput() ItemSectionFieldPasswordRecipeOutput ToItemSectionFieldPasswordRecipeOutputWithContext(context.Context) ItemSectionFieldPasswordRecipeOutput }
ItemSectionFieldPasswordRecipeInput is an input type that accepts ItemSectionFieldPasswordRecipeArgs and ItemSectionFieldPasswordRecipeOutput values. You can construct a concrete instance of `ItemSectionFieldPasswordRecipeInput` via:
ItemSectionFieldPasswordRecipeArgs{...}
type ItemSectionFieldPasswordRecipeOutput ¶
type ItemSectionFieldPasswordRecipeOutput struct{ *pulumi.OutputState }
func (ItemSectionFieldPasswordRecipeOutput) Digits ¶
func (o ItemSectionFieldPasswordRecipeOutput) Digits() pulumi.BoolPtrOutput
Use digits [0-9] when generating the password.
func (ItemSectionFieldPasswordRecipeOutput) ElementType ¶
func (ItemSectionFieldPasswordRecipeOutput) ElementType() reflect.Type
func (ItemSectionFieldPasswordRecipeOutput) Length ¶
func (o ItemSectionFieldPasswordRecipeOutput) Length() pulumi.IntPtrOutput
The length of the password to be generated.
func (ItemSectionFieldPasswordRecipeOutput) Letters ¶
func (o ItemSectionFieldPasswordRecipeOutput) Letters() pulumi.BoolPtrOutput
Use letters [a-zA-Z] when generating the password.
func (ItemSectionFieldPasswordRecipeOutput) Symbols ¶
func (o ItemSectionFieldPasswordRecipeOutput) Symbols() pulumi.BoolPtrOutput
Use symbols [!@.-_*] when generating the password.
func (ItemSectionFieldPasswordRecipeOutput) ToItemSectionFieldPasswordRecipeOutput ¶
func (o ItemSectionFieldPasswordRecipeOutput) ToItemSectionFieldPasswordRecipeOutput() ItemSectionFieldPasswordRecipeOutput
func (ItemSectionFieldPasswordRecipeOutput) ToItemSectionFieldPasswordRecipeOutputWithContext ¶
func (o ItemSectionFieldPasswordRecipeOutput) ToItemSectionFieldPasswordRecipeOutputWithContext(ctx context.Context) ItemSectionFieldPasswordRecipeOutput
func (ItemSectionFieldPasswordRecipeOutput) ToItemSectionFieldPasswordRecipePtrOutput ¶
func (o ItemSectionFieldPasswordRecipeOutput) ToItemSectionFieldPasswordRecipePtrOutput() ItemSectionFieldPasswordRecipePtrOutput
func (ItemSectionFieldPasswordRecipeOutput) ToItemSectionFieldPasswordRecipePtrOutputWithContext ¶
func (o ItemSectionFieldPasswordRecipeOutput) ToItemSectionFieldPasswordRecipePtrOutputWithContext(ctx context.Context) ItemSectionFieldPasswordRecipePtrOutput
type ItemSectionFieldPasswordRecipePtrInput ¶
type ItemSectionFieldPasswordRecipePtrInput interface { pulumi.Input ToItemSectionFieldPasswordRecipePtrOutput() ItemSectionFieldPasswordRecipePtrOutput ToItemSectionFieldPasswordRecipePtrOutputWithContext(context.Context) ItemSectionFieldPasswordRecipePtrOutput }
ItemSectionFieldPasswordRecipePtrInput is an input type that accepts ItemSectionFieldPasswordRecipeArgs, ItemSectionFieldPasswordRecipePtr and ItemSectionFieldPasswordRecipePtrOutput values. You can construct a concrete instance of `ItemSectionFieldPasswordRecipePtrInput` via:
ItemSectionFieldPasswordRecipeArgs{...} or: nil
func ItemSectionFieldPasswordRecipePtr ¶
func ItemSectionFieldPasswordRecipePtr(v *ItemSectionFieldPasswordRecipeArgs) ItemSectionFieldPasswordRecipePtrInput
type ItemSectionFieldPasswordRecipePtrOutput ¶
type ItemSectionFieldPasswordRecipePtrOutput struct{ *pulumi.OutputState }
func (ItemSectionFieldPasswordRecipePtrOutput) Digits ¶
func (o ItemSectionFieldPasswordRecipePtrOutput) Digits() pulumi.BoolPtrOutput
Use digits [0-9] when generating the password.
func (ItemSectionFieldPasswordRecipePtrOutput) ElementType ¶
func (ItemSectionFieldPasswordRecipePtrOutput) ElementType() reflect.Type
func (ItemSectionFieldPasswordRecipePtrOutput) Length ¶
func (o ItemSectionFieldPasswordRecipePtrOutput) Length() pulumi.IntPtrOutput
The length of the password to be generated.
func (ItemSectionFieldPasswordRecipePtrOutput) Letters ¶
func (o ItemSectionFieldPasswordRecipePtrOutput) Letters() pulumi.BoolPtrOutput
Use letters [a-zA-Z] when generating the password.
func (ItemSectionFieldPasswordRecipePtrOutput) Symbols ¶
func (o ItemSectionFieldPasswordRecipePtrOutput) Symbols() pulumi.BoolPtrOutput
Use symbols [!@.-_*] when generating the password.
func (ItemSectionFieldPasswordRecipePtrOutput) ToItemSectionFieldPasswordRecipePtrOutput ¶
func (o ItemSectionFieldPasswordRecipePtrOutput) ToItemSectionFieldPasswordRecipePtrOutput() ItemSectionFieldPasswordRecipePtrOutput
func (ItemSectionFieldPasswordRecipePtrOutput) ToItemSectionFieldPasswordRecipePtrOutputWithContext ¶
func (o ItemSectionFieldPasswordRecipePtrOutput) ToItemSectionFieldPasswordRecipePtrOutputWithContext(ctx context.Context) ItemSectionFieldPasswordRecipePtrOutput
type ItemSectionInput ¶
type ItemSectionInput interface { pulumi.Input ToItemSectionOutput() ItemSectionOutput ToItemSectionOutputWithContext(context.Context) ItemSectionOutput }
ItemSectionInput is an input type that accepts ItemSectionArgs and ItemSectionOutput values. You can construct a concrete instance of `ItemSectionInput` via:
ItemSectionArgs{...}
type ItemSectionOutput ¶
type ItemSectionOutput struct{ *pulumi.OutputState }
func (ItemSectionOutput) ElementType ¶
func (ItemSectionOutput) ElementType() reflect.Type
func (ItemSectionOutput) Fields ¶
func (o ItemSectionOutput) Fields() ItemSectionFieldArrayOutput
A list of custom fields in the section.
func (ItemSectionOutput) Id ¶
func (o ItemSectionOutput) Id() pulumi.StringPtrOutput
A unique identifier for the section.
func (ItemSectionOutput) Label ¶
func (o ItemSectionOutput) Label() pulumi.StringOutput
The label for the section.
func (ItemSectionOutput) ToItemSectionOutput ¶
func (o ItemSectionOutput) ToItemSectionOutput() ItemSectionOutput
func (ItemSectionOutput) ToItemSectionOutputWithContext ¶
func (o ItemSectionOutput) ToItemSectionOutputWithContext(ctx context.Context) ItemSectionOutput
type ItemState ¶
type ItemState struct { // The category of the item. One of ["login" "password" "database"] Category pulumi.StringPtrInput // (Only applies to the database category) The name of the database. Database pulumi.StringPtrInput // (Only applies to the database category) The address where the database can be found Hostname pulumi.StringPtrInput // Password for this item. Password pulumi.StringPtrInput // Password for this item. PasswordRecipe ItemPasswordRecipePtrInput // (Only applies to the database category) The port the database is listening on. Port pulumi.StringPtrInput // A list of custom sections in an item Sections ItemSectionArrayInput // An array of strings of the tags assigned to the item. Tags pulumi.StringArrayInput // The title of the item. Title pulumi.StringPtrInput // (Only applies to the database category) The type of database. One of ["db2" "filemaker" "msaccess" "mssql" "mysql" "oracle" "postgresql" "sqlite" "other"] Type pulumi.StringPtrInput // The primary URL for the item. Url pulumi.StringPtrInput // Username for this item. Username pulumi.StringPtrInput // The UUID of the item. Item identifiers are unique within a specific vault. Uuid pulumi.StringPtrInput // The UUID of the vault the item is in. Vault pulumi.StringPtrInput }
func (ItemState) ElementType ¶
type LookupItemArgs ¶
type LookupItemArgs struct { // The title of the item to retrieve. This field will be populated with the title of the item if the item it looked up by its UUID. Title *string `pulumi:"title"` // The UUID of the item to retrieve. This field will be populated with the UUID of the item if the item it looked up by its title. Uuid *string `pulumi:"uuid"` // The UUID of the vault the item is in. Vault string `pulumi:"vault"` }
A collection of arguments for invoking GetItem.
type LookupItemOutputArgs ¶
type LookupItemOutputArgs struct { // The title of the item to retrieve. This field will be populated with the title of the item if the item it looked up by its UUID. Title pulumi.StringPtrInput `pulumi:"title"` // The UUID of the item to retrieve. This field will be populated with the UUID of the item if the item it looked up by its title. Uuid pulumi.StringPtrInput `pulumi:"uuid"` // The UUID of the vault the item is in. Vault pulumi.StringInput `pulumi:"vault"` }
A collection of arguments for invoking GetItem.
func (LookupItemOutputArgs) ElementType ¶
func (LookupItemOutputArgs) ElementType() reflect.Type
type LookupItemResult ¶
type LookupItemResult struct { // The category of the item. One of ["login" "password" "database"] Category string `pulumi:"category"` // (Only applies to the database category) The name of the database. Database string `pulumi:"database"` // (Only applies to the database category) The address where the database can be found Hostname string `pulumi:"hostname"` Id string `pulumi:"id"` // Password for this item. Password string `pulumi:"password"` // (Only applies to the database category) The port the database is listening on. Port string `pulumi:"port"` // A list of custom sections in an item Sections []GetItemSection `pulumi:"sections"` // An array of strings of the tags assigned to the item. Tags []string `pulumi:"tags"` // The title of the item to retrieve. This field will be populated with the title of the item if the item it looked up by its UUID. Title string `pulumi:"title"` // (Only applies to the database category) The type of database. One of ["db2" "filemaker" "msaccess" "mssql" "mysql" "oracle" "postgresql" "sqlite" "other"] Type string `pulumi:"type"` // The primary URL for the item. Url string `pulumi:"url"` // Username for this item. Username string `pulumi:"username"` // The UUID of the item to retrieve. This field will be populated with the UUID of the item if the item it looked up by its title. Uuid string `pulumi:"uuid"` // The UUID of the vault the item is in. Vault string `pulumi:"vault"` }
A collection of values returned by GetItem.
func LookupItem ¶
func LookupItem(ctx *pulumi.Context, args *LookupItemArgs, opts ...pulumi.InvokeOption) (*LookupItemResult, error)
Use this data source to get details of an item by its vault uuid and either the title or the uuid of the item.
## Example Usage
```go package main
import (
"github.com/SimCubeLtd/pulumi-onepassword/sdk/go/onepassword" "github.com/pulumi/pulumi-onepassword/sdk/go/onepassword" "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() { pulumi.Run(func(ctx *pulumi.Context) error { _, err := onepassword.GetItem(ctx, &GetItemArgs{ Vault: _var.Demo_vault, Uuid: pulumi.StringRef(onepassword_item.Demo_sections.Uuid), }, nil) if err != nil { return err } return nil }) }
```
type LookupItemResultOutput ¶
type LookupItemResultOutput struct{ *pulumi.OutputState }
A collection of values returned by GetItem.
func LookupItemOutput ¶
func LookupItemOutput(ctx *pulumi.Context, args LookupItemOutputArgs, opts ...pulumi.InvokeOption) LookupItemResultOutput
func (LookupItemResultOutput) Category ¶
func (o LookupItemResultOutput) Category() pulumi.StringOutput
The category of the item. One of ["login" "password" "database"]
func (LookupItemResultOutput) Database ¶
func (o LookupItemResultOutput) Database() pulumi.StringOutput
(Only applies to the database category) The name of the database.
func (LookupItemResultOutput) ElementType ¶
func (LookupItemResultOutput) ElementType() reflect.Type
func (LookupItemResultOutput) Hostname ¶
func (o LookupItemResultOutput) Hostname() pulumi.StringOutput
(Only applies to the database category) The address where the database can be found
func (LookupItemResultOutput) Id ¶
func (o LookupItemResultOutput) Id() pulumi.StringOutput
func (LookupItemResultOutput) Password ¶
func (o LookupItemResultOutput) Password() pulumi.StringOutput
Password for this item.
func (LookupItemResultOutput) Port ¶
func (o LookupItemResultOutput) Port() pulumi.StringOutput
(Only applies to the database category) The port the database is listening on.
func (LookupItemResultOutput) Sections ¶
func (o LookupItemResultOutput) Sections() GetItemSectionArrayOutput
A list of custom sections in an item
func (LookupItemResultOutput) Tags ¶
func (o LookupItemResultOutput) Tags() pulumi.StringArrayOutput
An array of strings of the tags assigned to the item.
func (LookupItemResultOutput) Title ¶
func (o LookupItemResultOutput) Title() pulumi.StringOutput
The title of the item to retrieve. This field will be populated with the title of the item if the item it looked up by its UUID.
func (LookupItemResultOutput) ToLookupItemResultOutput ¶
func (o LookupItemResultOutput) ToLookupItemResultOutput() LookupItemResultOutput
func (LookupItemResultOutput) ToLookupItemResultOutputWithContext ¶
func (o LookupItemResultOutput) ToLookupItemResultOutputWithContext(ctx context.Context) LookupItemResultOutput
func (LookupItemResultOutput) Type ¶
func (o LookupItemResultOutput) Type() pulumi.StringOutput
(Only applies to the database category) The type of database. One of ["db2" "filemaker" "msaccess" "mssql" "mysql" "oracle" "postgresql" "sqlite" "other"]
func (LookupItemResultOutput) Url ¶
func (o LookupItemResultOutput) Url() pulumi.StringOutput
The primary URL for the item.
func (LookupItemResultOutput) Username ¶
func (o LookupItemResultOutput) Username() pulumi.StringOutput
Username for this item.
func (LookupItemResultOutput) Uuid ¶
func (o LookupItemResultOutput) Uuid() pulumi.StringOutput
The UUID of the item to retrieve. This field will be populated with the UUID of the item if the item it looked up by its title.
func (LookupItemResultOutput) Vault ¶
func (o LookupItemResultOutput) Vault() pulumi.StringOutput
The UUID of the vault the item is in.
type Provider ¶
type Provider struct { pulumi.ProviderResourceState // A valid token for your 1Password Connect API. Can also be sourced from OP_CONNECT_TOKEN. Token pulumi.StringOutput `pulumi:"token"` // The HTTP(S) URL where your 1Password Connect API can be found. Must be provided through the the OP_CONNECT_HOST // environment variable if this attribute is not set. Url pulumi.StringPtrOutput `pulumi:"url"` }
The provider type for the onepassword package. By default, resources use package-wide configuration settings, however an explicit `Provider` instance may be created and passed during resource construction to achieve fine-grained programmatic control over provider settings. See the [documentation](https://www.pulumi.com/docs/reference/programming-model/#providers) for more information.
func NewProvider ¶
func NewProvider(ctx *pulumi.Context, name string, args *ProviderArgs, opts ...pulumi.ResourceOption) (*Provider, error)
NewProvider registers a new resource with the given unique name, arguments, and options.
func (*Provider) ElementType ¶
func (*Provider) ToProviderOutput ¶
func (i *Provider) ToProviderOutput() ProviderOutput
func (*Provider) ToProviderOutputWithContext ¶
func (i *Provider) ToProviderOutputWithContext(ctx context.Context) ProviderOutput
type ProviderArgs ¶
type ProviderArgs struct { // A valid token for your 1Password Connect API. Can also be sourced from OP_CONNECT_TOKEN. Token pulumi.StringInput // The HTTP(S) URL where your 1Password Connect API can be found. Must be provided through the the OP_CONNECT_HOST // environment variable if this attribute is not set. Url pulumi.StringPtrInput }
The set of arguments for constructing a Provider resource.
func (ProviderArgs) ElementType ¶
func (ProviderArgs) ElementType() reflect.Type
type ProviderInput ¶
type ProviderInput interface { pulumi.Input ToProviderOutput() ProviderOutput ToProviderOutputWithContext(ctx context.Context) ProviderOutput }
type ProviderOutput ¶
type ProviderOutput struct{ *pulumi.OutputState }
func (ProviderOutput) ElementType ¶
func (ProviderOutput) ElementType() reflect.Type
func (ProviderOutput) ToProviderOutput ¶
func (o ProviderOutput) ToProviderOutput() ProviderOutput
func (ProviderOutput) ToProviderOutputWithContext ¶
func (o ProviderOutput) ToProviderOutputWithContext(ctx context.Context) ProviderOutput
func (ProviderOutput) Token ¶
func (o ProviderOutput) Token() pulumi.StringOutput
A valid token for your 1Password Connect API. Can also be sourced from OP_CONNECT_TOKEN.
func (ProviderOutput) Url ¶
func (o ProviderOutput) Url() pulumi.StringPtrOutput
The HTTP(S) URL where your 1Password Connect API can be found. Must be provided through the the OP_CONNECT_HOST environment variable if this attribute is not set.