ParameterState class
Input properties used for looking up and filtering Parameter resources.
Constructors
-
ParameterState({Input<
String?> ? allowedPattern, Input<String?> ? arn, Input<String?> ? dataType, Input<String?> ? description, Input<bool?> ? hasValueWo, Input<String?> ? insecureValue, Input<String?> ? keyId, Input<String?> ? name, Input<bool?> ? overwrite, Input<String?> ? region, Input<Map< ? tags, Input<String, String> ?>Map< ? tagsAll, Input<String, String> ?>String?> ? tier, Input? type, Input<String?> ? value, Input<String?> ? valueWo, Input<int?> ? valueWoVersion, Input<int?> ? version}) -
Creates a new ParameterState.
allowedPatternRegular expression used to validate the parameter value.arnARN of the parameter.dataTypeData type of the parameter. Valid values:text,aws:ssm:integrationandaws:ec2:imagefor AMI format, see the Native parameter support for AMI IDs.descriptionDescription of the parameter.hasValueWoIndicates whether the resource has avalueWoset.insecureValueValue of the parameter. Use caution: This value is never marked as sensitive in the pulumi preview output. This argument is not valid with atypeofSecureString.keyIdKMS key ID or ARN for encrypting a SecureString.nameName of the parameter. If the name contains a path (e.g., any forward slashes (/)), it must be fully qualified with a leading forward slash (/). For additional requirements and constraints, see the AWS SSM User Guide.overwriteOverwrite an existing parameter. If not specified, defaults tofalseduring create operations to avoid overwriting existing resources and thentruefor all subsequent operations once the resource is managed by IAC. Lifecycle rules should be used to manage non-standard update behavior.regionRegion where this resource will be managed. Defaults to the Region set in the provider configuration.tagsMap of tags to assign to the object. If configured with a providerdefaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.tagsAllMap of tags assigned to the resource, including those inherited from the providerdefaultTagsconfiguration block.tierParameter tier to assign to the parameter. If not specified, will use the default parameter tier for the region. Valid tiers areStandard,Advanced, andIntelligent-Tiering. Downgrading anAdvancedtier parameter toStandardwill recreate the resource. For more information on parameter tiers, see the AWS SSM Parameter tier comparison and guide.typeType of the parameter. Valid types areString,StringListandSecureString.valueValue of the parameter. This value is always marked as sensitive in the pulumi preview output, regardless oftype [valueWo] **NOTE:** This field is write-only and its value will not be updated in state as part of read operations. [valueWoVersion] Used together withvalueWoto trigger an update. Increment this value when an update to thevalueWo` is required.versionVersion of the parameter.const -
ParameterState.fromMap(Map<
String, dynamic> map) -
factory
Properties
-
allowedPattern
→ Input<
String?> ? -
Regular expression used to validate the parameter value.
final
-
arn
→ Input<
String?> ? -
ARN of the parameter.
final
-
dataType
→ Input<
String?> ? -
Data type of the parameter. Valid values:
text,aws:ssm:integrationandaws:ec2:imagefor AMI format, see the Native parameter support for AMI IDs.final -
description
→ Input<
String?> ? -
Description of the parameter.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
-
hasValueWo
→ Input<
bool?> ? -
Indicates whether the resource has a
valueWoset.final -
insecureValue
→ Input<
String?> ? -
Value of the parameter. Use caution: This value is never marked as sensitive in the pulumi preview output. This argument is not valid with a
typeofSecureString.final -
keyId
→ Input<
String?> ? -
KMS key ID or ARN for encrypting a SecureString.
final
-
name
→ Input<
String?> ? -
Name of the parameter. If the name contains a path (e.g., any forward slashes (
/)), it must be fully qualified with a leading forward slash (/). For additional requirements and constraints, see the AWS SSM User Guide.final -
overwrite
→ Input<
bool?> ? -
Overwrite an existing parameter. If not specified, defaults to
falseduring create operations to avoid overwriting existing resources and thentruefor all subsequent operations once the resource is managed by IAC. Lifecycle rules should be used to manage non-standard update behavior.final -
region
→ Input<
String?> ? -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
Map of tags to assign to the object. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.final -
Map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration block.final -
tier
→ Input<
String?> ? -
Parameter tier to assign to the parameter. If not specified, will use the default parameter tier for the region. Valid tiers are
Standard,Advanced, andIntelligent-Tiering. Downgrading anAdvancedtier parameter toStandardwill recreate the resource. For more information on parameter tiers, see the AWS SSM Parameter tier comparison and guide.final - type → Input?
-
Type of the parameter. Valid types are
String,StringListandSecureString.final -
value
→ Input<
String?> ? -
Value of the parameter. This value is always marked as sensitive in the pulumi preview output, regardless of `type
final
-
valueWo
→ Input<
String?> ? -
NOTE: This field is write-only and its value will not be updated in state as part of read operations.
Value of the parameter. This value is always marked as sensitive in the pulumi preview output, regardless of
type. Additionally,write-onlyvalues are never stored to state.valueWoVersioncan be used to trigger an update and is required with this argument.final -
valueWoVersion
→ Input<
int?> ? -
Used together with
valueWoto trigger an update. Increment this value when an update to thevalueWois required.final -
version
→ Input<
int?> ? -
Version of the parameter.
final
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toMap(
) → Map< String, dynamic> -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited