interface CfnParameterProps
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.SSM.CfnParameterProps |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsssm#CfnParameterProps |
![]() | software.amazon.awscdk.services.ssm.CfnParameterProps |
![]() | aws_cdk.aws_ssm.CfnParameterProps |
![]() | aws-cdk-lib » aws_ssm » CfnParameterProps |
Properties for defining a CfnParameter
.
See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-parameter.html
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_ssm as ssm } from 'aws-cdk-lib';
const cfnParameterProps: ssm.CfnParameterProps = {
type: 'type',
value: 'value',
// the properties below are optional
allowedPattern: 'allowedPattern',
dataType: 'dataType',
description: 'description',
name: 'name',
policies: 'policies',
tags: {
tagsKey: 'tags',
},
tier: 'tier',
};
Properties
Name | Type | Description |
---|---|---|
type | string | The type of parameter. |
value | string | The parameter value. |
allowed | string | A regular expression used to validate the parameter value. |
data | string | The data type of the parameter, such as text or aws:ec2:image . |
description? | string | Information about the parameter. |
name? | string | The name of the parameter. |
policies? | string | Information about the policies assigned to a parameter. |
tags? | { [string]: string } | Optional metadata that you assign to a resource in the form of an arbitrary set of tags (key-value pairs). |
tier? | string | The parameter tier. |
type
Type:
string
The type of parameter.
Parameters of type
SecureString
are not supported by AWS CloudFormation .
value
Type:
string
The parameter value.
If type is
StringList
, the system returns a comma-separated string with no spaces between commas in theValue
field.
allowedPattern?
Type:
string
(optional)
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+$
dataType?
Type:
string
(optional)
The data type of the parameter, such as text
or aws:ec2:image
.
The default is text
.
description?
Type:
string
(optional)
Information about the parameter.
name?
Type:
string
(optional)
The name of the parameter.
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?
Type:
string
(optional)
Information about the policies assigned to a parameter.
Assigning parameter policies in the AWS Systems Manager User Guide .
tags?
Type:
{ [string]: string }
(optional)
Optional metadata that you assign to a resource in the form of an arbitrary set of tags (key-value pairs).
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?
Type:
string
(optional)
The parameter tier.