Package software.amazon.awscdk.services.ssm

Interface IParameter

All Superinterfaces:

software.constructs.IConstruct, software.constructs.IDependable, 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.103.1 (build bef2dea)",
           date="2024-10-05T03:43:51.793Z")
@Stability(Stable)
public interface IParameter
extends software.amazon.jsii.JsiiSerializable, IResource

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
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.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.IResource

applyRemovalPolicy, getEnv, 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.