AWS CDK Reference

Appearance

v2.274.0

IStringParameter Interface ​

A String SSM Parameter.

Source
aws-ssm/lib/parameter.ts

Properties ​

envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironmentrequired#
The environment this resource belongs to.
notes

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

nodeNodenodeNodenodeNodeNodeNodeNodeNoderequired#
The tree node.
parameterArnstringparameter_arnstrparameterArnStringParameterArnstringParameterArn*stringrequired#
The ARN of the SSM Parameter resource.
parameterNamestringparameter_namestrparameterNameStringParameterNamestringParameterName*stringrequired#
The name of the SSM Parameter resource.
parameterRefParameterReferenceparameter_refParameterReferenceparameterRefParameterReferenceParameterRefParameterReferenceParameterRefParameterReferencerequired#
A reference to a Parameter resource.
parameterTypestringparameter_typestrparameterTypeStringParameterTypestringParameterType*stringrequired#
The type of the SSM Parameter resource.
stackStackstackStackstackStackStackStackStackStackrequired#
The stack in which this resource is defined.
stringValuestringstring_valuestrstringValueStringStringValuestringStringValue*stringrequired#
The parameter value.

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

Methods ​

applyRemovalPolicy(policy: RemovalPolicy): voiddef apply_removal_policy(self, policy: RemovalPolicy) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy)public void ApplyRemovalPolicy(RemovalPolicy policy)func ApplyRemovalPolicy(Policy RemovalPolicy)#
Apply the given removal policy to this resource.
notes

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: IGrantable): Grantdef grant_read(self, grantee: IGrantable) -> Grantpublic Grant grantRead(IGrantable grantee)public Grant GrantRead(IGrantable grantee)func GrantRead(Grantee IGrantable) Grant#
Grants read (DescribeParameter, GetParameters, GetParameter, GetParameterHistory) permissions on the SSM Parameter.
1 parameter

Parameters

  • granteegranteegranteegranteeGrantee — the role to be granted read-only access to the parameter.
grantWrite(grantee: IGrantable): Grantdef grant_write(self, grantee: IGrantable) -> Grantpublic Grant grantWrite(IGrantable grantee)public Grant GrantWrite(IGrantable grantee)func GrantWrite(Grantee IGrantable) Grant#
Grants write (PutParameter) permissions on the SSM Parameter.
1 parameter

Parameters

  • granteegranteegranteegranteeGrantee — the role to be granted write access to the parameter.
with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#
Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited.

1 parameter · returns

Parameters

  • mixinsmixinsmixinsmixinsMixins — The mixins to apply.

Returns: This construct for chaining