com.pulumi.aws.ssm.ParameterArgs Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of aws Show documentation
Show all versions of aws Show documentation
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
The newest version!
// *** WARNING: this file was generated by pulumi-java-gen. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
package com.pulumi.aws.ssm;
import com.pulumi.aws.ssm.enums.ParameterType;
import com.pulumi.core.Either;
import com.pulumi.core.Output;
import com.pulumi.core.annotations.Import;
import com.pulumi.exceptions.MissingRequiredPropertyException;
import java.lang.Boolean;
import java.lang.String;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import javax.annotation.Nullable;
public final class ParameterArgs extends com.pulumi.resources.ResourceArgs {
public static final ParameterArgs Empty = new ParameterArgs();
/**
* Regular expression used to validate the parameter value.
*
*/
@Import(name="allowedPattern")
private @Nullable Output allowedPattern;
/**
* @return Regular expression used to validate the parameter value.
*
*/
public Optional> allowedPattern() {
return Optional.ofNullable(this.allowedPattern);
}
/**
* ARN of the parameter.
*
*/
@Import(name="arn")
private @Nullable Output arn;
/**
* @return ARN of the parameter.
*
*/
public Optional> arn() {
return Optional.ofNullable(this.arn);
}
/**
* 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](https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-ec2-aliases.html).
*
*/
@Import(name="dataType")
private @Nullable Output dataType;
/**
* @return 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](https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-ec2-aliases.html).
*
*/
public Optional> dataType() {
return Optional.ofNullable(this.dataType);
}
/**
* Description of the parameter.
*
*/
@Import(name="description")
private @Nullable Output description;
/**
* @return Description of the parameter.
*
*/
public Optional> description() {
return Optional.ofNullable(this.description);
}
/**
* 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 `type` of `SecureString`.
*
*/
@Import(name="insecureValue")
private @Nullable Output insecureValue;
/**
* @return 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 `type` of `SecureString`.
*
*/
public Optional> insecureValue() {
return Optional.ofNullable(this.insecureValue);
}
/**
* KMS key ID or ARN for encrypting a SecureString.
*
*/
@Import(name="keyId")
private @Nullable Output keyId;
/**
* @return KMS key ID or ARN for encrypting a SecureString.
*
*/
public Optional> keyId() {
return Optional.ofNullable(this.keyId);
}
/**
* 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](https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-parameter-name-constraints.html).
*
*/
@Import(name="name")
private @Nullable Output name;
/**
* @return 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](https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-parameter-name-constraints.html).
*
*/
public Optional> name() {
return Optional.ofNullable(this.name);
}
/**
* 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).
*
* @deprecated
* this attribute has been deprecated
*
*/
@Deprecated /* this attribute has been deprecated */
@Import(name="overwrite")
private @Nullable Output overwrite;
/**
* @return 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).
*
* @deprecated
* this attribute has been deprecated
*
*/
@Deprecated /* this attribute has been deprecated */
public Optional> overwrite() {
return Optional.ofNullable(this.overwrite);
}
/**
* 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.
*
*/
@Import(name="tags")
private @Nullable Output> tags;
/**
* @return 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.
*
*/
public Optional>> tags() {
return Optional.ofNullable(this.tags);
}
/**
* 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](https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-advanced-parameters.html).
*
*/
@Import(name="tier")
private @Nullable Output tier;
/**
* @return 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](https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-advanced-parameters.html).
*
*/
public Optional> tier() {
return Optional.ofNullable(this.tier);
}
/**
* Type of the parameter. Valid types are `String`, `StringList` and `SecureString`.
*
* The following arguments are optional:
*
*/
@Import(name="type", required=true)
private Output> type;
/**
* @return Type of the parameter. Valid types are `String`, `StringList` and `SecureString`.
*
* The following arguments are optional:
*
*/
public Output> type() {
return this.type;
}
/**
* Value of the parameter. This value is always marked as sensitive in the pulumi preview output, regardless of `type`.
*
* > **NOTE:** `aws:ssm:integration` data_type parameters must be of the type `SecureString` and the name must start with the prefix `/d9d01087-4a3f-49e0-b0b4-d568d7826553/ssm/integrations/webhook/`. See [here](https://docs.aws.amazon.com/systems-manager/latest/userguide/creating-integrations.html) for information on the usage of `aws:ssm:integration` parameters.
*
*/
@Import(name="value")
private @Nullable Output value;
/**
* @return Value of the parameter. This value is always marked as sensitive in the pulumi preview output, regardless of `type`.
*
* > **NOTE:** `aws:ssm:integration` data_type parameters must be of the type `SecureString` and the name must start with the prefix `/d9d01087-4a3f-49e0-b0b4-d568d7826553/ssm/integrations/webhook/`. See [here](https://docs.aws.amazon.com/systems-manager/latest/userguide/creating-integrations.html) for information on the usage of `aws:ssm:integration` parameters.
*
*/
public Optional> value() {
return Optional.ofNullable(this.value);
}
private ParameterArgs() {}
private ParameterArgs(ParameterArgs $) {
this.allowedPattern = $.allowedPattern;
this.arn = $.arn;
this.dataType = $.dataType;
this.description = $.description;
this.insecureValue = $.insecureValue;
this.keyId = $.keyId;
this.name = $.name;
this.overwrite = $.overwrite;
this.tags = $.tags;
this.tier = $.tier;
this.type = $.type;
this.value = $.value;
}
public static Builder builder() {
return new Builder();
}
public static Builder builder(ParameterArgs defaults) {
return new Builder(defaults);
}
public static final class Builder {
private ParameterArgs $;
public Builder() {
$ = new ParameterArgs();
}
public Builder(ParameterArgs defaults) {
$ = new ParameterArgs(Objects.requireNonNull(defaults));
}
/**
* @param allowedPattern Regular expression used to validate the parameter value.
*
* @return builder
*
*/
public Builder allowedPattern(@Nullable Output allowedPattern) {
$.allowedPattern = allowedPattern;
return this;
}
/**
* @param allowedPattern Regular expression used to validate the parameter value.
*
* @return builder
*
*/
public Builder allowedPattern(String allowedPattern) {
return allowedPattern(Output.of(allowedPattern));
}
/**
* @param arn ARN of the parameter.
*
* @return builder
*
*/
public Builder arn(@Nullable Output arn) {
$.arn = arn;
return this;
}
/**
* @param arn ARN of the parameter.
*
* @return builder
*
*/
public Builder arn(String arn) {
return arn(Output.of(arn));
}
/**
* @param dataType 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](https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-ec2-aliases.html).
*
* @return builder
*
*/
public Builder dataType(@Nullable Output dataType) {
$.dataType = dataType;
return this;
}
/**
* @param dataType 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](https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-ec2-aliases.html).
*
* @return builder
*
*/
public Builder dataType(String dataType) {
return dataType(Output.of(dataType));
}
/**
* @param description Description of the parameter.
*
* @return builder
*
*/
public Builder description(@Nullable Output description) {
$.description = description;
return this;
}
/**
* @param description Description of the parameter.
*
* @return builder
*
*/
public Builder description(String description) {
return description(Output.of(description));
}
/**
* @param insecureValue 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 `type` of `SecureString`.
*
* @return builder
*
*/
public Builder insecureValue(@Nullable Output insecureValue) {
$.insecureValue = insecureValue;
return this;
}
/**
* @param insecureValue 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 `type` of `SecureString`.
*
* @return builder
*
*/
public Builder insecureValue(String insecureValue) {
return insecureValue(Output.of(insecureValue));
}
/**
* @param keyId KMS key ID or ARN for encrypting a SecureString.
*
* @return builder
*
*/
public Builder keyId(@Nullable Output keyId) {
$.keyId = keyId;
return this;
}
/**
* @param keyId KMS key ID or ARN for encrypting a SecureString.
*
* @return builder
*
*/
public Builder keyId(String keyId) {
return keyId(Output.of(keyId));
}
/**
* @param name 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](https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-parameter-name-constraints.html).
*
* @return builder
*
*/
public Builder name(@Nullable Output name) {
$.name = name;
return this;
}
/**
* @param name 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](https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-parameter-name-constraints.html).
*
* @return builder
*
*/
public Builder name(String name) {
return name(Output.of(name));
}
/**
* @param overwrite 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).
*
* @return builder
*
* @deprecated
* this attribute has been deprecated
*
*/
@Deprecated /* this attribute has been deprecated */
public Builder overwrite(@Nullable Output overwrite) {
$.overwrite = overwrite;
return this;
}
/**
* @param overwrite 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).
*
* @return builder
*
* @deprecated
* this attribute has been deprecated
*
*/
@Deprecated /* this attribute has been deprecated */
public Builder overwrite(Boolean overwrite) {
return overwrite(Output.of(overwrite));
}
/**
* @param tags 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.
*
* @return builder
*
*/
public Builder tags(@Nullable Output> tags) {
$.tags = tags;
return this;
}
/**
* @param tags 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.
*
* @return builder
*
*/
public Builder tags(Map tags) {
return tags(Output.of(tags));
}
/**
* @param tier 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](https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-advanced-parameters.html).
*
* @return builder
*
*/
public Builder tier(@Nullable Output tier) {
$.tier = tier;
return this;
}
/**
* @param tier 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](https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-advanced-parameters.html).
*
* @return builder
*
*/
public Builder tier(String tier) {
return tier(Output.of(tier));
}
/**
* @param type Type of the parameter. Valid types are `String`, `StringList` and `SecureString`.
*
* The following arguments are optional:
*
* @return builder
*
*/
public Builder type(Output> type) {
$.type = type;
return this;
}
/**
* @param type Type of the parameter. Valid types are `String`, `StringList` and `SecureString`.
*
* The following arguments are optional:
*
* @return builder
*
*/
public Builder type(Either type) {
return type(Output.of(type));
}
/**
* @param type Type of the parameter. Valid types are `String`, `StringList` and `SecureString`.
*
* The following arguments are optional:
*
* @return builder
*
*/
public Builder type(String type) {
return type(Either.ofLeft(type));
}
/**
* @param type Type of the parameter. Valid types are `String`, `StringList` and `SecureString`.
*
* The following arguments are optional:
*
* @return builder
*
*/
public Builder type(ParameterType type) {
return type(Either.ofRight(type));
}
/**
* @param value Value of the parameter. This value is always marked as sensitive in the pulumi preview output, regardless of `type`.
*
* > **NOTE:** `aws:ssm:integration` data_type parameters must be of the type `SecureString` and the name must start with the prefix `/d9d01087-4a3f-49e0-b0b4-d568d7826553/ssm/integrations/webhook/`. See [here](https://docs.aws.amazon.com/systems-manager/latest/userguide/creating-integrations.html) for information on the usage of `aws:ssm:integration` parameters.
*
* @return builder
*
*/
public Builder value(@Nullable Output value) {
$.value = value;
return this;
}
/**
* @param value Value of the parameter. This value is always marked as sensitive in the pulumi preview output, regardless of `type`.
*
* > **NOTE:** `aws:ssm:integration` data_type parameters must be of the type `SecureString` and the name must start with the prefix `/d9d01087-4a3f-49e0-b0b4-d568d7826553/ssm/integrations/webhook/`. See [here](https://docs.aws.amazon.com/systems-manager/latest/userguide/creating-integrations.html) for information on the usage of `aws:ssm:integration` parameters.
*
* @return builder
*
*/
public Builder value(String value) {
return value(Output.of(value));
}
public ParameterArgs build() {
if ($.type == null) {
throw new MissingRequiredPropertyException("ParameterArgs", "type");
}
return $;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy