1. Packages
  2. Rootly
  3. API Docs
  4. Secret
Rootly v1.5.0 published on Thursday, Apr 25, 2024 by Rootly

rootly.Secret

Explore with Pulumi AI

Create Secret Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Secret(name: string, args?: SecretArgs, opts?: CustomResourceOptions);
@overload
def Secret(resource_name: str,
           args: Optional[SecretArgs] = None,
           opts: Optional[ResourceOptions] = None)

@overload
def Secret(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           hashicorp_vault_mount: Optional[str] = None,
           hashicorp_vault_path: Optional[str] = None,
           hashicorp_vault_version: Optional[int] = None,
           name: Optional[str] = None,
           secret: Optional[str] = None)
func NewSecret(ctx *Context, name string, args *SecretArgs, opts ...ResourceOption) (*Secret, error)
public Secret(string name, SecretArgs? args = null, CustomResourceOptions? opts = null)
public Secret(String name, SecretArgs args)
public Secret(String name, SecretArgs args, CustomResourceOptions options)
type: rootly:Secret
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args SecretArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args SecretArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args SecretArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args SecretArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. SecretArgs
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 secretResource = new Rootly.Secret("secretResource", new()
{
    HashicorpVaultMount = "string",
    HashicorpVaultPath = "string",
    HashicorpVaultVersion = 0,
    Name = "string",
    Rootly_secret = "string",
});
Copy
example, err := rootly.NewSecret(ctx, "secretResource", &rootly.SecretArgs{
	HashicorpVaultMount:   pulumi.String("string"),
	HashicorpVaultPath:    pulumi.String("string"),
	HashicorpVaultVersion: pulumi.Int(0),
	Name:                  pulumi.String("string"),
	Secret:                pulumi.String("string"),
})
Copy
var secretResource = new Secret("secretResource", SecretArgs.builder()
    .hashicorpVaultMount("string")
    .hashicorpVaultPath("string")
    .hashicorpVaultVersion(0)
    .name("string")
    .secret("string")
    .build());
Copy
secret_resource = rootly.Secret("secretResource",
    hashicorp_vault_mount="string",
    hashicorp_vault_path="string",
    hashicorp_vault_version=0,
    name="string",
    secret="string")
Copy
const secretResource = new rootly.Secret("secretResource", {
    hashicorpVaultMount: "string",
    hashicorpVaultPath: "string",
    hashicorpVaultVersion: 0,
    name: "string",
    secret: "string",
});
Copy
type: rootly:Secret
properties:
    hashicorpVaultMount: string
    hashicorpVaultPath: string
    hashicorpVaultVersion: 0
    name: string
    secret: string
Copy

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

HashicorpVaultMount string
The HashiCorp Vault secret mount path
HashicorpVaultPath string
The HashiCorp Vault secret path
HashicorpVaultVersion int
The HashiCorp Vault secret version
Name string
The name of the secret
rootly_secret Changes to this property will trigger replacement. string
The redacted secret
HashicorpVaultMount string
The HashiCorp Vault secret mount path
HashicorpVaultPath string
The HashiCorp Vault secret path
HashicorpVaultVersion int
The HashiCorp Vault secret version
Name string
The name of the secret
Secret Changes to this property will trigger replacement. string
The redacted secret
hashicorpVaultMount String
The HashiCorp Vault secret mount path
hashicorpVaultPath String
The HashiCorp Vault secret path
hashicorpVaultVersion Integer
The HashiCorp Vault secret version
name String
The name of the secret
secret Changes to this property will trigger replacement. String
The redacted secret
hashicorpVaultMount string
The HashiCorp Vault secret mount path
hashicorpVaultPath string
The HashiCorp Vault secret path
hashicorpVaultVersion number
The HashiCorp Vault secret version
name string
The name of the secret
secret Changes to this property will trigger replacement. string
The redacted secret
hashicorp_vault_mount str
The HashiCorp Vault secret mount path
hashicorp_vault_path str
The HashiCorp Vault secret path
hashicorp_vault_version int
The HashiCorp Vault secret version
name str
The name of the secret
secret Changes to this property will trigger replacement. str
The redacted secret
hashicorpVaultMount String
The HashiCorp Vault secret mount path
hashicorpVaultPath String
The HashiCorp Vault secret path
hashicorpVaultVersion Number
The HashiCorp Vault secret version
name String
The name of the secret
secret Changes to this property will trigger replacement. String
The redacted secret

Outputs

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

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

Look up Existing Secret Resource

Get an existing Secret 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?: SecretState, opts?: CustomResourceOptions): Secret
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        hashicorp_vault_mount: Optional[str] = None,
        hashicorp_vault_path: Optional[str] = None,
        hashicorp_vault_version: Optional[int] = None,
        name: Optional[str] = None,
        secret: Optional[str] = None) -> Secret
func GetSecret(ctx *Context, name string, id IDInput, state *SecretState, opts ...ResourceOption) (*Secret, error)
public static Secret Get(string name, Input<string> id, SecretState? state, CustomResourceOptions? opts = null)
public static Secret get(String name, Output<String> id, SecretState state, CustomResourceOptions options)
resources:  _:    type: rootly:Secret    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
HashicorpVaultMount string
The HashiCorp Vault secret mount path
HashicorpVaultPath string
The HashiCorp Vault secret path
HashicorpVaultVersion int
The HashiCorp Vault secret version
Name string
The name of the secret
rootly_secret Changes to this property will trigger replacement. string
The redacted secret
HashicorpVaultMount string
The HashiCorp Vault secret mount path
HashicorpVaultPath string
The HashiCorp Vault secret path
HashicorpVaultVersion int
The HashiCorp Vault secret version
Name string
The name of the secret
Secret Changes to this property will trigger replacement. string
The redacted secret
hashicorpVaultMount String
The HashiCorp Vault secret mount path
hashicorpVaultPath String
The HashiCorp Vault secret path
hashicorpVaultVersion Integer
The HashiCorp Vault secret version
name String
The name of the secret
secret Changes to this property will trigger replacement. String
The redacted secret
hashicorpVaultMount string
The HashiCorp Vault secret mount path
hashicorpVaultPath string
The HashiCorp Vault secret path
hashicorpVaultVersion number
The HashiCorp Vault secret version
name string
The name of the secret
secret Changes to this property will trigger replacement. string
The redacted secret
hashicorp_vault_mount str
The HashiCorp Vault secret mount path
hashicorp_vault_path str
The HashiCorp Vault secret path
hashicorp_vault_version int
The HashiCorp Vault secret version
name str
The name of the secret
secret Changes to this property will trigger replacement. str
The redacted secret
hashicorpVaultMount String
The HashiCorp Vault secret mount path
hashicorpVaultPath String
The HashiCorp Vault secret path
hashicorpVaultVersion Number
The HashiCorp Vault secret version
name String
The name of the secret
secret Changes to this property will trigger replacement. String
The redacted secret

Package Details

Repository
rootly rootlyhq/pulumi-rootly
License
Apache-2.0
Notes
This Pulumi package is based on the rootly Terraform Provider.