IParameter

class aws_cdk.aws_ssm.IParameter(*args, **kwargs)

Bases: aws_cdk.core.IResource, typing_extensions.Protocol

An SSM Parameter reference.

__init__(*args, **kwargs)

Methods

grant_read(grantee)

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

Parameters

grantee (IGrantable) – the role to be granted read-only access to the parameter.

Return type

Grant

grant_write(grantee)

Grants write (PutParameter) permissions on the SSM Parameter.

Parameters

grantee (IGrantable) – the role to be granted write access to the parameter.

Return type

Grant

Attributes

node

The construct tree node for this construct.

Return type

ConstructNode

parameter_arn

The ARN of the SSM Parameter resource.

attribute: :attribute:: true

Return type

str

parameter_name

The name of the SSM Parameter resource.

attribute: :attribute:: true

Return type

str

parameter_type

The type of the SSM Parameter resource.

attribute: :attribute:: true

Return type

str

stack

The stack in which this resource is defined.

Return type

Stack