Package software.amazon.awscdk.cfnpropertymixins.services.ssm

Class CfnParameterPropsMixin

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.Mixin

software.amazon.awscdk.cfnpropertymixins.services.ssm.CfnParameterPropsMixin

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable, software.constructs.IMixin

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:20:05.702Z")
@Stability(Stable)
public class CfnParameterPropsMixin
extends Mixin
implements software.constructs.IMixin

The AWS::SSM::Parameter resource creates an SSM parameter in AWS Systems Manager Parameter Store.

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 .

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.ssm.*;
 import software.amazon.awscdk.*;
 IMergeStrategy mergeStrategy;
 CfnParameterPropsMixin cfnParameterPropsMixin = CfnParameterPropsMixin.Builder.create(CfnParameterMixinProps.builder()
         .allowedPattern("allowedPattern")
         .dataType("dataType")
         .description("description")
         .name("name")
         .policies("policies")
         .tags(Map.of(
                 "tagsKey", "tags"))
         .tier("tier")
         .type("type")
         .value("value")
         .build())
 .strategy(mergeStrategy)
 .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnParameterPropsMixin.Builder	A fluent builder for CfnParameterPropsMixin.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IMixin

software.constructs.IMixin.Jsii$Default, software.constructs.IMixin.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
protected static final List<String>	CFN_PROPERTY_KEYS

Constructor Summary

Constructors

Modifier	Constructor	Description
	CfnParameterPropsMixin(CfnParameterMixinProps props)	Create a mixin to apply properties to AWS::SSM::Parameter.
	CfnParameterPropsMixin(CfnParameterMixinProps props, CfnPropertyMixinOptions options)	Create a mixin to apply properties to AWS::SSM::Parameter.
protected	CfnParameterPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnParameterPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
void	applyTo(software.constructs.IConstruct construct)	Apply the mixin properties to the construct.
protected CfnParameterMixinProps	getProps()
protected IMergeStrategy	getStrategy()
Boolean	supports(software.constructs.IConstruct construct)	Check if this mixin supports the given construct.

Methods inherited from class software.amazon.awscdk.Mixin

isMixin

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_PROPERTY_KEYS

@Stability(Stable)
protected static final List<String> CFN_PROPERTY_KEYS

Constructor Details

CfnParameterPropsMixin

protected CfnParameterPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

CfnParameterPropsMixin

protected CfnParameterPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnParameterPropsMixin

@Stability(Stable)
public CfnParameterPropsMixin(@NotNull
 CfnParameterMixinProps props,
 @Nullable
 CfnPropertyMixinOptions options)

Create a mixin to apply properties to AWS::SSM::Parameter.

Parameters:

props - L1 properties to apply. This parameter is required.

options - Mixin options.

CfnParameterPropsMixin

@Stability(Stable)
public CfnParameterPropsMixin(@NotNull
 CfnParameterMixinProps props)

Create a mixin to apply properties to AWS::SSM::Parameter.

Parameters:

props - L1 properties to apply. This parameter is required.

Method Details

applyTo

@Stability(Stable)
public void applyTo(@NotNull
 software.constructs.IConstruct construct)

Apply the mixin properties to the construct.

Specified by:

applyTo in interface software.constructs.IMixin

Specified by:

applyTo in class Mixin

Parameters:

construct - This parameter is required.

supports

@Stability(Stable)
@NotNull
public Boolean supports(@NotNull
 software.constructs.IConstruct construct)

Check if this mixin supports the given construct.

Specified by:

supports in interface software.constructs.IMixin

Overrides:

supports in class Mixin

Parameters:

construct - This parameter is required.

getProps

@Stability(Stable)
@NotNull
protected CfnParameterMixinProps getProps()

getStrategy

@Stability(Stable)
@NotNull
protected IMergeStrategy getStrategy()