Alibaba Cloud

v3.28.0 published on Tuesday, Aug 16, 2022 by Pulumi

SecretParameter

Provides a OOS Secret Parameter resource.

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

NOTE: Available in v1.147.0+.

Create SecretParameter Resource

new SecretParameter(name: string, args: SecretParameterArgs, opts?: CustomResourceOptions);
@overload
def SecretParameter(resource_name: 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)
@overload
def SecretParameter(resource_name: str,
                    args: SecretParameterArgs,
                    opts: Optional[ResourceOptions] = 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.

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.

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:

  • AllowedValues: The value that is allowed for the encryption parameter. It must be an array string.
  • AllowedPattern: The pattern that is allowed for the encryption parameter. It must be a regular expression.
  • MinLength: The minimum length of the encryption parameter.
  • MaxLength: The maximum length of the encryption parameter.
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:

  • AllowedValues: The value that is allowed for the encryption parameter. It must be an array string.
  • AllowedPattern: The pattern that is allowed for the encryption parameter. It must be a regular expression.
  • MinLength: The minimum length of the encryption parameter.
  • MaxLength: The maximum length of the encryption parameter.
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:

  • AllowedValues: The value that is allowed for the encryption parameter. It must be an array string.
  • AllowedPattern: The pattern that is allowed for the encryption parameter. It must be a regular expression.
  • MinLength: The minimum length of the encryption parameter.
  • MaxLength: The maximum length of the encryption parameter.
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:

  • AllowedValues: The value that is allowed for the encryption parameter. It must be an array string.
  • AllowedPattern: The pattern that is allowed for the encryption parameter. It must be a regular expression.
  • MinLength: The minimum length of the encryption parameter.
  • MaxLength: The maximum length of the encryption parameter.
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:

  • AllowedValues: The value that is allowed for the encryption parameter. It must be an array string.
  • AllowedPattern: The pattern that is allowed for the encryption parameter. It must be a regular expression.
  • MinLength: The minimum length of the encryption parameter.
  • MaxLength: The maximum length of the encryption parameter.
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:

  • AllowedValues: The value that is allowed for the encryption parameter. It must be an array string.
  • AllowedPattern: The pattern that is allowed for the encryption parameter. It must be a regular expression.
  • MinLength: The minimum length of the encryption parameter.
  • MaxLength: The maximum length of the encryption parameter.
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:

  • AllowedValues: The value that is allowed for the encryption parameter. It must be an array string.
  • AllowedPattern: The pattern that is allowed for the encryption parameter. It must be a regular expression.
  • MinLength: The minimum length of the encryption parameter.
  • MaxLength: The maximum length of the encryption parameter.
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:

  • AllowedValues: The value that is allowed for the encryption parameter. It must be an array string.
  • AllowedPattern: The pattern that is allowed for the encryption parameter. It must be a regular expression.
  • MinLength: The minimum length of the encryption parameter.
  • MaxLength: The maximum length of the encryption parameter.
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:

  • AllowedValues: The value that is allowed for the encryption parameter. It must be an array string.
  • AllowedPattern: The pattern that is allowed for the encryption parameter. It must be a regular expression.
  • MinLength: The minimum length of the encryption parameter.
  • MaxLength: The maximum length of the encryption parameter.
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:

  • AllowedValues: The value that is allowed for the encryption parameter. It must be an array string.
  • AllowedPattern: The pattern that is allowed for the encryption parameter. It must be a regular expression.
  • MinLength: The minimum length of the encryption parameter.
  • MaxLength: The maximum length of the encryption parameter.
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:

  • AllowedValues: The value that is allowed for the encryption parameter. It must be an array string.
  • AllowedPattern: The pattern that is allowed for the encryption parameter. It must be a regular expression.
  • MinLength: The minimum length of the encryption parameter.
  • MaxLength: The maximum length of the encryption parameter.
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:

  • AllowedValues: The value that is allowed for the encryption parameter. It must be an array string.
  • AllowedPattern: The pattern that is allowed for the encryption parameter. It must be a regular expression.
  • MinLength: The minimum length of the encryption parameter.
  • MaxLength: The maximum length of the encryption parameter.
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>

Package Details

Repository
https://github.com/pulumi/pulumi-alicloud
License
Apache-2.0
Notes

This Pulumi package is based on the alicloud Terraform Provider.