Parameter

Provides an SSM Parameter resource.

Create a Parameter Resource

new Parameter(name: string, args: ParameterArgs, opts?: CustomResourceOptions);

def Parameter(resource_name, opts=None, allowed_pattern=None, arn=None, description=None, key_id=None, name=None, overwrite=None, tags=None, tier=None, type=None, value=None, __props__=None);

func NewParameter(ctx *Context, name string, args ParameterArgs, opts ...ResourceOption) (*Parameter, error)

public Parameter(string name, ParameterArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args ParameterArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args ParameterArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args ParameterArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

Parameter Resource Properties

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

Inputs

The Parameter resource accepts the following input properties:

Type string: The type of the parameter. Valid types are String, StringList and SecureString.
Value string: The value of the parameter.
AllowedPattern string: A regular expression used to validate the parameter value.
Arn string: The ARN of the parameter.
Description string: The description of the parameter.
KeyId string: The KMS key id or arn for encrypting a SecureString.
Name string: The name of the parameter. If the name contains a path (e.g. any forward slashes (/)), it must be fully qualified with a leading forward slash (/). For additional requirements and constraints, see the AWS SSM User Guide.
Overwrite bool: Overwrite an existing parameter. If not specified, will default to false if the resource has not been created by this provider to avoid overwrite of existing resource and will default to true otherwise (lifecycle rules should then be used to manage the update behavior).
Tags Dictionary<string, string>: A map of tags to assign to the object.
Tier string: The tier of the parameter. If not specified, will default to Standard. Valid tiers are Standard and Advanced. For more information on parameter tiers, see the AWS SSM Parameter tier comparison and guide.

Type string: The type of the parameter. Valid types are String, StringList and SecureString.
Value string: The value of the parameter.
AllowedPattern string: A regular expression used to validate the parameter value.
Arn string: The ARN of the parameter.
Description string: The description of the parameter.
KeyId string: The KMS key id or arn for encrypting a SecureString.
Name string: The name of the parameter. If the name contains a path (e.g. any forward slashes (/)), it must be fully qualified with a leading forward slash (/). For additional requirements and constraints, see the AWS SSM User Guide.
Overwrite bool: Overwrite an existing parameter. If not specified, will default to false if the resource has not been created by this provider to avoid overwrite of existing resource and will default to true otherwise (lifecycle rules should then be used to manage the update behavior).
Tags map[string]string: A map of tags to assign to the object.
Tier string: The tier of the parameter. If not specified, will default to Standard. Valid tiers are Standard and Advanced. For more information on parameter tiers, see the AWS SSM Parameter tier comparison and guide.

type ParameterType: The type of the parameter. Valid types are String, StringList and SecureString.
value string: The value of the parameter.
allowedPattern string: A regular expression used to validate the parameter value.
arn string: The ARN of the parameter.
description string: The description of the parameter.
keyId string: The KMS key id or arn for encrypting a SecureString.
name string: The name of the parameter. If the name contains a path (e.g. any forward slashes (/)), it must be fully qualified with a leading forward slash (/). For additional requirements and constraints, see the AWS SSM User Guide.
overwrite boolean: Overwrite an existing parameter. If not specified, will default to false if the resource has not been created by this provider to avoid overwrite of existing resource and will default to true otherwise (lifecycle rules should then be used to manage the update behavior).
tags {[key: string]: string}: A map of tags to assign to the object.
tier string: The tier of the parameter. If not specified, will default to Standard. Valid tiers are Standard and Advanced. For more information on parameter tiers, see the AWS SSM Parameter tier comparison and guide.

type str: The type of the parameter. Valid types are String, StringList and SecureString.
value str: The value of the parameter.
allowed_pattern str: A regular expression used to validate the parameter value.
arn str: The ARN of the parameter.
description str: The description of the parameter.
key_id str: The KMS key id or arn for encrypting a SecureString.
name str: The name of the parameter. If the name contains a path (e.g. any forward slashes (/)), it must be fully qualified with a leading forward slash (/). For additional requirements and constraints, see the AWS SSM User Guide.
overwrite bool: Overwrite an existing parameter. If not specified, will default to false if the resource has not been created by this provider to avoid overwrite of existing resource and will default to true otherwise (lifecycle rules should then be used to manage the update behavior).
tags Dict[str, str]: A map of tags to assign to the object.
tier str: The tier of the parameter. If not specified, will default to Standard. Valid tiers are Standard and Advanced. For more information on parameter tiers, see the AWS SSM Parameter tier comparison and guide.

Outputs

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

Id string: The provider-assigned unique ID for this managed resource.
Version int: The version of the parameter.

Id string: The provider-assigned unique ID for this managed resource.
Version int: The version of the parameter.

id string: The provider-assigned unique ID for this managed resource.
version number: The version of the parameter.

id str: The provider-assigned unique ID for this managed resource.
version float: The version of the parameter.

Look up an Existing Parameter Resource

Get an existing Parameter 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?: ParameterState, opts?: CustomResourceOptions): Parameter

static get(resource_name, id, opts=None, allowed_pattern=None, arn=None, description=None, key_id=None, name=None, overwrite=None, tags=None, tier=None, type=None, value=None, version=None, __props__=None);

func GetParameter(ctx *Context, name string, id IDInput, state *ParameterState, opts ...ResourceOption) (*Parameter, error)

public static Parameter Get(string name, Input<string> id, ParameterState? state, CustomResourceOptions? opts = null)

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.

The following state arguments are supported:

AllowedPattern string: A regular expression used to validate the parameter value.
Arn string: The ARN of the parameter.
Description string: The description of the parameter.
KeyId string: The KMS key id or arn for encrypting a SecureString.
Name string: The name of the parameter. If the name contains a path (e.g. any forward slashes (/)), it must be fully qualified with a leading forward slash (/). For additional requirements and constraints, see the AWS SSM User Guide.
Overwrite bool: Overwrite an existing parameter. If not specified, will default to false if the resource has not been created by this provider to avoid overwrite of existing resource and will default to true otherwise (lifecycle rules should then be used to manage the update behavior).
Tags Dictionary<string, string>: A map of tags to assign to the object.
Tier string: The tier of the parameter. If not specified, will default to Standard. Valid tiers are Standard and Advanced. For more information on parameter tiers, see the AWS SSM Parameter tier comparison and guide.
Type string: The type of the parameter. Valid types are String, StringList and SecureString.
Value string: The value of the parameter.
Version int: The version of the parameter.

AllowedPattern string: A regular expression used to validate the parameter value.
Arn string: The ARN of the parameter.
Description string: The description of the parameter.
KeyId string: The KMS key id or arn for encrypting a SecureString.
Name string: The name of the parameter. If the name contains a path (e.g. any forward slashes (/)), it must be fully qualified with a leading forward slash (/). For additional requirements and constraints, see the AWS SSM User Guide.
Overwrite bool: Overwrite an existing parameter. If not specified, will default to false if the resource has not been created by this provider to avoid overwrite of existing resource and will default to true otherwise (lifecycle rules should then be used to manage the update behavior).
Tags map[string]string: A map of tags to assign to the object.
Tier string: The tier of the parameter. If not specified, will default to Standard. Valid tiers are Standard and Advanced. For more information on parameter tiers, see the AWS SSM Parameter tier comparison and guide.
Type string: The type of the parameter. Valid types are String, StringList and SecureString.
Value string: The value of the parameter.
Version int: The version of the parameter.

allowedPattern string: A regular expression used to validate the parameter value.
arn string: The ARN of the parameter.
description string: The description of the parameter.
keyId string: The KMS key id or arn for encrypting a SecureString.
name string: The name of the parameter. If the name contains a path (e.g. any forward slashes (/)), it must be fully qualified with a leading forward slash (/). For additional requirements and constraints, see the AWS SSM User Guide.
overwrite boolean: Overwrite an existing parameter. If not specified, will default to false if the resource has not been created by this provider to avoid overwrite of existing resource and will default to true otherwise (lifecycle rules should then be used to manage the update behavior).
tags {[key: string]: string}: A map of tags to assign to the object.
tier string: The tier of the parameter. If not specified, will default to Standard. Valid tiers are Standard and Advanced. For more information on parameter tiers, see the AWS SSM Parameter tier comparison and guide.
type ParameterType: The type of the parameter. Valid types are String, StringList and SecureString.
value string: The value of the parameter.
version number: The version of the parameter.

allowed_pattern str: A regular expression used to validate the parameter value.
arn str: The ARN of the parameter.
description str: The description of the parameter.
key_id str: The KMS key id or arn for encrypting a SecureString.
name str: The name of the parameter. If the name contains a path (e.g. any forward slashes (/)), it must be fully qualified with a leading forward slash (/). For additional requirements and constraints, see the AWS SSM User Guide.
overwrite bool: Overwrite an existing parameter. If not specified, will default to false if the resource has not been created by this provider to avoid overwrite of existing resource and will default to true otherwise (lifecycle rules should then be used to manage the update behavior).
tags Dict[str, str]: A map of tags to assign to the object.
tier str: The tier of the parameter. If not specified, will default to Standard. Valid tiers are Standard and Advanced. For more information on parameter tiers, see the AWS SSM Parameter tier comparison and guide.
type str: The type of the parameter. Valid types are String, StringList and SecureString.
value str: The value of the parameter.
version float: The version of the parameter.

Package Details

Repository: https://github.com/pulumi/pulumi-aws
License: Apache-2.0
Notes: This Pulumi package is based on the aws Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud