aws-cdk-lib.aws_ssm.IParameter

interface IParameter

LanguageType name
.NETAmazon.CDK.AWS.SSM.IParameter
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsssm#IParameter
Javasoftware.amazon.awscdk.services.ssm.IParameter
Pythonaws_cdk.aws_ssm.IParameter
TypeScript (source)aws-cdk-lib » aws_ssm » IParameter

Implemented by StringListParameter, StringParameter

An SSM Parameter reference.

Properties

NameTypeDescription
envResourceEnvironmentThe environment this resource belongs to.
nodeNodeThe tree node.
parameterArnstringThe ARN of the SSM Parameter resource.
parameterNamestringThe name of the SSM Parameter resource.
parameterTypestringThe type of the SSM Parameter resource.
stackStackThe stack in which this resource is defined.

env

Type: ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.


node

Type: Node

The tree node.


parameterArn

Type: string

The ARN of the SSM Parameter resource.


parameterName

Type: string

The name of the SSM Parameter resource.


parameterType

Type: string

The type of the SSM Parameter resource.


stack

Type: Stack

The stack in which this resource is defined.

Methods

NameDescription
applyRemovalPolicy(policy)Apply the given removal policy to this resource.
grantRead(grantee)Grants read (DescribeParameter, GetParameter, GetParameterHistory) permissions on the SSM Parameter.
grantWrite(grantee)Grants write (PutParameter) permissions on the SSM Parameter.

applyRemovalPolicy(policy)

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

  • policy RemovalPolicy

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).


grantRead(grantee)

public grantRead(grantee: IGrantable): Grant

Parameters

  • grantee IGrantable — the role to be granted read-only access to the parameter.

Returns

  • Grant

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


grantWrite(grantee)

public grantWrite(grantee: IGrantable): Grant

Parameters

  • grantee IGrantable — the role to be granted write access to the parameter.

Returns

  • Grant

Grants write (PutParameter) permissions on the SSM Parameter.