Docs Packages
  1. Packages
  2. Alibaba Cloud
  3. API Docs
  4. oos
  5. SecretParameter
Alibaba Cloud v3.53.0 published on Wednesday, Apr 17, 2024 by Pulumi
pulumi/pulumi-alicloud

alicloud.oos.SecretParameter

Explore with Pulumi AI

alicloud logo
Alibaba Cloud v3.53.0 published on Wednesday, Apr 17, 2024 by Pulumi
pulumi/pulumi-alicloud

    Provides a OOS Secret Parameter resource.

    For information about OOS Secret Parameter and how to use it, see What is Secret Parameter.

    NOTE: Available since v1.147.0+.

    Example Usage

    Basic Usage

    import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";

const exampleResourceGroups = alicloud.resourcemanager.getResourceGroups({});
const exampleKey = new alicloud.kms.Key("exampleKey", {
    description: "terraform-example",
    status: "Enabled",
    pendingWindowInDays: 7,
});
const exampleSecretParameter = new alicloud.oos.SecretParameter("exampleSecretParameter", {
    secretParameterName: "terraform-example",
    value: "terraform-example",
    type: "Secret",
    keyId: exampleKey.id,
    description: "terraform-example",
    tags: {
        Created: "TF",
        For: "OosSecretParameter",
    },
    resourceGroupId: exampleResourceGroups.then(exampleResourceGroups => exampleResourceGroups.groups?.[0]?.id),
});

    import pulumi
import pulumi_alicloud as alicloud

example_resource_groups = alicloud.resourcemanager.get_resource_groups()
example_key = alicloud.kms.Key("exampleKey",
    description="terraform-example",
    status="Enabled",
    pending_window_in_days=7)
example_secret_parameter = alicloud.oos.SecretParameter("exampleSecretParameter",
    secret_parameter_name="terraform-example",
    value="terraform-example",
    type="Secret",
    key_id=example_key.id,
    description="terraform-example",
    tags={
        "Created": "TF",
        "For": "OosSecretParameter",
    },
    resource_group_id=example_resource_groups.groups[0].id)

    package main

import (
	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/kms"
	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/oos"
	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/resourcemanager"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		exampleResourceGroups, err := resourcemanager.GetResourceGroups(ctx, nil, nil)
		if err != nil {
			return err
		}
		exampleKey, err := kms.NewKey(ctx, "exampleKey", &kms.KeyArgs{
			Description:         pulumi.String("terraform-example"),
			Status:              pulumi.String("Enabled"),
			PendingWindowInDays: pulumi.Int(7),
		})
		if err != nil {
			return err
		}
		_, err = oos.NewSecretParameter(ctx, "exampleSecretParameter", &oos.SecretParameterArgs{
			SecretParameterName: pulumi.String("terraform-example"),
			Value:               pulumi.String("terraform-example"),
			Type:                pulumi.String("Secret"),
			KeyId:               exampleKey.ID(),
			Description:         pulumi.String("terraform-example"),
			Tags: pulumi.Map{
				"Created": pulumi.Any("TF"),
				"For":     pulumi.Any("OosSecretParameter"),
			},
			ResourceGroupId: pulumi.String(exampleResourceGroups.Groups[0].Id),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AliCloud = Pulumi.AliCloud;

return await Deployment.RunAsync(() => 
{
    var exampleResourceGroups = AliCloud.ResourceManager.GetResourceGroups.Invoke();

    var exampleKey = new AliCloud.Kms.Key("exampleKey", new()
    {
        Description = "terraform-example",
        Status = "Enabled",
        PendingWindowInDays = 7,
    });

    var exampleSecretParameter = new AliCloud.Oos.SecretParameter("exampleSecretParameter", new()
    {
        SecretParameterName = "terraform-example",
        Value = "terraform-example",
        Type = "Secret",
        KeyId = exampleKey.Id,
        Description = "terraform-example",
        Tags = 
        {
            { "Created", "TF" },
            { "For", "OosSecretParameter" },
        },
        ResourceGroupId = exampleResourceGroups.Apply(getResourceGroupsResult => getResourceGroupsResult.Groups[0]?.Id),
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.alicloud.resourcemanager.ResourcemanagerFunctions;
import com.pulumi.alicloud.resourcemanager.inputs.GetResourceGroupsArgs;
import com.pulumi.alicloud.kms.Key;
import com.pulumi.alicloud.kms.KeyArgs;
import com.pulumi.alicloud.oos.SecretParameter;
import com.pulumi.alicloud.oos.SecretParameterArgs;
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) {
        final var exampleResourceGroups = ResourcemanagerFunctions.getResourceGroups();

        var exampleKey = new Key("exampleKey", KeyArgs.builder()        
            .description("terraform-example")
            .status("Enabled")
            .pendingWindowInDays(7)
            .build());

        var exampleSecretParameter = new SecretParameter("exampleSecretParameter", SecretParameterArgs.builder()        
            .secretParameterName("terraform-example")
            .value("terraform-example")
            .type("Secret")
            .keyId(exampleKey.id())
            .description("terraform-example")
            .tags(Map.ofEntries(
                Map.entry("Created", "TF"),
                Map.entry("For", "OosSecretParameter")
            ))
            .resourceGroupId(exampleResourceGroups.applyValue(getResourceGroupsResult -> getResourceGroupsResult.groups()[0].id()))
            .build());

    }
}

    resources:
  exampleKey:
    type: alicloud:kms:Key
    properties:
      description: terraform-example
      status: Enabled
      pendingWindowInDays: 7
  exampleSecretParameter:
    type: alicloud:oos:SecretParameter
    properties:
      secretParameterName: terraform-example
      value: terraform-example
      type: Secret
      keyId: ${exampleKey.id}
      description: terraform-example
      tags:
        Created: TF
        For: OosSecretParameter
      resourceGroupId: ${exampleResourceGroups.groups[0].id}
variables:
  exampleResourceGroups:
    fn::invoke:
      Function: alicloud:resourcemanager:getResourceGroups
      Arguments: {}

    Create SecretParameter Resource

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

    Constructor syntax

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

@overload
def SecretParameter(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    secret_parameter_name: Optional[str] = None,
                    value: Optional[str] = None,
                    constraints: Optional[str] = None,
                    description: Optional[str] = None,
                    key_id: Optional[str] = None,
                    resource_group_id: Optional[str] = None,
                    tags: Optional[Mapping[str, Any]] = None,
                    type: Optional[str] = None)
    func NewSecretParameter(ctx *Context, name string, args SecretParameterArgs, opts ...ResourceOption) (*SecretParameter, error)
    public SecretParameter(string name, SecretParameterArgs args, CustomResourceOptions? opts = null)
    public SecretParameter(String name, SecretParameterArgs args)
public SecretParameter(String name, SecretParameterArgs args, CustomResourceOptions options)

    type: alicloud:oos:SecretParameter
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 SecretParameterArgs
    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 SecretParameterArgs
    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 SecretParameterArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SecretParameterArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SecretParameterArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var secretParameterResource = new AliCloud.Oos.SecretParameter("secretParameterResource", new()
{
    SecretParameterName = "string",
    Value = "string",
    Constraints = "string",
    Description = "string",
    KeyId = "string",
    ResourceGroupId = "string",
    Tags = 
    {
        { "string", "any" },
    },
    Type = "string",
});

    example, err := oos.NewSecretParameter(ctx, "secretParameterResource", &oos.SecretParameterArgs{
	SecretParameterName: pulumi.String("string"),
	Value:               pulumi.String("string"),
	Constraints:         pulumi.String("string"),
	Description:         pulumi.String("string"),
	KeyId:               pulumi.String("string"),
	ResourceGroupId:     pulumi.String("string"),
	Tags: pulumi.Map{
		"string": pulumi.Any("any"),
	},
	Type: pulumi.String("string"),
})

    var secretParameterResource = new SecretParameter("secretParameterResource", SecretParameterArgs.builder()        
    .secretParameterName("string")
    .value("string")
    .constraints("string")
    .description("string")
    .keyId("string")
    .resourceGroupId("string")
    .tags(Map.of("string", "any"))
    .type("string")
    .build());

    secret_parameter_resource = alicloud.oos.SecretParameter("secretParameterResource",
    secret_parameter_name="string",
    value="string",
    constraints="string",
    description="string",
    key_id="string",
    resource_group_id="string",
    tags={
        "string": "any",
    },
    type="string")

    const secretParameterResource = new alicloud.oos.SecretParameter("secretParameterResource", {
    secretParameterName: "string",
    value: "string",
    constraints: "string",
    description: "string",
    keyId: "string",
    resourceGroupId: "string",
    tags: {
        string: "any",
    },
    type: "string",
});

    type: alicloud:oos:SecretParameter
properties:
    constraints: string
    description: string
    keyId: string
    resourceGroupId: string
    secretParameterName: string
    tags:
        string: any
    type: string
    value: string

    SecretParameter Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The SecretParameter resource accepts the following input properties:

    SecretParameterName string
    The name of the encryption parameter. The name must be 2 to 180 characters in length, and can contain letters, digits, hyphens (-), forward slashes (/) and underscores (_). It cannot start with ALIYUN, ACS, ALIBABA, ALICLOUD, or OOS.
    Value string
    The value of the encryption parameter. The value must be 1 to 4096 characters in length.
    Constraints string
    The constraints of the encryption parameter. By default, this parameter is null. Valid values:
    Description string
    The description of the encryption parameter. The description must be 1 to 200 characters in length.
    KeyId string
    The Customer Master Key (CMK) of Key Management Service (KMS) that is used to encrypt the parameter.
    ResourceGroupId string
    The ID of the Resource Group.
    Tags Dictionary<string, object>
    A mapping of tags to assign to the resource.
    Type string
    The data type of the encryption parameter. Valid values: Secret.
    SecretParameterName string
    The name of the encryption parameter. The name must be 2 to 180 characters in length, and can contain letters, digits, hyphens (-), forward slashes (/) and underscores (_). It cannot start with ALIYUN, ACS, ALIBABA, ALICLOUD, or OOS.
    Value string
    The value of the encryption parameter. The value must be 1 to 4096 characters in length.
    Constraints string
    The constraints of the encryption parameter. By default, this parameter is null. Valid values:
    Description string
    The description of the encryption parameter. The description must be 1 to 200 characters in length.
    KeyId string
    The Customer Master Key (CMK) of Key Management Service (KMS) that is used to encrypt the parameter.
    ResourceGroupId string
    The ID of the Resource Group.
    Tags map[string]interface{}
    A mapping of tags to assign to the resource.
    Type string
    The data type of the encryption parameter. Valid values: Secret.
    secretParameterName String
    The name of the encryption parameter. The name must be 2 to 180 characters in length, and can contain letters, digits, hyphens (-), forward slashes (/) and underscores (_). It cannot start with ALIYUN, ACS, ALIBABA, ALICLOUD, or OOS.
    value String
    The value of the encryption parameter. The value must be 1 to 4096 characters in length.
    constraints String
    The constraints of the encryption parameter. By default, this parameter is null. Valid values:
    description String
    The description of the encryption parameter. The description must be 1 to 200 characters in length.
    keyId String
    The Customer Master Key (CMK) of Key Management Service (KMS) that is used to encrypt the parameter.
    resourceGroupId String
    The ID of the Resource Group.
    tags Map<String,Object>
    A mapping of tags to assign to the resource.
    type String
    The data type of the encryption parameter. Valid values: Secret.
    secretParameterName string
    The name of the encryption parameter. The name must be 2 to 180 characters in length, and can contain letters, digits, hyphens (-), forward slashes (/) and underscores (_). It cannot start with ALIYUN, ACS, ALIBABA, ALICLOUD, or OOS.
    value string
    The value of the encryption parameter. The value must be 1 to 4096 characters in length.
    constraints string
    The constraints of the encryption parameter. By default, this parameter is null. Valid values:
    description string
    The description of the encryption parameter. The description must be 1 to 200 characters in length.
    keyId string
    The Customer Master Key (CMK) of Key Management Service (KMS) that is used to encrypt the parameter.
    resourceGroupId string
    The ID of the Resource Group.
    tags {[key: string]: any}
    A mapping of tags to assign to the resource.
    type string
    The data type of the encryption parameter. Valid values: Secret.
    secret_parameter_name str
    The name of the encryption parameter. The name must be 2 to 180 characters in length, and can contain letters, digits, hyphens (-), forward slashes (/) and underscores (_). It cannot start with ALIYUN, ACS, ALIBABA, ALICLOUD, or OOS.
    value str
    The value of the encryption parameter. The value must be 1 to 4096 characters in length.
    constraints str
    The constraints of the encryption parameter. By default, this parameter is null. Valid values:
    description str
    The description of the encryption parameter. The description must be 1 to 200 characters in length.
    key_id str
    The Customer Master Key (CMK) of Key Management Service (KMS) that is used to encrypt the parameter.
    resource_group_id str
    The ID of the Resource Group.
    tags Mapping[str, Any]
    A mapping of tags to assign to the resource.
    type str
    The data type of the encryption parameter. Valid values: Secret.
    secretParameterName String
    The name of the encryption parameter. The name must be 2 to 180 characters in length, and can contain letters, digits, hyphens (-), forward slashes (/) and underscores (_). It cannot start with ALIYUN, ACS, ALIBABA, ALICLOUD, or OOS.
    value String
    The value of the encryption parameter. The value must be 1 to 4096 characters in length.
    constraints String
    The constraints of the encryption parameter. By default, this parameter is null. Valid values:
    description String
    The description of the encryption parameter. The description must be 1 to 200 characters in length.
    keyId String
    The Customer Master Key (CMK) of Key Management Service (KMS) that is used to encrypt the parameter.
    resourceGroupId String
    The ID of the Resource Group.
    tags Map<Any>
    A mapping of tags to assign to the resource.
    type String
    The data type of the encryption parameter. Valid values: Secret.

    Outputs

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

    Get an existing SecretParameter 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?: SecretParameterState, opts?: CustomResourceOptions): SecretParameter
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        constraints: Optional[str] = None,
        description: Optional[str] = None,
        key_id: Optional[str] = None,
        resource_group_id: Optional[str] = None,
        secret_parameter_name: Optional[str] = None,
        tags: Optional[Mapping[str, Any]] = None,
        type: Optional[str] = None,
        value: Optional[str] = None) -> SecretParameter
    func GetSecretParameter(ctx *Context, name string, id IDInput, state *SecretParameterState, opts ...ResourceOption) (*SecretParameter, error)
    public static SecretParameter Get(string name, Input<string> id, SecretParameterState? state, CustomResourceOptions? opts = null)
    public static SecretParameter get(String name, Output<String> id, SecretParameterState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Constraints string
    The constraints of the encryption parameter. By default, this parameter is null. Valid values:
    Description string
    The description of the encryption parameter. The description must be 1 to 200 characters in length.
    KeyId string
    The Customer Master Key (CMK) of Key Management Service (KMS) that is used to encrypt the parameter.
    ResourceGroupId string
    The ID of the Resource Group.
    SecretParameterName string
    The name of the encryption parameter. The name must be 2 to 180 characters in length, and can contain letters, digits, hyphens (-), forward slashes (/) and underscores (_). It cannot start with ALIYUN, ACS, ALIBABA, ALICLOUD, or OOS.
    Tags Dictionary<string, object>
    A mapping of tags to assign to the resource.
    Type string
    The data type of the encryption parameter. Valid values: Secret.
    Value string
    The value of the encryption parameter. The value must be 1 to 4096 characters in length.
    Constraints string
    The constraints of the encryption parameter. By default, this parameter is null. Valid values:
    Description string
    The description of the encryption parameter. The description must be 1 to 200 characters in length.
    KeyId string
    The Customer Master Key (CMK) of Key Management Service (KMS) that is used to encrypt the parameter.
    ResourceGroupId string
    The ID of the Resource Group.
    SecretParameterName string
    The name of the encryption parameter. The name must be 2 to 180 characters in length, and can contain letters, digits, hyphens (-), forward slashes (/) and underscores (_). It cannot start with ALIYUN, ACS, ALIBABA, ALICLOUD, or OOS.
    Tags map[string]interface{}
    A mapping of tags to assign to the resource.
    Type string
    The data type of the encryption parameter. Valid values: Secret.
    Value string
    The value of the encryption parameter. The value must be 1 to 4096 characters in length.
    constraints String
    The constraints of the encryption parameter. By default, this parameter is null. Valid values:
    description String
    The description of the encryption parameter. The description must be 1 to 200 characters in length.
    keyId String
    The Customer Master Key (CMK) of Key Management Service (KMS) that is used to encrypt the parameter.
    resourceGroupId String
    The ID of the Resource Group.
    secretParameterName String
    The name of the encryption parameter. The name must be 2 to 180 characters in length, and can contain letters, digits, hyphens (-), forward slashes (/) and underscores (_). It cannot start with ALIYUN, ACS, ALIBABA, ALICLOUD, or OOS.
    tags Map<String,Object>
    A mapping of tags to assign to the resource.
    type String
    The data type of the encryption parameter. Valid values: Secret.
    value String
    The value of the encryption parameter. The value must be 1 to 4096 characters in length.
    constraints string
    The constraints of the encryption parameter. By default, this parameter is null. Valid values:
    description string
    The description of the encryption parameter. The description must be 1 to 200 characters in length.
    keyId string
    The Customer Master Key (CMK) of Key Management Service (KMS) that is used to encrypt the parameter.
    resourceGroupId string
    The ID of the Resource Group.
    secretParameterName string
    The name of the encryption parameter. The name must be 2 to 180 characters in length, and can contain letters, digits, hyphens (-), forward slashes (/) and underscores (_). It cannot start with ALIYUN, ACS, ALIBABA, ALICLOUD, or OOS.
    tags {[key: string]: any}
    A mapping of tags to assign to the resource.
    type string
    The data type of the encryption parameter. Valid values: Secret.
    value string
    The value of the encryption parameter. The value must be 1 to 4096 characters in length.
    constraints str
    The constraints of the encryption parameter. By default, this parameter is null. Valid values:
    description str
    The description of the encryption parameter. The description must be 1 to 200 characters in length.
    key_id str
    The Customer Master Key (CMK) of Key Management Service (KMS) that is used to encrypt the parameter.
    resource_group_id str
    The ID of the Resource Group.
    secret_parameter_name str
    The name of the encryption parameter. The name must be 2 to 180 characters in length, and can contain letters, digits, hyphens (-), forward slashes (/) and underscores (_). It cannot start with ALIYUN, ACS, ALIBABA, ALICLOUD, or OOS.
    tags Mapping[str, Any]
    A mapping of tags to assign to the resource.
    type str
    The data type of the encryption parameter. Valid values: Secret.
    value str
    The value of the encryption parameter. The value must be 1 to 4096 characters in length.
    constraints String
    The constraints of the encryption parameter. By default, this parameter is null. Valid values:
    description String
    The description of the encryption parameter. The description must be 1 to 200 characters in length.
    keyId String
    The Customer Master Key (CMK) of Key Management Service (KMS) that is used to encrypt the parameter.
    resourceGroupId String
    The ID of the Resource Group.
    secretParameterName String
    The name of the encryption parameter. The name must be 2 to 180 characters in length, and can contain letters, digits, hyphens (-), forward slashes (/) and underscores (_). It cannot start with ALIYUN, ACS, ALIBABA, ALICLOUD, or OOS.
    tags Map<Any>
    A mapping of tags to assign to the resource.
    type String
    The data type of the encryption parameter. Valid values: Secret.
    value String
    The value of the encryption parameter. The value must be 1 to 4096 characters in length.

    Import

    OOS Secret Parameter can be imported using the id, e.g.

    $ pulumi import alicloud:oos/secretParameter:SecretParameter example <secret_parameter_name>

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Alibaba Cloud pulumi/pulumi-alicloud
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the alicloud Terraform Provider.
    alicloud logo
    Alibaba Cloud v3.53.0 published on Wednesday, Apr 17, 2024 by Pulumi
    pulumi/pulumi-alicloud