Package com.pulumi.aws.ssm

Class ParameterArgs

  • public final class ParameterArgs
extends com.pulumi.resources.ResourceArgs

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  ParameterArgs.Builder  

      • Nested classes/interfaces inherited from class com.pulumi.resources.InputArgs

        com.pulumi.resources.InputArgs.InputArgsInternal

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> allowedPattern()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> arn()  
      static ParameterArgs.Builder builder()  
      static ParameterArgs.Builder builder​(ParameterArgs defaults)  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> dataType()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> description()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> insecureValue()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> keyId()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> name()  
      java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> overwrite()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> region()  
      java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>>> tags()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> tier()  
      com.pulumi.core.Output<com.pulumi.core.Either<java.lang.String,​ParameterType>> type()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> value()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> valueWo()  
      java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> valueWoVersion()  

      • Methods inherited from class com.pulumi.resources.ResourceArgs

        validateMember

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Method Detail

      • allowedPattern

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> allowedPattern()
        Returns:
        Regular expression used to validate the parameter value.

      • arn

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> arn()
        Returns:
        ARN of the parameter.

      • dataType

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> dataType()
        Returns:
        Data type of the parameter. Valid values: `text`, `aws:ssm:integration` and `aws:ec2:image` for AMI format, see the [Native parameter support for AMI IDs](https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-ec2-aliases.html).

      • description

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> description()
        Returns:
        Description of the parameter.

      • insecureValue

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> insecureValue()
        Returns:
        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`.

      • keyId

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> keyId()
        Returns:
        KMS key ID or ARN for encrypting a SecureString.

      • name

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> name()
        Returns:
        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).

      • overwrite

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> overwrite()
        Returns:
        Overwrite an existing parameter. If not specified, defaults to `false` during create operations to avoid overwriting existing resources and then `true` for all subsequent operations once the resource is managed by IAC. Lifecycle rules should be used to manage non-standard update behavior.

      • region

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> region()
        Returns:
        Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.

      • tags

        public java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        Map of tags to assign to the object. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.

      • tier

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> tier()
        Returns:
        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).

      • type

        public com.pulumi.core.Output<com.pulumi.core.Either<java.lang.String,​ParameterType>> type()
        Returns:
        Type of the parameter. Valid types are `String`, `StringList` and `SecureString`. The following arguments are optional:

      • value

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> value()
        Returns:
        Value of the parameter. This value is always marked as sensitive in the pulumi preview output, regardless of `type

      • valueWo

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> valueWo()
        Returns:
        **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-only` values are never stored to state. If set, requires `valueWoVersion`.

      • valueWoVersion

        public java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> valueWoVersion()
        Returns:
        Required when `valueWo` is set. Changing this value triggers an update to `valueWo`. > **NOTE:** `aws:ssm:integration` dataType 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.