published on Monday, Apr 27, 2026 by akeyless-community
published on Monday, Apr 27, 2026 by akeyless-community
Static secret Resource
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as akeyless from "@pulumi/akeyless";
const secret = new akeyless.StaticSecret("secret", {
path: "terraform/secret",
value: "this value was set from terraform",
});
import pulumi
import pulumi_akeyless as akeyless
secret = akeyless.StaticSecret("secret",
path="terraform/secret",
value="this value was set from terraform")
package main
import (
"github.com/pulumi/pulumi-terraform-provider/sdks/go/akeyless/v2/akeyless"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := akeyless.NewStaticSecret(ctx, "secret", &akeyless.StaticSecretArgs{
Path: pulumi.String("terraform/secret"),
Value: pulumi.String("this value was set from terraform"),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Akeyless = Pulumi.Akeyless;
return await Deployment.RunAsync(() =>
{
var secret = new Akeyless.StaticSecret("secret", new()
{
Path = "terraform/secret",
Value = "this value was set from terraform",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.akeyless.StaticSecret;
import com.pulumi.akeyless.StaticSecretArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var secret = new StaticSecret("secret", StaticSecretArgs.builder()
.path("terraform/secret")
.value("this value was set from terraform")
.build());
}
}
resources:
secret:
type: akeyless:StaticSecret
properties:
path: terraform/secret
value: this value was set from terraform
Create StaticSecret Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new StaticSecret(name: string, args: StaticSecretArgs, opts?: CustomResourceOptions);@overload
def StaticSecret(resource_name: str,
args: StaticSecretArgs,
opts: Optional[ResourceOptions] = None)
@overload
def StaticSecret(resource_name: str,
opts: Optional[ResourceOptions] = None,
path: Optional[str] = None,
protection_key: Optional[str] = None,
secure_access_ssh_user: Optional[str] = None,
delete_protection: Optional[str] = None,
description: Optional[str] = None,
format: Optional[str] = None,
ignore_cache: Optional[str] = None,
inject_urls: Optional[Sequence[str]] = None,
item_custom_fields: Optional[Mapping[str, str]] = None,
keep_prev_version: Optional[str] = None,
max_versions: Optional[str] = None,
multiline_value: Optional[bool] = None,
password: Optional[str] = None,
change_event: Optional[str] = None,
accessibility: Optional[str] = None,
custom_field: Optional[Mapping[str, str]] = None,
secure_access_certificate_issuer: Optional[str] = None,
secure_access_web: Optional[bool] = None,
secure_access_hosts: Optional[Sequence[str]] = None,
secure_access_rdp_user: Optional[str] = None,
secure_access_ssh_creds: Optional[str] = None,
secure_access_enable: Optional[str] = None,
secure_access_url: Optional[str] = None,
secure_access_gateway: Optional[str] = None,
secure_access_web_browsing: Optional[bool] = None,
secure_access_web_proxy: Optional[bool] = None,
static_secret_id: Optional[str] = None,
tags: Optional[Sequence[str]] = None,
type: Optional[str] = None,
username: Optional[str] = None,
value: Optional[str] = None)func NewStaticSecret(ctx *Context, name string, args StaticSecretArgs, opts ...ResourceOption) (*StaticSecret, error)public StaticSecret(string name, StaticSecretArgs args, CustomResourceOptions? opts = null)
public StaticSecret(String name, StaticSecretArgs args)
public StaticSecret(String name, StaticSecretArgs args, CustomResourceOptions options)
type: akeyless:StaticSecret
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args StaticSecretArgs
- 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 StaticSecretArgs
- 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 StaticSecretArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args StaticSecretArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args StaticSecretArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var staticSecretResource = new Akeyless.StaticSecret("staticSecretResource", new()
{
Path = "string",
ProtectionKey = "string",
SecureAccessSshUser = "string",
DeleteProtection = "string",
Description = "string",
Format = "string",
IgnoreCache = "string",
InjectUrls = new[]
{
"string",
},
ItemCustomFields =
{
{ "string", "string" },
},
KeepPrevVersion = "string",
MaxVersions = "string",
MultilineValue = false,
Password = "string",
ChangeEvent = "string",
Accessibility = "string",
CustomField =
{
{ "string", "string" },
},
SecureAccessCertificateIssuer = "string",
SecureAccessWeb = false,
SecureAccessHosts = new[]
{
"string",
},
SecureAccessRdpUser = "string",
SecureAccessSshCreds = "string",
SecureAccessEnable = "string",
SecureAccessUrl = "string",
SecureAccessGateway = "string",
SecureAccessWebBrowsing = false,
SecureAccessWebProxy = false,
StaticSecretId = "string",
Tags = new[]
{
"string",
},
Type = "string",
Username = "string",
Value = "string",
});
example, err := akeyless.NewStaticSecret(ctx, "staticSecretResource", &akeyless.StaticSecretArgs{
Path: pulumi.String("string"),
ProtectionKey: pulumi.String("string"),
SecureAccessSshUser: pulumi.String("string"),
DeleteProtection: pulumi.String("string"),
Description: pulumi.String("string"),
Format: pulumi.String("string"),
IgnoreCache: pulumi.String("string"),
InjectUrls: pulumi.StringArray{
pulumi.String("string"),
},
ItemCustomFields: pulumi.StringMap{
"string": pulumi.String("string"),
},
KeepPrevVersion: pulumi.String("string"),
MaxVersions: pulumi.String("string"),
MultilineValue: pulumi.Bool(false),
Password: pulumi.String("string"),
ChangeEvent: pulumi.String("string"),
Accessibility: pulumi.String("string"),
CustomField: pulumi.StringMap{
"string": pulumi.String("string"),
},
SecureAccessCertificateIssuer: pulumi.String("string"),
SecureAccessWeb: pulumi.Bool(false),
SecureAccessHosts: pulumi.StringArray{
pulumi.String("string"),
},
SecureAccessRdpUser: pulumi.String("string"),
SecureAccessSshCreds: pulumi.String("string"),
SecureAccessEnable: pulumi.String("string"),
SecureAccessUrl: pulumi.String("string"),
SecureAccessGateway: pulumi.String("string"),
SecureAccessWebBrowsing: pulumi.Bool(false),
SecureAccessWebProxy: pulumi.Bool(false),
StaticSecretId: pulumi.String("string"),
Tags: pulumi.StringArray{
pulumi.String("string"),
},
Type: pulumi.String("string"),
Username: pulumi.String("string"),
Value: pulumi.String("string"),
})
var staticSecretResource = new StaticSecret("staticSecretResource", StaticSecretArgs.builder()
.path("string")
.protectionKey("string")
.secureAccessSshUser("string")
.deleteProtection("string")
.description("string")
.format("string")
.ignoreCache("string")
.injectUrls("string")
.itemCustomFields(Map.of("string", "string"))
.keepPrevVersion("string")
.maxVersions("string")
.multilineValue(false)
.password("string")
.changeEvent("string")
.accessibility("string")
.customField(Map.of("string", "string"))
.secureAccessCertificateIssuer("string")
.secureAccessWeb(false)
.secureAccessHosts("string")
.secureAccessRdpUser("string")
.secureAccessSshCreds("string")
.secureAccessEnable("string")
.secureAccessUrl("string")
.secureAccessGateway("string")
.secureAccessWebBrowsing(false)
.secureAccessWebProxy(false)
.staticSecretId("string")
.tags("string")
.type("string")
.username("string")
.value("string")
.build());
static_secret_resource = akeyless.StaticSecret("staticSecretResource",
path="string",
protection_key="string",
secure_access_ssh_user="string",
delete_protection="string",
description="string",
format="string",
ignore_cache="string",
inject_urls=["string"],
item_custom_fields={
"string": "string",
},
keep_prev_version="string",
max_versions="string",
multiline_value=False,
password="string",
change_event="string",
accessibility="string",
custom_field={
"string": "string",
},
secure_access_certificate_issuer="string",
secure_access_web=False,
secure_access_hosts=["string"],
secure_access_rdp_user="string",
secure_access_ssh_creds="string",
secure_access_enable="string",
secure_access_url="string",
secure_access_gateway="string",
secure_access_web_browsing=False,
secure_access_web_proxy=False,
static_secret_id="string",
tags=["string"],
type="string",
username="string",
value="string")
const staticSecretResource = new akeyless.StaticSecret("staticSecretResource", {
path: "string",
protectionKey: "string",
secureAccessSshUser: "string",
deleteProtection: "string",
description: "string",
format: "string",
ignoreCache: "string",
injectUrls: ["string"],
itemCustomFields: {
string: "string",
},
keepPrevVersion: "string",
maxVersions: "string",
multilineValue: false,
password: "string",
changeEvent: "string",
accessibility: "string",
customField: {
string: "string",
},
secureAccessCertificateIssuer: "string",
secureAccessWeb: false,
secureAccessHosts: ["string"],
secureAccessRdpUser: "string",
secureAccessSshCreds: "string",
secureAccessEnable: "string",
secureAccessUrl: "string",
secureAccessGateway: "string",
secureAccessWebBrowsing: false,
secureAccessWebProxy: false,
staticSecretId: "string",
tags: ["string"],
type: "string",
username: "string",
value: "string",
});
type: akeyless:StaticSecret
properties:
accessibility: string
changeEvent: string
customField:
string: string
deleteProtection: string
description: string
format: string
ignoreCache: string
injectUrls:
- string
itemCustomFields:
string: string
keepPrevVersion: string
maxVersions: string
multilineValue: false
password: string
path: string
protectionKey: string
secureAccessCertificateIssuer: string
secureAccessEnable: string
secureAccessGateway: string
secureAccessHosts:
- string
secureAccessRdpUser: string
secureAccessSshCreds: string
secureAccessSshUser: string
secureAccessUrl: string
secureAccessWeb: false
secureAccessWebBrowsing: false
secureAccessWebProxy: false
staticSecretId: string
tags:
- string
type: string
username: string
value: string
StaticSecret Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The StaticSecret resource accepts the following input properties:
- Path string
- The path where the secret will be stored.
- Accessibility string
- For personal password manager
- Change
Event string - Trigger an event when a secret value changed true/false
- Custom
Field Dictionary<string, string> - Additional custom fields to associate with the item (e.g fieldName1=value1) (relevant only for type 'password')
- Delete
Protection string - Protection from accidental deletion of this auth method, [true/false]
- Description string
- Description of the object
- Format string
- Secret format text/json/key-value
- Ignore
Cache string - Retrieve the Secret value without checking the Gateway's cache [true/false]
- Inject
Urls List<string> - List of URLs associated with the item (relevant only for type 'password')
- Item
Custom Dictionary<string, string>Fields - Additional custom fields to associate with the item
- Keep
Prev stringVersion - Whether to keep previous version [true/false]. If not set, use default according to account settings
- Max
Versions string - Set the maximum number of versions, limited by the account settings defaults
- Multiline
Value bool - The provided value is a multiline value (separated by ' ')
- Password string
- Password value (relevant only for type 'password')
- Protection
Key string - The name of a key that is used to encrypt the secret value (if empty, the account default protectionKey key will be used)
- Secure
Access stringCertificate Issuer - Path to the SSH Certificate Issuer for your Akeyless Secure Access
- Secure
Access stringEnable - Enable/Disable secure remote access, [true/false]
- Secure
Access stringGateway - Secure Remote Access Gateway
- Secure
Access List<string>Hosts - Target servers for connections., For multiple values repeat this flag.
- Secure
Access stringRdp User - Remote Desktop Username
- Secure
Access stringSsh Creds - Static-Secret values contains SSH Credentials, either Private Key or Password [password/private-key]
- Secure
Access stringSsh User - Override the SSH username as indicated in SSH Certificate Issuer
- Secure
Access stringUrl - Destination URL to inject secrets.
- Secure
Access boolWeb - Enable Web Secure Remote Access
- Secure
Access boolWeb Browsing - Secure browser via Akeyless's Secure Remote Access (SRA)
- Secure
Access boolWeb Proxy - Web-Proxy via Akeyless's Secure Remote Access (SRA)
- Static
Secret stringId - The ID of this resource.
- List<string>
- List of the tags attached to this secret. To specify multiple tags use argument multiple times: -t Tag1 -t Tag2
- Type string
- Secret type [generic/password]
- Username string
- Username value (relevant only for type 'password')
- Value string
- The secret content.
- Path string
- The path where the secret will be stored.
- Accessibility string
- For personal password manager
- Change
Event string - Trigger an event when a secret value changed true/false
- Custom
Field map[string]string - Additional custom fields to associate with the item (e.g fieldName1=value1) (relevant only for type 'password')
- Delete
Protection string - Protection from accidental deletion of this auth method, [true/false]
- Description string
- Description of the object
- Format string
- Secret format text/json/key-value
- Ignore
Cache string - Retrieve the Secret value without checking the Gateway's cache [true/false]
- Inject
Urls []string - List of URLs associated with the item (relevant only for type 'password')
- Item
Custom map[string]stringFields - Additional custom fields to associate with the item
- Keep
Prev stringVersion - Whether to keep previous version [true/false]. If not set, use default according to account settings
- Max
Versions string - Set the maximum number of versions, limited by the account settings defaults
- Multiline
Value bool - The provided value is a multiline value (separated by ' ')
- Password string
- Password value (relevant only for type 'password')
- Protection
Key string - The name of a key that is used to encrypt the secret value (if empty, the account default protectionKey key will be used)
- Secure
Access stringCertificate Issuer - Path to the SSH Certificate Issuer for your Akeyless Secure Access
- Secure
Access stringEnable - Enable/Disable secure remote access, [true/false]
- Secure
Access stringGateway - Secure Remote Access Gateway
- Secure
Access []stringHosts - Target servers for connections., For multiple values repeat this flag.
- Secure
Access stringRdp User - Remote Desktop Username
- Secure
Access stringSsh Creds - Static-Secret values contains SSH Credentials, either Private Key or Password [password/private-key]
- Secure
Access stringSsh User - Override the SSH username as indicated in SSH Certificate Issuer
- Secure
Access stringUrl - Destination URL to inject secrets.
- Secure
Access boolWeb - Enable Web Secure Remote Access
- Secure
Access boolWeb Browsing - Secure browser via Akeyless's Secure Remote Access (SRA)
- Secure
Access boolWeb Proxy - Web-Proxy via Akeyless's Secure Remote Access (SRA)
- Static
Secret stringId - The ID of this resource.
- []string
- List of the tags attached to this secret. To specify multiple tags use argument multiple times: -t Tag1 -t Tag2
- Type string
- Secret type [generic/password]
- Username string
- Username value (relevant only for type 'password')
- Value string
- The secret content.
- path String
- The path where the secret will be stored.
- accessibility String
- For personal password manager
- change
Event String - Trigger an event when a secret value changed true/false
- custom
Field Map<String,String> - Additional custom fields to associate with the item (e.g fieldName1=value1) (relevant only for type 'password')
- delete
Protection String - Protection from accidental deletion of this auth method, [true/false]
- description String
- Description of the object
- format String
- Secret format text/json/key-value
- ignore
Cache String - Retrieve the Secret value without checking the Gateway's cache [true/false]
- inject
Urls List<String> - List of URLs associated with the item (relevant only for type 'password')
- item
Custom Map<String,String>Fields - Additional custom fields to associate with the item
- keep
Prev StringVersion - Whether to keep previous version [true/false]. If not set, use default according to account settings
- max
Versions String - Set the maximum number of versions, limited by the account settings defaults
- multiline
Value Boolean - The provided value is a multiline value (separated by ' ')
- password String
- Password value (relevant only for type 'password')
- protection
Key String - The name of a key that is used to encrypt the secret value (if empty, the account default protectionKey key will be used)
- secure
Access StringCertificate Issuer - Path to the SSH Certificate Issuer for your Akeyless Secure Access
- secure
Access StringEnable - Enable/Disable secure remote access, [true/false]
- secure
Access StringGateway - Secure Remote Access Gateway
- secure
Access List<String>Hosts - Target servers for connections., For multiple values repeat this flag.
- secure
Access StringRdp User - Remote Desktop Username
- secure
Access StringSsh Creds - Static-Secret values contains SSH Credentials, either Private Key or Password [password/private-key]
- secure
Access StringSsh User - Override the SSH username as indicated in SSH Certificate Issuer
- secure
Access StringUrl - Destination URL to inject secrets.
- secure
Access BooleanWeb - Enable Web Secure Remote Access
- secure
Access BooleanWeb Browsing - Secure browser via Akeyless's Secure Remote Access (SRA)
- secure
Access BooleanWeb Proxy - Web-Proxy via Akeyless's Secure Remote Access (SRA)
- static
Secret StringId - The ID of this resource.
- List<String>
- List of the tags attached to this secret. To specify multiple tags use argument multiple times: -t Tag1 -t Tag2
- type String
- Secret type [generic/password]
- username String
- Username value (relevant only for type 'password')
- value String
- The secret content.
- path string
- The path where the secret will be stored.
- accessibility string
- For personal password manager
- change
Event string - Trigger an event when a secret value changed true/false
- custom
Field {[key: string]: string} - Additional custom fields to associate with the item (e.g fieldName1=value1) (relevant only for type 'password')
- delete
Protection string - Protection from accidental deletion of this auth method, [true/false]
- description string
- Description of the object
- format string
- Secret format text/json/key-value
- ignore
Cache string - Retrieve the Secret value without checking the Gateway's cache [true/false]
- inject
Urls string[] - List of URLs associated with the item (relevant only for type 'password')
- item
Custom {[key: string]: string}Fields - Additional custom fields to associate with the item
- keep
Prev stringVersion - Whether to keep previous version [true/false]. If not set, use default according to account settings
- max
Versions string - Set the maximum number of versions, limited by the account settings defaults
- multiline
Value boolean - The provided value is a multiline value (separated by ' ')
- password string
- Password value (relevant only for type 'password')
- protection
Key string - The name of a key that is used to encrypt the secret value (if empty, the account default protectionKey key will be used)
- secure
Access stringCertificate Issuer - Path to the SSH Certificate Issuer for your Akeyless Secure Access
- secure
Access stringEnable - Enable/Disable secure remote access, [true/false]
- secure
Access stringGateway - Secure Remote Access Gateway
- secure
Access string[]Hosts - Target servers for connections., For multiple values repeat this flag.
- secure
Access stringRdp User - Remote Desktop Username
- secure
Access stringSsh Creds - Static-Secret values contains SSH Credentials, either Private Key or Password [password/private-key]
- secure
Access stringSsh User - Override the SSH username as indicated in SSH Certificate Issuer
- secure
Access stringUrl - Destination URL to inject secrets.
- secure
Access booleanWeb - Enable Web Secure Remote Access
- secure
Access booleanWeb Browsing - Secure browser via Akeyless's Secure Remote Access (SRA)
- secure
Access booleanWeb Proxy - Web-Proxy via Akeyless's Secure Remote Access (SRA)
- static
Secret stringId - The ID of this resource.
- string[]
- List of the tags attached to this secret. To specify multiple tags use argument multiple times: -t Tag1 -t Tag2
- type string
- Secret type [generic/password]
- username string
- Username value (relevant only for type 'password')
- value string
- The secret content.
- path str
- The path where the secret will be stored.
- accessibility str
- For personal password manager
- change_
event str - Trigger an event when a secret value changed true/false
- custom_
field Mapping[str, str] - Additional custom fields to associate with the item (e.g fieldName1=value1) (relevant only for type 'password')
- delete_
protection str - Protection from accidental deletion of this auth method, [true/false]
- description str
- Description of the object
- format str
- Secret format text/json/key-value
- ignore_
cache str - Retrieve the Secret value without checking the Gateway's cache [true/false]
- inject_
urls Sequence[str] - List of URLs associated with the item (relevant only for type 'password')
- item_
custom_ Mapping[str, str]fields - Additional custom fields to associate with the item
- keep_
prev_ strversion - Whether to keep previous version [true/false]. If not set, use default according to account settings
- max_
versions str - Set the maximum number of versions, limited by the account settings defaults
- multiline_
value bool - The provided value is a multiline value (separated by ' ')
- password str
- Password value (relevant only for type 'password')
- protection_
key str - The name of a key that is used to encrypt the secret value (if empty, the account default protectionKey key will be used)
- secure_
access_ strcertificate_ issuer - Path to the SSH Certificate Issuer for your Akeyless Secure Access
- secure_
access_ strenable - Enable/Disable secure remote access, [true/false]
- secure_
access_ strgateway - Secure Remote Access Gateway
- secure_
access_ Sequence[str]hosts - Target servers for connections., For multiple values repeat this flag.
- secure_
access_ strrdp_ user - Remote Desktop Username
- secure_
access_ strssh_ creds - Static-Secret values contains SSH Credentials, either Private Key or Password [password/private-key]
- secure_
access_ strssh_ user - Override the SSH username as indicated in SSH Certificate Issuer
- secure_
access_ strurl - Destination URL to inject secrets.
- secure_
access_ boolweb - Enable Web Secure Remote Access
- secure_
access_ boolweb_ browsing - Secure browser via Akeyless's Secure Remote Access (SRA)
- secure_
access_ boolweb_ proxy - Web-Proxy via Akeyless's Secure Remote Access (SRA)
- static_
secret_ strid - The ID of this resource.
- Sequence[str]
- List of the tags attached to this secret. To specify multiple tags use argument multiple times: -t Tag1 -t Tag2
- type str
- Secret type [generic/password]
- username str
- Username value (relevant only for type 'password')
- value str
- The secret content.
- path String
- The path where the secret will be stored.
- accessibility String
- For personal password manager
- change
Event String - Trigger an event when a secret value changed true/false
- custom
Field Map<String> - Additional custom fields to associate with the item (e.g fieldName1=value1) (relevant only for type 'password')
- delete
Protection String - Protection from accidental deletion of this auth method, [true/false]
- description String
- Description of the object
- format String
- Secret format text/json/key-value
- ignore
Cache String - Retrieve the Secret value without checking the Gateway's cache [true/false]
- inject
Urls List<String> - List of URLs associated with the item (relevant only for type 'password')
- item
Custom Map<String>Fields - Additional custom fields to associate with the item
- keep
Prev StringVersion - Whether to keep previous version [true/false]. If not set, use default according to account settings
- max
Versions String - Set the maximum number of versions, limited by the account settings defaults
- multiline
Value Boolean - The provided value is a multiline value (separated by ' ')
- password String
- Password value (relevant only for type 'password')
- protection
Key String - The name of a key that is used to encrypt the secret value (if empty, the account default protectionKey key will be used)
- secure
Access StringCertificate Issuer - Path to the SSH Certificate Issuer for your Akeyless Secure Access
- secure
Access StringEnable - Enable/Disable secure remote access, [true/false]
- secure
Access StringGateway - Secure Remote Access Gateway
- secure
Access List<String>Hosts - Target servers for connections., For multiple values repeat this flag.
- secure
Access StringRdp User - Remote Desktop Username
- secure
Access StringSsh Creds - Static-Secret values contains SSH Credentials, either Private Key or Password [password/private-key]
- secure
Access StringSsh User - Override the SSH username as indicated in SSH Certificate Issuer
- secure
Access StringUrl - Destination URL to inject secrets.
- secure
Access BooleanWeb - Enable Web Secure Remote Access
- secure
Access BooleanWeb Browsing - Secure browser via Akeyless's Secure Remote Access (SRA)
- secure
Access BooleanWeb Proxy - Web-Proxy via Akeyless's Secure Remote Access (SRA)
- static
Secret StringId - The ID of this resource.
- List<String>
- List of the tags attached to this secret. To specify multiple tags use argument multiple times: -t Tag1 -t Tag2
- type String
- Secret type [generic/password]
- username String
- Username value (relevant only for type 'password')
- value String
- The secret content.
Outputs
All input properties are implicitly available as output properties. Additionally, the StaticSecret resource produces the following output properties:
Look up Existing StaticSecret Resource
Get an existing StaticSecret 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?: StaticSecretState, opts?: CustomResourceOptions): StaticSecret@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
accessibility: Optional[str] = None,
change_event: Optional[str] = None,
custom_field: Optional[Mapping[str, str]] = None,
delete_protection: Optional[str] = None,
description: Optional[str] = None,
format: Optional[str] = None,
ignore_cache: Optional[str] = None,
inject_urls: Optional[Sequence[str]] = None,
item_custom_fields: Optional[Mapping[str, str]] = None,
keep_prev_version: Optional[str] = None,
max_versions: Optional[str] = None,
multiline_value: Optional[bool] = None,
password: Optional[str] = None,
path: Optional[str] = None,
protection_key: Optional[str] = None,
secure_access_certificate_issuer: Optional[str] = None,
secure_access_enable: Optional[str] = None,
secure_access_gateway: Optional[str] = None,
secure_access_hosts: Optional[Sequence[str]] = None,
secure_access_rdp_user: Optional[str] = None,
secure_access_ssh_creds: Optional[str] = None,
secure_access_ssh_user: Optional[str] = None,
secure_access_url: Optional[str] = None,
secure_access_web: Optional[bool] = None,
secure_access_web_browsing: Optional[bool] = None,
secure_access_web_proxy: Optional[bool] = None,
static_secret_id: Optional[str] = None,
tags: Optional[Sequence[str]] = None,
type: Optional[str] = None,
username: Optional[str] = None,
value: Optional[str] = None,
version: Optional[float] = None) -> StaticSecretfunc GetStaticSecret(ctx *Context, name string, id IDInput, state *StaticSecretState, opts ...ResourceOption) (*StaticSecret, error)public static StaticSecret Get(string name, Input<string> id, StaticSecretState? state, CustomResourceOptions? opts = null)public static StaticSecret get(String name, Output<String> id, StaticSecretState state, CustomResourceOptions options)resources: _: type: akeyless:StaticSecret get: id: ${id}- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Accessibility string
- For personal password manager
- Change
Event string - Trigger an event when a secret value changed true/false
- Custom
Field Dictionary<string, string> - Additional custom fields to associate with the item (e.g fieldName1=value1) (relevant only for type 'password')
- Delete
Protection string - Protection from accidental deletion of this auth method, [true/false]
- Description string
- Description of the object
- Format string
- Secret format text/json/key-value
- Ignore
Cache string - Retrieve the Secret value without checking the Gateway's cache [true/false]
- Inject
Urls List<string> - List of URLs associated with the item (relevant only for type 'password')
- Item
Custom Dictionary<string, string>Fields - Additional custom fields to associate with the item
- Keep
Prev stringVersion - Whether to keep previous version [true/false]. If not set, use default according to account settings
- Max
Versions string - Set the maximum number of versions, limited by the account settings defaults
- Multiline
Value bool - The provided value is a multiline value (separated by ' ')
- Password string
- Password value (relevant only for type 'password')
- Path string
- The path where the secret will be stored.
- Protection
Key string - The name of a key that is used to encrypt the secret value (if empty, the account default protectionKey key will be used)
- Secure
Access stringCertificate Issuer - Path to the SSH Certificate Issuer for your Akeyless Secure Access
- Secure
Access stringEnable - Enable/Disable secure remote access, [true/false]
- Secure
Access stringGateway - Secure Remote Access Gateway
- Secure
Access List<string>Hosts - Target servers for connections., For multiple values repeat this flag.
- Secure
Access stringRdp User - Remote Desktop Username
- Secure
Access stringSsh Creds - Static-Secret values contains SSH Credentials, either Private Key or Password [password/private-key]
- Secure
Access stringSsh User - Override the SSH username as indicated in SSH Certificate Issuer
- Secure
Access stringUrl - Destination URL to inject secrets.
- Secure
Access boolWeb - Enable Web Secure Remote Access
- Secure
Access boolWeb Browsing - Secure browser via Akeyless's Secure Remote Access (SRA)
- Secure
Access boolWeb Proxy - Web-Proxy via Akeyless's Secure Remote Access (SRA)
- Static
Secret stringId - The ID of this resource.
- List<string>
- List of the tags attached to this secret. To specify multiple tags use argument multiple times: -t Tag1 -t Tag2
- Type string
- Secret type [generic/password]
- Username string
- Username value (relevant only for type 'password')
- Value string
- The secret content.
- Version double
- The version of the secret.
- Accessibility string
- For personal password manager
- Change
Event string - Trigger an event when a secret value changed true/false
- Custom
Field map[string]string - Additional custom fields to associate with the item (e.g fieldName1=value1) (relevant only for type 'password')
- Delete
Protection string - Protection from accidental deletion of this auth method, [true/false]
- Description string
- Description of the object
- Format string
- Secret format text/json/key-value
- Ignore
Cache string - Retrieve the Secret value without checking the Gateway's cache [true/false]
- Inject
Urls []string - List of URLs associated with the item (relevant only for type 'password')
- Item
Custom map[string]stringFields - Additional custom fields to associate with the item
- Keep
Prev stringVersion - Whether to keep previous version [true/false]. If not set, use default according to account settings
- Max
Versions string - Set the maximum number of versions, limited by the account settings defaults
- Multiline
Value bool - The provided value is a multiline value (separated by ' ')
- Password string
- Password value (relevant only for type 'password')
- Path string
- The path where the secret will be stored.
- Protection
Key string - The name of a key that is used to encrypt the secret value (if empty, the account default protectionKey key will be used)
- Secure
Access stringCertificate Issuer - Path to the SSH Certificate Issuer for your Akeyless Secure Access
- Secure
Access stringEnable - Enable/Disable secure remote access, [true/false]
- Secure
Access stringGateway - Secure Remote Access Gateway
- Secure
Access []stringHosts - Target servers for connections., For multiple values repeat this flag.
- Secure
Access stringRdp User - Remote Desktop Username
- Secure
Access stringSsh Creds - Static-Secret values contains SSH Credentials, either Private Key or Password [password/private-key]
- Secure
Access stringSsh User - Override the SSH username as indicated in SSH Certificate Issuer
- Secure
Access stringUrl - Destination URL to inject secrets.
- Secure
Access boolWeb - Enable Web Secure Remote Access
- Secure
Access boolWeb Browsing - Secure browser via Akeyless's Secure Remote Access (SRA)
- Secure
Access boolWeb Proxy - Web-Proxy via Akeyless's Secure Remote Access (SRA)
- Static
Secret stringId - The ID of this resource.
- []string
- List of the tags attached to this secret. To specify multiple tags use argument multiple times: -t Tag1 -t Tag2
- Type string
- Secret type [generic/password]
- Username string
- Username value (relevant only for type 'password')
- Value string
- The secret content.
- Version float64
- The version of the secret.
- accessibility String
- For personal password manager
- change
Event String - Trigger an event when a secret value changed true/false
- custom
Field Map<String,String> - Additional custom fields to associate with the item (e.g fieldName1=value1) (relevant only for type 'password')
- delete
Protection String - Protection from accidental deletion of this auth method, [true/false]
- description String
- Description of the object
- format String
- Secret format text/json/key-value
- ignore
Cache String - Retrieve the Secret value without checking the Gateway's cache [true/false]
- inject
Urls List<String> - List of URLs associated with the item (relevant only for type 'password')
- item
Custom Map<String,String>Fields - Additional custom fields to associate with the item
- keep
Prev StringVersion - Whether to keep previous version [true/false]. If not set, use default according to account settings
- max
Versions String - Set the maximum number of versions, limited by the account settings defaults
- multiline
Value Boolean - The provided value is a multiline value (separated by ' ')
- password String
- Password value (relevant only for type 'password')
- path String
- The path where the secret will be stored.
- protection
Key String - The name of a key that is used to encrypt the secret value (if empty, the account default protectionKey key will be used)
- secure
Access StringCertificate Issuer - Path to the SSH Certificate Issuer for your Akeyless Secure Access
- secure
Access StringEnable - Enable/Disable secure remote access, [true/false]
- secure
Access StringGateway - Secure Remote Access Gateway
- secure
Access List<String>Hosts - Target servers for connections., For multiple values repeat this flag.
- secure
Access StringRdp User - Remote Desktop Username
- secure
Access StringSsh Creds - Static-Secret values contains SSH Credentials, either Private Key or Password [password/private-key]
- secure
Access StringSsh User - Override the SSH username as indicated in SSH Certificate Issuer
- secure
Access StringUrl - Destination URL to inject secrets.
- secure
Access BooleanWeb - Enable Web Secure Remote Access
- secure
Access BooleanWeb Browsing - Secure browser via Akeyless's Secure Remote Access (SRA)
- secure
Access BooleanWeb Proxy - Web-Proxy via Akeyless's Secure Remote Access (SRA)
- static
Secret StringId - The ID of this resource.
- List<String>
- List of the tags attached to this secret. To specify multiple tags use argument multiple times: -t Tag1 -t Tag2
- type String
- Secret type [generic/password]
- username String
- Username value (relevant only for type 'password')
- value String
- The secret content.
- version Double
- The version of the secret.
- accessibility string
- For personal password manager
- change
Event string - Trigger an event when a secret value changed true/false
- custom
Field {[key: string]: string} - Additional custom fields to associate with the item (e.g fieldName1=value1) (relevant only for type 'password')
- delete
Protection string - Protection from accidental deletion of this auth method, [true/false]
- description string
- Description of the object
- format string
- Secret format text/json/key-value
- ignore
Cache string - Retrieve the Secret value without checking the Gateway's cache [true/false]
- inject
Urls string[] - List of URLs associated with the item (relevant only for type 'password')
- item
Custom {[key: string]: string}Fields - Additional custom fields to associate with the item
- keep
Prev stringVersion - Whether to keep previous version [true/false]. If not set, use default according to account settings
- max
Versions string - Set the maximum number of versions, limited by the account settings defaults
- multiline
Value boolean - The provided value is a multiline value (separated by ' ')
- password string
- Password value (relevant only for type 'password')
- path string
- The path where the secret will be stored.
- protection
Key string - The name of a key that is used to encrypt the secret value (if empty, the account default protectionKey key will be used)
- secure
Access stringCertificate Issuer - Path to the SSH Certificate Issuer for your Akeyless Secure Access
- secure
Access stringEnable - Enable/Disable secure remote access, [true/false]
- secure
Access stringGateway - Secure Remote Access Gateway
- secure
Access string[]Hosts - Target servers for connections., For multiple values repeat this flag.
- secure
Access stringRdp User - Remote Desktop Username
- secure
Access stringSsh Creds - Static-Secret values contains SSH Credentials, either Private Key or Password [password/private-key]
- secure
Access stringSsh User - Override the SSH username as indicated in SSH Certificate Issuer
- secure
Access stringUrl - Destination URL to inject secrets.
- secure
Access booleanWeb - Enable Web Secure Remote Access
- secure
Access booleanWeb Browsing - Secure browser via Akeyless's Secure Remote Access (SRA)
- secure
Access booleanWeb Proxy - Web-Proxy via Akeyless's Secure Remote Access (SRA)
- static
Secret stringId - The ID of this resource.
- string[]
- List of the tags attached to this secret. To specify multiple tags use argument multiple times: -t Tag1 -t Tag2
- type string
- Secret type [generic/password]
- username string
- Username value (relevant only for type 'password')
- value string
- The secret content.
- version number
- The version of the secret.
- accessibility str
- For personal password manager
- change_
event str - Trigger an event when a secret value changed true/false
- custom_
field Mapping[str, str] - Additional custom fields to associate with the item (e.g fieldName1=value1) (relevant only for type 'password')
- delete_
protection str - Protection from accidental deletion of this auth method, [true/false]
- description str
- Description of the object
- format str
- Secret format text/json/key-value
- ignore_
cache str - Retrieve the Secret value without checking the Gateway's cache [true/false]
- inject_
urls Sequence[str] - List of URLs associated with the item (relevant only for type 'password')
- item_
custom_ Mapping[str, str]fields - Additional custom fields to associate with the item
- keep_
prev_ strversion - Whether to keep previous version [true/false]. If not set, use default according to account settings
- max_
versions str - Set the maximum number of versions, limited by the account settings defaults
- multiline_
value bool - The provided value is a multiline value (separated by ' ')
- password str
- Password value (relevant only for type 'password')
- path str
- The path where the secret will be stored.
- protection_
key str - The name of a key that is used to encrypt the secret value (if empty, the account default protectionKey key will be used)
- secure_
access_ strcertificate_ issuer - Path to the SSH Certificate Issuer for your Akeyless Secure Access
- secure_
access_ strenable - Enable/Disable secure remote access, [true/false]
- secure_
access_ strgateway - Secure Remote Access Gateway
- secure_
access_ Sequence[str]hosts - Target servers for connections., For multiple values repeat this flag.
- secure_
access_ strrdp_ user - Remote Desktop Username
- secure_
access_ strssh_ creds - Static-Secret values contains SSH Credentials, either Private Key or Password [password/private-key]
- secure_
access_ strssh_ user - Override the SSH username as indicated in SSH Certificate Issuer
- secure_
access_ strurl - Destination URL to inject secrets.
- secure_
access_ boolweb - Enable Web Secure Remote Access
- secure_
access_ boolweb_ browsing - Secure browser via Akeyless's Secure Remote Access (SRA)
- secure_
access_ boolweb_ proxy - Web-Proxy via Akeyless's Secure Remote Access (SRA)
- static_
secret_ strid - The ID of this resource.
- Sequence[str]
- List of the tags attached to this secret. To specify multiple tags use argument multiple times: -t Tag1 -t Tag2
- type str
- Secret type [generic/password]
- username str
- Username value (relevant only for type 'password')
- value str
- The secret content.
- version float
- The version of the secret.
- accessibility String
- For personal password manager
- change
Event String - Trigger an event when a secret value changed true/false
- custom
Field Map<String> - Additional custom fields to associate with the item (e.g fieldName1=value1) (relevant only for type 'password')
- delete
Protection String - Protection from accidental deletion of this auth method, [true/false]
- description String
- Description of the object
- format String
- Secret format text/json/key-value
- ignore
Cache String - Retrieve the Secret value without checking the Gateway's cache [true/false]
- inject
Urls List<String> - List of URLs associated with the item (relevant only for type 'password')
- item
Custom Map<String>Fields - Additional custom fields to associate with the item
- keep
Prev StringVersion - Whether to keep previous version [true/false]. If not set, use default according to account settings
- max
Versions String - Set the maximum number of versions, limited by the account settings defaults
- multiline
Value Boolean - The provided value is a multiline value (separated by ' ')
- password String
- Password value (relevant only for type 'password')
- path String
- The path where the secret will be stored.
- protection
Key String - The name of a key that is used to encrypt the secret value (if empty, the account default protectionKey key will be used)
- secure
Access StringCertificate Issuer - Path to the SSH Certificate Issuer for your Akeyless Secure Access
- secure
Access StringEnable - Enable/Disable secure remote access, [true/false]
- secure
Access StringGateway - Secure Remote Access Gateway
- secure
Access List<String>Hosts - Target servers for connections., For multiple values repeat this flag.
- secure
Access StringRdp User - Remote Desktop Username
- secure
Access StringSsh Creds - Static-Secret values contains SSH Credentials, either Private Key or Password [password/private-key]
- secure
Access StringSsh User - Override the SSH username as indicated in SSH Certificate Issuer
- secure
Access StringUrl - Destination URL to inject secrets.
- secure
Access BooleanWeb - Enable Web Secure Remote Access
- secure
Access BooleanWeb Browsing - Secure browser via Akeyless's Secure Remote Access (SRA)
- secure
Access BooleanWeb Proxy - Web-Proxy via Akeyless's Secure Remote Access (SRA)
- static
Secret StringId - The ID of this resource.
- List<String>
- List of the tags attached to this secret. To specify multiple tags use argument multiple times: -t Tag1 -t Tag2
- type String
- Secret type [generic/password]
- username String
- Username value (relevant only for type 'password')
- value String
- The secret content.
- version Number
- The version of the secret.
Import
$ pulumi import akeyless:index/staticSecret:StaticSecret example /full-secret-path/and-name-in-akeyless
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- akeyless akeyless-community/terraform-provider-akeyless
- License
- Notes
- This Pulumi package is based on the
akeylessTerraform Provider.
published on Monday, Apr 27, 2026 by akeyless-community
