Class CfnParameter
The AWS::SSM::Parameter
resource creates an SSM parameter in AWS Systems Manager Parameter Store.
Inherited Members
Namespace: Amazon.CDK.AWS.SSM
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnParameter : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnParameter
Inherits CfnResource
Implements IInspectable, ITaggable
Remarks
To create an SSM parameter, you must have the AWS Identity and Access Management ( IAM ) permissions ssm:PutParameter
and ssm:AddTagsToResource
. On stack creation, AWS CloudFormation adds the following three tags to the parameter: aws:cloudformation:stack-name
, aws:cloudformation:logical-id
, and aws:cloudformation:stack-id
, in addition to any custom tags you specify.
To add, update, or remove tags during stack update, you must have IAM permissions for both ssm:AddTagsToResource
and ssm:RemoveTagsFromResource
. For more information, see Managing Access Using Policies in the AWS Systems Manager User Guide .
For information about valid values for parameters, see About requirements and constraints for parameter names in the AWS Systems Manager User Guide and PutParameter in the AWS Systems Manager API Reference .
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-parameter.html
CloudformationResource: AWS::SSM::Parameter
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 cfnParameter = new CfnParameter(this, "MyCfnParameter", 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
CfnParameter(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnParameter(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnParameter(Construct, String, ICfnParameterProps) |
Properties
AllowedPattern | A regular expression used to validate the parameter value. |
AttrType | Returns the type of the parameter. |
AttrValue | Returns the value of the parameter. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
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 | Tag Manager which manages the tags for this resource. |
TagsRaw | 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. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnParameter(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnParameter(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnParameter(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnParameter(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnParameter(Construct, String, ICfnParameterProps)
public CfnParameter(Construct scope, string id, ICfnParameterProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnParameterProps
Resource properties.
Properties
AllowedPattern
A regular expression used to validate the parameter value.
public virtual string AllowedPattern { get; set; }
Property Value
System.String
AttrType
Returns the type of the parameter.
public virtual string AttrType { get; }
Property Value
System.String
Remarks
Valid values are String
or StringList
.
CloudformationAttribute: Type
AttrValue
Returns the value of the parameter.
public virtual string AttrValue { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Value
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
DataType
The data type of the parameter, such as text
or aws:ec2:image
.
public virtual string DataType { get; set; }
Property Value
System.String
Description
Information about the parameter.
public virtual string Description { get; set; }
Property Value
System.String
Name
The name of the parameter.
public virtual string Name { get; set; }
Property Value
System.String
Policies
Information about the policies assigned to a parameter.
public virtual string Policies { get; set; }
Property Value
System.String
Tags
Tag Manager which manages the tags for this resource.
public virtual TagManager Tags { get; }
Property Value
TagsRaw
Optional metadata that you assign to a resource in the form of an arbitrary set of tags (key-value pairs).
public virtual IDictionary<string, string> TagsRaw { get; set; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.String>
Tier
The parameter tier.
public virtual string Tier { get; set; }
Property Value
System.String
Type
The type of parameter.
public virtual string Type { get; set; }
Property Value
System.String
Value
The parameter value.
public virtual string Value { get; set; }
Property Value
System.String
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>