Package software.amazon.awscdk.services.ssm

Interface IParameter

All Superinterfaces:

software.constructs.IConstruct, software.constructs.IDependable, IEnvironmentAware, IParameterRef, IResource, software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

IParameter.Jsii$Default, IStringListParameter, IStringListParameter.Jsii$Default, IStringParameter, IStringParameter.Jsii$Default

All Known Implementing Classes:

IParameter.Jsii$Proxy, IStringListParameter.Jsii$Proxy, IStringParameter.Jsii$Proxy, StringListParameter, StringParameter

@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)",
           date="2025-12-05T22:26:46.110Z")
@Stability(Stable)
public interface IParameter
extends software.amazon.jsii.JsiiSerializable, IResource, IParameterRef

An SSM Parameter reference.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	IParameter.Jsii$Default	Internal default implementation for IParameter.
static final class	IParameter.Jsii$Proxy	A proxy class which represents a concrete javascript instance of this type.

Method Summary

Modifier and Type	Method	Description
ResourceEnvironment	getEnv()	The environment this resource belongs to.
software.constructs.Node	getNode()	The tree node.
String	getParameterArn()	The ARN of the SSM Parameter resource.
String	getParameterName()	The name of the SSM Parameter resource.
String	getParameterType()	The type of the SSM Parameter resource.
Grant	grantRead(IGrantable grantee)	Grants read (DescribeParameter, GetParameters, GetParameter, GetParameterHistory) permissions on the SSM Parameter.
Grant	grantWrite(IGrantable grantee)	Grants write (PutParameter) permissions on the SSM Parameter.

Methods inherited from interface software.amazon.awscdk.interfaces.ssm.IParameterRef

getParameterRef

Methods inherited from interface software.amazon.awscdk.IResource

applyRemovalPolicy, getStack

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getParameterArn

@Stability(Stable)
@NotNull
String getParameterArn()

The ARN of the SSM Parameter resource.

getParameterName

@Stability(Stable)
@NotNull
String getParameterName()

The name of the SSM Parameter resource.

getParameterType

@Stability(Stable)
@NotNull
String getParameterType()

The type of the SSM Parameter resource.

grantRead

@Stability(Stable)
@NotNull
Grant grantRead(@NotNull
 IGrantable grantee)

Grants read (DescribeParameter, GetParameters, GetParameter, GetParameterHistory) permissions on the SSM Parameter.

Parameters:

grantee - the role to be granted read-only access to the parameter. This parameter is required.

grantWrite

@Stability(Stable)
@NotNull
Grant grantWrite(@NotNull
 IGrantable grantee)

Grants write (PutParameter) permissions on the SSM Parameter.

Parameters:

grantee - the role to be granted write access to the parameter. This parameter is required.

getNode

@Stability(Stable)
@NotNull
software.constructs.Node getNode()

The tree node.

Specified by:

getNode in interface software.constructs.IConstruct

getEnv

@Stability(Stable)
@NotNull
ResourceEnvironment getEnv()

The environment this resource belongs to.

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

Specified by:

getEnv in interface IEnvironmentAware