Optional ReadonlyencryptionThe encryption key that is used to encrypt this parameter.
ReadonlyenvThe 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.
ReadonlynodeThe tree node.
ReadonlyparameterReadonlyparameterReadonlyparameterProtected ReadonlyphysicalReturns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.
This value will resolve to one of the following:
"my-awesome-bucket")undefined, when a name should be generated by CloudFormationReadonlystackThe stack in which this resource is defined.
ReadonlystringThe parameter value. Value must not nest another parameter. Do not use {{}} in the value.
Static ReadonlyPROPERTY_Uniquely identifies this class.
InternalCalled when this resource is referenced across environments (account/region) to order to request that a physical name will be generated for this resource during synthesis, so the resource can be referenced through its absolute name/arn.
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).
ProtectedgenerateProtectedgetReturns an environment-sensitive token that should be used for the
resource's "ARN" attribute (e.g. bucket.bucketArn).
Normally, this token will resolve to arnAttr, but if the resource is
referenced across environments, arnComponents will be used to synthesize
a concrete ARN with the resource's physical name. Make sure to reference
this.physicalName in arnComponents.
The CFN attribute which resolves to the ARN of the resource.
Commonly it will be called "Arn" (e.g. resource.attrArn), but sometimes
it's the CFN resource's ref.
The format of the ARN of this resource. You must
reference this.physicalName somewhere within the ARN in order for
cross-environment references to work.
ProtectedgetReturns an environment-sensitive token that should be used for the
resource's "name" attribute (e.g. bucket.bucketName).
Normally, this token will resolve to nameAttr, but if the resource is
referenced across environments, it will be resolved to this.physicalName,
which will be a concrete name.
The CFN attribute which resolves to the resource's name.
Commonly this is the resource's ref.
Grants read (DescribeParameter, GetParameters, GetParameter, GetParameterHistory) permissions on the SSM Parameter.
the role to be granted read-only access to the parameter.
Grants write (PutParameter) permissions on the SSM Parameter.
the role to be granted write access to the parameter.
Returns a string representation of this construct.
StaticfromStaticfromStaticfromStaticfromStaticisChecks if x is a construct.
Use this method instead of instanceof to properly detect Construct
instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the constructs library on
disk are seen as independent, completely different libraries. As a
consequence, the class Construct in each copy of the constructs library
is seen as a different class, and an instance of one class will not test as
instanceof the other class. npm install will not create installations
like this, but users may manually symlink construct libraries together or
use a monorepo tool: in those cases, multiple copies of the constructs
library can be accidentally installed, and instanceof will behave
unpredictably. It is safest to avoid using instanceof, and using
this type-testing method instead.
Any object
true if x is an object created from a class which extends Construct.
StaticisReturns true if the construct was created by CDK, and false otherwise
StaticisCheck whether the given construct is a Resource
StaticvalueReturns a token that will resolve (during deployment)
Some scope within a stack
The name of the SSM parameter
The parameter version (required for secure strings)
StaticvalueReturns a token that will resolve (during deployment) to the string value of an SSM string parameter.
Some scope within a stack
The name of the SSM parameter.
Optionalversion: numberThe parameter version (recommended in order to ensure that the value won't change during deployment)
StaticvalueReturns a token that will resolve (during deployment) to the string value of an SSM string parameter.
Some scope within a stack
The name of the SSM parameter.
Optionaltype: ParameterTypeThe type of the SSM parameter.
Optionalversion: numberThe parameter version (recommended in order to ensure that the value won't change during deployment)
StaticvalueReturns a token that will resolve (during deployment) to the string value of an SSM string parameter.
Some scope within a stack
The name of the SSM parameter.
Optionaltype: ParameterValueTypeThe type of the SSM parameter.
Optionalversion: numberThe parameter version (recommended in order to ensure that the value won't change during deployment)
StaticvalueReads the value of an SSM parameter during synthesis through an environmental context provider.
Requires that the stack this scope is defined in will have explicit account/region information. Otherwise, it will fail during synthesis.
If defaultValue is provided, it will be used as the dummyValue and the ContextProvider will be told NOT to raise an error on synthesis if the SSM Parameter is not found in the account at synth time.
OptionaldefaultValue: stringOptionaloptions: StringParameterLookupOptions
A StringParameter which automatically handles tokens in the path