IStringParameter

class aws_cdk.aws_ssm.IStringParameter(*args, **kwds)

Bases: aws_cdk.aws_ssm.IParameter, typing_extensions.Protocol

A String SSM Parameter.

Methods

apply_removal_policy(policy)

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).

Parameters

policy (RemovalPolicy) –

Return type

None

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

env

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.

Return type

ResourceEnvironment

node

The construct tree node for this construct.

Return type

ConstructNode

parameter_arn

The ARN of the SSM Parameter resource.

Attribute

true

Return type

str

parameter_name

The name of the SSM Parameter resource.

Attribute

true

Return type

str

parameter_type

The type of the SSM Parameter resource.

Attribute

true

Return type

str

stack

The stack in which this resource is defined.

Return type

Stack

string_value

The parameter value.

Value must not nest another parameter. Do not use {{}} in the value.

Attribute

Value

Return type

str