AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the PutParameter operation. Add a parameter to the system.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.SimpleSystemsManagement.AmazonSimpleSystemsManagementRequest
      Amazon.SimpleSystemsManagement.Model.PutParameterRequest

Namespace: Amazon.SimpleSystemsManagement.Model
Assembly: AWSSDK.SimpleSystemsManagement.dll
Version: 3.x.y.z

Syntax

C#
public class PutParameterRequest : AmazonSimpleSystemsManagementRequest
         IAmazonWebServiceRequest

The PutParameterRequest type exposes the following members

Constructors

NameDescription
Public Method PutParameterRequest()

Properties

NameTypeDescription
Public Property AllowedPattern System.String

Gets and sets the property AllowedPattern.

A regular expression used to validate the parameter value. For example, for String types with values restricted to numbers, you can specify the following: AllowedPattern=^\d+$

Public Property Description System.String

Gets and sets the property Description.

Information about the parameter that you want to add to the system. Optional but recommended.

Do not enter personally identifiable information in this field.

Public Property KeyId System.String

Gets and sets the property KeyId.

The KMS Key ID that you want to use to encrypt a parameter. Either the default AWS Key Management Service (AWS KMS) key automatically assigned to your AWS account or a custom key. Required for parameters that use the SecureString data type.

If you don't specify a key ID, the system uses the default key associated with your AWS account.

  • To use your default AWS KMS key, choose the SecureString data type, and do not specify the Key ID when you create the parameter. The system automatically populates Key ID with your default KMS key.

  • To use a custom KMS key, choose the SecureString data type with the

    Key
                ID
    
    parameter.

Public Property Name System.String

Gets and sets the property Name.

The fully qualified name of the parameter that you want to add to the system. The fully qualified name includes the complete hierarchy of the parameter path and name. For example: /Dev/DBServer/MySQL/db-string13

Naming Constraints:

  • Parameter names are case sensitive.

  • A parameter name must be unique within an AWS Region

  • A parameter name can't be prefixed with "aws" or "ssm" (case-insensitive).

  • Parameter names can include only the following symbols and letters: a-zA-Z0-9_.-/

  • A parameter name can't include spaces.

  • Parameter hierarchies are limited to a maximum depth of fifteen levels.

For additional information about valid values for parameter names, see Requirements and Constraints for Parameter Names in the AWS Systems Manager User Guide.

The maximum length constraint listed below includes capacity for additional system attributes that are not part of the name. The maximum length for the fully qualified parameter name is 1011 characters.

Public Property Overwrite System.Boolean

Gets and sets the property Overwrite.

Overwrite an existing parameter. If not specified, will default to "false".

Public Property Type Amazon.SimpleSystemsManagement.ParameterType

Gets and sets the property Type.

The type of parameter that you want to add to the system.

Items in a StringList must be separated by a comma (,). You can't use other punctuation or special character to escape items in the list. If you have a parameter value that requires a comma, then use the String data type.

SecureString is not currently supported for AWS CloudFormation templates or in the China Regions.

Public Property Value System.String

Gets and sets the property Value.

The parameter value that you want to add to the system.

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms