pulumi-aws-kotlin/com.pulumi.aws.ssm.kotlin/Parameter

Parameter

class Parameter : KotlinCustomResource

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. This argument has been deprecated and will be removed in v6.0.0 of the provider. For more information on how this affects the behavior of this resource, see this issue comment.

Example Usage

Basic example

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());
    }
}
Content copied to clipboard

Encrypted string using default SSM KMS key

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")
            .dbName("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());
    }
}
Content copied to clipboard

Import

Using pulumi import, import SSM Parameters using the parameter store name. For example:

$ pulumi import aws:ssm/parameter:Parameter my_param /my_path/my_paramname
Content copied to clipboard

Properties

Link copied to clipboard
val allowedPattern: Output<String>?

Regular expression used to validate the parameter value.

Link copied to clipboard
val arn: Output<String>

ARN of the parameter.

Link copied to clipboard
val dataType: Output<String>

Data type of the parameter. Valid values: text, aws:ssm:integration and aws:ec2:image for AMI format, see the Native parameter support for Amazon Machine Image IDs.

Link copied to clipboard
val description: Output<String>?

Description of the parameter.

Link copied to clipboard
val id: Output<String>
Link copied to clipboard
val insecureValue: Output<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 of SecureString.

Link copied to clipboard
val keyId: Output<String>

KMS key ID or ARN for encrypting a SecureString.

Link copied to clipboard
val name: Output<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.

Link copied to clipboard
val overwrite: Output<Boolean>?

Overwrite an existing parameter. If not specified, defaults to false if the resource has not been created by Pulumi to avoid overwrite of existing resource, and will default to true otherwise (Pulumi lifecycle rules should then be used to manage the update behavior).

Link copied to clipboard
val pulumiChildResources: Set<KotlinResource>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val tags: Output<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.

Link copied to clipboard
val tagsAll: Output<Map<String, String>>

Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Link copied to clipboard
val tier: Output<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, and Intelligent-Tiering. Downgrading an Advanced tier parameter to Standard will recreate the resource. For more information on parameter tiers, see the AWS SSM Parameter tier comparison and guide.

Link copied to clipboard
val type: Output<String>

Type of the parameter. Valid types are String, StringList and SecureString. The following arguments are optional:

Link copied to clipboard
val urn: Output<String>
Link copied to clipboard
val value: Output<String>

Value of the parameter. This value is always marked as sensitive in the plan output, regardless of type.

Link copied to clipboard
val version: Output<Int>

Version of the parameter.