Package software.amazon.awscdk.services.ssm

Interface CfnParameterProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnParameterProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.113.0 (build fc68b25)",
           date="2025-09-02T11:25:40.936Z")
@Stability(Stable)
public interface CfnParameterProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnParameter.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.ssm.*;
 CfnParameterProps cfnParameterProps = CfnParameterProps.builder()
         .type("type")
         .value("value")
         // the properties below are optional
         .allowedPattern("allowedPattern")
         .dataType("dataType")
         .description("description")
         .name("name")
         .policies("policies")
         .tags(Map.of(
                 "tagsKey", "tags"))
         .tier("tier")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-parameter.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnParameterProps.Builder	A builder for CfnParameterProps
static final class	CfnParameterProps.Jsii$Proxy	An implementation for CfnParameterProps

Method Summary

Modifier and Type	Method	Description
static CfnParameterProps.Builder	builder()
default String	getAllowedPattern()	A regular expression used to validate the parameter value.
default String	getDataType()	The data type of the parameter, such as text or aws:ec2:image .
default String	getDescription()	Information about the parameter.
default String	getName()	The name of the parameter.
default String	getPolicies()	Information about the policies assigned to a parameter.
default Map<String,String>	getTags()	Optional metadata that you assign to a resource in the form of an arbitrary set of tags (key-value pairs).
default String	getTier()	The parameter tier.
String	getType()	The type of parameter.
String	getValue()	The parameter value.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getType

@Stability(Stable)
@NotNull
String getType()

The type of parameter.

Parameters of type SecureString are not supported by AWS CloudFormation .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-parameter.html#cfn-ssm-parameter-type

getValue

@Stability(Stable)
@NotNull
String getValue()

The parameter value.

If type is StringList , the system returns a comma-separated string with no spaces between commas in the Value field.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-parameter.html#cfn-ssm-parameter-value

getAllowedPattern

@Stability(Stable)
@Nullable
default String getAllowedPattern()

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+$

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-parameter.html#cfn-ssm-parameter-allowedpattern

getDataType

@Stability(Stable)
@Nullable
default String getDataType()

The data type of the parameter, such as text or aws:ec2:image .

The default is text .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-parameter.html#cfn-ssm-parameter-datatype

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

Information about the parameter.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-parameter.html#cfn-ssm-parameter-description

getName

@Stability(Stable)
@Nullable
default String getName()

The name of the parameter.

The reported maximum length of 2048 characters for a parameter name includes 1037 characters that are reserved for internal use by Systems Manager . The maximum length for a parameter name that you specify is 1011 characters.

This count of 1011 characters includes the characters in the ARN that precede the name you specify. This ARN length will vary depending on your partition and Region. For example, the following 45 characters count toward the 1011 character maximum for a parameter created in the US East (Ohio) Region: arn:aws:ssm:us-east-2:111122223333:parameter/ .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-parameter.html#cfn-ssm-parameter-name

getPolicies

@Stability(Stable)
@Nullable
default String getPolicies()

Information about the policies assigned to a parameter.

Assigning parameter policies in the AWS Systems Manager User Guide .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-parameter.html#cfn-ssm-parameter-policies

getTags

@Stability(Stable)
@Nullable
default Map<String,String> getTags()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-parameter.html#cfn-ssm-parameter-tags

getTier

@Stability(Stable)
@Nullable
default String getTier()

The parameter tier.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-parameter.html#cfn-ssm-parameter-tier

builder

@Stability(Stable)
static CfnParameterProps.Builder builder()

Returns:

a CfnParameterProps.Builder of CfnParameterProps