Class CfnParameterProps
Properties for defining a CfnParameter
.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.SSM
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnParameterProps : Object, ICfnParameterProps
Syntax (vb)
Public Class CfnParameterProps
Inherits Object
Implements ICfnParameterProps
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-parameter.html
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.SSM;
var cfnParameterProps = new CfnParameterProps {
Type = "type",
Value = "value",
// the properties below are optional
AllowedPattern = "allowedPattern",
DataType = "dataType",
Description = "description",
Name = "name",
Policies = "policies",
Tags = new Dictionary<string, string> {
{ "tagsKey", "tags" }
},
Tier = "tier"
};
Synopsis
Constructors
CfnParameterProps() |
Properties
AllowedPattern | A regular expression used to validate the parameter value. |
DataType | The data type of the parameter, such as |
Description | Information about the parameter. |
Name | The name of the parameter. |
Policies | Information about the policies assigned to a parameter. |
Tags | Optional metadata that you assign to a resource in the form of an arbitrary set of tags (key-value pairs). |
Tier | The parameter tier. |
Type | The type of parameter. |
Value | The parameter value. |
Constructors
CfnParameterProps()
public CfnParameterProps()
Properties
AllowedPattern
A regular expression used to validate the parameter value.
public string AllowedPattern { get; set; }
Property Value
System.String
Remarks
For example, for String
types with values restricted to numbers, you can specify the following: AllowedPattern=^\d+$
DataType
The data type of the parameter, such as text
or aws:ec2:image
.
public string DataType { get; set; }
Property Value
System.String
Remarks
Description
Information about the parameter.
public string Description { get; set; }
Property Value
System.String
Remarks
Name
The name of the parameter.
public string Name { get; set; }
Property Value
System.String
Remarks
The maximum length constraint listed below includes capacity for additional system attributes that aren't part of the name. The maximum length for a parameter name, including the full length of the parameter Amazon Resource Name (ARN), is 1011 characters. For example, the length of the following parameter name is 65 characters, not 20 characters: arn:aws:ssm:us-east-2:111222333444:parameter/ExampleParameterName
Policies
Information about the policies assigned to a parameter.
public string Policies { get; set; }
Property Value
System.String
Remarks
Assigning parameter policies in the AWS Systems Manager User Guide .
Tags
Optional metadata that you assign to a resource in the form of an arbitrary set of tags (key-value pairs).
public IDictionary<string, string> Tags { get; set; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.String>
Remarks
Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a Systems Manager parameter to identify the type of resource to which it applies, the environment, or the type of configuration data referenced by the parameter.
Tier
The parameter tier.
public string Tier { get; set; }
Property Value
System.String
Remarks
Type
The type of parameter.
public string Type { get; set; }
Property Value
System.String
Remarks
Value
The parameter value.
public string Value { get; set; }
Property Value
System.String
Remarks
If type is StringList
, the system returns a comma-separated string with no spaces between commas in the Value
field.