Class Parameter

Provides an SSM Parameter resource.

Example Usage

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
public MyStack()
{
    var foo = new Aws.Ssm.Parameter("foo", new Aws.Ssm.ParameterArgs
    {
        Type = "String",
        Value = "bar",
    });
}

}

Inheritance

System.Object

Resource

CustomResource

Parameter

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Aws.Ssm

Assembly: Pulumi.Aws.dll

Syntax

public class Parameter : CustomResource

Constructors

Parameter(String, ParameterArgs, CustomResourceOptions)

Create a Parameter resource with the given unique name, arguments, and options.

Declaration

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

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
ParameterArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

AllowedPattern

A regular expression used to validate the parameter value.

Declaration

public Output<string> AllowedPattern { get; }

Property Value

Type	Description
Output<System.String>

Arn

The ARN of the parameter.

Declaration

public Output<string> Arn { get; }

Property Value

Type	Description
Output<System.String>

Description

The description of the parameter.

Declaration

public Output<string> Description { get; }

Property Value

Type	Description
Output<System.String>

KeyId

The KMS key id or arn for encrypting a SecureString.

Declaration

public Output<string> KeyId { get; }

Property Value

Type	Description
Output<System.String>

Name

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.

Declaration

public Output<string> Name { get; }

Property Value

Type	Description
Output<System.String>

Overwrite

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).

Declaration

public Output<bool?> Overwrite { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

Tags

A map of tags to assign to the object.

Declaration

public Output<ImmutableDictionary<string, object>> Tags { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableDictionary<System.String, System.Object>>

Tier

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.

Declaration

public Output<string> Tier { get; }

Property Value

Type	Description
Output<System.String>

Type

The type of the parameter. Valid types are String, StringList and SecureString.

Declaration

public Output<string> Type { get; }

Property Value

Type	Description
Output<System.String>

Value

The value of the parameter.

Declaration

public Output<string> Value { get; }

Property Value

Type	Description
Output<System.String>

Version

The version of the parameter.

Declaration

public Output<int> Version { get; }

Property Value

Type	Description
Output<System.Int32>

Methods

Get(String, Input<String>, ParameterState, CustomResourceOptions)

Get an existing Parameter resource's state with the given name, ID, and optional extra properties used to qualify the lookup.

Declaration

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

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
ParameterState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
Parameter