Package software.amazon.awscdk.services.ssm

Interface IParameter.Jsii$Default

All Superinterfaces:

software.constructs.IConstruct, software.constructs.IConstruct.Jsii$Default, software.constructs.IDependable, software.constructs.IDependable.Jsii$Default, IEnvironmentAware, IEnvironmentAware.Jsii$Default, IParameter, IParameterRef, IParameterRef.Jsii$Default, IResource, IResource.Jsii$Default, software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

IStringListParameter.Jsii$Default, IStringParameter.Jsii$Default

All Known Implementing Classes:

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

Enclosing interface:

IParameter

@Internal
public static interface IParameter.Jsii$Default
extends IParameter, IResource.Jsii$Default, IParameterRef.Jsii$Default

Internal default implementation for IParameter.

Nested Class Summary

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

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

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

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

Nested classes/interfaces inherited from interface software.amazon.awscdk.interfaces.IEnvironmentAware

IEnvironmentAware.Jsii$Default, IEnvironmentAware.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.ssm.IParameter

IParameter.Jsii$Default, IParameter.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.interfaces.ssm.IParameterRef

IParameterRef.Jsii$Default, IParameterRef.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.IResource

IResource.Jsii$Default, IResource.Jsii$Proxy

Method Summary

Modifier and Type	Method	Description
default String	getParameterArn()	The ARN of the SSM Parameter resource.
default String	getParameterName()	The name of the SSM Parameter resource.
default String	getParameterType()	The type of the SSM Parameter resource.
default Grant	grantRead(IGrantable grantee)	Grants read (DescribeParameter, GetParameters, GetParameter, GetParameterHistory) permissions on the SSM Parameter.
default Grant	grantWrite(IGrantable grantee)	Grants write (PutParameter) permissions on the SSM Parameter.

Methods inherited from interface software.constructs.IConstruct.Jsii$Default

getNode

Methods inherited from interface software.amazon.awscdk.interfaces.IEnvironmentAware.Jsii$Default

getEnv

Methods inherited from interface software.amazon.awscdk.interfaces.ssm.IParameterRef.Jsii$Default

getParameterRef

Methods inherited from interface software.amazon.awscdk.IResource.Jsii$Default

applyRemovalPolicy, getStack

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getParameterArn

@Stability(Stable)
@NotNull
default String getParameterArn()

The ARN of the SSM Parameter resource.

Specified by:

getParameterArn in interface IParameter

getParameterName

@Stability(Stable)
@NotNull
default String getParameterName()

The name of the SSM Parameter resource.

Specified by:

getParameterName in interface IParameter

getParameterType

@Stability(Stable)
@NotNull
default String getParameterType()

The type of the SSM Parameter resource.

Specified by:

getParameterType in interface IParameter

grantRead

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

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

Specified by:

grantRead in interface IParameter

Parameters:

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

grantWrite

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

Grants write (PutParameter) permissions on the SSM Parameter.

Specified by:

grantWrite in interface IParameter

Parameters:

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