AWS Classic v5.41.0, May 15 23
AWS Classic v5.41.0, May 15 23
aws.ssm.Parameter
Explore with Pulumi AI
Provides an SSM Parameter resource.
Note:
overwrite
also makes it possible to overwrite an existing SSM Parameter that’s not created by the provider before.
Example Usage
Basic example
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var foo = new Aws.Ssm.Parameter("foo", new()
{
Type = "String",
Value = "bar",
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/ssm"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := ssm.NewParameter(ctx, "foo", &ssm.ParameterArgs{
Type: pulumi.String("String"),
Value: pulumi.String("bar"),
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ssm.Parameter;
import com.pulumi.aws.ssm.ParameterArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var foo = new Parameter("foo", ParameterArgs.builder()
.type("String")
.value("bar")
.build());
}
}
import pulumi
import pulumi_aws as aws
foo = aws.ssm.Parameter("foo",
type="String",
value="bar")
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const foo = new aws.ssm.Parameter("foo", {
type: "String",
value: "bar",
});
resources:
foo:
type: aws:ssm:Parameter
properties:
type: String
value: bar
Encrypted string using default SSM KMS key
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var @default = new Aws.Rds.Instance("default", new()
{
AllocatedStorage = 10,
StorageType = "gp2",
Engine = "mysql",
EngineVersion = "5.7.16",
InstanceClass = "db.t2.micro",
Name = "mydb",
Username = "foo",
Password = @var.Database_master_password,
DbSubnetGroupName = "my_database_subnet_group",
ParameterGroupName = "default.mysql5.7",
});
var secret = new Aws.Ssm.Parameter("secret", new()
{
Description = "The parameter description",
Type = "SecureString",
Value = @var.Database_master_password,
Tags =
{
{ "environment", "production" },
},
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/rds"
"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/ssm"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := rds.NewInstance(ctx, "default", &rds.InstanceArgs{
AllocatedStorage: pulumi.Int(10),
StorageType: pulumi.String("gp2"),
Engine: pulumi.String("mysql"),
EngineVersion: pulumi.String("5.7.16"),
InstanceClass: pulumi.String("db.t2.micro"),
Name: pulumi.String("mydb"),
Username: pulumi.String("foo"),
Password: pulumi.Any(_var.Database_master_password),
DbSubnetGroupName: pulumi.String("my_database_subnet_group"),
ParameterGroupName: pulumi.String("default.mysql5.7"),
})
if err != nil {
return err
}
_, err = ssm.NewParameter(ctx, "secret", &ssm.ParameterArgs{
Description: pulumi.String("The parameter description"),
Type: pulumi.String("SecureString"),
Value: pulumi.Any(_var.Database_master_password),
Tags: pulumi.StringMap{
"environment": pulumi.String("production"),
},
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.rds.Instance;
import com.pulumi.aws.rds.InstanceArgs;
import com.pulumi.aws.ssm.Parameter;
import com.pulumi.aws.ssm.ParameterArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var default_ = new Instance("default", InstanceArgs.builder()
.allocatedStorage(10)
.storageType("gp2")
.engine("mysql")
.engineVersion("5.7.16")
.instanceClass("db.t2.micro")
.name("mydb")
.username("foo")
.password(var_.database_master_password())
.dbSubnetGroupName("my_database_subnet_group")
.parameterGroupName("default.mysql5.7")
.build());
var secret = new Parameter("secret", ParameterArgs.builder()
.description("The parameter description")
.type("SecureString")
.value(var_.database_master_password())
.tags(Map.of("environment", "production"))
.build());
}
}
import pulumi
import pulumi_aws as aws
default = aws.rds.Instance("default",
allocated_storage=10,
storage_type="gp2",
engine="mysql",
engine_version="5.7.16",
instance_class="db.t2.micro",
name="mydb",
username="foo",
password=var["database_master_password"],
db_subnet_group_name="my_database_subnet_group",
parameter_group_name="default.mysql5.7")
secret = aws.ssm.Parameter("secret",
description="The parameter description",
type="SecureString",
value=var["database_master_password"],
tags={
"environment": "production",
})
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const _default = new aws.rds.Instance("default", {
allocatedStorage: 10,
storageType: "gp2",
engine: "mysql",
engineVersion: "5.7.16",
instanceClass: "db.t2.micro",
name: "mydb",
username: "foo",
password: _var.database_master_password,
dbSubnetGroupName: "my_database_subnet_group",
parameterGroupName: "default.mysql5.7",
});
const secret = new aws.ssm.Parameter("secret", {
description: "The parameter description",
type: "SecureString",
value: _var.database_master_password,
tags: {
environment: "production",
},
});
resources:
default:
type: aws:rds:Instance
properties:
allocatedStorage: 10
storageType: gp2
engine: mysql
engineVersion: 5.7.16
instanceClass: db.t2.micro
name: mydb
username: foo
password: ${var.database_master_password}
dbSubnetGroupName: my_database_subnet_group
parameterGroupName: default.mysql5.7
secret:
type: aws:ssm:Parameter
properties:
description: The parameter description
type: SecureString
value: ${var.database_master_password}
tags:
environment: production
Create Parameter Resource
new Parameter(name: string, args: ParameterArgs, opts?: CustomResourceOptions);
@overload
def Parameter(resource_name: str,
opts: Optional[ResourceOptions] = None,
allowed_pattern: Optional[str] = None,
arn: Optional[str] = None,
data_type: Optional[str] = None,
description: Optional[str] = None,
insecure_value: Optional[str] = None,
key_id: Optional[str] = None,
name: Optional[str] = None,
overwrite: Optional[bool] = None,
tags: Optional[Mapping[str, str]] = None,
tier: Optional[str] = None,
type: Optional[Union[str, ParameterType]] = None,
value: Optional[str] = None)
@overload
def Parameter(resource_name: str,
args: ParameterArgs,
opts: Optional[ResourceOptions] = None)
func NewParameter(ctx *Context, name string, args ParameterArgs, opts ...ResourceOption) (*Parameter, error)
public Parameter(string name, ParameterArgs args, CustomResourceOptions? opts = null)
public Parameter(String name, ParameterArgs args)
public Parameter(String name, ParameterArgs args, CustomResourceOptions options)
type: aws:ssm:Parameter
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ParameterArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args ParameterArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args ParameterArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ParameterArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ParameterArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Parameter Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The Parameter resource accepts the following input properties:
- Type
string | Pulumi.
Aws. Ssm. Parameter Type Type of the parameter. Valid types are
String
,StringList
andSecureString
.- Allowed
Pattern string Regular expression used to validate the parameter value.
- Arn string
ARN of the parameter.
- Data
Type string Data type of the parameter. Valid values:
text
,aws:ssm:integration
andaws:ec2:image
for AMI format, see the Native parameter support for Amazon Machine Image IDs.- Description string
Description of the parameter.
- Insecure
Value string Value of the parameter. Use caution: This value is never marked as sensitive in the preview. This argument is not valid with a
type
ofSecureString
.- Key
Id string KMS key ID or ARN for encrypting a SecureString.
- Name 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.- Overwrite bool
Overwrite an existing parameter. If not specified, will default to
false
if the resource has not been created by this provider to avoid overwrite of existing resource and will default totrue
otherwise.- Dictionary<string, string>
Map of tags to assign to the object. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.- Tier 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 anAdvanced
tier parameter toStandard
will recreate the resource. For more information on parameter tiers, see the AWS SSM Parameter tier comparison and guide.- Value string
Value of the parameter. This value is always marked as sensitive in the plan output, regardless of
type
.
- Type
string | Parameter
Type Type of the parameter. Valid types are
String
,StringList
andSecureString
.- Allowed
Pattern string Regular expression used to validate the parameter value.
- Arn string
ARN of the parameter.
- Data
Type string Data type of the parameter. Valid values:
text
,aws:ssm:integration
andaws:ec2:image
for AMI format, see the Native parameter support for Amazon Machine Image IDs.- Description string
Description of the parameter.
- Insecure
Value string Value of the parameter. Use caution: This value is never marked as sensitive in the preview. This argument is not valid with a
type
ofSecureString
.- Key
Id string KMS key ID or ARN for encrypting a SecureString.
- Name 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.- Overwrite bool
Overwrite an existing parameter. If not specified, will default to
false
if the resource has not been created by this provider to avoid overwrite of existing resource and will default totrue
otherwise.- map[string]string
Map of tags to assign to the object. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.- Tier 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 anAdvanced
tier parameter toStandard
will recreate the resource. For more information on parameter tiers, see the AWS SSM Parameter tier comparison and guide.- Value string
Value of the parameter. This value is always marked as sensitive in the plan output, regardless of
type
.
- type
String | Parameter
Type Type of the parameter. Valid types are
String
,StringList
andSecureString
.- allowed
Pattern String Regular expression used to validate the parameter value.
- arn String
ARN of the parameter.
- data
Type String Data type of the parameter. Valid values:
text
,aws:ssm:integration
andaws:ec2:image
for AMI format, see the Native parameter support for Amazon Machine Image IDs.- description String
Description of the parameter.
- insecure
Value String Value of the parameter. Use caution: This value is never marked as sensitive in the preview. This argument is not valid with a
type
ofSecureString
.- key
Id String KMS key ID or ARN for encrypting a SecureString.
- name 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.- overwrite Boolean
Overwrite an existing parameter. If not specified, will default to
false
if the resource has not been created by this provider to avoid overwrite of existing resource and will default totrue
otherwise.- Map<String,String>
Map of tags to assign to the object. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.- tier 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 anAdvanced
tier parameter toStandard
will recreate the resource. For more information on parameter tiers, see the AWS SSM Parameter tier comparison and guide.- value String
Value of the parameter. This value is always marked as sensitive in the plan output, regardless of
type
.
- type
string | Parameter
Type Type of the parameter. Valid types are
String
,StringList
andSecureString
.- allowed
Pattern string Regular expression used to validate the parameter value.
- arn string
ARN of the parameter.
- data
Type string Data type of the parameter. Valid values:
text
,aws:ssm:integration
andaws:ec2:image
for AMI format, see the Native parameter support for Amazon Machine Image IDs.- description string
Description of the parameter.
- insecure
Value string Value of the parameter. Use caution: This value is never marked as sensitive in the preview. This argument is not valid with a
type
ofSecureString
.- key
Id string KMS key ID or ARN for encrypting a SecureString.
- name 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.- overwrite boolean
Overwrite an existing parameter. If not specified, will default to
false
if the resource has not been created by this provider to avoid overwrite of existing resource and will default totrue
otherwise.- {[key: string]: string}
Map of tags to assign to the object. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.- tier 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 anAdvanced
tier parameter toStandard
will recreate the resource. For more information on parameter tiers, see the AWS SSM Parameter tier comparison and guide.- value string
Value of the parameter. This value is always marked as sensitive in the plan output, regardless of
type
.
- type
str | Parameter
Type Type of the parameter. Valid types are
String
,StringList
andSecureString
.- allowed_
pattern str Regular expression used to validate the parameter value.
- arn str
ARN of the parameter.
- data_
type str Data type of the parameter. Valid values:
text
,aws:ssm:integration
andaws:ec2:image
for AMI format, see the Native parameter support for Amazon Machine Image IDs.- description str
Description of the parameter.
- insecure_
value str Value of the parameter. Use caution: This value is never marked as sensitive in the preview. This argument is not valid with a
type
ofSecureString
.- key_
id str KMS key ID or ARN for encrypting a SecureString.
- name str
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.- overwrite bool
Overwrite an existing parameter. If not specified, will default to
false
if the resource has not been created by this provider to avoid overwrite of existing resource and will default totrue
otherwise.- Mapping[str, str]
Map of tags to assign to the object. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.- tier str
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 anAdvanced
tier parameter toStandard
will recreate the resource. For more information on parameter tiers, see the AWS SSM Parameter tier comparison and guide.- value str
Value of the parameter. This value is always marked as sensitive in the plan output, regardless of
type
.
- type
String | "String" | "String
List" | "Secure String" Type of the parameter. Valid types are
String
,StringList
andSecureString
.- allowed
Pattern String Regular expression used to validate the parameter value.
- arn String
ARN of the parameter.
- data
Type String Data type of the parameter. Valid values:
text
,aws:ssm:integration
andaws:ec2:image
for AMI format, see the Native parameter support for Amazon Machine Image IDs.- description String
Description of the parameter.
- insecure
Value String Value of the parameter. Use caution: This value is never marked as sensitive in the preview. This argument is not valid with a
type
ofSecureString
.- key
Id String KMS key ID or ARN for encrypting a SecureString.
- name 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.- overwrite Boolean
Overwrite an existing parameter. If not specified, will default to
false
if the resource has not been created by this provider to avoid overwrite of existing resource and will default totrue
otherwise.- Map<String>
Map of tags to assign to the object. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.- tier 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 anAdvanced
tier parameter toStandard
will recreate the resource. For more information on parameter tiers, see the AWS SSM Parameter tier comparison and guide.- value String
Value of the parameter. This value is always marked as sensitive in the plan output, regardless of
type
.
Outputs
All input properties are implicitly available as output properties. Additionally, the Parameter resource produces the following output properties:
Look up Existing Parameter Resource
Get an existing Parameter resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: ParameterState, opts?: CustomResourceOptions): Parameter
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
allowed_pattern: Optional[str] = None,
arn: Optional[str] = None,
data_type: Optional[str] = None,
description: Optional[str] = None,
insecure_value: Optional[str] = None,
key_id: Optional[str] = None,
name: Optional[str] = None,
overwrite: Optional[bool] = None,
tags: Optional[Mapping[str, str]] = None,
tags_all: Optional[Mapping[str, str]] = None,
tier: Optional[str] = None,
type: Optional[Union[str, ParameterType]] = None,
value: Optional[str] = None,
version: Optional[int] = None) -> Parameter
func GetParameter(ctx *Context, name string, id IDInput, state *ParameterState, opts ...ResourceOption) (*Parameter, error)
public static Parameter Get(string name, Input<string> id, ParameterState? state, CustomResourceOptions? opts = null)
public static Parameter get(String name, Output<String> id, ParameterState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Allowed
Pattern string Regular expression used to validate the parameter value.
- Arn string
ARN of the parameter.
- Data
Type string Data type of the parameter. Valid values:
text
,aws:ssm:integration
andaws:ec2:image
for AMI format, see the Native parameter support for Amazon Machine Image IDs.- Description string
Description of the parameter.
- Insecure
Value string Value of the parameter. Use caution: This value is never marked as sensitive in the preview. This argument is not valid with a
type
ofSecureString
.- Key
Id string KMS key ID or ARN for encrypting a SecureString.
- Name 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.- Overwrite bool
Overwrite an existing parameter. If not specified, will default to
false
if the resource has not been created by this provider to avoid overwrite of existing resource and will default totrue
otherwise.- Dictionary<string, string>
Map of tags to assign to the object. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.- Dictionary<string, string>
Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.- Tier 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 anAdvanced
tier parameter toStandard
will recreate the resource. For more information on parameter tiers, see the AWS SSM Parameter tier comparison and guide.- Type
string | Pulumi.
Aws. Ssm. Parameter Type Type of the parameter. Valid types are
String
,StringList
andSecureString
.- Value string
Value of the parameter. This value is always marked as sensitive in the plan output, regardless of
type
.- Version int
Version of the parameter.
- Allowed
Pattern string Regular expression used to validate the parameter value.
- Arn string
ARN of the parameter.
- Data
Type string Data type of the parameter. Valid values:
text
,aws:ssm:integration
andaws:ec2:image
for AMI format, see the Native parameter support for Amazon Machine Image IDs.- Description string
Description of the parameter.
- Insecure
Value string Value of the parameter. Use caution: This value is never marked as sensitive in the preview. This argument is not valid with a
type
ofSecureString
.- Key
Id string KMS key ID or ARN for encrypting a SecureString.
- Name 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.- Overwrite bool
Overwrite an existing parameter. If not specified, will default to
false
if the resource has not been created by this provider to avoid overwrite of existing resource and will default totrue
otherwise.- map[string]string
Map of tags to assign to the object. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.- map[string]string
Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.- Tier 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 anAdvanced
tier parameter toStandard
will recreate the resource. For more information on parameter tiers, see the AWS SSM Parameter tier comparison and guide.- Type
string | Parameter
Type Type of the parameter. Valid types are
String
,StringList
andSecureString
.- Value string
Value of the parameter. This value is always marked as sensitive in the plan output, regardless of
type
.- Version int
Version of the parameter.
- allowed
Pattern String Regular expression used to validate the parameter value.
- arn String
ARN of the parameter.
- data
Type String Data type of the parameter. Valid values:
text
,aws:ssm:integration
andaws:ec2:image
for AMI format, see the Native parameter support for Amazon Machine Image IDs.- description String
Description of the parameter.
- insecure
Value String Value of the parameter. Use caution: This value is never marked as sensitive in the preview. This argument is not valid with a
type
ofSecureString
.- key
Id String KMS key ID or ARN for encrypting a SecureString.
- name 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.- overwrite Boolean
Overwrite an existing parameter. If not specified, will default to
false
if the resource has not been created by this provider to avoid overwrite of existing resource and will default totrue
otherwise.- Map<String,String>
Map of tags to assign to the object. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.- Map<String,String>
Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.- tier 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 anAdvanced
tier parameter toStandard
will recreate the resource. For more information on parameter tiers, see the AWS SSM Parameter tier comparison and guide.- type
String | Parameter
Type Type of the parameter. Valid types are
String
,StringList
andSecureString
.- value String
Value of the parameter. This value is always marked as sensitive in the plan output, regardless of
type
.- version Integer
Version of the parameter.
- allowed
Pattern string Regular expression used to validate the parameter value.
- arn string
ARN of the parameter.
- data
Type string Data type of the parameter. Valid values:
text
,aws:ssm:integration
andaws:ec2:image
for AMI format, see the Native parameter support for Amazon Machine Image IDs.- description string
Description of the parameter.
- insecure
Value string Value of the parameter. Use caution: This value is never marked as sensitive in the preview. This argument is not valid with a
type
ofSecureString
.- key
Id string KMS key ID or ARN for encrypting a SecureString.
- name 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.- overwrite boolean
Overwrite an existing parameter. If not specified, will default to
false
if the resource has not been created by this provider to avoid overwrite of existing resource and will default totrue
otherwise.- {[key: string]: string}
Map of tags to assign to the object. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.- {[key: string]: string}
Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.- tier 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 anAdvanced
tier parameter toStandard
will recreate the resource. For more information on parameter tiers, see the AWS SSM Parameter tier comparison and guide.- type
string | Parameter
Type Type of the parameter. Valid types are
String
,StringList
andSecureString
.- value string
Value of the parameter. This value is always marked as sensitive in the plan output, regardless of
type
.- version number
Version of the parameter.
- allowed_
pattern str Regular expression used to validate the parameter value.
- arn str
ARN of the parameter.
- data_
type str Data type of the parameter. Valid values:
text
,aws:ssm:integration
andaws:ec2:image
for AMI format, see the Native parameter support for Amazon Machine Image IDs.- description str
Description of the parameter.
- insecure_
value str Value of the parameter. Use caution: This value is never marked as sensitive in the preview. This argument is not valid with a
type
ofSecureString
.- key_
id str KMS key ID or ARN for encrypting a SecureString.
- name str
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.- overwrite bool
Overwrite an existing parameter. If not specified, will default to
false
if the resource has not been created by this provider to avoid overwrite of existing resource and will default totrue
otherwise.- Mapping[str, str]
Map of tags to assign to the object. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.- Mapping[str, str]
Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.- tier str
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 anAdvanced
tier parameter toStandard
will recreate the resource. For more information on parameter tiers, see the AWS SSM Parameter tier comparison and guide.- type
str | Parameter
Type Type of the parameter. Valid types are
String
,StringList
andSecureString
.- value str
Value of the parameter. This value is always marked as sensitive in the plan output, regardless of
type
.- version int
Version of the parameter.
- allowed
Pattern String Regular expression used to validate the parameter value.
- arn String
ARN of the parameter.
- data
Type String Data type of the parameter. Valid values:
text
,aws:ssm:integration
andaws:ec2:image
for AMI format, see the Native parameter support for Amazon Machine Image IDs.- description String
Description of the parameter.
- insecure
Value String Value of the parameter. Use caution: This value is never marked as sensitive in the preview. This argument is not valid with a
type
ofSecureString
.- key
Id String KMS key ID or ARN for encrypting a SecureString.
- name 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.- overwrite Boolean
Overwrite an existing parameter. If not specified, will default to
false
if the resource has not been created by this provider to avoid overwrite of existing resource and will default totrue
otherwise.- Map<String>
Map of tags to assign to the object. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.- Map<String>
Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.- tier 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 anAdvanced
tier parameter toStandard
will recreate the resource. For more information on parameter tiers, see the AWS SSM Parameter tier comparison and guide.- type
String | "String" | "String
List" | "Secure String" Type of the parameter. Valid types are
String
,StringList
andSecureString
.- value String
Value of the parameter. This value is always marked as sensitive in the plan output, regardless of
type
.- version Number
Version of the parameter.
Supporting Types
ParameterType
- String
- String
- String
List - StringList
- Secure
String - SecureString
- Parameter
Type String - String
- Parameter
Type String List - StringList
- Parameter
Type Secure String - SecureString
- String
- String
- String
List - StringList
- Secure
String - SecureString
- String
- String
- String
List - StringList
- Secure
String - SecureString
- STRING
- String
- STRING_LIST
- StringList
- SECURE_STRING
- SecureString
- "String"
- String
- "String
List" - StringList
- "Secure
String" - SecureString
Import
SSM Parameters can be imported using the parameter store name
, e.g.,
$ pulumi import aws:ssm/parameter:Parameter my_param /my_path/my_paramname
Package Details
- Repository
- AWS Classic pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
aws
Terraform Provider.